Class AbstractMultiKey`Abstract`

An abstract representation of an account public key.

Provides a common interface for deriving an authentication key.

Hierarchy (view full)

AccountPublicKey
- AbstractMultiKey
  - MultiEd25519PublicKey
  - MultiKey

Index

Implementation - BCS

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the TypeScript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer.
Inherited from AccountPublicKey.bcsToBytes
- Defined in src/bcs/serializer.ts:45

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

Returns Hex
A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
Inherited from AccountPublicKey.bcsToHex
- Defined in src/bcs/serializer.ts:58

Implementation - Serialization

`Abstract`authKey

authKey(): AuthenticationKey
Get the authentication key associated with this public key

Returns AuthenticationKey
Inherited from AccountPublicKey.authKey
- Defined in src/core/crypto/publicKey.ts:105

createBitmap

createBitmap(args): Uint8Array
Create a bitmap that holds the mapping from the original public keys to the signatures passed in
Parameters
- args: {
  bits: number[];
  }
  - bits: number[]
    array of the index mapping to the matching public keys
Returns Uint8Array
Uint8array bit map
- Defined in src/core/crypto/multiKey.ts:45

getIndex

getIndex(publicKey): number
Get the index of the provided public key.

This function retrieves the index of a specified public key within the MultiKey. If the public key does not exist, it throws an error.
Parameters
- publicKey: PublicKey
  The public key to find the index for.
Returns number
The corresponding index of the public key, if it exists.

Throws
Error - If the public key is not found in the MultiKey.
- Defined in src/core/crypto/multiKey.ts:91

toString

toString(): string
Get the public key as a hex string with a 0x prefix.

Returns string
The public key in hex format.
Inherited from AccountPublicKey.toString
- Defined in src/core/crypto/publicKey.ts:84

toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

Returns Uint8Array
Inherited from AccountPublicKey.toUint8Array
- Defined in src/core/crypto/publicKey.ts:73

`Abstract`verifySignature

verifySignature(args): boolean
Verifies that the private key associated with this public key signed the message with the given signature.
Parameters
- args: VerifySignatureArgs
Returns boolean
Inherited from AccountPublicKey.verifySignature
- Defined in src/core/crypto/publicKey.ts:54

verifySignatureAsync

verifySignatureAsync(args): Promise<boolean>
Verifies signature with the public key and makes any network calls required to get state required to verify the signature.
Parameters
- args: VerifySignatureAsyncArgs
Returns Promise<boolean>
Inherited from AccountPublicKey.verifySignatureAsync
- Defined in src/core/crypto/publicKey.ts:64

Constructors

constructor

new AbstractMultiKey(args): AbstractMultiKey
Parameters
- args: {
  publicKeys: PublicKey[];
  }
  - publicKeys: PublicKey[]
Returns AbstractMultiKey
Overrides AccountPublicKey.constructor
- Defined in src/core/crypto/multiKey.ts:31

Methods

`Abstract`getSignaturesRequired

getSignaturesRequired(): number
Returns number
- Defined in src/core/crypto/multiKey.ts:100

`Abstract`serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Inherited from AccountPublicKey.serialize
- Defined in src/bcs/serializer.ts:36

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from AccountPublicKey.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:67

Properties

publicKeys

publicKeys: PublicKey[]

Class AbstractMultiKeyAbstract

Hierarchy (view full)

Index

Implementation - BCS

Implementation - Serialization

Constructors

Methods

Properties

Implementation - BCS

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

Implementation - Serialization

AbstractauthKey

Returns AuthenticationKey

createBitmap

Parameters

bits: number[]

Returns Uint8Array

getIndex

Parameters

Returns number

Throws

toString

Returns string

toUint8Array

Returns Uint8Array

AbstractverifySignature

Parameters

Returns boolean

verifySignatureAsync

Parameters

Returns Promise<boolean>

Constructors

constructor

Parameters

publicKeys: PublicKey[]

Returns AbstractMultiKey

Methods

AbstractgetSignaturesRequired

Returns number

Abstractserialize

Parameters

Returns void

toStringWithoutPrefix

Returns string

Properties

publicKeys

Settings

On This Page

Class AbstractMultiKey`Abstract`

`Abstract`authKey

`Abstract`verifySignature

`Abstract`getSignaturesRequired

`Abstract`serialize