api/entities/MultiSig.MultiSig

Represents a MultiSig Account. A MultiSig Account is composed of one or more signing Accounts. In order to submit a transaction, a specific amount of those signing Accounts must approve it first

• Account

  ↳ MultiSig

• address
• authorizations
• key
• subsidies
• uuid

• checkPermissions
• details
• exists
• getBalance
• getCreator
• getCurrentNonce
• getIdentity
• getMultiSig
• getPermissions
• getProposal
• getProposals
• getSubsidy
• getTransactionHistory
• getTransactionHistoryV2
• isEqual
• isFrozen
• modify
• toHuman
• generateUuid
• unserialize

• address: string

Polymesh-specific address of the Account. Serves as an identifier

Account.address

api/entities/Account.ts:274

---

• authorizations: Authorizations<Account>

Account.authorizations

api/entities/Account.ts:283

---

• key: string

A hex representation of the cryptographic public key of the Account. This is consistent across Substrate chains, while the address depends on the chain as well.

Account.key

api/entities/Account.ts:280

---

• subsidies: Subsidies

Account.subsidies

api/entities/Account.ts:284

---

• uuid: string

Account.uuid

api/entities/Entity.ts:46

▸ checkPermissions(permissions): Promise<CheckPermissionsResult<Account>>

Check if this Account possesses certain Permissions to act on behalf of its corresponding Identity

Name	Type
permissions	SimplePermissions

Promise<CheckPermissionsResult<Account>>

which permissions the Account is missing (if any) and the final result

Account.checkPermissions

---

▸ details(): Promise<MultiSigDetails>

Return details about this MultiSig such as the signing Accounts and the required number of signatures to execute a MultiSigProposal

Promise<MultiSigDetails>

---

▸ exists(): Promise<boolean>

Determine whether this Account exists on chain

Promise<boolean>

Account.exists

---

▸ getBalance(): Promise<Balance>

Get the free/locked POLYX balance of the Account

Note

can be subscribed to

Promise<Balance>

Account.getBalance

▸ getBalance(callback): Promise<UnsubCallback>

Name	Type
callback	SubCallback<Balance>

Promise<UnsubCallback>

Account.getBalance

---

▸ getCreator(): Promise<Identity>

Returns the Identity of the MultiSig creator. This Identity can add or remove signers directly without creating a MultiSigProposal first.

Promise<Identity>

---

▸ getCurrentNonce(): Promise<BigNumber>

Retrieve the current nonce for this Account

Promise<BigNumber>

Account.getCurrentNonce

---

▸ getIdentity(): Promise<null | Identity>

Retrieve the Identity associated to this Account (null if there is none)

Promise<null | Identity>

Account.getIdentity

---

▸ getMultiSig(): Promise<null | MultiSig>

Fetch the MultiSig this Account is part of. If this Account is not a signer on any MultiSig, return null

Promise<null | MultiSig>

Account.getMultiSig

---

▸ getPermissions(): Promise<Permissions>

Retrieve the Permissions this Account has as a Permissioned Account for its corresponding Identity

Throws

if there is no Identity associated with the Account

Promise<Permissions>

Account.getPermissions

---

▸ getProposal(args): Promise<MultiSigProposal>

Given an ID, fetch a MultiSigProposal for this MultiSig

Throws

if the MultiSigProposal is not found

Name	Type
args	Object
args.id	BigNumber

Promise<MultiSigProposal>

---

▸ getProposals(): Promise<MultiSigProposal[]>

Return all MultiSigProposal for this MultiSig Account

Promise<MultiSigProposal[]>

---

▸ getSubsidy(): Promise<null | SubsidyWithAllowance>

Get the subsidized balance of this Account and the subsidizer Account. If this Account isn't being subsidized, return null

Note

can be subscribed to

Deprecated

in favour of subsidies.getSubsidizer

Promise<null | SubsidyWithAllowance>

Account.getSubsidy

▸ getSubsidy(callback): Promise<UnsubCallback>

Name	Type
callback	SubCallback<null | SubsidyWithAllowance>

Promise<UnsubCallback>

Account.getSubsidy

---

▸ getTransactionHistory(filters?): Promise<ResultSet<ExtrinsicData>>

Retrieve a list of transactions signed by this Account. Can be filtered using parameters

Note

if both blockNumber and blockHash are passed, only blockNumber is taken into account

Note

uses the middleware

Name	Type	Description
filters	Object	-
filters.blockHash?	string	-
filters.blockNumber?	BigNumber	-
filters.orderBy?	TransactionOrderByInput	-
filters.size?	BigNumber	page size
filters.start?	BigNumber	page offset
filters.success?	boolean	whether the transaction was successful or not
filters.tag?	TxTag	tag associated with the transaction

Promise<ResultSet<ExtrinsicData>>

Account.getTransactionHistory

---

▸ getTransactionHistoryV2(filters?): Promise<ResultSet<ExtrinsicData>>

Retrieve a list of transactions signed by this Account. Can be filtered using parameters

Note

if both blockNumber and blockHash are passed, only blockNumber is taken into account

Note

uses the middlewareV2

Name	Type	Description
filters	Object	-
filters.blockHash?	string	-
filters.blockNumber?	BigNumber	-
filters.orderBy?	ExtrinsicsOrderBy	-
filters.size?	BigNumber	page size
filters.start?	BigNumber	page offset
filters.success?	boolean	whether the transaction was successful or not
filters.tag?	TxTag	tag associated with the transaction

Promise<ResultSet<ExtrinsicData>>

Account.getTransactionHistoryV2

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Account.isEqual

---

▸ isFrozen(): Promise<boolean>

Check whether this Account is frozen. If frozen, it cannot perform any Identity related action until the primary Account of the Identity unfreezes all secondary Accounts

Note

returns false if the Account isn't associated to any Identity

Promise<boolean>

Account.isFrozen

---

▸ modify(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Modify the signers for the MultiSig. The signing Account must belong to the Identity of the creator of the MultiSig

Note

this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Name	Type
args	Pick<ModifyMultiSigParams, "signers">
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

---

▸ toHuman(): string

Return the Account's address

string

Account.toHuman

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Account.generateUuid

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Account.unserialize