Volo Module

The Volo Module provides functionality for the Volo staking protocol, allowing users to stake SUI tokens and receive vSUI tokens.

Core Features

SUI Staking: Stake SUI to receive vSUI
vSUI Unstaking: Unstake vSUI to receive SUI
Statistics Query: Get detailed statistics of the staking pool
APY Monitoring: Monitor staking annual percentage yield

Configuration Options

packageId

The package ID of the Volo staking contract, defaults to 0x68d22cf8bdbcd11ecba1e094922873e4080d4d11133e2443fddda0bfd11dae20.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient({
  configs: {
    volo: {
      packageId: '0x68d22cf8bdbcd11ecba1e094922873e4080d4d11133e2443fddda0bfd11dae20'
    }
  }
})

poolId

The ID of the staking pool, defaults to 0x2d914e23d82fedef1b5f56a32d5c64bdcc3087ccfea2b4d6ea51a71f587840e5.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient({
  configs: {
    volo: {
      poolId: '0x2d914e23d82fedef1b5f56a32d5c64bdcc3087ccfea2b4d6ea51a71f587840e5'
    }
  }
})

metadataId

The ID of the staking pool metadata, defaults to 0x680cd26af32b2bde8d3361e804c53ec1d1cfe24c7f039eb7f549e8dfde389a60.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient({
  configs: {
    volo: {
      metadataId: '0x680cd26af32b2bde8d3361e804c53ec1d1cfe24c7f039eb7f549e8dfde389a60'
    }
  }
})

coinType

The vSUI token type, defaults to 0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient({
  configs: {
    volo: {
      coinType: '0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT'
    }
  }
})

API Reference

getStats

Get current statistics and detailed information of the Volo staking pool.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
const stats = await walletClient.volo.getStats()
console.log('Volo Statistics:', stats)

Result Example

{
  "operatorBalance": "1000000000000",
  "collectableFee": "50000000000",
  "pendingStakes": "200000000000",
  "totalStaked": "10000000000000",
  "totalRewardsInStakes": "300000000000",
  "activeStake": "9500000000000",
  "currentEpoch": "12345",
  "validators": [
    {
      "address": "0x123...",
      "totalStaked": "1000000000000",
      "assigned_weight": "0.1",
      "apy": "5.2",
      "name": "Validator 1"
    }
  ],
  "exchangeRate": 1.05,
  "totalSupply": "10500000000000",
  "apy": 5.2,
  "maxInstantUnstake": "5000000000000",
  "maxNoFeeUnstake": "2000000000000",
  "totalStakers": 1500,
  "lastUpdated": 1640995200000
}

stake

Stake SUI tokens to receive vSUI tokens.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
const result = await walletClient.volo.stake(
  1000000000, // Staking amount (1 SUI)
  { dryRun: false } // Optional parameters
)

stakePTB

Adds staking operation to a transaction block for building complex transactions.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'
import { Transaction } from '@mysten/sui/transactions'

const walletClient = new WalletClient()
const tx = new Transaction()

// Get SUI balance and merge coins
const suiBalance = walletClient.balance.portfolio.getBalance('0x2::sui::SUI')
const mergedCoin = mergeCoinsPTB(tx, suiBalance.coins, {
  balance: 1000000000, // 1 SUI
  useGasCoin: true
})

// Add staking operation to transaction
const vSuiCoin = await walletClient.volo.stakePTB(tx, mergedCoin)

// Transfer vSUI to user address
tx.transferObjects([vSuiCoin], walletClient.address)

// Execute transaction
const result = await walletClient.signExecuteTransaction({
  transaction: tx,
  dryRun: false
})

This method is used for building complex transactions that combine multiple operations. For simple staking operations, use the stake method instead.

unstake

Unstake vSUI tokens to receive SUI tokens.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
const result = await walletClient.volo.unstake(
  1000000000, // Unstaking amount (1 vSUI)
  { dryRun: false } // Optional parameters
)

unstakePTB

Adds unstaking operation to a transaction block for building complex transactions.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'
import { Transaction } from '@mysten/sui/transactions'

const walletClient = new WalletClient()
const tx = new Transaction()

// Get vSUI balance and merge coins
const vSuiBalance = walletClient.balance.portfolio.getBalance(
  '0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT'
)
const mergedCoin = mergeCoinsPTB(tx, vSuiBalance.coins, {
  balance: 1000000000 // 1 vSUI
})

// Add unstaking operation to transaction
const suiCoin = await walletClient.volo.unstakePTB(tx, mergedCoin)

// Transfer SUI to user address
tx.transferObjects([suiCoin], walletClient.address)

// Execute transaction
const result = await walletClient.signExecuteTransaction({
  transaction: tx,
  dryRun: false
})

This method is used for building complex transactions that combine multiple operations. For simple unstaking operations, use the unstake method instead.

Events

volo:stake-success

Event triggered when staking is successful.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
walletClient.events.on('volo:stake-success', (data) => {
  console.log('Staking successful:', {
    suiAmount: data.suiAmount
  })
})

Event Data Example

{
  "suiAmount": 1000000000
}

volo:unstake-success

Event triggered when unstaking is successful.

Usage Example

import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
walletClient.events.on('volo:unstake-success', (data) => {
  console.log('Unstaking successful:', {
    vSuiAmount: data.vSuiAmount
  })
})

Event Data Example

{
  "vSuiAmount": 1000000000
}

Volo Module

On this page