api.entities.MultiSigProposal.MultiSigProposal

Class: MultiSigProposal

api/entities/MultiSigProposal.MultiSigProposal

A proposal for a MultiSig transaction. This is a wrapper around an extrinsic that will be executed when the amount of approvals reaches the signature threshold set on the MultiSig Account

Hierarchy

• Entity<UniqueIdentifiers, HumanReadable>

  ↳ MultiSigProposal

Table of contents

Properties

• id
• multiSig
• uuid

Methods

• approve
• createdAt
• creator
• details
• exists
• isEqual
• reject
• toHuman
• votes
• generateUuid
• isUniqueIdentifiers
• unserialize

Properties

id

• id: BigNumber

Defined in

api/entities/MultiSigProposal/index.ts:54

---

multiSig

• multiSig: MultiSig

Defined in

api/entities/MultiSigProposal/index.ts:53

---

uuid

• uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

approve

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

Approve this MultiSig proposal

Parameters

Name	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

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

Defined in

api/entities/MultiSigProposal/index.ts:98

---

createdAt

▸ createdAt(): Promise<null | EventIdentifier>

Retrieve the identifier data (block number, date and event index) of the event that was emitted when this MultiSig Proposal was created

Returns

Promise<null | EventIdentifier>

Note

uses the middlewareV2

Note

there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Defined in

api/entities/MultiSigProposal/index.ts:351

---

creator

▸ creator(): Promise<null | Account>

Retrieve the account which created this MultiSig Proposal

Returns

Promise<null | Account>

Note

uses the middlewareV2

Note

there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Defined in

api/entities/MultiSigProposal/index.ts:366

---

details

▸ details(): Promise<MultiSigProposalDetails>

Fetches the details of the Proposal. This includes the amount of approvals and rejections, the expiry, and details of the wrapped extrinsic

Returns

Promise<MultiSigProposalDetails>

Defined in

api/entities/MultiSigProposal/index.ts:115

---

exists

▸ exists(): Promise<boolean>

Determines whether this Proposal exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/MultiSigProposal/index.ts:248

---

isEqual

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61

---

reject

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

Reject this MultiSig proposal

Parameters

Name	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

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

Defined in

api/entities/MultiSigProposal/index.ts:108

---

toHuman

▸ toHuman(): HumanReadable

Returns a human readable representation

Returns

HumanReadable

Overrides

Entity.toHuman

Defined in

api/entities/MultiSigProposal/index.ts:270

---

votes

▸ votes(): Promise<MultiSigProposalVote[]>

Fetches the individual votes for this MultiSig proposal and their identifier data (block number, date and event index) of the event that was emitted when this MultiSig Proposal Vote was casted

Returns

Promise<MultiSigProposalVote[]>

Note

uses the middlewareV2

Defined in

api/entities/MultiSigProposal/index.ts:287

---

generateUuid

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

Name	Type
identifiers	Identifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14

---

isUniqueIdentifiers

▸ Static isUniqueIdentifiers(identifiers): boolean

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

Parameters

Name	Type	Description
identifiers	unknown	object to type check

Returns

boolean

Inherited from

Entity.isUniqueIdentifiers

Defined in

api/entities/Entity.ts:42

---

unserialize

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

Name	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23