Class Key

Represents a Key that can identify different types of entities in the system.

Hierarchy

  • Key

Constructors

constructor

Properties

account? addressableEntity? balance? balanceHold? bid? bidAddr? blockGlobal? byteCode? chainspecRegistry? checksumRegistry? deploy? dictionary? entryPoint? era? eraSummary? hash? message? namedKey? package? systemContactRegistry? transfer? type uRef? unbond? withdraw?

Methods

bytes toJSON toPrefixedString toString concatBytes createByType findPrefixByMap fromBytes newKey parseTypeByString

Constructors

constructor

Properties

Optional account

account?: AccountHash

Optional addressableEntity

addressableEntity?: EntityAddr

Optional balance

balance?: Hash

Optional balanceHold

balanceHold?: BalanceHoldAddr

Optional bid

bid?: AccountHash

Optional bidAddr

bidAddr?: BidAddr

Optional blockGlobal

blockGlobal?: BlockGlobalAddr

Optional byteCode

byteCode?: ByteCode

Optional chainspecRegistry

chainspecRegistry?: Hash

Optional checksumRegistry

checksumRegistry?: Hash

Optional deploy

deploy?: Hash

Optional dictionary

dictionary?: Hash

Optional entryPoint

entryPoint?: EntryPointAddr

Optional era

era?: Era

Optional eraSummary

eraSummary?: Hash

Optional hash

hash?: Hash

Optional message

message?: MessageAddr

Optional namedKey

namedKey?: NamedKeyAddr

Optional package

package?: Hash

Optional systemContactRegistry

systemContactRegistry?: Hash

Optional transfer

transfer?: TransferHash

type

type: KeyTypeID

Optional uRef

uRef?: URef

Optional unbond

unbond?: AccountHash

Optional withdraw

withdraw?: AccountHash

Methods

bytes

  • Converts the key to bytes.

    Returns

    A Uint8Array representing the serialized key.

    Parameters

    • withKeyTypeID: boolean = true

    Returns Uint8Array

toJSON

  • Converts the instance to a JSON-compatible hexadecimal string.

    Returns

    The hex-encoded string representation of the instance.

    Returns string

toPrefixedString

  • Converts the key to a prefixed string representation.

    Returns

    The prefixed string of the key.

    Returns string

toString

  • Converts the key to a string representation.

    Returns

    The string representation of the key.

    Returns string

Static Private concatBytes

  • Concatenates the type and field bytes.

    Returns

    A Uint8Array with concatenated type and field bytes.

    Parameters

    • fieldBytes: Uint8Array = ...

      The bytes representing the field.

    • Optional typeBytes: Uint8Array

      The bytes representing the type.

    Returns Uint8Array

Static createByType

  • Creates a Key instance based on the type ID and source string.

    Returns

    A new Key instance.

    Throws

    Error if the type is not found or invalid.

    Parameters

    • source: string

      The string containing the key data.

    • typeID: KeyTypeID

      The TypeID of the key.

    Returns Key

Static findPrefixByMap

  • Finds the prefix name by matching the source string with a map of prefixes.

    Returns

    The matching PrefixName or undefined if not found.

    Parameters

    • source: string

      The string to check for a matching prefix.

    • prefixes: Map<PrefixName, KeyTypeID>

      The map of prefix names to KeyTypeID.

    Returns PrefixName

Static fromBytes

Static newKey

  • Creates a new Key instance from a source string.

    Returns

    A new Key instance.

    Throws

    Error if the prefix is not found or the source is invalid.

    Parameters

    • source: string

      The string containing the key data.

    Returns Key

Static parseTypeByString

  • Parses a Key instance from a string representation.

    Returns

    A new Key instance.

    Throws

    Error if the format is invalid or unexpected.

    Parameters

    • source: string

      The string containing the key data.

    Returns Key

Settings

Member Visibility

Theme

Generated using TypeDoc