Everstake Wallet SDK

Appearance

Return to top
On this page

Getting Info Sui

The Sui SDK provides several read-only methods to retrieve information about balances and stakes:

  • getBalanceByAddress(address): Retrieves the Sui balance for a given address. Returns a BigNumber representing the balance in MIST.
  • getStakes(address): Gets all staking positions for a given address.

Balance Example

ts
// Import SDK
import { Sui } from '@everstake/wallet-sdk-sui';

// Initialize Sui client with the desired network
const client = new Sui('mainnet');

// User address
const address = '0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234';

// Get the balance
const balance = await client.getBalanceByAddress(address);

// Convert from MIST to SUI (1 SUI = 10^9 MIST)
const balanceInSui = Number(balance) / 1e9;

console.log(`Balance: ${balanceInSui} SUI`);

Staking Positions Example

ts
// Import SDK
import { Sui } from '@everstake/wallet-sdk-sui';

// Initialize Sui client with the desired network
const client = new Sui('testnet');

// User address
const address = '0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234';

// Get all staking positions
const delegatedStakes = await client.getStakes(address);

// Example of processing stake information
if (delegatedStakes.length > 0) {
  delegatedStakes.forEach((delegatedStake, index) => {
    console.log(`DelegatedStake #${index + 1}:`);
    console.log(`  Validator: ${delegatedStake.validatorAddress}`);
    console.log(`  Staking Pool: ${delegatedStake.stakingPool}`);
    delegatedStake.stakes.forEach((stake, index) => {
      console.log(`  Stake #${index + 1}:`);
      console.log(`    ID:     ${stake.stakedSuiId}`);
      console.log(`    Amount: ${stake.principal} MIST`);
      console.log(`    Status: ${stake.status}`);
      console.log(`    Request Epoch: ${stake.stakeRequestEpoch}`);
      console.log(`    Active Epoch:  ${stake.stakeActiveEpoch}`);
      if (stake.status === 'Active') {
        console.log(`    Estimated Reward: ${stake.estimatedReward} MIST`);
      }
    })
  });
} else {
  console.log('No active stakes found');
}