Overview

Staking on the Solana network involves locking up tokens to support the network's security and operations. In return, stakers earn rewards.

The Solana blockchain, distinguished by its high throughput and low latency, leverages the Proof of History (PoH) mechanism combined with the Tower BFT consensus algorithm. This innovative structure allows for fast transaction processing and scalability without compromising security. By staking SOL, Solana's native token, validators maintain the network, secure the blockchain, and incentivize active participation, ensuring the network remains robust and efficient.

The Chorus One SDK simplifies the staking process on the Solana network, providing developers with the tools needed to build, sign, and broadcast staking transactions.

This guide will walk you through the fundamentals of staking on Solana using the Chorus One SDK.

Compatibility Notice

The methods provided in this documentation are compatible with popular Solana libraries such as @solana/web3.js. This compatibility ensures that you can seamlessly integrate these methods into your existing Solana projects.

Setting Up the Staker

To get started with staking on the Solana network using the Chorus One SDK, you will first need to initialize the SDK.

Note: For testing purposes, we will use the Solana testnet.

First, create an instance of SolanaStaker with the necessary configuration:

import { SolanaStaker } from '@chorus-one/solana'

const staker = new SolanaStaker({
  rpcUrl: 'https://api.testnet.solana.com'
})

Configuration Parameters:

rpcUrl: The URL of the Solana network RPC endpoint. This is where the SDK will connect to interact with the network. In this example, we are using a public endpoint for the Solana testnet.

Initializing the Staker

After configuring the SolanaStaker, initialize it to prepare for staking operations.

This can be done via the following input:

await staker.init()

The init method establishes a connection with the configured RPC endpoint and prepares the staker for operations such as building and broadcasting transactions.

Building Transactions

Once the staker is set up, you can start building transactions for staking operations.

The SolanaStaker class provides methods to build transactions for staking, unstaking, merging and splitting stakes, and creating stake accounts.

You can learn more about these methods in the Methods section.

Example of building a staking transaction:

const { tx, stakeAccountAddress } = await staker.buildStakeTx({
  delegatorAddress: '3Ps2hwsgGMSuqxAwjcGJHiEpMsSTZcxrCGprHgxWkfma',
  validatorAddress: 'Chorus6Kis8tFHA7AowrPMcRJk3LbApHTYpgSNXzY5KE',
  amount: '1' // 1 SOL
})

Optionally you can specify the stake account address by passing the stakeAccountAddress argument. If it is not provided, the SDK will create a new stake account for you and return the address.

On the Solana network, a stake account lets you delegate tokens to validators to earn rewards. Unlike a wallet account, which is limited, a stake account can handle the token delegation.

Getting the Validator Address provided by Chorus One

The @chorus-one/solana module includes the CHORUS_ONE_SOLANA_VALIDATOR constant, which contains the Chorus One validator address for building transactions.

import { CHORUS_ONE_SOLANA_VALIDATOR } from '@chorus-one/solana'

const validatorAddress = CHORUS_ONE_SOLANA_VALIDATOR

Signing the Transaction

Once the transaction is built, you can sign that transaction using your own signing solution e.g.:

const signedTx = await yourWallet.signTransaction(tx)

Additionally, you can use the Chorus One SDK to sign transactions using Fireblocks, mnemonic or other methods.

For detailed information on setting up and configuring these options, please refer to the What is a Signer? section.

By integrating Fireblocks, you can leverage its robust security features to sign transactions on the Solana network. To set up Fireblocks, you will need to provide the necessary API key, secret key, and vault ID:

import { SolanaStaker } from '@chorus-one/solana'
import { FireblocksSigner } from '@chorus-one/signer-fireblocks'

const signer = new FireblocksSigner({
  apiSecretKey: 'your-api-secret-key',
  apiKey: 'your-api-key',
  vaultName: 'your-vault-name',
  assetId: 'SOL_TEST',
  addressDerivationFn: SolanaStaker.getAddressDerivationFn()
})

await signer.init()

const { signedTx } = await staker.sign({
  signer,
  signerAddress: '3Ps2hwsgGMSuqxAwjcGJHiEpMsSTZcxrCGprHgxWkfma',
  tx
})

For more information please refer to the Signing with Fireblocks

Broadcasting the Transaction

After signing the transaction, you will need to broadcast it to the network. You can do this using the broadcast method:

const { txHash } = await staker.broadcast({ signedTx })

And now you can track the transaction status:

const { status, receipt } = await staker.getTxStatus({ txHash })

console.log(status) // 'success'

Next Steps

In this section you learned how to set up the Chorus One SDK for the Solana network using the Solana testnet, which included how to build staking transactions, sign, broadcast, and track them.

To learn more about the available methods on SolanaStaker continue to the Methods section.