@scallop-io/sui-scallop-sdk 1.3.4-alpha.6 → 1.3.4-isolated-asset.2

package/dist/types/query/spool.d.ts

@@ -0,0 +1,122 @@
+import type { SupportStakeMarketCoins } from '../constant';
+type OptionalKeys<T> = {
+    [K in keyof T]?: T[K];
+};
+export type Spools = OptionalKeys<Record<SupportStakeMarketCoins, Spool>>;
+export type Spool = {
+    marketCoinName: SupportStakeMarketCoins;
+    symbol: string;
+    coinType: string;
+    marketCoinType: string;
+    rewardCoinType: string;
+    sCoinType: string;
+    coinDecimal: number;
+    rewardCoinDecimal: number;
+    coinPrice: number;
+    marketCoinPrice: number;
+    rewardCoinPrice: number;
+} & Required<Pick<ParsedSpoolData, 'maxPoint' | 'distributedPoint' | 'maxStake'>> & CalculatedSpoolData & SpoolRewardPool;
+export type OriginSpoolData = {
+    stakeType: {
+        fields: {
+            name: string;
+        };
+    };
+    maxDistributedPoint: string;
+    distributedPoint: string;
+    distributedPointPerPeriod: string;
+    pointDistributionTime: string;
+    maxStake: string;
+    stakes: string;
+    index: string;
+    createdAt: string;
+    lastUpdate: string;
+};
+export type ParsedSpoolData = {
+    stakeType: string;
+    maxPoint: number;
+    distributedPoint: number;
+    pointPerPeriod: number;
+    period: number;
+    maxStake: number;
+    staked: number;
+    index: number;
+    createdAt: number;
+    lastUpdate: number;
+};
+export type CalculatedSpoolData = {
+    stakedAmount: number;
+    stakedCoin: number;
+    stakedValue: number;
+    distributedPointPerSec: number;
+    accumulatedPoints: number;
+    currentPointIndex: number;
+    currentTotalDistributedPoint: number;
+    startDate: Date;
+    endDate: Date;
+};
+export type SpoolRewardPool = Required<Pick<ParsedSpoolRewardPoolData, 'exchangeRateNumerator' | 'exchangeRateDenominator'>> & CalculatedSpoolRewardPoolData;
+export type OriginSpoolRewardPoolData = {
+    claimed_rewards: string;
+    exchange_rate_denominator: string;
+    exchange_rate_numerator: string;
+    rewards: string;
+    spool_id: string;
+};
+export type ParsedSpoolRewardPoolData = {
+    claimedRewards: number;
+    exchangeRateDenominator: number;
+    exchangeRateNumerator: number;
+    rewards: number;
+    spoolId: string;
+};
+export type CalculatedSpoolRewardPoolData = {
+    rewardApr: number;
+    totalRewardAmount: number;
+    totalRewardCoin: number;
+    totalRewardValue: number;
+    remaindRewardAmount: number;
+    remaindRewardCoin: number;
+    remaindRewardValue: number;
+    claimedRewardAmount: number;
+    claimedRewardCoin: number;
+    claimedRewardValue: number;
+    rewardPerSec: number;
+};
+export type StakePools = OptionalKeys<Record<SupportStakeMarketCoins, StakePool>>;
+export type StakeRewardPools = OptionalKeys<Record<SupportStakeMarketCoins, StakeRewardPool>>;
+export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
+export interface StakeAccount {
+    id: string;
+    type: string;
+    stakePoolId: string;
+    stakeType: string;
+    staked: number;
+    index: number;
+    points: number;
+    totalPoints: number;
+}
+export interface StakePool {
+    id: string;
+    type: string;
+    maxPoint: number;
+    distributedPoint: number;
+    pointPerPeriod: number;
+    period: number;
+    maxStake: number;
+    stakeType: string;
+    totalStaked: number;
+    index: number;
+    createdAt: number;
+    lastUpdate: number;
+}
+export interface StakeRewardPool {
+    id: string;
+    type: string;
+    stakePoolId: string;
+    ratioDenominator: number;
+    ratioNumerator: number;
+    rewards: number;
+    claimedRewards: number;
+}
+export {};

package/dist/types/query/vesca.d.ts

@@ -0,0 +1,26 @@
+import type { SuiObjectRef } from '@mysten/sui/client';
+export type Vesca = {
+    id: string;
+    keyId: string;
+    keyObject?: SuiObjectRef;
+    object: SuiObjectRef;
+    lockedScaAmount: string;
+    lockedScaCoin: number;
+    currentVeScaBalance: number;
+    unlockAt: number;
+};
+export type VeScaTreasuryFields = {
+    total_ve_sca_amount: string;
+    sca_balance: string;
+    unlock_schedule: {
+        fields: {
+            locked_sca_amount: string;
+        };
+    };
+};
+export type VeScaTreasuryInfo = {
+    totalLockedSca: number;
+    totalVeSca: number;
+    averageLockingPeriod: number;
+    averageLockingPeriodUnit: string;
+};

package/dist/types/utils.d.ts

@@ -0,0 +1,21 @@
+import type { SupportAssetCoins } from './constant';
+export type OptionalKeys<T> = {
+    [K in keyof T]?: T[K];
+};
+export type CoinPrices = OptionalKeys<Record<SupportAssetCoins, number>>;
+export type PriceMap = Map<SupportAssetCoins, {
+    price: number;
+    publishTime: number;
+}>;
+export type PoolAddressInfo = {
+    name: string;
+    coingeckoId: string;
+    decimal: number;
+    pythFeedId: string;
+    lendingPoolAddress: string;
+    collateralPoolAddress?: string;
+    sCoinAddress: string | undefined;
+    marketCoinAddress: string;
+    coinAddress: string;
+    sCoinName: string | undefined;
+};

package/dist/utils/builder.d.ts

@@ -0,0 +1,15 @@
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
+/**
+ * Check and get the sender from the transaction block.
+ *
+ * @param txBlock - TxBlock created by SuiKit.
+ * @return Sender of transaction.
+ */
+export declare const requireSender: (txBlock: SuiKitTxBlock) => string;
+export declare const checkVesca: (prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkVescaExpired: (prevUnlockAtInMillisTimestamp: number) => void;
+export declare const checkExtendLockPeriod: (lockPeriodInDays: number, newUnlockAtInSecondTimestamp: number, prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkLockSca: (scaAmountOrCoin: number | SuiObjectArg | undefined, lockPeriodInDays?: number, newUnlockAtInSecondTimestamp?: number, prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkExtendLockAmount: (scaAmount: number, prevUnlockAtInMillisTimestamp?: number) => void;
+export declare const checkRenewExpiredVeSca: (scaAmount: number, lockPeriodInDays: number, prevUnlockAtInMillisTimestamp?: number) => void;

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './builder';
+export * from './query';
+export * from './util';
+export * from './tokenBucket';
+export * from './indexer';

package/dist/utils/indexer.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generic wrapper for methods with indexer fallback.
+ *
+ * @param method - The method to call with fallback behavior.
+ * @param context - The context (`this`) of the class instance.
+ * @param args - The arguments to pass to the method.
+ * @returns The result of the method call.
+ */
+export declare function callMethodWithIndexerFallback(method: Function, context: any, ...args: any[]): Promise<any>;
+/**
+ * This function creates a wrapper for methods that have an indexer parameter.
+ * It ensures fallback behavior if indexer fails.
+ *
+ * @param method - The method to wrap.
+ * @returns A function that applies indexer fallback.
+ */
+export declare function withIndexerFallback(method: Function): (...args: any[]) => Promise<any>;

package/dist/utils/query.d.ts

@@ -0,0 +1,62 @@
+import BigNumber from 'bignumber.js';
+import type { ScallopUtils } from '../models';
+import type { OriginMarketPoolData, ParsedMarketPoolData, CalculatedMarketPoolData, OriginMarketCollateralData, ParsedMarketCollateralData, CalculatedMarketCollateralData, OriginSpoolData, ParsedSpoolData, CalculatedSpoolData, OriginSpoolRewardPoolData, ParsedSpoolRewardPoolData, CalculatedSpoolRewardPoolData, OriginBorrowIncentivePoolData, ParsedBorrowIncentivePoolData, OriginBorrowIncentiveAccountData, ParsedBorrowIncentiveAccountData, OriginBorrowIncentivePoolPointData, ParsedBorrowIncentivePoolPointData, CalculatedBorrowIncentivePoolPointData, OriginBorrowIncentiveAccountPoolData, ParsedBorrowIncentiveAccountPoolData } from '../types';
+/**
+ *  Parse origin market pool data to a more readable format.
+ *
+ * @param originMarketPoolData - Origin market pool data
+ * @return Parsed market pool data
+ */
+export declare const parseOriginMarketPoolData: (originMarketPoolData: OriginMarketPoolData) => ParsedMarketPoolData;
+export declare const calculateMarketPoolData: (utils: ScallopUtils, parsedMarketPoolData: ParsedMarketPoolData) => CalculatedMarketPoolData;
+/**
+ *  Parse origin market collateral data to a more readable format.
+ *
+ * @param originMarketCollateralData - Origin market collateral data
+ * @return Parsed market collateral data
+ */
+export declare const parseOriginMarketCollateralData: (originMarketCollateralData: OriginMarketCollateralData) => ParsedMarketCollateralData;
+export declare const calculateMarketCollateralData: (utils: ScallopUtils, parsedMarketCollateralData: ParsedMarketCollateralData) => CalculatedMarketCollateralData;
+/**
+ *  Parse origin spool data to a more readable format.
+ *
+ * @param originSpoolData - Origin spool data
+ * @return Parsed spool data
+ */
+export declare const parseOriginSpoolData: (originSpoolData: OriginSpoolData) => ParsedSpoolData;
+export declare const calculateSpoolData: (parsedSpoolData: ParsedSpoolData, stakeMarketCoinPrice: number, stakeMarketCoinDecimal: number) => CalculatedSpoolData;
+/**
+ *  Parse origin spool reward pool data to a more readable format.
+ *
+ * @param originRewardPoolData - Origin reward pool data
+ * @return Parsed spool reward pool data
+ */
+export declare const parseOriginSpoolRewardPoolData: (originSpoolRewardPoolData: OriginSpoolRewardPoolData) => ParsedSpoolRewardPoolData;
+export declare const calculateSpoolRewardPoolData: (parsedSpoolData: ParsedSpoolData, parsedSpoolRewardPoolData: ParsedSpoolRewardPoolData, calculatedSpoolData: CalculatedSpoolData, rewardCoinPrice: number, rewardCoinDecimal: number) => CalculatedSpoolRewardPoolData;
+export declare const parseOriginBorrowIncentivesPoolPointData: (originBorrowIncentivePoolPointData: OriginBorrowIncentivePoolPointData) => ParsedBorrowIncentivePoolPointData;
+/**
+ *  Parse origin borrow incentive pool data to a more readable format.
+ *
+ * @param originBorrowIncentivePoolData - Origin borrow incentive pool data
+ * @return Parsed borrow incentive pool data
+ */
+export declare const parseOriginBorrowIncentivePoolData: (originBorrowIncentivePoolData: OriginBorrowIncentivePoolData) => ParsedBorrowIncentivePoolData;
+export declare const calculateBorrowIncentivePoolPointData: (parsedBorrowIncentivePoolPointData: ParsedBorrowIncentivePoolPointData, rewardCoinPrice: number, rewardCoinDecimal: number, poolCoinPrice: number, poolCoinDecimal: number) => CalculatedBorrowIncentivePoolPointData;
+export declare const parseOriginBorrowIncentiveAccountPoolPointData: (originBorrowIncentiveAccountPoolPointData: OriginBorrowIncentiveAccountPoolData) => ParsedBorrowIncentiveAccountPoolData;
+/**
+ *  Parse origin borrow incentive account data to a more readable format.
+ *
+ * @param originBorrowIncentiveAccountData - Origin borrow incentive account data
+ * @return Parsed borrow incentive account data
+ */
+export declare const parseOriginBorrowIncentiveAccountData: (originBorrowIncentiveAccountData: OriginBorrowIncentiveAccountData) => ParsedBorrowIncentiveAccountData;
+export declare const minBigNumber: (...args: BigNumber.Value[]) => BigNumber;
+export declare const maxBigNumber: (...args: BigNumber.Value[]) => BigNumber;
+/**
+ * Dynamically adjust the decrease or increase ratio according to the amount
+ * @param amount - The amount required to calculate factor.
+ * @param scaleStep - The scale step required to determine the factor..
+ * @param type - The type of the calculation.
+ * @return The estimated factor
+ * */
+export declare const estimatedFactor: (amount: number, scaleStep: number, type: "increase" | "decrease") => number;

package/dist/utils/tokenBucket.d.ts

@@ -0,0 +1,11 @@
+declare class TokenBucket {
+    private tokensPerInterval;
+    private interval;
+    private tokens;
+    private lastRefill;
+    constructor(tokensPerInterval: number, intervalInMs: number);
+    refill(): void;
+    removeTokens(count: number): boolean;
+}
+declare const callWithRateLimit: <T>(tokenBucket: TokenBucket, fn: () => Promise<T>, retryDelayInMs?: number, maxRetries?: number, backoffFactor?: number) => Promise<T | null>;
+export { TokenBucket, callWithRateLimit };

package/dist/utils/util.d.ts

@@ -0,0 +1,26 @@
+import type { PriceFeed } from '@pythnetwork/pyth-sui-js';
+import type { ScallopAddress } from '../models';
+import type { SupportAssetCoins, SupportCoins, SupportMarketCoins, SupportSCoin, SupportSuiBridgeCoins, SupportWormholeCoins } from '../types';
+export declare const isMarketCoin: (coinName: SupportCoins) => coinName is SupportMarketCoins | SupportSCoin;
+export declare const isSuiBridgeAsset: (coinName: any) => coinName is SupportSuiBridgeCoins;
+export declare const isWormholeAsset: (coinName: any) => coinName is SupportWormholeCoins;
+export declare const parseAssetSymbol: (coinName: SupportCoins) => string;
+/**
+ * Parse price from pyth price feed.
+ *
+ * @param feed  - Price feed object from pyth.
+ * @param address - Scallop address instance.
+ * @return Price Data inclue coin name, price, and publish time.
+ */
+export declare const parseDataFromPythPriceFeed: (feed: PriceFeed, address: ScallopAddress) => {
+    coinName: SupportAssetCoins;
+    price: number;
+    publishTime: number;
+};
+/**
+ * Find the closest unlock round timestamp (12AM) to the given unlock at timestamp in seconds.
+ *
+ * @param unlockAtInSecondTimestamp - Unlock at in seconds timestamp to find the closest round.
+ * @returns Closest round (12AM) in seconds timestamp.
+ */
+export declare const findClosestUnlockRound: (unlockAtInSecondTimestamp: number) => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "1.3.4-alpha.6",
+  "version": "1.3.4-isolated-asset.2",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -149,7 +149,7 @@
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
     "build": "pnpm run build:types && pnpm run build:tsup",
-    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap --clean",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
     "build:types": "tsc --build",
     "watch:tsup": "tsup ./src/index.ts --format esm,cjs --clean --splitting --watch",
     "watch:types": "tsc --watch",

package/src/constants/coinGecko.ts

@@ -1,11 +1,11 @@
 import { SupportPoolCoins } from 'src/types/constant/common';
 
 export const COIN_GECKGO_IDS: Record<SupportPoolCoins, string> = {
-  usdc: 'usdc-coin',
+  usdc: 'usdc',
   sbeth: 'ethereum',
   weth: 'ethereum',
   wbtc: 'bitcoin',
-  wusdc: 'usdc-coin',
+  wusdc: 'usdc',
   wusdt: 'tether',
   sui: 'sui',
   wapt: 'aptos',
@@ -15,4 +15,6 @@ export const COIN_GECKGO_IDS: Record<SupportPoolCoins, string> = {
   hasui: 'sui',
   vsui: 'sui',
   sca: 'scallop-2',
+  deep: 'deepbook',
+  fud: 'fud-the-pug',
 };

package/src/constants/common.ts

@@ -44,6 +44,8 @@ export const SUPPORT_POOLS = [
   'hasui',
   'vsui',
   'sca',
+  'fud',
+  'deep',
 ] as const;
 
 export const SUPPORT_COLLATERALS = [

package/src/constants/enum.ts

@@ -16,6 +16,8 @@ export const coinDecimals: types.SupportCoinDecimals = {
   hasui: 9,
   vsui: 9,
   sca: 9,
+  deep: 6,
+  fud: 5,
   susdc: 6,
   sweth: 8,
   ssbeth: 8,
@@ -30,6 +32,8 @@ export const coinDecimals: types.SupportCoinDecimals = {
   shasui: 9,
   svsui: 9,
   ssca: 9,
+  sdeep: 6,
+  sfud: 5,
 };
 
 export const assetCoins: types.AssetCoins = {
@@ -47,6 +51,8 @@ export const assetCoins: types.AssetCoins = {
   hasui: 'hasui',
   vsui: 'vsui',
   sca: 'sca',
+  deep: 'deep',
+  fud: 'fud',
 };
 
 export const marketCoins: types.MarketCoins = {
@@ -64,6 +70,8 @@ export const marketCoins: types.MarketCoins = {
   shasui: 'shasui',
   svsui: 'svsui',
   ssca: 'ssca',
+  sdeep: 'sdeep',
+  sfud: 'sfud',
 };
 
 export const sCoins: types.SCoins = {
@@ -140,6 +148,9 @@ export const coinIds: types.AssetCoinIds = {
   sca: IS_VE_SCA_TEST
     ? '0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524'
     : '0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6',
+  // isolated assets
+  deep: '0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP',
+  fud: '0x76cb819b01abed502bee8a702b4c2d547532c12f25001c9dea795a5e631c26f1::fud::FUD',
 };
 
 export const wormholeCoinIds: types.WormholeCoinIds = {
@@ -161,14 +172,24 @@ export const sCoinIds: types.SCoinIds = {
     '0x854950aa624b1df59fe64e630b2ba7c550642e9342267a33061d59fb31582da5::scallop_usdc::SCALLOP_USDC',
   ssbeth:
     '0xb14f82d8506d139eacef109688d1b71e7236bcce9b2c0ad526abcd6aa5be7de0::scallop_sb_eth::SCALLOP_SB_ETH',
-  ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
+  ssui:
+    // TODO: use prod value
+    // '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
+    '0xf569919046f19a0c40b519ecfbb6ca0319698cd5908716c29b62ef56541f298b::scallop_sui::SCALLOP_SUI',
   scetus:
     '0xea346ce428f91ab007210443efcea5f5cdbbb3aae7e9affc0ca93f9203c31f0c::scallop_cetus::SCALLOP_CETUS',
-  ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
+  ssca:
+    // TODO: use prod value
+    // '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
+    '0x958428555e778e55918a59eb1c92c77f32b5c554fa3a5e56cd0815086b5072e7::scallop_sca::SCALLOP_SCA',
   swusdc:
-    '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
+    // TODO: use prod value
+    // '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
+    '0xf5447c4305a486d8c8557559887c2c39449ddb5e748f15d33946d02a1663c158::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
   swusdt:
-    '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
+    // TODO: use prod value
+    // '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
+    '0xac781d9f73058ff5e69f9bf8dde32f2e8c71c66d7fe8497fc83b2d9182254b22::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
   sweth:
     '0x67540ceb850d418679e69f1fb6b2093d6df78a2a699ffc733f7646096d552e9b::scallop_wormhole_eth::SCALLOP_WORMHOLE_ETH',
   safsui:

package/src/constants/index.ts

@@ -10,3 +10,4 @@ export * from './rpc';
 export * from './testAddress';
 export * from './tokenBucket';
 export * from './vesca';
+export * from './testAddress';

package/src/constants/poolAddress.ts

@@ -4,7 +4,7 @@ export const POOL_ADDRESSES: Record<
   SupportPoolCoins,
   {
     lendingPoolAddress: string;
-    collateralPoolAddress: string;
+    collateralPoolAddress?: string;
   }
 > = {
   usdc: {
@@ -91,4 +91,10 @@ export const POOL_ADDRESSES: Record<
     collateralPoolAddress:
       '0xff677a5d9e9dc8f08f0a8681ebfc7481d1c7d57bc441f2881974adcdd7b13c31',
   },
+  fud: {
+    lendingPoolAddress: '',
+  },
+  deep: {
+    lendingPoolAddress: '',
+  },
 };

package/src/constants/pyth.ts

@@ -22,4 +22,6 @@ export const PYTH_FEED_IDS: Record<SupportPoolCoins, string> = {
   hasui: '23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744',
   vsui: '23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744',
   sca: '7e17f0ac105abe9214deb9944c30264f5986bf292869c6bd8e8da3ccd92d79bc',
+  deep: '29bdd5248234e33bd93d3b81100b5fa32eaa5997843847e2c2cb16d7c6d9f7ff',
+  fud: '6a4090703da959247727f2b490eb21aea95c8684ecfac675f432008830890c75',
 };