Skip to content

MultisigAccount

@algorandfoundation/algokit-utils / types/account / MultisigAccount

types/account.MultisigAccount

Account wrapper that supports partial or full multisig signing.

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new MultisigAccount(multisigParams, signingAccounts): MultisigAccount

Parameters

NameType
multisigParamsMultisigMetadata
signingAccounts(default | SigningAccount)[]

Returns

MultisigAccount

Defined in

src/types/account.ts:46

Properties

_addr

_addr: Address

Defined in

src/types/account.ts:23


_params

_params: MultisigMetadata

Defined in

src/types/account.ts:21


_signer

_signer: TransactionSigner

Defined in

src/types/account.ts:24


_signingAccounts

_signingAccounts: (default | SigningAccount)[]

Defined in

src/types/account.ts:22

Accessors

addr

get addr(): Readonly<Address>

The address of the multisig account

Returns

Readonly<Address>

Defined in

src/types/account.ts:37


params

get params(): Readonly<MultisigMetadata>

The parameters for the multisig account

Returns

Readonly<MultisigMetadata>

Defined in

src/types/account.ts:27


signer

get signer(): TransactionSigner

The transaction signer for the multisig account

Returns

TransactionSigner

Defined in

src/types/account.ts:42


signingAccounts

get signingAccounts(): readonly (default | SigningAccount)[]

The list of accounts that are present to sign

Returns

readonly (default | SigningAccount)[]

Defined in

src/types/account.ts:32

Methods

sign

sign(transaction): Uint8Array

Sign the given transaction

Parameters

NameTypeDescription
transactionUint8Array | TransactionEither a transaction object or a raw, partially signed transaction

Returns

Uint8Array

The transaction signed by the present signers

Example

const signedTxn = multisigAccount.sign(myTransaction);

Defined in

src/types/account.ts:65