Class MultiEd25519PublicKey

Represents the public key of a K-of-N Ed25519 multi-sig transaction.

A K-of-N multi-sig transaction requires at least K out of N authorized signers to sign the transaction for it to be executed. This class encapsulates the logic for managing the public keys and the threshold for valid signatures.

See

Creating a Signed Transaction

Hierarchy (view full)

AccountPublicKey
- MultiEd25519PublicKey

Index

Constructors

constructor

new MultiEd25519PublicKey(args): MultiEd25519PublicKey
Public key for a K-of-N multi-sig transaction. A K-of-N multi-sig transaction means that for such a transaction to be executed, at least K out of the N authorized signers have signed the transaction and passed the check conducted by the chain.
Parameters
- args: {
  publicKeys: Ed25519PublicKey[];
  threshold: number;
  }
  A wrapper to let you choose the param order.
  - publicKeys: Ed25519PublicKey[]
    A list of public keys
  - threshold: number
    At least "threshold" signatures must be valid
Returns MultiEd25519PublicKey
See
Creating a Signed Transaction
Overrides AccountPublicKey.constructor
- Defined in src/core/crypto/multiEd25519.ts:57

Methods

authKey

authKey(): AuthenticationKey
Generates an authentication key based on the current instance's byte representation. This function is essential for creating a secure authentication key that can be used for various cryptographic operations.

Returns AuthenticationKey
The generated authentication key.
Overrides AccountPublicKey.authKey
- Defined in src/core/crypto/multiEd25519.ts:133

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:29

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:40

serialize

serialize(serializer): void
Serializes the current instance into bytes using the provided serializer. This allows for the conversion of the instance's data into a format suitable for transmission or storage.
Parameters
- serializer: Serializer
  The serializer used to convert the instance into bytes.
Returns void
Overrides AccountPublicKey.serialize
- Defined in src/core/crypto/multiEd25519.ts:164

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:44

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:49

toUint8Array

toUint8Array(): Uint8Array
Converts a PublicKeys into Uint8Array (bytes) with: bytes = p1_bytes | ... | pn_bytes | threshold

Returns Uint8Array
Overrides AccountPublicKey.toUint8Array
- Defined in src/core/crypto/multiEd25519.ts:143

verifySignature

verifySignature(args): boolean
Verifies a multi-signature against a given message. This function ensures that the provided signatures meet the required threshold and are valid for the given message.
Parameters
- args: VerifySignatureArgs
  The arguments for verifying the signature.
Returns boolean
True if the signature is valid; otherwise, false.

Throws
Error if the bitmap and signatures length mismatch or if there are not enough valid signatures.
Overrides AccountPublicKey.verifySignature
- Defined in src/core/crypto/multiEd25519.ts:92

`Static`deserialize

deserialize(deserializer): MultiEd25519PublicKey
Deserializes a MultiEd25519Signature from the provided deserializer. This function helps in reconstructing a MultiEd25519Signature object from its serialized byte representation.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns MultiEd25519PublicKey
- Defined in src/core/crypto/multiEd25519.ts:174

Properties

`Readonly`publicKeys

publicKeys: Ed25519PublicKey[]

List of Ed25519 public keys for this LegacyMultiEd25519PublicKey

`Readonly`threshold

threshold: number

The minimum number of valid signatures required, for the number of public keys specified

`Static` `Readonly`MAX_KEYS

MAX_KEYS = 32

Maximum number of public keys supported

`Static` `Readonly`MIN_KEYS

MIN_KEYS = 2

Minimum number of public keys needed

`Static` `Readonly`MIN_THRESHOLD

MIN_THRESHOLD = 1

Minimum threshold for the number of valid signatures required

Class MultiEd25519PublicKey

See

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

publicKeys: Ed25519PublicKey[]

threshold: number

Returns MultiEd25519PublicKey

See

Methods

authKey

Returns AuthenticationKey

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

verifySignature

Parameters

Returns boolean

Throws

Staticdeserialize

Parameters

Returns MultiEd25519PublicKey

Properties

ReadonlypublicKeys

Readonlythreshold

Static ReadonlyMAX_KEYS

Static ReadonlyMIN_KEYS

Static ReadonlyMIN_THRESHOLD

Settings

On This Page

`Static`deserialize

`Readonly`publicKeys

`Readonly`threshold

`Static` `Readonly`MAX_KEYS

`Static` `Readonly`MIN_KEYS

`Static` `Readonly`MIN_THRESHOLD