NAVI Lending SDK

https://sdk.naviprotocol.io
Admin
NAVI Lending SDK is a lending SDK designed for the Sui blockchain, providing complete lending...
Tokens:77,961
Snippets:544
Trust Score:9.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### Quick Start with NAVI Protocol Wallet Client (TypeScript)

Source: https://sdk.naviprotocol.io/wallet-client

Demonstrates the basic setup and usage of the NAVI Wallet Client in TypeScript. It covers client initialization with a custom RPC URL and private key, interacting with balance, swap, lending, Haedal, and Volo modules.

```typescript
import { WalletClient } from '@naviprotocol/wallet-client'
import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519"


// Create wallet client
const walletClient = new WalletClient({
    client: {
        url: 'https://fullnode.mainnet.sui.io' // Custom RPC URL
    },
    signer: Ed25519Keypair.fromSecretKey(privateKey),
    configs: {
      swap: {
        serviceFee: {
          recipient: '0x123...',
          fee: 0.001 // 0.1%
        }
      }
    }
})

// Use balance module
const portfolio = walletClient.balance.portfolio
const suiBalance = portfolio.getBalance('0x2::sui::SUI')

// Use swap module
const result = await walletClient.swap.swap(
  '0x2::sui::SUI',
  '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN',
  1000000000,
  0.01
)

// Use lending module
const healthFactor = await walletClient.lending.getHealthFactor()
const pools = await walletClient.lending.getPools()

// Use Haedal module
const apy = await walletClient.haedal.getApy()
const stakeResult = await walletClient.haedal.stake(1000000000)

// Use Volo module
const stats = await walletClient.volo.getStats()
const voloStakeResult = await walletClient.volo.stake(1000000000)
```

--------------------------------

### Install NAVI Protocol SDK using npm

Source: https://sdk.naviprotocol.io/bridge/start

This command installs the NAVI Protocol Astros Bridge SDK using npm. Ensure you have Node.js and npm installed on your system. This is the first step to using the SDK's functionalities.

```bash
npm install @naviprotocol/astros-bridge-sdk
```

--------------------------------

### Install @naviprotocol/wallet-client

Source: https://sdk.naviprotocol.io/typedoc/modules/_naviprotocol_wallet-client

Installs the @naviprotocol/wallet-client package using npm. This is the first step to integrate the wallet client into your project.

```bash
npm install @naviprotocol/wallet-client

```

--------------------------------

### Install NAVI Lending SDK

Source: https://sdk.naviprotocol.io/typedoc/modules/_naviprotocol_lending

This snippet shows how to install the @naviprotocol/lending package using npm. This is the first step to integrating the SDK into your project.

```bash
npm install @naviprotocol/lending
```

--------------------------------

### Install NAVI Protocol Wallet Client SDK

Source: https://sdk.naviprotocol.io/wallet-client

Installs the NAVI Protocol Wallet Client SDK using npm. This is the first step to integrating NAVI Protocol's functionalities into your application.

```bash
npm install @naviprotocol/wallet-client
```

--------------------------------

### Example: Fetch Swap Quote with SwapOptions in TypeScript

Source: https://sdk.naviprotocol.io/swap/swap-options

This TypeScript example demonstrates how to instantiate and use the SwapOptions type when calling the getQuote function from the NAVI Protocol SDK. It shows how to set a custom API base URL, specify a list of DEXs for routing, configure a service fee, and define slippage tolerance. The example requires importing necessary types and functions from the SDK.

```typescript
import {SwapOptions, Dex, getQuote} from "@naviprotocol/astros-aggregator-sdk";


const swapOptions: SwapOptions = {
  baseUrl: 'https://open-aggregator-api.naviprotocol.io/find_routes',
  dexList: [Dex.CETUS, Dex.TURBOS, Dex.KRIYA_V2],
  depth: 3,
  feeOption: {
    fee: 0.03, // 3% fee
    receiverAddress: '0x...' // Replace with actual receiver address
  },
  slippage: 0.01 // 1% slippage
}

const quote = await getQuote(
  '0x2::sui::SUI', // Source token address
  '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN', // Target token address
  1000000000, // Swap amount
  'your-api-key', // Optional API key
  swapOptions
)
```

--------------------------------

### Navi Astros Bridge SDK - Installation

Source: https://sdk.naviprotocol.io/typedoc/modules/_naviprotocol_astros-bridge-sdk

Instructions on how to install the @naviprotocol/astros-bridge-sdk package using npm.

```APIDOC
## Installation

```bash
npm install @naviprotocol/astros-bridge-sdk
```
```

--------------------------------

### Usage Example

Source: https://sdk.naviprotocol.io/swap/swap-options

Demonstrates how to import and use the `SwapOptions` type with the `getQuote` function in the NAVI Protocol SDK.

```APIDOC
## Usage Example

### Description

This example shows how to configure and use `SwapOptions` when fetching a quote for a token swap using the NAVI Protocol SDK.

### Method

```javascript
import {SwapOptions, Dex, getQuote} from "@naviprotocol/astros-aggregator-sdk";
```

### Request Example

```javascript
const swapOptions: SwapOptions = {
  baseUrl: 'https://open-aggregator-api.naviprotocol.io/find_routes',
  dexList: [Dex.CETUS, Dex.TURBOS, Dex.KRIYA_V2],
  depth: 3,
  serviceFee: {
    fee: 0.03, // 3% fee
    receiverAddress: '0x...'
  },
  slippage: 0.01 // 1% slippage
}

const quote = await getQuote(
  '0x2::sui::SUI', // Source token address
  '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN', // Target token address
  1000000000, // Swap amount
  'your-api-key', // Optional API key
  swapOptions
)
```

### Response

#### Success Response (200)

The `getQuote` function returns a quote object containing details about the potential swap, which would be assigned to the `quote` variable.

#### Response Example

```json
{
  "example": "quote object"
}
```
```

--------------------------------

### Start bridge transaction using NAVI Protocol SDK

Source: https://sdk.naviprotocol.io/bridge/start

Initiates a bridge transaction using the obtained quote. This function requires the selected route from the quote, sender and receiver addresses, and wallet connection details. It returns transaction details, including a transaction ID for status tracking.

```javascript
import {swap} from '@naviprotocol/astros-bridge-sdk';

const transaction = await swap(quotes.routes[0], fromAddress, toAddress, walletConnect)
```

--------------------------------

### Complete Flash Loan Arbitrage Example

Source: https://sdk.naviprotocol.io/lending/flashloan

Demonstrates a full-cycle flash loan usage for arbitrage trading, including initiation, execution of arbitrage logic, and repayment.

```APIDOC
## Complete Flash Loan Arbitrage Example

### Description
This example illustrates how to perform an arbitrage trade using NAVI Protocol's Flash Loans within a Programmable Transaction Block (PTB).

### Method
N/A (This is a script-level example using SDK functions)

### Endpoint
N/A

### Request Example
```javascript
import { flashloanPTB, repayFlashLoanPTB } from '@naviprotocol/lending';
import { Transaction } from '@mysten/sui/transactions';

async function executeFlashLoanArbitrage() {
  const tx = new Transaction();

  // Step 1: Initiate flash loan
  const [borrowedBalance, receipt] = await flashloanPTB(
    tx,
    '0x2::sui::SUI', // Asset identifier
    1000000000,     // Amount to borrow (e.g., 1 SUI)
    { env: 'prod' }
  );

  // Step 2: Execute arbitrage logic with borrowed funds
  // 
  // Placeholder for your specific arbitrage trading logic.
  // This would involve interacting with other DEXs or protocols
  // using the 'borrowedBalance' coin object obtained from the flash loan.
  // For example, trading borrowed SUI for another asset on DEX A,
  // and then trading it back for more SUI on DEX B.
  console.log('Executing arbitrage logic...');
  // ... your arbitrage trading logic here ...

  // Step 3: Repay the flash loan
  // The 'borrowedBalance' object (or a modified version after arbitrage)
  // must be used as the source for repayment.
  const [remainingBalance] = await repayFlashLoanPTB(
    tx,
    '0x2::sui::SUI', // Asset identifier
    receipt,        // Receipt from original flash loan
    borrowedBalance, // Coin object containing repayment amount (original borrowed + fees)
    { env: 'prod' }
  );

  console.log('Flash loan repaid.');

  // Step 4: Execute the transaction
  // At this point, 'tx' contains all the operations for the flash loan and arbitrage.
  // You would then typically sign and execute this transaction using the Sui client.
  // For example:
  // const result = await suiClient.executeTransaction(tx, { sign: true });
  // console.log('Arbitrage transaction executed:', result);

  // The 'remainingBalance' would represent any profit or remaining coin after the operation.
  return remainingBalance;
}

// To run the example:
// executeFlashLoanArbitrage().catch(console.error);
```
```

--------------------------------

### Quick Start: Initialize and Use WalletClient

Source: https://sdk.naviprotocol.io/typedoc/modules/_naviprotocol_wallet-client

Demonstrates initializing the WalletClient and using its core modules like balance, swap, lending, Haedal, and Volo. It shows how to fetch portfolio data, perform swaps, check lending health, and initiate staking operations.

```typescript
import { WalletClient } from '@naviprotocol/wallet-client'  
  
// Create wallet client  
const walletClient = new WalletClient()  
  
// Use balance module  
const portfolio = walletClient.balance.portfolio  
const suiBalance = portfolio.getBalance('0x2::sui::SUI')  
  
// Use swap module  
const result = await walletClient.swap.swap(  
  '0x2::sui::SUI',  
  '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN',  
  1000000000,  
  0.01  
)  
  
// Use lending module  
const healthFactor = await walletClient.lending.getHealthFactor()  
const pools = await walletClient.lending.getPools()  
  
// Use Haedal module  
const apy = await walletClient.haedal.getApy()  
const stakeResult = await walletClient.haedal.stake(1000000000)  
  
// Use Volo module  
const stats = walletClient.volo.getStats()  
const voloStakeResult = await walletClient.volo.stake(1000000000)
```

--------------------------------

### Install Astros DEX Aggregator SDK with npm

Source: https://sdk.naviprotocol.io/swap

This snippet shows how to install the Astros DEX Aggregator SDK using npm, the Node Package Manager. This is the primary method for integrating the SDK into your project.

```bash
npm install @naviprotocol/astros-aggregator-sdk
```

--------------------------------

### Get Portfolio Data

Source: https://sdk.naviprotocol.io/wallet-client/balance

Categorize and aggregate portfolio data based on coins, with support for querying specific coin balances.

```APIDOC
### portfolio

Categorize and aggregate data based on coins. Supports querying balance for specified coins.

**Usage Example**
```javascript
import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
const portfolio = walletClient.balance.portfolio
const suiBalance = portfolio.getBalance('0x2::sui::SUI')
```

**Result Example**
```json
{
  amount: BigNumber('1000000000'),
  coins: [{
    coinObjectId: '0x1',
    balance: '1000000000',
    coinType: '0x2::sui::SUI'
  }]
}
```
```

--------------------------------

### Configure NAVI Protocol SDK with API Key

Source: https://sdk.naviprotocol.io/bridge/start

Configure the NAVI Protocol SDK with your unique API key. This step is crucial for authenticating your requests to the NAVI Protocol services. Replace 'your api key' with your actual API key.

```javascript
import {config} from '@naviprotocol/astros-bridge-sdk';

config({
  apiKey: 'your api key'
});
```

--------------------------------

### Get Portfolio Balance and Details (JavaScript)

Source: https://sdk.naviprotocol.io/wallet-client/balance

Accesses the user's portfolio, which categorizes and aggregates coin data. It allows querying the balance for specific coin types and provides a list of associated coins.

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

const walletClient = new WalletClient()
const portfolio = walletClient.balance.portfolio
const suiBalance = portfolio.getBalance('0x2::sui::SUI')
```

--------------------------------

### Get Swap Configuration Options

Source: https://sdk.naviprotocol.io/wallet-client/swap

Retrieves the current configuration options for the swap module. This includes settings like baseUrl, dexList, depth, and serviceFee.

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

const walletClient = new WalletClient()
const options = walletClient.swap.swapOptions
console.log('Current swap options:', options)
```

--------------------------------

### Get Wallet Coins

Source: https://sdk.naviprotocol.io/wallet-client/balance

Retrieve the current list of token objects within the wallet.

```APIDOC
## API Reference

### coins

Get the current list of token objects in the wallet.

**Usage Example**
```javascript
import { WalletClient } from '@naviprotocol/wallet-client'

const walletClient = new WalletClient()
const coins = walletClient.balance.coins
```

**Result Example**
```json
[
  {
    coinObjectId: '0x1',
    balance: '1000000000',
    coinType: '0x2::sui::SUI',
    digest: '0x...',
    version: '123456'
  }
]
```
```

--------------------------------

### Listen to Lending Repayment Success Event (JavaScript)

Source: https://sdk.naviprotocol.io/wallet-client/lending

This example illustrates how to capture the 'lending:repay-success' event using the Navi Protocol WalletClient. It logs the identifier and amount upon a successful loan repayment. The '@naviprotocol/wallet-client' library must be imported.

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

const walletClient = new WalletClient()
walletClient.events.on('lending:repay-success', (data) => {
  console.log('Repayment successful:', {
    identifier: data.identifier,
    amount: data.amount
  })
})
```

--------------------------------

### Listen to Lending Claim Rewards Success Event (JavaScript)

Source: https://sdk.naviprotocol.io/wallet-client/lending

This example shows how to use the Navi Protocol WalletClient to listen for the 'lending:claim-rewards-success' event. It logs the rewards data upon successful claiming of lending rewards. The '@naviprotocol/wallet-client' library is a prerequisite.

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

const walletClient = new WalletClient()
walletClient.events.on('lending:claim-rewards-success', (data) => {
  console.log('Reward claiming successful:', {
    rewards: data.rewards
  })
})
```

--------------------------------

### Configure Volo Module with Package ID - JavaScript

Source: https://sdk.naviprotocol.io/wallet-client/volo

Example demonstrating how to configure the Volo Module within the WalletClient by specifying the package ID for the Volo staking contract. This ensures the client interacts with the correct contract instance. It uses the '@naviprotocol/wallet-client' library.

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

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

--------------------------------

### Configure Volo Module with Metadata ID - JavaScript

Source: https://sdk.naviprotocol.io/wallet-client/volo

Shows how to initialize the Volo Module with a custom metadata ID for the staking pool. This allows for specific metadata retrieval and management related to staking operations. The example uses the '@naviprotocol/wallet-client' library.

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

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

--------------------------------

### Get Volo Staking Pool Statistics - JavaScript

Source: https://sdk.naviprotocol.io/wallet-client/volo

Example of how to retrieve current statistics and detailed information about the Volo staking pool using the WalletClient. This method returns data such as operator balance, rewards, staked amounts, and validator details. It utilizes the '@naviprotocol/wallet-client' library.

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

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

--------------------------------

### Instantiate WalletClient

Source: https://sdk.naviprotocol.io/typedoc/classes/_naviprotocol_wallet-client.WalletClient

Creates a new instance of the WalletClient. Requires WalletClientOptions for configuration, which may include settings for underlying modules and network connections.

```typescript
import { WalletClient, WalletClientOptions } from "@naviprotocol/wallet-client";

const options: WalletClientOptions = {
  // ... configuration options ...
};

const walletClient = new WalletClient(options);

```

--------------------------------

### Get quote for bridge transaction using NAVI Protocol SDK

Source: https://sdk.naviprotocol.io/bridge/start

Retrieves a quote for a bridge transaction between two tokens on different chains. This function calculates the estimated amount of tokens to receive, fees, and potential slippage. Input requires source and destination tokens, amount, and optional slippage settings.

```javascript
import {getQuote} from '@naviprotocol/astros-bridge-sdk';

const quotes = await getQuote(SUI_NAVX, SolanaUSDC, 10, {
    slippageBps: 50
})
```

--------------------------------

### Complete Flash Loan Arbitrage Example (TypeScript)

Source: https://sdk.naviprotocol.io/lending/flashloan

Demonstrates a complete workflow for executing a flash loan-based arbitrage strategy using the NAVI Protocol SDK. It includes initiating the loan, executing arbitrage logic, and repaying the loan within a single transaction using PTBs.

```typescript
import { flashloanPTB, repayFlashLoanPTB } from '@naviprotocol/lending'
import { Transaction } from '@mysten/sui/transactions'

async function executeFlashLoanArbitrage() {
  const tx = new Transaction()

  // Step 1: Initiate flash loan
  const [borrowedBalance, receipt] = await flashloanPTB(
    tx,
    '0x2::sui::SUI',
    1000000000, // 1 SUI
    { env: 'prod' }
  )

  // Step 2: Execute arbitrage logic with borrowed funds
  // ... your arbitrage trading logic here ...

  // Step 3: Repay the flash loan
  const [remainingBalance] = await repayFlashLoanPTB(
    tx,
    '0x2::sui::SUI',
    receipt,
    borrowedBalance,
    { env: 'prod' }
  )

  // Step 4: Execute the transaction
  ...
}
```

--------------------------------

### WalletClientOptions

Source: https://sdk.naviprotocol.io/typedoc/types/_naviprotocol_wallet-client.WalletClientOptions

Configuration options for initializing the wallet client.

```APIDOC
## Type Alias: WalletClientOptions

### Description
Options for initializing the wallet client.

### Properties

#### `signer` (Signer) - Required

The signer for transaction signing.

#### `client` (SuiClientOptions) - Optional

Optional Sui client configuration.

#### `configs` (Partial<UserConfigs>) - Optional

Optional module-specific configurations.

### Request Example
```json
{
  "signer": { /* Signer object */ },
  "client": { /* SuiClientOptions object */ },
  "configs": { /* UserConfigs object */ }
}
```

### Response Example
```json
{
  "message": "Wallet client initialized successfully."
}
```
```

--------------------------------

### Get Swap Quote with NAVI Protocol SDK

Source: https://sdk.naviprotocol.io/swap/quote

Obtain a swap quote between two tokens using the NAVI Protocol SDK. This function helps identify the best route and exchange rate for a token swap. It requires source and target token addresses, swap amount, and optionally an API key and swap options.

```javascript
import { getQuote } from '@naviprotocol/astros-aggregator-sdk'

const quote = await getQuote(
  '0x2::sui::SUI', // Source token address
  '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN', // Target token address
  1000000000, // Swap amount
  'your-api-key', // Optional API key
  swapOptions
)
```

--------------------------------

### Query all supported chains using NAVI Protocol SDK

Source: https://sdk.naviprotocol.io/bridge/start

Fetches a list of all supported blockchain chains from the NAVI Protocol. This function returns an array of chain objects, allowing you to identify and select specific chains like Sui or Solana for further operations. Dependencies: Requires the SDK to be configured with an API key.

```javascript
import {getSupportChains} from '@naviprotocol/astros-bridge-sdk';

const supportChains = await getSupportChains();

const SuiChain = supportChains[6]
const SolanaChain = supportChains[0]
```

--------------------------------

### Get Quote API

Source: https://sdk.naviprotocol.io/typedoc/functions/_naviprotocol_astros-aggregator-sdk.getQuote

Retrieves a quote for swapping one coin to another using the Astros Aggregator SDK.

```APIDOC
## GET /quote

### Description
Retrieves a quote for swapping one coin to another.

### Method
GET

### Endpoint
/quote

### Parameters
#### Query Parameters
- **fromCoinAddress** (string) - Required - The address of the coin to swap from.
- **toCoinAddress** (string) - Required - The address of the coin to swap to.
- **amountIn** (string | number | bigint) - Required - The amount of the fromCoin to swap. Can be a number, string, or bigint.
- **apiKey** (string) - Optional - The API key for authentication.
- **swapOptions** (object) - Optional - The options for the swap, including baseUrl, dexList, byAmountIn, and depth.

### Request Example
```json
{
  "fromCoinAddress": "0x123...",
  "toCoinAddress": "0x456...",
  "amountIn": "100",
  "apiKey": "your_api_key",
  "swapOptions": {
    "baseUrl": "https://aggregator.naviprotocol.io",
    "dexList": "uniswap,sushi",
    "byAmountIn": true,
    "depth": 1
  }
}
```

### Response
#### Success Response (200)
- **quote** (object) - A quote object containing details of the swap.
  - **fromCoinAddress** (string)
  - **toCoinAddress** (string)
  - **amountIn** (string)
  - **amountOut** (string)
  - **estimatedGas** (string)
  - **route** (array)

#### Response Example
```json
{
  "quote": {
    "fromCoinAddress": "0x123...",
    "toCoinAddress": "0x456...",
    "amountIn": "100",
    "amountOut": "99.5",
    "estimatedGas": "0.001ETH",
    "route": [
      {
        "dex": "uniswap",
        "pair": "0xabc...",
        "amountIn": "50",
        "amountOut": "49.75"
      }
    ]
  }
}
```
```

--------------------------------

### Swap SUI to NAVX using Astros Aggregator SDK

Source: https://sdk.naviprotocol.io/swap/example

This example demonstrates how to swap 1 SUI to NAVX using the NAVI Protocol's Astros Aggregator SDK. It involves fetching a quote for the swap, building the transaction, and executing it. Dependencies include the Astros Aggregator SDK and the Sui SDK. It takes private key, amount, and API key as inputs.

```typescript
import {
  SwapOptions,
  Dex,
  getQuote,
  buildSwapPTBFromQuote,
  executeTransaction
} from '@naviprotocol/astros-aggregator-sdk'
import { Transaction } from '@mysten/sui/transactions'

import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519"

const signer = Ed25519Keypair.fromSecretKey(privateKey)

const userAddress = signer.address;

const tx = new Transaction()

const swapOptions: SwapOptions = {
  baseUrl: 'https://open-aggregator-api.naviprotocol.io/find_routes',
  dexList: [Dex.CETUS, Dex.TURBOS],
  depth: 3,
  feeOption: {
    fee: 0.03, // 3% fee
    receiverAddress: '0xc41d2d2b2988e00f9b64e7c41a5e70ef58a3ef835703eeb6bf1bd17a9497d9fe'
  }
}

const quote = await getQuote(
  '0x2::sui::SUI', // Source token address
  '0xa99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX', // Target token address
  1e9, // Swap amount
  'your-api-key',
  swapOptions
)

const coinOut = await buildSwapPTBFromQuote(
  userAddress,
  tx,
  // The minimum output amount of the target token, specified with decimals, used to validate slippage.
  minAmountOut,
  // The transaction Object of Coin that will be swapped. (e.g., const coinIn = txb.splitCoins(txb.gas, [amount]);)
  coinIn,
  // Quote from getQuote()
  quote,
  // optional. Used to identify the swap service provider, default to 0
  referral,
  // optional. Used to print the swap information, default to true
  ifPrint,
  // optional. A string used for API authentication. Leave empty for limited access.
  apiKey,
  // optional.
  swapOptions
)

await txb.transferObjects([coinOut], userAddress);

await executeTransaction(tx, signer)
```

--------------------------------

### GET /getStats

Source: https://sdk.naviprotocol.io/wallet-client/volo

Retrieves current statistics and detailed information about the Volo staking pool.

```APIDOC
## GET /getStats

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

### Method
GET

### Endpoint
/volo/getStats

### Parameters
None

### Request Example
```javascript
import { WalletClient } from '@naviprotocol/wallet-client'

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

### Response
#### Success Response (200)
- **operatorBalance** (string) - The operator's balance.
- **collectableFee** (string) - The amount of collectable fees.
- **pendingStakes** (string) - The amount of pending stakes.
- **totalStaked** (string) - The total amount of SUI staked.
- **totalRewardsInStakes** (string) - The total rewards currently in stakes.
- **activeStake** (string) - The amount of active stakes.
- **currentEpoch** (string) - The current epoch number.
- **validators** (array) - An array of validator objects.
  - **address** (string) - The validator's address.
  - **totalStaked** (string) - The total amount staked with this validator.
  - **assigned_weight** (string) - The assigned weight of the validator.
  - **apy** (string) - The Annual Percentage Yield of the validator.
  - **name** (string) - The name of the validator.
- **exchangeRate** (number) - The current exchange rate between vSUI and SUI.
- **totalSupply** (string) - The total supply of vSUI.
- **apy** (number) - The Annual Percentage Yield for staking.
- **maxInstantUnstake** (string) - The maximum amount that can be unstaked instantly.
- **maxNoFeeUnstake** (string) - The maximum amount that can be unstaked without fees.
- **totalStakers** (number) - The total number of stakers.
- **lastUpdated** (number) - Timestamp of the last update.

#### Response Example
```json
{
  "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
}
```
```

--------------------------------

### Transaction History API

Source: https://sdk.naviprotocol.io/lending/account

Get a user's transaction history under the NAVI protocol.

```APIDOC
## GET /getTransactions

### Description
Retrieve the transaction history for a user's account on the NAVI protocol. This includes details of supplies, withdrawals, repayments, and other relevant operations.

### Method
GET

### Endpoint
/getTransactions

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The unique identifier for the user's account.

#### Query Parameters
- **cursor** (string) - Optional - A cursor for pagination, used to fetch the next set of transactions.

### Request Example
```javascript
// Assuming accountId is already defined
const transactionResult = await getTransactions(accountId, {
  cursor: ""
});
```

### Response
#### Success Response (200)
- **cursor** (string) - A cursor for fetching subsequent pages of results.
- **data** (array) - An array of transaction objects.
  - **type** (string) - The type of transaction (e.g., 'supply', 'withdraw', 'repay').
  - **status** (string) - The status of the transaction (e.g., 'success').
  - **coinChanges** (array) - Details of coin changes associated with the transaction.
    - **symbol** (string) - The symbol of the coin.
    - **amount** (string) - The amount of the coin that changed.
  - **timestamp** (string) - The timestamp when the transaction occurred.
  - **digest** (string) - The unique identifier for the transaction.

#### Response Example
```json
{
  "cursor": "7dmAzBcvd6BcX5msm1UFJns1KdMyqWKfMfqmr6n7ZHEx::0",
  "data": [
    {
      "type": "supply",
      "status": "success",
      "coinChanges": [],
      "timestamp": "1751358720243",
      "digest": "BVpGDpt9nmb1TkTnh65QmqedXt2gYqkVMhhkBE1uraWG"
    },
    {
      "type": "supply",
      "status": "success",
      "coinChanges": [
        {
          "symbol": "xBTC",
          "amount": "-93199"
        }
      ],
      "timestamp": "1751026542701",
      "digest": "GboAWeq8Lt73MUyUrrqsyURqsZRb4XqbBSvP3qHbcbEy"
    }
  ]
}
```
```

--------------------------------

### WebSigner Constructor

Source: https://sdk.naviprotocol.io/typedoc/classes/_naviprotocol_wallet-client.WebSigner

Details on how to create a new instance of the WebSigner.

```APIDOC
## Constructors

### constructor
  * `new WebSigner(address: string): WebSigner`

Creates a new watch-only signer

#### Parameters
    * `address` (string) - The wallet address to watch

#### Returns WebSigner
```

--------------------------------

### Import WalletClient Dependencies

Source: https://sdk.naviprotocol.io/wallet-client/client

Imports necessary classes for WalletClient initialization and keypair management from the NAVI Protocol SDK and Sui libraries.

```typescript
import { WalletClient, WatchSigner, WebSigner } from '@naviprotocol/wallet-client'
import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519"
```

--------------------------------

### Configure Haedal Module with Coin Type

Source: https://sdk.naviprotocol.io/wallet-client/haedal

Example of initializing the WalletClient with a specific coinType for the haSUI token. This is useful if you are using a custom token for haSUI.

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

const walletClient = new WalletClient({
  configs: {
    haedal: {
      coinType: '0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI'
    }
  }
})
```

--------------------------------

### Manage Blockchain Modules

Source: https://sdk.naviprotocol.io/typedoc/classes/_naviprotocol_wallet-client.WalletClient

Provides methods to check for the existence of specific modules and retrieve module instances. Supported modules include 'lending', 'balance', 'volo', 'swap', and 'haedal'.

```typescript
if (walletClient.hasModule("lending")) {
  const lendingModule = walletClient.module("lending");
  // Use lending module
}

const balanceModule = walletClient.module("balance");
// Use balance module

```

--------------------------------

### Get Swap Quote

Source: https://sdk.naviprotocol.io/wallet-client/swap

Fetches a quote for a potential swap operation from the aggregator. It returns estimated amounts and routes for the specified token pair and amount.

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

const walletClient = new WalletClient()
const quote = await walletClient.swap.getQuote(
  '0x2::sui::SUI', // Source token type
  '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN', // Target token type
  1000000000 // Amount to swap
)
console.log('Quote received:', quote)
```

--------------------------------

### Event Listening with NAVI Protocol Wallet Client (TypeScript)

Source: https://sdk.naviprotocol.io/wallet-client

Demonstrates how to subscribe to and handle various events emitted by the NAVI Wallet Client. This includes balance updates, swap success, lending operations, and staking events from Haedal and Volo modules.

```typescript
// Listen for balance updates
walletClient.events.on('balance:portfolio-updated', () => {
  console.log('Portfolio updated')
})

// Listen for swap success
walletClient.events.on('swap:swap-success', (data) => {
  console.log('Swap successful:', data)
})

// Listen for lending operations
walletClient.events.on('lending:deposit-success', (data) => {
  console.log('Deposit successful:', data)
})

// Listen for staking operations
walletClient.events.on('haedal:stake-success', (data) => {
  console.log('Haedal staking successful:', data)
})

walletClient.events.on('volo:stake-success', (data) => {
  console.log('Volo staking successful:', data)
})
```

--------------------------------

### Configure Haedal Module with Package ID

Source: https://sdk.naviprotocol.io/wallet-client/haedal

Example of initializing the WalletClient with a specific packageId for the Haedal module. This is necessary if you are using a custom deployment of the Haedal contract.

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

const walletClient = new WalletClient({
  configs: {
    haedal: {
      packageId: '0x19e6ea7f5ced4f090e20da794cc80349a03e638940ddb95155a4e301f5f4967c'
    }
  }
})
```

--------------------------------

### Event Listening with WalletClient

Source: https://sdk.naviprotocol.io/typedoc/modules/_naviprotocol_wallet-client

Shows how to subscribe to various events emitted by the WalletClient, including portfolio updates, swap success, deposit success, and staking operations for Haedal and Volo modules. This allows for real-time feedback on asynchronous operations.

```typescript
// Listen for balance updates  
walletClient.events.on('balance:portfolio-updated', () => {  
  console.log('Portfolio updated')  
})  
  
// Listen for swap success  
walletClient.events.on('swap:swap-success', (data) => {  
  console.log('Swap successful:', data)  
})  
  
// Listen for lending operations  
walletClient.events.on('lending:deposit-success', (data) => {  
  console.log('Deposit successful:', data)  
})  
  
// Listen for staking operations  
walletClient.events.on('haedal:stake-success', (data) => {  
  console.log('Haedal staking successful:', data)  
})  
  
walletClient.events.on('volo:stake-success', (data) => {  
  console.log('Volo staking successful:', data)  
})
```

--------------------------------

### Get Referral ID

Source: https://sdk.naviprotocol.io/wallet-client/swap

Retrieves the referral ID associated with the configured API key. This feature is available if an API key has been set in the swap module configuration.

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

const walletClient = new WalletClient()
const referralId = walletClient.swap.referral
```

--------------------------------

### Configure Haedal Module with Config ID

Source: https://sdk.naviprotocol.io/wallet-client/haedal

Example of initializing the WalletClient with a specific configId for the Haedal module. This configuration is used for specific operational parameters of the Haedal contract.

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

const walletClient = new WalletClient({
  configs: {
    haedal: {
      configId: '0x47b224762220393057ebf4f70501b6e657c3e56684737568439a04f80849b2ca'
    }
  }
})
```

--------------------------------

### Get Lending Pools

Source: https://sdk.naviprotocol.io/typedoc/variables/_naviprotocol_lending.getPools

This function retrieves the complete list of lending pools from the Navi protocol API. It's wrapped with caching and singleton behavior for efficient data access.

```APIDOC
## GET /pools

### Description
Fetches all available lending pools from the Navi protocol.

### Method
GET

### Endpoint
/pools

### Parameters
#### Query Parameters
- **options** (Partial<EnvOption & CacheOption>) - Optional - Optional environment and caching options.

### Request Example
```json
{
  "options": {
    "env": "mainnet",
    "cache": true
  }
}
```

### Response
#### Success Response (200)
- **Pool[]** - Array of all available lending pools.

#### Response Example
```json
[
  {
    "id": "pool123",
    "name": "USDC Pool",
    "totalDeposits": "1000000.00",
    "availableLiquidity": "500000.00"
  },
  {
    "id": "pool456",
    "name": "SOL Pool",
    "totalDeposits": "50000.00",
    "availableLiquidity": "20000.00"
  }
]
```
```

--------------------------------

### Create Browser Extension Wallet Adapter

Source: https://sdk.naviprotocol.io/wallet-client/client

Defines a WebSignerAdapter for integrating browser extension wallets (like Sui Wallet or Ethos Wallet) with the NAVI Protocol SDK. This adapter handles signing and executing transactions via the extension.

```typescript
// Browser extension wallet adapter
class WebSignerAdapter extends WebSigner {
    constructor(address: string) {
        super(address)
    }

    // Sign and execute transaction
    async signAndExecuteTransaction({ transaction, client }) {
        // Implement interaction logic with browser extension
        // For example: call Sui Wallet, Ethos Wallet, etc.
        return await this.walletExtension.signAndExecuteTransaction(transaction)
    }

    // Sign transaction
    async signTransaction(bytes: Uint8Array) {
        return await this.walletExtension.signTransaction(bytes)
    }

    // Sign personal message
    async signPersonalMessage(bytes: Uint8Array) {
        return await this.walletExtension.signPersonalMessage(bytes)
    }
}

// Create browser wallet client
const walletClient = new WalletClient({
    client: {
        url: 'https://fullnode.mainnet.sui.io'
    },
    signer: new WebSignerAdapter('0x...')
})
```

--------------------------------

### GET /getUserAvailableLendingRewards

Source: https://sdk.naviprotocol.io/lending/reward

Retrieves the user's available lending rewards. This endpoint allows users to check the rewards they are eligible to claim from their lending activities.

```APIDOC
## GET /getUserAvailableLendingRewards

### Description
Get user's available lending rewards. See documentation for details.

### Method
GET

### Endpoint
/getUserAvailableLendingRewards

### Parameters
#### Query Parameters
- **userAddress** (string) - Required - The address of the user to query rewards for.

### Request Example
```json
{
  "userAddress": "0x..."
}
```

### Response
#### Success Response (200)
- **rewards** (array) - A list of available lending rewards for the user.
  - **assetId** (number) - The ID of the asset.
  - **assetCoinType** (string) - The coin type of the asset.
  - **rewardCoinType** (string) - The coin type of the reward.
  - **option** (number) - Reward option identifier.
  - **userClaimableReward** (number) - The amount of reward claimable by the user.
  - **ruleIds** (array of strings) - Identifiers for the reward rules.

#### Response Example
```json
[
  {
    "assetId": 19,
    "assetCoinType": "0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068::usdt::USDT",
    "rewardCoinType": "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT",
    "option": 3,
    "userClaimableReward": 0.005299,
    "ruleIds": ["0x02d80d2d9a2b9fc65baf19c13a0e7d0584fe4bb69487f24b672c3e50de820150"]
  }
]
```
```

--------------------------------

### WebSigner Methods

Source: https://sdk.naviprotocol.io/typedoc/classes/_naviprotocol_wallet-client.WebSigner

Documentation for all available methods within the WebSigner class, including signing and retrieval operations.

```APIDOC
## Methods

### getKeyScheme
  * `getKeyScheme(): any`

Gets the key scheme for this signer

#### Returns any
Key scheme string (ed25519 for compatibility)

### getPublicKey
  * `getPublicKey(): any`

Gets the public key information for this signer
Returns a mock public key object that provides the wallet address but cannot be used for actual cryptographic operations.

#### Returns any
Mock public key object

### sign
  * `sign(bytes: Uint8Array): Promise<any>`

Signs transaction bytes (not implemented for watch-only mode)
This method is required by the Signer interface but cannot actually sign transactions in watch-only mode.

#### Parameters
    * `bytes` (Uint8Array) - Transaction bytes to sign

#### Returns Promise<any>
Promise - Empty signature (not valid)

### signAndExecuteTransaction
  * `signAndExecuteTransaction(
__namedParameters: SignAndExecuteOptions,
): Promise<TransactionResponse>`

#### Parameters
    * `__namedParameters` (SignAndExecuteOptions)

#### Returns Promise<TransactionResponse>

### signPersonalMessage
  * `signPersonalMessage(bytes: Uint8Array): Promise<SignatureWithBytes>`

Signs provided personal message by calling `signWithIntent()` with a `PersonalMessage` provided as intent scope

#### Parameters
    * `bytes` (Uint8Array)

#### Returns Promise<SignatureWithBytes>

### signTransaction
  * `signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes>`

Signs provided transaction by calling `signWithIntent()` with a `TransactionData` provided as intent scope

#### Parameters
    * `bytes` (Uint8Array)

#### Returns Promise<SignatureWithBytes>

### signWithIntent
  * `signWithIntent(
bytes: Uint8Array,
intent: IntentScope,
): Promise<SignatureWithBytes>`

Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, it ensures that a signed message is tied to a specific purpose and domain separator is provided

#### Parameters
    * `bytes` (Uint8Array)
    * `intent` (IntentScope)

#### Returns Promise<SignatureWithBytes>

### toSuiAddress
  * `toSuiAddress(): string`

#### Returns string
```
Tokens:
Raw