Class MultiSigPublicKey

A MultiSig public key

Hierarchy (view full)

Constructors

constructor

Methods

combinePartialSignatures equals flag getPublicKeys getSigner getThreshold toBase64 toRawBytes toString toSuiAddress toSuiBytes toSuiPublicKey verify verifyAddress verifyPersonalMessage verifyTransaction verifyWithIntent fromPublicKeys

Constructors

constructor

Methods

combinePartialSignatures

  • combinePartialSignatures(signatures): string

  • Combines multiple partial signatures into a single multisig, ensuring that each public key signs only once and that all the public keys involved are known and valid, and then serializes multisig into the standard format

    Parameters

    • signatures: string[]

    Returns string

equals

  • equals(publicKey): boolean

  • Checks if two MultiSig public keys are equal

    Parameters

    Returns boolean

flag

  • flag(): number

  • Return the Sui address associated with this MultiSig public key

    Returns number

getPublicKeys

  • getPublicKeys(): {
        publicKey: PublicKey;
        weight: number;
    }[]

  • Returns {
        publicKey: PublicKey;
        weight: number;
    }[]

getSigner

getThreshold

  • getThreshold(): number

  • Returns number

toBase64

  • toBase64(): string

  • Return the base-64 representation of the public key

    Returns string

toRawBytes

  • toRawBytes(): Uint8Array

  • Return the byte array representation of the MultiSig public key

    Returns Uint8Array

toString

  • toString(): never

  • Returns never

toSuiAddress

  • toSuiAddress(): string

  • Return the Sui address associated with this MultiSig public key

    Returns string

toSuiBytes

  • toSuiBytes(): Uint8Array

  • Returns the bytes representation of the public key prefixed with the signature scheme flag

    Returns Uint8Array

toSuiPublicKey

  • toSuiPublicKey(): string

  • Return the Sui representation of the public key encoded in base-64. A Sui public key is formed by the concatenation of the scheme flag with the raw bytes of the public key

    Returns string

verify

  • verify(message, multisigSignature): Promise<boolean>

  • Verifies that the signature is valid for for the provided message

    Parameters

    • message: Uint8Array
    • multisigSignature: string

    Returns Promise<boolean>

verifyAddress

  • verifyAddress(address): boolean

  • Verifies that the public key is associated with the provided address

    Parameters

    • address: string

    Returns boolean

verifyPersonalMessage

  • verifyPersonalMessage(message, signature): Promise<boolean>

  • Verifies that the signature is valid for for the provided PersonalMessage

    Parameters

    • message: Uint8Array
    • signature: string | Uint8Array

    Returns Promise<boolean>

verifyTransaction

  • verifyTransaction(transaction, signature): Promise<boolean>

  • Verifies that the signature is valid for for the provided Transaction

    Parameters

    • transaction: Uint8Array
    • signature: string | Uint8Array

    Returns Promise<boolean>

verifyWithIntent

  • verifyWithIntent(bytes, signature, intent): Promise<boolean>

  • Parameters

    • bytes: Uint8Array
    • signature: string | Uint8Array
    • intent: IntentScope

    Returns Promise<boolean>

StaticfromPublicKeys

  • fromPublicKeys(__namedParameters): MultiSigPublicKey

  • A static method to create a new MultiSig publickey instance from a set of public keys and their associated weights pairs and threshold.

    Parameters

    • __namedParameters: {
          publicKeys: {
              publicKey: PublicKey;
              weight: number;
          }[];
          threshold: number;
      }
      • publicKeys: {
            publicKey: PublicKey;
            weight: number;
        }[]
      • threshold: number

    Returns MultiSigPublicKey

Settings

Member Visibility

On This Page

Constructors
Methods