Methods

This section provides an overview of the key methods available in the Chorus One SDK for staking on the Cosmos network.

The SDK supports a range of staking operations including staking, unstaking, redelegating, and withdrawing rewards. Below, we explore each method with practical examples to help you get started.

buildStakeTx

Description

The buildStakeTx method helps you create a transaction for staking tokens with a validator. Staking tokens involves locking them up to support the network's security and operations, and in return you earn rewards.

How to Use

To build a staking transaction, you need to specify the amount to stake, the delegator's address (your wallet), and the validator's address where you want to stake your tokens.

Example

const { tx } = await staker.buildStakeTx({
  delegatorAddress: 'cosmos1x88j7vp2xnw3zec8ur3g4waxycyz7m0mahdv3p',
  validatorAddress: 'cosmosvaloper15urq2dtp9qce4fyc85m6upwm9xul3049e02707',
  amount: '1' // 1 ATOM
})

In this example, we're staking 1 ATOM with a specified validator.

• Read more in the API Reference

---

buildUnstakeTx

Description

The buildUnstakeTx method allows you to create a transaction for unstaking tokens from a validator.

Unstaking involves withdrawing your staked tokens, during which they enter an unbonding period. On the Cosmos network, the unbonding period typically lasts 21 days, during which your tokens are not earning rewards and cannot be transferred.

After the unbonding period, the tokens become available in your wallet.

How to Use

To build an unstaking transaction, you need to provide the amount to unstake, the delegator's address, and the validator's address from where you want to withdraw your tokens.

Example

const { tx } = await staker.buildUnstakeTx({
  delegatorAddress: 'cosmos1x88j7vp2xnw3zec8ur3g4waxycyz7m0mahdv3p',
  validatorAddress: 'cosmosvaloper15urq2dtp9qce4fyc85m6upwm9xul3049e02707',
  amount: '1' // 1 ATOM
})

Here, we're unstaking 1 ATOM from a specified validator.

• Read more in the API Reference

---

buildRedelegateTx

Description

The buildRedelegateTx method helps you create a transaction for redelegating tokens from one validator to another.

This is useful if you want to move your staked tokens to a different validator instantly instead of unstaking, waiting for the unbonding period to complete, then staking them with a different validator.

How to Use

To build a redelegation transaction, you need to specify the amount to redelegate, the delegator's address, the source validator's address, and the destination validator's address.

Example

const { tx } = await staker.buildRedelegateTx({
  delegatorAddress: 'cosmos1x88j7vp2xnw3zec8ur3g4waxycyz7m0mahdv3p',
  validatorSrcAddress: 'cosmosvaloper1tnrq6ahy4g6g3foc5g3dgdj0sdfurfd5f4vz5e',
  validatorDstAddress: 'cosmosvaloper15urq2dtp9qce4fyc85m6upwm9xul3049e02707',
  amount: '1' // 1 ATOM
})

In this example, we're moving 1 ATOM from one validator to another.

• Read more in the API Reference

---

buildWithdrawRewardsTx

Description

The buildWithdrawRewardsTx method allows you to create a transaction for withdrawing staking rewards from a validator.

Staking rewards accumulate over time and you can withdraw them periodically.

How to Use

To build a rewards withdrawal transaction, you need to provide the delegator's address and the validator's address that you want to withdraw your rewards from.

Example

const { tx } = await staker.buildWithdrawRewardsTx({
  delegatorAddress: 'cosmos1x88j7vp2xnw3zec8ur3g4waxycyz7m0mahdv3p',
  validatorAddress: 'cosmosvaloper15urq2dtp9qce4fyc85m6upwm9xul3049e02707'
})

Here, we're withdrawing rewards from a specified validator.

• Read more in the API Reference

---

getStake

Description

The getStake method retrieves the staking information from a delegator.

• This includes the amount of tokens currently staked with a validator.

How to Use

To get staking information, you need to provide the delegator's address (your wallet), and optionally the validator's address. If the validator's address is not provided, the method returns rewards from all validators.

Example

const { balance } = await staker.getStake({
  delegatorAddress: 'cosmos1x88j7vp2xnw3zec8ur3g4waxycyz7m0mahdv3p',
  validatorAddress: 'cosmosvaloper15urq2dtp9qce4fyc85m6upwm9xul3049e02707'
})
console.log(`Staked balance: ${balance}`)

In this example, we're retrieving the staked balance for a given delegator and validator.

• Read more in the API Reference

---

getRewards

Description

The getRewards method fetches the rewards data accumulated for a delegator.

This shows the total rewards earned from staking with a specific validator.

How to Use

To get rewards data, you need to provide the delegator's (your wallet) address and optionally the validator's address. If the validator's address is not provided, the method returns rewards from all validators.

You can also specify denom to get rewards for a specific token, and denomMultiplier to get rewards in a specific format.

Example

const { rewards } = await staker.getRewards({
  delegatorAddress: 'cosmos1x88j7vp2xnw3zec8ur3g4waxycyz7m0mahdv3p',
  validatorAddress: 'cosmosvaloper15urq2dtp9qce4fyc85m6upwm9xul3049e02707'
})
console.log(`Rewards: ${rewards}`)

Here, we're fetching the rewards earned by a delegator from a specific validator.

• Read more in the API Reference

---

Further Reading

For more detailed information and additional methods, please refer to the official API reference:

• CosmosStaker API Reference