@scallop-io/sui-scallop-sdk 1.3.3 → 1.3.4-alpha.2

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

@@ -1,361 +0,0 @@
-import type { SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, CoinWrappedType, SupportSCoin } from '../constant';
-type OptionalKeys<T> = {
-    [K in keyof T]?: T[K];
-};
-export type MarketPools = OptionalKeys<Record<SupportPoolCoins, MarketPool>>;
-export type MarketCollaterals = OptionalKeys<Record<SupportCollateralCoins, MarketCollateral>>;
-export type CoinAmounts = OptionalKeys<Record<SupportPoolCoins, number>>;
-export type MarketCoinAmounts = OptionalKeys<Record<SupportMarketCoins, number>>;
-export type SCoinAmounts = OptionalKeys<Record<SupportSCoin, number>>;
-export type BalanceSheet = {
-    cash: string;
-    debt: string;
-    market_coin_supply: string;
-    revenue: string;
-};
-export type BorrowIndex = {
-    borrow_index: string;
-    interest_rate: {
-        fields: {
-            value: string;
-        };
-    };
-    interest_rate_scale: string;
-    last_updated: string;
-};
-export type InterestModel = {
-    base_borrow_rate_per_sec: {
-        fields: {
-            value: string;
-        };
-    };
-    borrow_rate_on_high_kink: {
-        fields: {
-            value: string;
-        };
-    };
-    borrow_rate_on_mid_kink: {
-        fields: {
-            value: string;
-        };
-    };
-    borrow_weight: {
-        fields: {
-            value: string;
-        };
-    };
-    borrow_fee_rate: {
-        fields: {
-            value: string;
-        };
-    };
-    high_kink: {
-        fields: {
-            value: string;
-        };
-    };
-    interest_rate_scale: string;
-    max_borrow_rate: {
-        fields: {
-            value: string;
-        };
-    };
-    mid_kink: {
-        fields: {
-            value: string;
-        };
-    };
-    min_borrow_amount: string;
-    revenue_factor: {
-        fields: {
-            value: string;
-        };
-    };
-    type: {
-        fields: {
-            name: string;
-        };
-    };
-};
-export type RiskModel = {
-    collateral_factor: {
-        fields: {
-            value: string;
-        };
-    };
-    liquidation_discount: {
-        fields: {
-            value: string;
-        };
-    };
-    liquidation_factor: {
-        fields: {
-            value: string;
-        };
-    };
-    liquidation_penalty: {
-        fields: {
-            value: string;
-        };
-    };
-    liquidation_revenue_factor: {
-        fields: {
-            value: string;
-        };
-    };
-    max_collateral_amount: string;
-    type: {
-        fields: {
-            name: string;
-        };
-    };
-};
-export type CollateralStat = {
-    amount: string;
-};
-export type MarketPool = {
-    coinName: SupportPoolCoins;
-    symbol: string;
-    coinType: string;
-    marketCoinType: string;
-    sCoinType: string;
-    coinWrappedType: CoinWrappedType;
-    coinDecimal: number;
-    coinPrice: number;
-    maxSupplyCoin: number;
-    isIsolated: boolean;
-} & Required<Pick<ParsedMarketPoolData, 'highKink' | 'midKink' | 'reserveFactor' | 'borrowWeight' | 'borrowFee' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
-export type MarketCollateral = {
-    coinName: SupportCollateralCoins;
-    symbol: string;
-    coinType: string;
-    marketCoinType: string;
-    coinWrappedType: CoinWrappedType;
-    coinDecimal: number;
-    coinPrice: number;
-} & Required<Pick<ParsedMarketCollateralData, 'collateralFactor' | 'liquidationFactor' | 'liquidationDiscount' | 'liquidationPanelty' | 'liquidationReserveFactor'>> & CalculatedMarketCollateralData;
-export type OriginMarketPoolData = {
-    type: {
-        name: string;
-    };
-    maxBorrowRate: {
-        value: string;
-    };
-    interestRate: {
-        value: string;
-    };
-    interestRateScale: string;
-    borrowIndex: string;
-    lastUpdated: string;
-    cash: string;
-    debt: string;
-    marketCoinSupply: string;
-    reserve: string;
-    reserveFactor: {
-        value: string;
-    };
-    borrowWeight: {
-        value: string;
-    };
-    borrowFeeRate: {
-        value: string;
-    };
-    baseBorrowRatePerSec: {
-        value: string;
-    };
-    borrowRateOnHighKink: {
-        value: string;
-    };
-    borrowRateOnMidKink: {
-        value: string;
-    };
-    highKink: {
-        value: string;
-    };
-    midKink: {
-        value: string;
-    };
-    minBorrowAmount: string;
-};
-export type ParsedMarketPoolData = {
-    coinType: string;
-    maxBorrowRate: number;
-    borrowRate: number;
-    borrowRateScale: number;
-    borrowIndex: number;
-    lastUpdated: number;
-    cashAmount: number;
-    debtAmount: number;
-    marketCoinSupplyAmount: number;
-    reserveAmount: number;
-    reserveFactor: number;
-    borrowWeight: number;
-    borrowFee: number;
-    baseBorrowRate: number;
-    borrowRateOnHighKink: number;
-    borrowRateOnMidKink: number;
-    highKink: number;
-    midKink: number;
-    minBorrowAmount: number;
-};
-export type CalculatedMarketPoolData = {
-    baseBorrowApr: number;
-    baseBorrowApy: number;
-    borrowAprOnHighKink: number;
-    borrowApyOnHighKink: number;
-    borrowAprOnMidKink: number;
-    borrowApyOnMidKink: number;
-    maxBorrowApr: number;
-    maxBorrowApy: number;
-    borrowApr: number;
-    borrowApy: number;
-    borrowIndex: number;
-    growthInterest: number;
-    supplyAmount: number;
-    supplyCoin: number;
-    borrowAmount: number;
-    borrowCoin: number;
-    reserveAmount: number;
-    reserveCoin: number;
-    utilizationRate: number;
-    supplyApr: number;
-    supplyApy: number;
-    conversionRate: number;
-};
-export type OriginMarketCollateralData = {
-    type: {
-        name: string;
-    };
-    collateralFactor: {
-        value: string;
-    };
-    liquidationFactor: {
-        value: string;
-    };
-    liquidationDiscount: {
-        value: string;
-    };
-    liquidationPanelty: {
-        value: string;
-    };
-    liquidationReserveFactor: {
-        value: string;
-    };
-    maxCollateralAmount: string;
-    totalCollateralAmount: string;
-};
-export type ParsedMarketCollateralData = {
-    coinType: string;
-    collateralFactor: number;
-    liquidationFactor: number;
-    liquidationDiscount: number;
-    liquidationPanelty: number;
-    liquidationReserveFactor: number;
-    maxCollateralAmount: number;
-    totalCollateralAmount: number;
-};
-export type CalculatedMarketCollateralData = {
-    maxDepositAmount: number;
-    maxDepositCoin: number;
-    depositAmount: number;
-    depositCoin: number;
-};
-export type Market = {
-    pools: MarketPools;
-    collaterals: MarketCollaterals;
-    data?: MarketQueryInterface;
-};
-export type Obligation = {
-    id: string;
-    keyId: string;
-    locked: boolean;
-};
-/**
- * The query interface for `market_query::market_data` inspectTxn.
- */
-export interface MarketQueryInterface {
-    collaterals: {
-        collateralFactor: {
-            value: string;
-        };
-        liquidationDiscount: {
-            value: string;
-        };
-        liquidationFactor: {
-            value: string;
-        };
-        liquidationPanelty: {
-            value: string;
-        };
-        liquidationReserveFactor: {
-            value: string;
-        };
-        maxCollateralAmount: string;
-        totalCollateralAmount: string;
-        type: {
-            name: string;
-        };
-    }[];
-    pools: {
-        baseBorrowRatePerSec: {
-            value: string;
-        };
-        borrowRateOnHighKink: {
-            value: string;
-        };
-        borrowRateOnMidKink: {
-            value: string;
-        };
-        maxBorrowRate: {
-            value: string;
-        };
-        highKink: {
-            value: string;
-        };
-        midKink: {
-            value: string;
-        };
-        interestRate: {
-            value: string;
-        };
-        interestRateScale: string;
-        borrowIndex: string;
-        lastUpdated: string;
-        cash: string;
-        debt: string;
-        marketCoinSupply: string;
-        minBorrowAmount: string;
-        reserve: string;
-        reserveFactor: {
-            value: string;
-        };
-        borrowWeight: {
-            value: string;
-        };
-        borrowFeeRate: {
-            value: string;
-        };
-        type: {
-            name: string;
-        };
-    }[];
-}
-/**
- * The query interface for `obligation_query::obligation_data` inspectTxn.
- */
-export interface ObligationQueryInterface {
-    collaterals: {
-        type: {
-            name: string;
-        };
-        amount: string;
-    }[];
-    debts: {
-        type: {
-            name: string;
-        };
-        amount: string;
-        borrowIndex: string;
-    }[];
-}
-export {};

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

@@ -1,7 +0,0 @@
-export type * from './core';
-export type * from './spool';
-export type * from './borrowIncentive';
-export type * from './portfolio';
-export type * from './vesca';
-export type * from './loyaltyProgram';
-export type * from './sCoin';

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

@@ -1,5 +0,0 @@
-export type LoyaltyProgramInfo = {
-    pendingReward: number;
-    totalPoolReward: number;
-    isClaimEnabled: boolean;
-};

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

@@ -1,115 +0,0 @@
-import type { MarketPool } from './core';
-import type { Spool } from './spool';
-import type { SupportPoolCoins, SupportCollateralCoins, SupportBorrowIncentiveRewardCoins } from '../constant';
-type OptionalKeys<T> = {
-    [K in keyof T]?: T[K];
-};
-export type Lendings = OptionalKeys<Record<SupportPoolCoins, Lending>>;
-export type ObligationAccounts = OptionalKeys<Record<string, ObligationAccount>>;
-export type Lending = Required<Pick<MarketPool, 'coinName' | 'symbol' | 'coinType' | 'marketCoinType' | 'sCoinType' | 'coinDecimal' | 'coinPrice' | 'conversionRate' | 'isIsolated'> & Pick<Spool, 'marketCoinPrice'>> & {
-    supplyApr: number;
-    supplyApy: number;
-    rewardApr: number;
-    suppliedAmount: number;
-    suppliedCoin: number;
-    suppliedValue: number;
-    stakedMarketAmount: number;
-    stakedMarketCoin: number;
-    stakedAmount: number;
-    stakedCoin: number;
-    stakedValue: number;
-    unstakedMarketAmount: number;
-    unstakedMarketCoin: number;
-    unstakedAmount: number;
-    unstakedCoin: number;
-    unstakedValue: number;
-    availableSupplyAmount: number;
-    availableSupplyCoin: number;
-    availableWithdrawAmount: number;
-    availableWithdrawCoin: number;
-    availableStakeAmount: number;
-    availableStakeCoin: number;
-    availableUnstakeAmount: number;
-    availableUnstakeCoin: number;
-    availableClaimAmount: number;
-    availableClaimCoin: number;
-};
-export type ObligationAccount = {
-    obligationId: string;
-    totalDepositedValue: number;
-    totalBorrowedValue: number;
-    totalBalanceValue: number;
-    totalBorrowCapacityValue: number;
-    totalAvailableCollateralValue: number;
-    totalBorrowedValueWithWeight: number;
-    totalRequiredCollateralValue: number;
-    totalUnhealthyCollateralValue: number;
-    totalRiskLevel: number;
-    totalDepositedPools: number;
-    totalBorrowedPools: number;
-    totalRewardedPools: number;
-    collaterals: OptionalKeys<Record<SupportCollateralCoins, ObligationCollateral>>;
-    debts: OptionalKeys<Record<SupportPoolCoins, ObligationDebt>>;
-    borrowIncentives: OptionalKeys<Record<SupportPoolCoins, ObligationBorrowIncentive>>;
-};
-export type ObligationCollateral = {
-    coinName: SupportCollateralCoins;
-    coinType: string;
-    symbol: string;
-    coinDecimal: number;
-    coinPrice: number;
-    depositedAmount: number;
-    depositedCoin: number;
-    depositedValue: number;
-    borrowCapacityValue: number;
-    requiredCollateralValue: number;
-    availableDepositAmount: number;
-    availableDepositCoin: number;
-    availableWithdrawAmount: number;
-    availableWithdrawCoin: number;
-};
-export type ObligationDebt = {
-    coinName: SupportPoolCoins;
-    coinType: string;
-    symbol: string;
-    coinDecimal: number;
-    coinPrice: number;
-    borrowedAmount: number;
-    borrowedCoin: number;
-    borrowedValue: number;
-    borrowedValueWithWeight: number;
-    borrowIndex: number;
-    requiredRepayAmount: number;
-    requiredRepayCoin: number;
-    availableBorrowAmount: number;
-    availableBorrowCoin: number;
-    availableRepayAmount: number;
-    availableRepayCoin: number;
-};
-export type ObligationBorrowIcentiveReward = {
-    coinName: SupportBorrowIncentiveRewardCoins;
-    coinType: string;
-    symbol: string;
-    coinDecimal: number;
-    coinPrice: number;
-    availableClaimCoin: number;
-    availableClaimAmount: number;
-    boostValue: number;
-};
-export type ObligationBorrowIncentive = {
-    coinName: SupportPoolCoins;
-    coinType: string;
-    symbol: string;
-    coinDecimal: number;
-    coinPrice: number;
-    rewards: ObligationBorrowIcentiveReward[];
-};
-export type TotalValueLocked = {
-    supplyValue: number;
-    borrowValue: number;
-    totalValue: number;
-    supplyValueChangeRatio?: number;
-    borrowValueChangeRatio?: number;
-    totalValueChangeRatio?: number;
-};
-export {};

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

@@ -1 +0,0 @@
-export type sCoinBalance = number;

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

@@ -1,122 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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;
-}>;

package/dist/utils/builder.d.ts

@@ -1,15 +0,0 @@
-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

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

package/dist/utils/indexer.d.ts

@@ -1,17 +0,0 @@
-/**
- * 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>;