Class DistributionAPI

Hierarchy

BaseAPI
- DistributionAPI

Index

Constructors

constructor

Properties

lcd

Methods

Constructors

constructor

new DistributionAPI(lcd: LCDClient): DistributionAPI

Overrides BaseAPI.constructor
- Defined in client/lcd/api/DistributionAPI.ts:65
Parameters
- lcd: LCDClient
Returns DistributionAPI

Properties

lcd

Methods

communityPool

communityPool(chainID: string, params?: APIParams): Promise<Coins>

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

Parameters
- chainID: string
  
  chain id
- params: APIParams = {}
Returns Promise<Coins>

getReqFromAddress

getReqFromAddress(address: string): APIRequester

Inherited from BaseAPI.getReqFromAddress
- Defined in client/lcd/api/BaseAPI.ts:20
Parameters
- address: string
Returns APIRequester

getReqFromChainID

getReqFromChainID(chainID: string): APIRequester

Inherited from BaseAPI.getReqFromChainID
- Defined in client/lcd/api/BaseAPI.ts:16
Parameters
- chainID: string
Returns APIRequester

parameters

parameters(chainID: string, params?: APIParams): Promise<DistributionParams>

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

Parameters
- chainID: string
  
  chain id
- params: APIParams = {}
Returns Promise<DistributionParams>

rewards

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

- Defined in client/lcd/api/DistributionAPI.ts:73
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:98
Gets a validator's rewards.

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

validatorSlashingEvents

validatorSlashingEvents(validator: string, params?: APIParams): Promise<[any[], Pagination]>

- Defined in client/lcd/api/DistributionAPI.ts:119
Gets a validator's slashing events.

Parameters
- validator: string
  
  validator's operator address
- params: APIParams = {}
Returns Promise<[any[], Pagination]>

withdrawAddress

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

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

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