Skip to main content

UsageStore

@totemsdk/governance

@totemsdk/governance / UsageStore

Class: UsageStore

Constructors​

Constructor​

new UsageStore(): UsageStore

Returns​

UsageStore

Methods​

abortMandateUse()​

abortMandateUse(reservationId, _reason?): boolean

Parameters​

reservationId​

string

_reason?​

string

Returns​

boolean

commitMandateUse()​

commitMandateUse(reservationId, receiptParams): string | MandateReceipt

Parameters​

reservationId​

string

receiptParams​
actionIndex​

number

actionType​

ProposalActionType

proofId?​

string

proposalId​

string

Returns​

string | MandateReceipt

getReceipt()​

getReceipt(receiptId): MandateReceipt | undefined

Parameters​

receiptId​

string

Returns​

MandateReceipt | undefined

getReceiptsByMandate()​

getReceiptsByMandate(mandateProofId): MandateReceipt[]

Parameters​

mandateProofId​

string

Returns​

MandateReceipt[]

getReservation()​

getReservation(reservationId): UsageReservation | undefined

Parameters​

reservationId​

string

Returns​

UsageReservation | undefined

getReservationsByMandate()​

getReservationsByMandate(mandateProofId): UsageReservation[]

Parameters​

mandateProofId​

string

Returns​

UsageReservation[]

reserveMandateUse()​

reserveMandateUse(mandateProofId, intentId, ttlMs?): UsageReservation

Parameters​

mandateProofId​

string

intentId​

string

ttlMs?​

number

Returns​

UsageReservation