Reward System

The reward module provides comprehensive lending reward functionality, including reward queries, claiming, and management for users who participate in lending activities.

API Reference

getUserAvailableLendingRewards

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

Usage Example

import { getUserAvailableLendingRewards } from '@naviprotocol/lending'

const rewards = await getUserAvailableLendingRewards('0x...')

Result Example

[
  {
    "assetId": 19,
    "assetCoinType": "0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068::usdt::USDT",
    "rewardCoinType": "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT",
    "option": 3,
    "userClaimableReward": 0.005299,
    "ruleIds": ["0x02d80d2d9a2b9fc65baf19c13a0e7d0584fe4bb69487f24b672c3e50de820150"],
    "market": "main",
    "owner": "0x...",
    "emodeId": 1
  },
  {
    "assetId": 5,
    "assetCoinType": "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT",
    "rewardCoinType": "0xa99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX",
    "option": 1,
    "userClaimableReward": 0.345351397,
    "ruleIds": ["0x3f2610eb38a4ff44b9e6e6ba292c9ddcc3b5a75e4a99169f4fc3bdbcd0d69676"],
    "market": "main",
    "owner": "0x..."
  }
]

Return Fields

assetId: Asset identifier
assetCoinType: Asset coin type
rewardCoinType: Reward coin type
option: Reward option identifier
userClaimableReward: Amount of reward available to claim
ruleIds: Array of rule IDs for this reward
market: Market identifier (e.g., "main")
owner: Owner address (user address or account cap)
emodeId: Optional EMode ID if the reward is from an EMode position

summaryLendingRewards

Summarize lending rewards by asset and reward type. See documentation for details.

Usage Example

import { summaryLendingRewards } from '@naviprotocol/lending'

const rewards = await getUserAvailableLendingRewards('0x...')
const summary = summaryLendingRewards(rewards)

Result Example

[
  {
    "assetId": 19,
    "rewardType": 1,
    "market": "main",
    "rewards": [
      {
        "coinType": "0x2::sui::SUI",
        "available": "0.123456"
      }
    ]
  }
]

Return Fields

assetId: Asset identifier
rewardType: Type of reward
market: Market identifier (e.g., "main")
rewards: Array of available rewards by coin type

getUserTotalClaimedReward

Get user's total claimed rewards in USD value. See documentation for details.

Usage Example

import { getUserTotalClaimedReward } from '@naviprotocol/lending'

// Get total claimed rewards
const totalRewards = await getUserTotalClaimedReward('0x...')

// Get total claimed rewards for specific market
const marketRewards = await getUserTotalClaimedReward('0x...', {
  market: 'main' // Optional: market identifier
})

Result Example

{
  "USDValue": 123.45
}

getUserClaimedRewardHistory

Get user's claimed reward history. See documentation for details.

Usage Example

import { getUserClaimedRewardHistory } from '@naviprotocol/lending'

// Get reward history
const history = await getUserClaimedRewardHistory('0x...', {
  page: 1,
  size: 20
})

// Get reward history for specific market
const marketHistory = await getUserClaimedRewardHistory('0x...', {
  page: 1,
  size: 20,
  market: 'main' // Optional: market identifier
})

Result Example

{
  "data": [
    {
      "type": "claim",
      "status": "success",
      "coinChanges": [
        {
          "symbol": "SUI",
          "amount": "1000000"
        }
      ],
      "timestamp": "1751358720243",
      "digest": "BVpGDpt9nmb1TkTnh65QmqedXt2gYqkVMhhkBE1uraWG"
    }
  ],
  "cursor": "next_page_cursor"
}

Claim lending rewards in a programmable transaction block. This function automatically handles both standard rewards and EMode rewards. For EMode rewards, it will automatically use the account cap from the EMode Cap. See documentation for details.

Usage Example

import { claimLendingRewardsPTB } from '@naviprotocol/lending'
import { Transaction } from '@mysten/sui/transactions'

const tx = new Transaction()
const rewards = await getUserAvailableLendingRewards(
  '0xc41d2d2b2988e00f9b64e7c41a5e70ef58a3ef835703eeb6bf1bd17a9497d9fe'
)

// Standard claiming (automatically handles both standard and EMode rewards)
const rewardCoins = await claimLendingRewardsPTB(tx, rewards)

// Claiming with account cap and custom coin handling (transfer reward to another address)
await claimLendingRewardsPTB(tx, rewards, {
  accountCap: '0x...',
  customCoinReceive: {
    type: 'transfer',
    transfer: '0xrecipient_address'
  }
})

// Claiming and depositing to NAVI
await claimLendingRewardsPTB(tx, rewards, {
  accountCap: '0x...',
  customCoinReceive: {
    type: 'depositNAVI'
  }
})

// Claiming with market option
await claimLendingRewardsPTB(tx, rewards, {
  market: 'main' // Optional: market identifier
})

Note on EMode Rewards

When claiming rewards that include EMode positions (rewards with emodeId field), the function will automatically use the account cap from the corresponding EMode Cap. You don't need to manually specify the account cap for EMode rewards - the SDK will handle it automatically based on the isEMode flag in the reward data.

Reward System

API Reference

getUserAvailableLendingRewards

summaryLendingRewards

getUserTotalClaimedReward

getUserClaimedRewardHistory

claimLendingRewardsPTB

On this page