@polymeshassociation/polymesh-sdk / api/entities/Account/Staking

api/entities/Account/Staking

Classes

Staking

Defined in: api/entities/Account/Staking/index.ts:26

Handles Account staking related functionality

Extends

• Namespace<Account>

Methods

getCommission()

getCommission(): Promise<StakingCommission | null>

Defined in: api/entities/Account/Staking/index.ts:244

Fetch the commission settings for this validator account

Returns

Promise<StakingCommission | null>

The commission details or null if the account is not seeking nominations as a validator

getController()

Call Signature

getController(): Promise<Account | null>

Defined in: api/entities/Account/Staking/index.ts:185

Fetch the controller associated to this account if there is one

Returns

Promise<Account | null>

The controller account or null if the account is not a stash

Note

a stash can be its own controller

Call Signature

getController(callback): Promise<UnsubCallback>

Defined in: api/entities/Account/Staking/index.ts:196

Fetch the controller associated to this account if there is one

Parameters

Parameter	Type	Description
callback	SubCallback<Account | null>	Callback function that can be used to listen for changes to the controller

Returns

Promise<UnsubCallback>

The controller account or null if the account is not a stash

Note

can be subscribed to, if connected to node using a web socket

Note

a stash can be its own controller

getLedger()

getLedger(): Promise<StakingLedger | null>

Defined in: api/entities/Account/Staking/index.ts:32

Fetch the ledger information for a stash account

Returns

Promise<StakingLedger | null>

The staking ledger information or null if the account is not a controller

getNomination()

Call Signature

getNomination(): Promise<StakingNomination | null>

Defined in: api/entities/Account/Staking/index.ts:125

Fetch this account's current nominations

Returns

Promise<StakingNomination | null>

The nomination details or null if the account is not a controller

Call Signature

getNomination(callback): Promise<UnsubCallback>

Defined in: api/entities/Account/Staking/index.ts:135

Fetch this account's current nominations

Parameters

Parameter	Type	Description
callback	SubCallback<StakingNomination | null>	Callback function that can be used to listen for changes to the nominations

Returns

Promise<UnsubCallback>

The nomination details or null if the account is not a controller

Note

can be subscribed to, if connected to node using a web socket

getPayee()

Call Signature

getPayee(): Promise<StakingPayee | null>

Defined in: api/entities/Account/Staking/index.ts:56

Fetch the payee that will receive a stash account's rewards

Returns

Promise<StakingPayee | null>

The payee account or null if the account is not a stash

Call Signature

getPayee(callback): Promise<UnsubCallback>

Defined in: api/entities/Account/Staking/index.ts:66

Fetch the payee that will receive a stash account's rewards

Parameters

Parameter	Type	Description
callback	SubCallback<StakingPayee | null>	Callback function that can be used to listen for changes to the staking payee

Returns

Promise<UnsubCallback>

The payee account or null if the account is not a stash

Note

can be subscribed to, if connected to node using a web socket