Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MultisigMessage

Represents a Multisignature inter-wallet Message that is used to exchange data between multisignature participants

Hierarchy

  • MultisigMessage

Index

Constructors

constructor

Accessors

destination

  • get destination(): Address
  • set destination(destination: Address): void

nonce

  • get nonce(): number
  • A one-time nonce value that should increment/change for every message exchanged between the wallets

    Returns number

partialKeyImages

partialSigningKeys

preparedTransactions

  • get preparedTransactions(): TransactionInterfaces.PreparedTransaction[]
  • set preparedTransactions(preparedTransactions: TransactionInterfaces.PreparedTransaction[]): void
  • The prepared transactions transferred in the message

    Returns TransactionInterfaces.PreparedTransaction[]

  • The prepared transactions transferred in the message

    Parameters

    • preparedTransactions: TransactionInterfaces.PreparedTransaction[]

    Returns void

source

spendKeys

view

  • get view(): string

Methods

addSpendKeys

  • addSpendKeys(keypair: KeyPair): boolean
  • Adds a new set of spend keys to the message

    Note: The key pair must be complete (both private and public) to complete the necessary signing processes to provide proof that we have the private key for the given public key.

    Parameters

    • keypair: KeyPair

      The spend key pair to include.

    Returns boolean

encode

  • encode(): Promise<string>
  • Encodes the multisig message object as a Base58 encoded string that can be easily

    This method performs all necessary signing of the supplied public keys, encrypts the payload, and signs the message to prevent tampering and protect the confidential information inside.

    transferred between multisig wallet participants

    async

    Returns Promise<string>

    The Base58 encoded string for transmission

Static decode

  • Decodes a Base58 string into a multisig message object.

    This method validates that all signatures included in the data are valid, the data is properly decrypted, and the signatures of the public keys included in the payload(s) are valid

    async

    Parameters

    • destination: Address

      The wallet address that this message was sent

    • base58: string

      The Base58 encoded data

    Returns Promise<MultisigMessage>

Generated using TypeDoc