-
Notifications
You must be signed in to change notification settings - Fork 11
api.client.Staking.Staking
api/client/Staking.Staking
Handles Staking related functionality
▸ bond(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Bond POLYX for staking
| Name | Type |
|---|---|
args |
BondPolyxParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
the signing account cannot be a stash
Note
this method is of type ProcedureMethod, which means you can call bond.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ bondExtra(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Bond extra POLYX for staking
| Name | Type |
|---|---|
args |
UpdatePolyxBondParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
this transaction must be signed by a stash
Note
this method is of type ProcedureMethod, which means you can call bondExtra.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ eraInfo(): Promise<StakingEraInfo>
Retrieve the current staking era
Promise<StakingEraInfo>
Note
can be subscribed to, if connected to node using a web socket
▸ eraInfo(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<StakingEraInfo> |
Promise<UnsubCallback>
▸ getValidators(paginationOpts?): Promise<ResultSet<StakingCommission>>
Return information about nomination targets
| Name | Type |
|---|---|
paginationOpts? |
PaginationOptions |
Promise<ResultSet<StakingCommission>>
Note
supports pagination
▸ nominate(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Nominate validators for the bonded POLYX
| Name | Type |
|---|---|
args |
NominateValidatorsParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
this transaction must be signed by a controller
Note
this method is of type ProcedureMethod, which means you can call nominate.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ setController(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Allow for a stash account to update its controller
| Name | Type |
|---|---|
args |
SetStakingControllerParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
the transaction must be signed by a stash account
Note
this method is of type ProcedureMethod, which means you can call setController.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ setPayee(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Allow for a stash account to update where it's staking rewards are deposited
| Name | Type |
|---|---|
args |
SetStakingPayeeParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
the transaction must be signed by a controller account
Note
this method is of type ProcedureMethod, which means you can call setPayee.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ unbond(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Unbond POLYX for staking. The unbonded amount can be withdrawn after the lockup period
| Name | Type |
|---|---|
args |
UpdatePolyxBondParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call unbond.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ withdraw(opts?): Promise<GenericPolymeshTransaction<void, void>>
Withdraw unbonded POLYX to free it for the stash account
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
this transaction must be signed by a controller
Note
this method is of type NoArgsProcedureMethod, which means you can call withdraw.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types