Class StakingAPI

Hierarchy

BaseAPI
- StakingAPI

Index

Constructors

Methods

delegations delegationsByDelegator delegationsByDelegatorValidator delegationsByValidator params pool redelegations unbondingDelegations validators validatorsByValidator validatorsDelegationsByValidator validatorsDelegationsByValidatorDelegator validatorsUnbondingDelegations validatorsUnbondingDelegationsByValidatorDelegator

Constructors

constructor

new StakingAPI(request: APIRequester): StakingAPI
Parameters
- request: APIRequester
Returns StakingAPI
Inherited from BaseAPI.constructor
- Defined in api/BaseAPI.ts:4

Methods

delegations

delegations(delegator: string, params?: PaginationOptions): Promise<QueryDelegatorDelegationsResponse>
Parameters
- delegator: string
- Optional params: PaginationOptions
Returns Promise<QueryDelegatorDelegationsResponse>
- Defined in api/StakingAPI.ts:11

delegationsByDelegator

delegationsByDelegator(delegator: string, params?: PaginationOptions): Promise<QueryValidatorsResponse>
Parameters
- delegator: string
- Optional params: PaginationOptions
Returns Promise<QueryValidatorsResponse>
- Defined in api/StakingAPI.ts:52

delegationsByDelegatorValidator

delegationsByDelegatorValidator(delegator: string, validator: string, params?: PaginationOptions): Promise<QueryValidatorsResponse>
Parameters
- delegator: string
- validator: string
- Optional params: PaginationOptions
Returns Promise<QueryValidatorsResponse>
- Defined in api/StakingAPI.ts:62

delegationsByValidator

delegationsByValidator(delegator: string, validator: string, params?: PaginationOptions): Promise<QueryDelegatorDelegationsResponse>
Parameters
- delegator: string
- validator: string
- Optional params: PaginationOptions
Returns Promise<QueryDelegatorDelegationsResponse>
- Defined in api/StakingAPI.ts:41

params

params(): Promise<QueryParamsResponse>
Returns Promise<QueryParamsResponse>
- Defined in api/StakingAPI.ts:130

pool

pool(): Promise<QueryPoolResponse>
Returns Promise<QueryPoolResponse>
- Defined in api/StakingAPI.ts:124

redelegations

redelegations(delegator?: string, params?: PaginationOptions): Promise<QueryRedelegationsResponse>
Parameters
- Optional delegator: string
- Optional params: PaginationOptions
Returns Promise<QueryRedelegationsResponse>
- Defined in api/StakingAPI.ts:21

unbondingDelegations

unbondingDelegations(delegator?: string, params?: PaginationOptions): Promise<QueryDelegatorUnbondingDelegationsResponse>
Parameters
- Optional delegator: string
- Optional params: PaginationOptions
Returns Promise<QueryDelegatorUnbondingDelegationsResponse>
- Defined in api/StakingAPI.ts:31

validators

validators(params?: PaginationOptions): Promise<QueryValidatorsResponse>
Parameters
- Optional params: PaginationOptions
Returns Promise<QueryValidatorsResponse>
- Defined in api/StakingAPI.ts:73

validatorsByValidator

validatorsByValidator(validator: string): Promise<QueryValidatorResponse>
Parameters
- validator: string
Returns Promise<QueryValidatorResponse>
- Defined in api/StakingAPI.ts:82

validatorsDelegationsByValidator

validatorsDelegationsByValidator(validator: string): Promise<QueryDelegatorDelegationsResponse>
Parameters
- validator: string
Returns Promise<QueryDelegatorDelegationsResponse>
- Defined in api/StakingAPI.ts:90

validatorsDelegationsByValidatorDelegator

validatorsDelegationsByValidatorDelegator(validator: string, delegator: string): Promise<QueryDelegationResponse>
Parameters
- validator: string
- delegator: string
Returns Promise<QueryDelegationResponse>
- Defined in api/StakingAPI.ts:98

validatorsUnbondingDelegations

validatorsUnbondingDelegations(validator: string): Promise<QueryDelegatorUnbondingDelegationsResponse>
Parameters
- validator: string
Returns Promise<QueryDelegatorUnbondingDelegationsResponse>
- Defined in api/StakingAPI.ts:116

validatorsUnbondingDelegationsByValidatorDelegator

validatorsUnbondingDelegationsByValidatorDelegator(validator: string, delegator: string): Promise<QueryUnbondingDelegationResponse>
Parameters
- validator: string
- delegator: string
Returns Promise<QueryUnbondingDelegationResponse>
- Defined in api/StakingAPI.ts:107