Class MultiKeySignature

Represents a multi-signature transaction using Ed25519 signatures. This class allows for the creation and management of a K-of-N multi-signature scheme, where a specified number of signatures are required to authorize a transaction.

It includes functionality to validate the number of signatures against a bitmap, which indicates which public keys have signed the transaction.

Hierarchy (view full)

Signature
- MultiKeySignature

Index

Constructors

constructor

new MultiKeySignature(args): MultiKeySignature
Signature for a K-of-N multi-sig transaction.
Parameters
- args: {
  bitmap: Uint8Array | number[];
  signatures: (Signature | AnySignature)[];
  }
  - bitmap: Uint8Array | number[]
    4 bytes, at most 32 signatures are supported. If Nth bit value is 1, the Nth signature should be provided in signatures. Bits are read from left to right
  - signatures: (Signature | AnySignature)[]
    A list of signatures
Returns MultiKeySignature
See
Creating a Signed Transaction
Overrides Signature.constructor
- Defined in src/core/crypto/multiKey.ts:248

Methods

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 Signature.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 Signature.bcsToHex
- Defined in src/bcs/serializer.ts:40

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Signature.serialize
- Defined in src/core/crypto/multiKey.ts:325

toString

toString(): string
Get the signature as a hex string with a 0x prefix e.g. 0x123456...

Returns string
The hex string representation of the signature.
Inherited from Signature.toString
- Defined in src/core/crypto/signature.ts:23

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 Signature.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:49

toUint8Array

toUint8Array(): Uint8Array
Get the raw signature bytes

Returns Uint8Array
Inherited from Signature.toUint8Array
- Defined in src/core/crypto/signature.ts:15

`Static`createBitmap

createBitmap(args): Uint8Array
Helper method to create a bitmap out of the specified bit positions
Parameters
- args: {
  bits: number[];
  }
  - bits: number[]
    The bitmap positions that should be set. A position starts at index 0. Valid position should range between 0 and 31.
Returns Uint8Array
bitmap that is 32bit long
Example
Here's an example of valid bits
```
[0, 2, 31]
```
[0, 2, 31] means the 1st, 3rd and 32nd bits should be set in the bitmap. The result bitmap should be 0b1010000000000000000000000000001
- Defined in src/core/crypto/multiKey.ts:289

`Static`deserialize

deserialize(deserializer): MultiKeySignature
Parameters
- deserializer: Deserializer
Returns MultiKeySignature
- Defined in src/core/crypto/multiKey.ts:331

Properties

`Readonly`bitmap

bitmap: Uint8Array

32-bit Bitmap representing who signed the transaction

This is represented where each public key can be masked to determine whether the message was signed by that key.

`Readonly`signatures

signatures: AnySignature[]

The list of underlying Ed25519 signatures

`Static`BITMAP_LEN

BITMAP_LEN: number = 4

Number of bytes in the bitmap representing who signed the transaction (32-bits)

`Static`MAX_SIGNATURES_SUPPORTED

MAX_SIGNATURES_SUPPORTED: number = ...

Maximum number of Ed25519 signatures supported

Class MultiKeySignature

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

bitmap: Uint8Array | number[]

signatures: (Signature | AnySignature)[]

Returns MultiKeySignature

See

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

StaticcreateBitmap

Parameters

bits: number[]

Returns Uint8Array

Example

Staticdeserialize

Parameters

Returns MultiKeySignature

Properties

Readonlybitmap

Readonlysignatures

StaticBITMAP_LEN

StaticMAX_SIGNATURES_SUPPORTED

Settings

On This Page

`Static`createBitmap

`Static`deserialize

`Readonly`bitmap

`Readonly`signatures

`Static`BITMAP_LEN

`Static`MAX_SIGNATURES_SUPPORTED