api_entities_Subsidy.Subsidy
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Subsidy
.Subsidy
Represents a Subsidy relationship on chain
<, HumanReadable>
↳ Subsidy
Account whose transactions are being paid for
Defined in
Account that is paying for the transactions
Defined in
• uuid: string
Inherited from
Defined in
â–¸ decreaseAllowance(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Decrease allowance for this Subsidy relationship
note Only the subsidizer is allowed to decrease the allowance
throws if the amount to decrease by is more than the existing allowance
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Subsidy relationship exists on chain
Returns
Promise<boolean>
Overrides
Defined in
â–¸ getAllowance(): Promise<BigNumber>
Get amount of POLYX subsidized for this Subsidy relationship
throws if the Subsidy does not exist
Returns
Promise<BigNumber>
Defined in
â–¸ increaseAllowance(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Increase allowance for this Subsidy relationship
note Only the subsidizer is allowed to increase the allowance
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ quit(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Terminate this Subsidy relationship. The beneficiary Account will be forced to pay for their own transactions
note both the beneficiary and the subsidizer are allowed to unilaterally quit the Subsidy
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ setAllowance(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Set allowance for this Subsidy relationship
note Only the subsidizer is allowed to set the allowance
throws if the allowance to set is equal to the current allowance
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Return the Subsidy's static data
Returns
Overrides
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• beneficiary:
• subsidizer:
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Pick<, "allowance">
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Pick<, "allowance">
<unknown, unknown>
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Pick<, "allowance">
â–¸ toHuman():
.
.
.