MultisigAccount
@algorandfoundation/algokit-utils / types/account / MultisigAccount
types/account.MultisigAccount
Account wrapper that supports partial or full multisig signing.
Table of contents
Section titled “Table of contents”Constructors
Section titled “Constructors”Properties
Section titled “Properties”Accessors
Section titled “Accessors”Methods
Section titled “Methods”Constructors
Section titled “Constructors”constructor
Section titled “constructor”• new MultisigAccount(multisigParams, signingAccounts): MultisigAccount
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
multisigParams | MultisigMetadata |
signingAccounts | (default | SigningAccount)[] |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”Properties
Section titled “Properties”• _addr: Address
Defined in
Section titled “Defined in”_params
Section titled “_params”• _params: MultisigMetadata
Defined in
Section titled “Defined in”_signer
Section titled “_signer”• _signer: TransactionSigner
Defined in
Section titled “Defined in”_signingAccounts
Section titled “_signingAccounts”• _signingAccounts: (default | SigningAccount)[]
Defined in
Section titled “Defined in”Accessors
Section titled “Accessors”• get addr(): Readonly<Address>
The address of the multisig account
Returns
Section titled “Returns”Readonly<Address>
Defined in
Section titled “Defined in”params
Section titled “params”• get params(): Readonly<MultisigMetadata>
The parameters for the multisig account
Returns
Section titled “Returns”Readonly<MultisigMetadata>
Defined in
Section titled “Defined in”signer
Section titled “signer”• get signer(): TransactionSigner
The transaction signer for the multisig account
Returns
Section titled “Returns”TransactionSigner
Defined in
Section titled “Defined in”signingAccounts
Section titled “signingAccounts”• get signingAccounts(): readonly (default | SigningAccount)[]
The list of accounts that are present to sign
Returns
Section titled “Returns”readonly (default | SigningAccount)[]
Defined in
Section titled “Defined in”Methods
Section titled “Methods”▸ sign(transaction): Uint8Array
Sign the given transaction
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
transaction | Uint8Array | Transaction | Either a transaction object or a raw, partially signed transaction |
Returns
Section titled “Returns”Uint8Array
The transaction signed by the present signers
Example
const signedTxn = multisigAccount.sign(myTransaction);