Class DistributionAPI

Hierarchy

BaseAPI
- DistributionAPI

Index

Constructors

constructor

Methods

Constructors

constructor

new DistributionAPI(c: APIRequester): DistributionAPI

Inherited from BaseAPI.constructor
- Defined in client/lcd/api/BaseAPI.ts:4
Parameters
- c: APIRequester
Returns DistributionAPI

Methods

communityPool

communityPool(params?: APIParams): Promise<Coins>

- Defined in client/lcd/api/DistributionAPI.ts:129
Gets the current value of the community pool.

Parameters
- params: APIParams = {}
Returns Promise<Coins>

parameters

parameters(params?: APIParams): Promise<DistributionParams>

- Defined in client/lcd/api/DistributionAPI.ts:141
Gets the current distribution parameters.

Parameters
- params: APIParams = {}
Returns Promise<DistributionParams>

rewards

rewards(delegator: string, params?: APIParams): Promise<Rewards>

- Defined in client/lcd/api/DistributionAPI.ts:68
Gets a delegator's rewards.

Parameters
- delegator: string
  
  delegator's account address
- params: APIParams = {}
Returns Promise<Rewards>

validatorCommission

validatorCommission(validator: string, params?: APIParams): Promise<Coins>

- Defined in client/lcd/api/DistributionAPI.ts:93
Gets a validator's rewards.

Parameters
- validator: string
  
  validator's operator address
- params: APIParams = {}
Returns Promise<Coins>

withdrawAddress

withdrawAddress(delegator: string, params?: APIParams): Promise<string>

- Defined in client/lcd/api/DistributionAPI.ts:114
Gets the withdraw address of a delegator, the address to which rewards are withdrawn.

Parameters
- delegator: string
- params: APIParams = {}
Returns Promise<string>