Class Api<SecurityDataType>

Title

cosmos/distribution/v1beta1/distribution.proto

Version

version not set

Type Parameters

SecurityDataType extends unknown

Hierarchy

HttpClient<SecurityDataType>
- Api

Index

Constructors

constructor

new Api<SecurityDataType>(__namedParameters?: ApiConfig<SecurityDataType>): Api<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- __namedParameters: ApiConfig<SecurityDataType> = {}
Returns Api<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in cosmos.distribution.v1beta1/rest.ts:317

Properties

instance

instance: AxiosInstance

Methods

queryCommunityPool

queryCommunityPool(params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryCommunityPoolResponse>>
No description

Tags
Query

Name
QueryCommunityPool

Summary
CommunityPool queries the community pool coins.

Request
GET:/cosmos/distribution/v1beta1/community_pool
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryCommunityPoolResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:408

queryDelegationRewards

queryDelegationRewards(delegatorAddress: string, validatorAddress: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegationRewardsResponse>>
No description

Tags
Query

Name
QueryDelegationRewards

Summary
DelegationRewards queries the total rewards accrued by a delegation.

Request
GET:/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards/{validator_address}
Parameters
- delegatorAddress: string
- validatorAddress: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegationRewardsResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:441

queryDelegationTotalRewards

queryDelegationTotalRewards(delegatorAddress: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegationTotalRewardsResponse>>
No description

Tags
Query

Name
QueryDelegationTotalRewards

Summary
DelegationTotalRewards queries the total rewards accrued by a each validator.

Request
GET:/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards
Parameters
- delegatorAddress: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegationTotalRewardsResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:425

queryDelegatorValidators

queryDelegatorValidators(delegatorAddress: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorsResponse>>
No description

Tags
Query

Name
QueryDelegatorValidators

Summary
DelegatorValidators queries the validators of a delegator.

Request
GET:/cosmos/distribution/v1beta1/delegators/{delegator_address}/validators
Parameters
- delegatorAddress: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorsResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:457

queryDelegatorWithdrawAddress

queryDelegatorWithdrawAddress(delegatorAddress: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegatorWithdrawAddressResponse>>
No description

Tags
Query

Name
QueryDelegatorWithdrawAddress

Summary
DelegatorWithdrawAddress queries withdraw address of a delegator.

Request
GET:/cosmos/distribution/v1beta1/delegators/{delegator_address}/withdraw_address
Parameters
- delegatorAddress: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegatorWithdrawAddressResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:473

queryParams

queryParams(params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryParamsResponse>>
No description

Tags
Query

Name
QueryParams

Summary
Params queries params of the distribution module.

Request
GET:/cosmos/distribution/v1beta1/params
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryParamsResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:489

queryValidatorCommission

queryValidatorCommission(validatorAddress: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorCommissionResponse>>
No description

Tags
Query

Name
QueryValidatorCommission

Summary
ValidatorCommission queries accumulated commission for a validator.

Request
GET:/cosmos/distribution/v1beta1/validators/{validator_address}/commission
Parameters
- validatorAddress: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorCommissionResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:505

queryValidatorOutstandingRewards

queryValidatorOutstandingRewards(validatorAddress: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorOutstandingRewardsResponse>>
No description

Tags
Query

Name
QueryValidatorOutstandingRewards

Summary
ValidatorOutstandingRewards queries rewards of a validator address.

Request
GET:/cosmos/distribution/v1beta1/validators/{validator_address}/outstanding_rewards
Parameters
- validatorAddress: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorOutstandingRewardsResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:521

queryValidatorSlashes

queryValidatorSlashes(validatorAddress: string, query?: {
    ending_height?: string;
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
    starting_height?: string;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorSlashesResponse>>
No description

Tags
Query

Name
QueryValidatorSlashes

Summary
ValidatorSlashes queries slash events of a validator.

Request
GET:/cosmos/distribution/v1beta1/validators/{validator_address}/slashes
Parameters
- validatorAddress: string
- Optional query: {
      ending_height?: string;
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
      starting_height?: string;
  }
  - Optional ending_height?: string
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
  - Optional starting_height?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorSlashesResponse>>
- Defined in cosmos.distribution.v1beta1/rest.ts:537

request

request<T, _E>(__namedParameters: FullRequestParams): Promise<AxiosResponse<T>>
Type Parameters
- T = any
- _E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<AxiosResponse<T>>
Inherited from HttpClient.request
- Defined in cosmos.distribution.v1beta1/rest.ts:356

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in cosmos.distribution.v1beta1/rest.ts:324

Class Api<SecurityDataType>

Title

Version

Type Parameters

SecurityDataType extends unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

SecurityDataType extends unknown

Parameters

__namedParameters: ApiConfig<SecurityDataType> = {}

Returns Api<SecurityDataType>

Properties

instance

Methods

queryCommunityPool

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryCommunityPoolResponse>>

queryDelegationRewards

Tags

Name

Summary

Request

Parameters

delegatorAddress: string

validatorAddress: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegationRewardsResponse>>

queryDelegationTotalRewards

Tags

Name

Summary

Request

Parameters

delegatorAddress: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegationTotalRewardsResponse>>

queryDelegatorValidators

Tags

Name

Summary

Request

Parameters

delegatorAddress: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorsResponse>>

queryDelegatorWithdrawAddress

Tags

Name

Summary

Request

Parameters

delegatorAddress: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegatorWithdrawAddressResponse>>

queryParams

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryParamsResponse>>

queryValidatorCommission

Tags

Name

Summary

Request

Parameters

validatorAddress: string

`Optional` query: {
ending_height?: string;
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
starting_height?: string;
}

`Optional` ending_height?: string

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` starting_height?: string