Class MultiEd25519PublicKey

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

Hierarchy (view full)

Constructors

constructor

Properties

publicKeys threshold MAX_KEYS MIN_KEYS MIN_THRESHOLD

Methods

authKey bcsToBytes bcsToHex serialize toString toUint8Array verifySignature deserialize

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;
      }
      • publicKeys: Ed25519PublicKey[]

        A list of public keys

      • threshold: number

        At least "threshold" signatures must be valid

    Returns MultiEd25519PublicKey

    See

    Creating a Signed Transaction

Properties

ReadonlypublicKeys

publicKeys: Ed25519PublicKey[]

List of Ed25519 public keys for this LegacyMultiEd25519PublicKey

Readonlythreshold

threshold: number

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

Static ReadonlyMAX_KEYS

MAX_KEYS: 32 = 32

Maximum number of public keys supported

Static ReadonlyMIN_KEYS

MIN_KEYS: 2 = 2

Minimum number of public keys needed

Static ReadonlyMIN_THRESHOLD

MIN_THRESHOLD: 1 = 1

Minimum threshold for the number of valid signatures required

Methods

authKey

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

bcsToHex

  • bcsToHex(): Hex

  • Helper function to get a value's BCS-serialized bytes as a Hex instance.

    Returns Hex

    a Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array

serialize

  • serialize(serializer): void

  • Parameters

    Returns void

toString

  • toString(): string

  • Get the public key as a hex string with a 0x prefix e.g. 0x123456...

    Returns string

toUint8Array

  • toUint8Array(): Uint8Array

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

    Returns Uint8Array

verifySignature

  • verifySignature(args): boolean

  • Verifies that the private key associated with this public key signed the message with the given signature.

    Parameters

    Returns boolean

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods