Class Api<SecurityDataType>

Title

cosmos/staking/v1beta1/authz.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.staking.v1beta1/rest.ts:850

Properties

instance

instance: AxiosInstance

Methods

queryDelegation

queryDelegation(validatorAddr: string, delegatorAddr: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegationResponse>>
No description

Tags
Query

Name
QueryDelegation

Summary
Delegation queries delegate info for given validator delegator pair.

Request
GET:/cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}
Parameters
- validatorAddr: string
- delegatorAddr: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegationResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1188

queryDelegatorDelegations

queryDelegatorDelegations(delegatorAddr: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegatorDelegationsResponse>>
No description

Tags
Query

Name
QueryDelegatorDelegations

Summary
DelegatorDelegations queries all delegations of a given delegator address.

Request
GET:/cosmos/staking/v1beta1/delegations/{delegator_addr}
Parameters
- delegatorAddr: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegatorDelegationsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:941

queryDelegatorUnbondingDelegations

queryDelegatorUnbondingDelegations(delegatorAddr: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegatorUnbondingDelegationsResponse>>
No description

Tags
Query

Name
QueryDelegatorUnbondingDelegations

Summary
DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

Request
GET:/cosmos/staking/v1beta1/delegators/{delegator_addr}/unbonding_delegations
Parameters
- delegatorAddr: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegatorUnbondingDelegationsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:998

queryDelegatorValidator

queryDelegatorValidator(delegatorAddr: string, validatorAddr: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorResponse>>
No description

Tags
Query

Name
QueryDelegatorValidator

Summary
DelegatorValidator queries validator info for given delegator validator pair.

Request
GET:/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators/{validator_addr}
Parameters
- delegatorAddr: string
- validatorAddr: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1054

queryDelegatorValidators

queryDelegatorValidators(delegatorAddr: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorsResponse>>
No description

Tags
Query

Name
QueryDelegatorValidators

Summary
DelegatorValidators queries all validators info for given delegator address.

Request
GET:/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators
Parameters
- delegatorAddr: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1026

queryHistoricalInfo

queryHistoricalInfo(height: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryHistoricalInfoResponse>>
No description

Tags
Query

Name
QueryHistoricalInfo

Summary
HistoricalInfo queries the historical info for given height.

Request
GET:/cosmos/staking/v1beta1/historical_info/{height}
Parameters
- height: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryHistoricalInfoResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1070

queryParams

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

Tags
Query

Name
QueryParams

Summary
Parameters queries the staking parameters.

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

queryPool

queryPool(params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryPoolResponse>>
No description

Tags
Query

Name
QueryPool

Summary
Pool queries the pool info.

Request
GET:/cosmos/staking/v1beta1/pool
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryPoolResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1102

queryRedelegations

queryRedelegations(delegatorAddr: string, query?: {
    dst_validator_addr?: string;
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
    src_validator_addr?: string;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryRedelegationsResponse>>
No description

Tags
Query

Name
QueryRedelegations

Summary
Redelegations queries redelegations of given address.

Request
GET:/cosmos/staking/v1beta1/delegators/{delegator_addr}/redelegations
Parameters
- delegatorAddr: string
- Optional query: {
      dst_validator_addr?: string;
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
      src_validator_addr?: string;
  }
  - Optional dst_validator_addr?: string
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
  - Optional src_validator_addr?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryRedelegationsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:968

queryUnbondingDelegation

queryUnbondingDelegation(validatorAddr: string, delegatorAddr: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryUnbondingDelegationResponse>>
No description

Tags
Query

Name
QueryUnbondingDelegation

Summary
UnbondingDelegation queries unbonding info for given validator delegator pair.

Request
GET:/cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}/unbonding_delegation
Parameters
- validatorAddr: string
- delegatorAddr: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryUnbondingDelegationResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1205

queryValidator

queryValidator(validatorAddr: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorResponse>>
No description

Tags
Query

Name
QueryValidator

Summary
Validator queries validator info for given validator address.

Request
GET:/cosmos/staking/v1beta1/validators/{validator_addr}
Parameters
- validatorAddr: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1145

queryValidatorDelegations

queryValidatorDelegations(validatorAddr: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorDelegationsResponse>>
No description

Tags
Query

Name
QueryValidatorDelegations

Summary
ValidatorDelegations queries delegate info for given validator.

Request
GET:/cosmos/staking/v1beta1/validators/{validator_addr}/delegations
Parameters
- validatorAddr: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorDelegationsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1161

queryValidatorUnbondingDelegations

queryValidatorUnbondingDelegations(validatorAddr: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorUnbondingDelegationsResponse>>
No description

Tags
Query

Name
QueryValidatorUnbondingDelegations

Summary
ValidatorUnbondingDelegations queries unbonding delegations of a validator.

Request
GET:/cosmos/staking/v1beta1/validators/{validator_addr}/unbonding_delegations
Parameters
- validatorAddr: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorUnbondingDelegationsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1221

queryValidators

queryValidators(query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
    status?: string;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryValidatorsResponse>>
No description

Tags
Query

Name
QueryValidators

Summary
Validators queries all validators that match the given status.

Request
GET:/cosmos/staking/v1beta1/validators
Parameters
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
      status?: string;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
  - Optional status?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryValidatorsResponse>>
- Defined in cosmos.staking.v1beta1/rest.ts:1118

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.staking.v1beta1/rest.ts:889

setSecurityData

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

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

queryDelegation

Tags

Name

Summary

Request

Parameters

validatorAddr: string

delegatorAddr: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegationResponse>>

queryDelegatorDelegations

Tags

Name

Summary

Request

Parameters

delegatorAddr: string

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

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegatorDelegationsResponse>>

queryDelegatorUnbondingDelegations

Tags

Name

Summary

Request

Parameters

delegatorAddr: string

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

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegatorUnbondingDelegationsResponse>>

queryDelegatorValidator

Tags

Name

Summary

Request

Parameters

delegatorAddr: string

validatorAddr: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDelegatorValidatorResponse>>

queryDelegatorValidators

Tags

Name

Summary

Request

Parameters

delegatorAddr: string

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

Optional pagination.count_total?: boolean

Optional pagination.key?: string

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

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

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

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

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

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

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

`Optional` dst_validator_addr?: string

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` src_validator_addr?: string