Staking | @irisnet/irishub-sdk

This module provides staking functionalities for validators and delegators

More Details

since

Hierarchy

Staking

Index

Methods

createValidator

createValidator(): void

- Defined in src/modules/staking.ts:539
Create new validator initialized with a self-delegation to it

** Not Supported **

Returns void

delegate

delegate(validatorAddr: string, amount: Coin, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/staking.ts:35
Delegate liquid tokens to an validator

since

v0.17

Parameters
- validatorAddr: string
  
  Bech32 validator address
- amount: Coin
  
  Amount to be delegated to the validator
- baseTx: BaseTx
Returns Promise<TxResult>

queryDelegation

queryDelegation(delegator_addr: string, validator_addr: string): Promise<Delegation>

- Defined in src/modules/staking.ts:118
Query a delegation based on delegator address and validator address

since

Parameters
- delegator_addr: string
  
  Bech32 delegator address
- validator_addr: string
  
  Bech32 validator address
Returns Promise<Delegation>

queryDelegations

queryDelegations(query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }): Promise<Delegation[]>

- Defined in src/modules/staking.ts:148
Query all delegations made from one delegator

since

Parameters
- query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }
  - Optional count_total?: undefined | false | true
  - delegator_addr: string
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
Returns Promise<Delegation[]>

queryDelegatorUnbondingDelegations

queryDelegatorUnbondingDelegations(query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }): Promise<UnbondingDelegation[]>

- Defined in src/modules/staking.ts:209
Query all unbonding-delegations records for one delegator

since

Parameters
- query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }
  - Optional count_total?: undefined | false | true
  - delegator_addr: string
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
Returns Promise<UnbondingDelegation[]>

queryDelegatorValidator

queryDelegatorValidator(query: { delegator_addr: string; validator_addr: string }): Promise<object>

- Defined in src/modules/staking.ts:311
Query validator info for given delegator validator

since

Parameters
- query: { delegator_addr: string; validator_addr: string }
  - delegator_addr: string
  - validator_addr: string
Returns Promise<object>

queryDelegatorValidators

queryDelegatorValidators(query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }): Promise<object>

- Defined in src/modules/staking.ts:280
Query all validators info for given delegator

since

Parameters
- query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }
  - Optional count_total?: undefined | false | true
  - delegator_addr: string
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
Returns Promise<object>

queryHistoricalInfo

queryHistoricalInfo(query: { height: number }): Promise<object>

- Defined in src/modules/staking.ts:342
Query the historical info for given height.

since

Parameters
- query: { height: number }
  - height: number
Returns Promise<object>

queryParams

queryParams(): Promise<StakingParams>

- Defined in src/modules/staking.ts:506
Query the current staking parameters information

since

Returns Promise<StakingParams>

queryPool

queryPool(): Promise<StakingPool>

- Defined in src/modules/staking.ts:492
Query the current staking pool values

since

Returns Promise<StakingPool>

queryRedelegation

queryRedelegation(query: { count_total?: undefined | false | true; delegator_addr: string; dst_validator_addr?: undefined | string; key?: undefined | string; page?: undefined | number; size?: undefined | number; src_validator_addr?: undefined | string }): Promise<Redelegation[]>

- Defined in src/modules/staking.ts:241
Query a redelegation record based on delegator and a source and destination validator address

since

Parameters
- query: { count_total?: undefined | false | true; delegator_addr: string; dst_validator_addr?: undefined | string; key?: undefined | string; page?: undefined | number; size?: undefined | number; src_validator_addr?: undefined | string }
  - Optional count_total?: undefined | false | true
  - delegator_addr: string
  - Optional dst_validator_addr?: undefined | string
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
  - Optional src_validator_addr?: undefined | string
Returns Promise<Redelegation[]>

queryUnbondingDelegation

queryUnbondingDelegation(delegator_addr: string, validator_addr: string): Promise<UnbondingDelegation>

- Defined in src/modules/staking.ts:179
Query an unbonding-delegation record based on delegator and validator address

since

Parameters
- delegator_addr: string
  
  Bech32 delegator address
- validator_addr: string
  
  Bech32 validator address
Returns Promise<UnbondingDelegation>

queryValidator

queryValidator(address: string): Promise<Validator>

- Defined in src/modules/staking.ts:429
Query a validator

since

Parameters
- address: string
  
  Bech32 validator address
Returns Promise<Validator>

queryValidatorDelegations

queryValidatorDelegations(query: { count_total?: undefined | false | true; key?: undefined | string; page?: undefined | number; size?: undefined | number; validator_addr: string }): Promise<Delegation[]>

- Defined in src/modules/staking.ts:368
Query all delegations to one validator

since

Parameters
- query: { count_total?: undefined | false | true; key?: undefined | string; page?: undefined | number; size?: undefined | number; validator_addr: string }
  - Optional count_total?: undefined | false | true
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
  - validator_addr: string
Returns Promise<Delegation[]>

queryValidatorUnbondingDelegations

queryValidatorUnbondingDelegations(query: { count_total?: undefined | false | true; key?: undefined | string; page?: undefined | number; size?: undefined | number; validator_addr: string }): Promise<UnbondingDelegation[]>

- Defined in src/modules/staking.ts:399
Query all unbonding delegatations from a validator

since

Parameters
- query: { count_total?: undefined | false | true; key?: undefined | string; page?: undefined | number; size?: undefined | number; validator_addr: string }
  - Optional count_total?: undefined | false | true
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
  - validator_addr: string
Returns Promise<UnbondingDelegation[]>

queryValidators

queryValidators(query: { count_total?: undefined | false | true; key?: undefined | string; page?: undefined | number; size?: undefined | number; status?: undefined | string }): Promise<Validator[]>

- Defined in src/modules/staking.ts:454
Query for all validators

since

Parameters
- query: { count_total?: undefined | false | true; key?: undefined | string; page?: undefined | number; size?: undefined | number; status?: undefined | string }
  - Optional count_total?: undefined | false | true
  - Optional key?: undefined | string
  - Optional page?: undefined | number
  - Optional size?: undefined | number
  - Optional status?: undefined | string
Returns Promise<Validator[]>

redelegate

redelegate(validatorSrcAddr: string, validatorDstAddr: string, amount: Coin, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/staking.ts:89
Redelegate illiquid tokens from one validator to another

since

v0.17

Parameters
- validatorSrcAddr: string
  
  Bech32 source validator address
- validatorDstAddr: string
  
  Bech32 destination validator address
- amount: Coin
  
  Amount to be redelegated
- baseTx: BaseTx
Returns Promise<TxResult>

undelegate

undelegate(validatorAddr: string, amount: Coin, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/staking.ts:62
Undelegate from a validator

since

v0.17

Parameters
- validatorAddr: string
  
  Bech32 validator address
- amount: Coin
  
  Amount to be undelegated from the validator
- baseTx: BaseTx
Returns Promise<TxResult>

Hierarchy

Index

Methods

Methods

createValidator

Returns void

delegate

Parameters

validatorAddr: string

amount: Coin

baseTx: BaseTx

Returns Promise<TxResult>

queryDelegation

Parameters

delegator_addr: string

validator_addr: string

Returns Promise<Delegation>

queryDelegations

Parameters

query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }

Optional count_total?: undefined | false | true

delegator_addr: string

Optional key?: undefined | string

Optional page?: undefined | number

Optional size?: undefined | number

Returns Promise<Delegation[]>

queryDelegatorUnbondingDelegations

Parameters

query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }

Optional count_total?: undefined | false | true

delegator_addr: string

Optional key?: undefined | string

Optional page?: undefined | number

Optional size?: undefined | number

Returns Promise<UnbondingDelegation[]>

queryDelegatorValidator

Parameters

query: { delegator_addr: string; validator_addr: string }

delegator_addr: string

validator_addr: string

Returns Promise<object>

queryDelegatorValidators

Parameters

query: { count_total?: undefined | false | true; delegator_addr: string; key?: undefined | string; page?: undefined | number; size?: undefined | number }

Optional count_total?: undefined | false | true

delegator_addr: string

Optional key?: undefined | string

Optional page?: undefined | number

Optional size?: undefined | number

Returns Promise<object>

queryHistoricalInfo

Parameters

query: { height: number }

height: number

Returns Promise<object>

queryParams

Returns Promise<StakingParams>

queryPool

Returns Promise<StakingPool>

queryRedelegation

Parameters

query: { count_total?: undefined | false | true; delegator_addr: string; dst_validator_addr?: undefined | string; key?: undefined | string; page?: undefined | number; size?: undefined | number; src_validator_addr?: undefined | string }

Optional count_total?: undefined | false | true

delegator_addr: string

Optional dst_validator_addr?: undefined | string

Optional key?: undefined | string

Optional page?: undefined | number

Optional size?: undefined | number

Optional src_validator_addr?: undefined | string

Returns Promise<Redelegation[]>

queryUnbondingDelegation

Parameters

delegator_addr: string

validator_addr: string

Returns Promise<UnbondingDelegation>

queryValidator

Parameters

address: string

Returns Promise<Validator>

queryValidatorDelegations