api.entities.MultiSigProposal - PolymeshAssociation/polymesh-sdk GitHub Wiki

@polymeshassociation/polymesh-sdk / api/entities/MultiSigProposal

api/entities/MultiSigProposal

Classes

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

Extends

Properties

id

id: BigNumber

Defined in: api/entities/MultiSigProposal/index.ts:51

multiSig

multiSig: MultiSig

Defined in: api/entities/MultiSigProposal/index.ts:50

uuid

uuid: string

Defined in: api/entities/Entity.ts:46

Inherited from

Entity.uuid

Methods

approve()

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

Defined in: api/entities/MultiSigProposal/index.ts:92

Approve this MultiSig proposal

Parameters
Parameter 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

createdAt()

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

Returns

Promise<EventIdentifier | null>

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

creator()

creator(): Promise<Account | null>

Defined in: api/entities/MultiSigProposal/index.ts:287

Retrieve the account which created this MultiSig Proposal

Returns

Promise<Account | null>

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

details()

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

Returns

Promise<MultiSigProposalDetails>

exists()

exists(): Promise<boolean>

Defined in: api/entities/MultiSigProposal/index.ts:168

Determines whether this Proposal exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

isEqual()

isEqual(entity): boolean

Defined in: api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters
Parameter Type
entity Entity<unknown, unknown>
Returns

boolean

Inherited from

Entity.isEqual

reject()

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

Defined in: api/entities/MultiSigProposal/index.ts:97

Reject this MultiSig proposal

Parameters
Parameter 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

toHuman()

toHuman(): HumanReadable

Defined in: api/entities/MultiSigProposal/index.ts:190

Returns a human readable representation

Returns

HumanReadable

Overrides

Entity.toHuman

votes()

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

Returns

Promise<MultiSigProposalVote[]>

Note

uses the middlewareV2

generateUuid()

static generateUuid<Identifiers>(identifiers): string

Defined in: api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters
Type Parameter
Identifiers
Parameters
Parameter Type Description
identifiers Identifiers -
Returns

string

Inherited from

Entity.generateUuid

isUniqueIdentifiers()

static isUniqueIdentifiers(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

Parameters
Parameter Type Description
identifiers unknown object to type check
Returns

boolean

Inherited from

Entity.isUniqueIdentifiers

unserialize()

static unserialize<Identifiers>(serialized): Identifiers

Defined in: api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters
Type Parameter
Identifiers
Parameters
Parameter Type Description
serialized string UUID to unserialize
Returns

Identifiers

Inherited from

Entity.unserialize

Interfaces

HumanReadable

Defined in: api/entities/MultiSigProposal/index.ts:41

Properties

id

id: string

Defined in: api/entities/MultiSigProposal/index.ts:43

multiSigAddress

multiSigAddress: string

Defined in: api/entities/MultiSigProposal/index.ts:42

⚠️ **GitHub.com Fallback** ⚠️