api.entities.MultiSigProposal - PolymeshAssociation/polymesh-sdk GitHub Wiki
@polymeshassociation/polymesh-sdk / api/entities/MultiSigProposal
Defined in: api/entities/MultiSigProposal/index.ts:49
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
-
Entity<UniqueIdentifiers,HumanReadable>
id:
BigNumber
Defined in: api/entities/MultiSigProposal/index.ts:51
multiSig:
MultiSig
Defined in: api/entities/MultiSigProposal/index.ts:50
uuid:
string
Defined in: api/entities/Entity.ts:46
approve(
opts?):Promise<GenericPolymeshTransaction<void,void>>
Defined in: api/entities/MultiSigProposal/index.ts:92
Approve this MultiSig proposal
| Parameter | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
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
createdAt():
Promise<EventIdentifier|null>
Defined in: api/entities/MultiSigProposal/index.ts:272
Retrieve the identifier data (block number, date and event index) of the event that was emitted when this MultiSig Proposal was created
Promise<EventIdentifier | null>
uses the middlewareV2
there is a possibility that the data is not ready by the time it is requested. In that case, null is returned
creator():
Promise<Account|null>
Defined in: api/entities/MultiSigProposal/index.ts:287
Retrieve the account which created this MultiSig Proposal
Promise<Account | null>
uses the middlewareV2
there is a possibility that the data is not ready by the time it is requested. In that case, null is returned
details():
Promise<MultiSigProposalDetails>
Defined in: api/entities/MultiSigProposal/index.ts:102
Fetches the details of the Proposal. This includes the amount of approvals and rejections, the expiry, and details of the wrapped extrinsic
Promise<MultiSigProposalDetails>
exists():
Promise<boolean>
Defined in: api/entities/MultiSigProposal/index.ts:168
Determines whether this Proposal exists on chain
Promise<boolean>
isEqual(
entity):boolean
Defined in: api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
| Parameter | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
reject(
opts?):Promise<GenericPolymeshTransaction<void,void>>
Defined in: api/entities/MultiSigProposal/index.ts:97
Reject this MultiSig proposal
| Parameter | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
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
toHuman():
HumanReadable
Defined in: api/entities/MultiSigProposal/index.ts:190
Returns a human readable representation
votes():
Promise<MultiSigProposalVote[]>
Defined in: api/entities/MultiSigProposal/index.ts:207
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
Promise<MultiSigProposalVote[]>
uses the middlewareV2
staticgenerateUuid<Identifiers>(identifiers):string
Defined in: api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
| Type Parameter |
|---|
Identifiers |
| Parameter | Type | Description |
|---|---|---|
identifiers |
Identifiers |
- |
string
staticisUniqueIdentifiers(identifiers):boolean
Defined in: api/entities/Entity.ts:42
Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden
| Parameter | Type | Description |
|---|---|---|
identifiers |
unknown |
object to type check |
boolean
staticunserialize<Identifiers>(serialized):Identifiers
Defined in: api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
| Type Parameter |
|---|
Identifiers |
| Parameter | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Defined in: api/entities/MultiSigProposal/index.ts:41
id:
string
Defined in: api/entities/MultiSigProposal/index.ts:43
multiSigAddress:
string
Defined in: api/entities/MultiSigProposal/index.ts:42