@scallop-io/sui-scallop-sdk 1.5.0-alpha.1 → 1.5.0

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

@@ -1,37 +0,0 @@
-import { SuiObjectArg, SuiTxBlock as SuiKitTxBlock, TransactionResult } from '@scallop-io/sui-kit';
-import { SupportSCoin } from '../constant';
-import { ScallopBuilder } from 'src/models';
-import { BaseScallopTxBlock } from '.';
-export type sCoinPkgIds = {
-    pkgId: string;
-};
-export type sCoinNormalMethods = {
-    /**
-     * Lock marketCoin and return sCoin
-     * @param marketCoinName
-     * @param marketCoin
-     * @returns
-     */
-    mintSCoin: (marketCoinName: SupportSCoin, marketCoin: SuiObjectArg) => TransactionResult;
-    /**
-     * Burn sCoin and return marketCoin
-     * @param sCoinName
-     * @param sCoin
-     * @returns
-     */
-    burnSCoin: (sCoinName: SupportSCoin, sCoin: SuiObjectArg) => TransactionResult;
-};
-export type sCoinQuickMethods = {
-    mintSCoinQuick: (marketCoinName: SupportSCoin, amount: number) => Promise<TransactionResult>;
-    burnSCoinQuick: (sCoinName: SupportSCoin, amount: number) => Promise<TransactionResult>;
-};
-export type SuiTxBlockWithSCoinNormalMethods = SuiKitTxBlock & BaseScallopTxBlock & sCoinNormalMethods;
-export type SCoinTxBlock = SuiTxBlockWithSCoinNormalMethods & sCoinQuickMethods;
-export type GenerateSCoinNormalMethod = (params: {
-    builder: ScallopBuilder;
-    txBlock: SuiKitTxBlock;
-}) => sCoinNormalMethods;
-export type GenerateSCoinQuickMethod = (params: {
-    builder: ScallopBuilder;
-    txBlock: SuiTxBlockWithSCoinNormalMethods;
-}) => sCoinQuickMethods;

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

@@ -1,29 +0,0 @@
-import type { SuiTxBlock as SuiKitTxBlock, SuiAddressArg, SuiObjectArg } from '@scallop-io/sui-kit';
-import type { TransactionResult } from '@mysten/sui/transactions';
-import type { ScallopBuilder } from '../../models';
-import type { SupportStakeMarketCoins } from '../constant';
-import { SuiTxBlockWithSCoin } from '.';
-export type SpoolIds = {
-    spoolPkg: string;
-};
-export type SpoolNormalMethods = {
-    createStakeAccount: (stakeMarketCoinName: SupportStakeMarketCoins) => TransactionResult;
-    stake: (stakeAccount: SuiAddressArg, coin: SuiObjectArg, stakeMarketCoinName: SupportStakeMarketCoins) => void;
-    unstake: (stakeAccount: SuiAddressArg, amount: number, stakeMarketCoinName: SupportStakeMarketCoins) => TransactionResult;
-    claim: (stakeAccount: SuiAddressArg, stakeMarketCoinName: SupportStakeMarketCoins) => TransactionResult;
-};
-export type SpoolQuickMethods = {
-    stakeQuick(amountOrMarketCoin: SuiObjectArg | number, stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg): Promise<void>;
-    unstakeQuick(amount: number, stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg, returnSCoin?: boolean): Promise<TransactionResult | undefined>;
-    claimQuick(stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg): Promise<TransactionResult[]>;
-};
-export type SuiTxBlockWithSpoolNormalMethods = SuiKitTxBlock & SuiTxBlockWithSCoin & SpoolNormalMethods;
-export type SpoolTxBlock = SuiTxBlockWithSpoolNormalMethods & SpoolQuickMethods;
-export type GenerateSpoolNormalMethod = (params: {
-    builder: ScallopBuilder;
-    txBlock: SuiKitTxBlock;
-}) => SpoolNormalMethods;
-export type GenerateSpoolQuickMethod = (params: {
-    builder: ScallopBuilder;
-    txBlock: SuiTxBlockWithSpoolNormalMethods;
-}) => SpoolQuickMethods;

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

@@ -1,51 +0,0 @@
-import { SuiTxBlock as SuiKitTxBlock, SuiObjectArg } from '@scallop-io/sui-kit';
-import type { TransactionResult } from '@mysten/sui/transactions';
-import { ScallopBuilder } from 'src/models';
-export type VescaIds = {
-    pkgId: string;
-    table: string;
-    treasury: string;
-    config: string;
-};
-export type VeScaNormalMethods = {
-    lockSca: (scaCoin: SuiObjectArg, unlockAtInSecondTimestamp: number) => TransactionResult;
-    extendLockPeriod: (veScaKey: SuiObjectArg, newUnlockAtInSecondTimestamp: number) => void;
-    extendLockAmount: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg) => void;
-    renewExpiredVeSca: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg, newUnlockAtInSecondTimestamp: number) => void;
-    redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
-    mintEmptyVeSca: () => TransactionResult;
-};
-export type RedeemScaQuickReturnType<T extends boolean> = T extends true ? void : TransactionResult | undefined;
-export type VeScaQuickMethods = {
-    /**
-     * Quick methods to automate
-     * lock initial SCA, extend lock period, lock more SCA, renew expired VeSCA, and redeem SCA
-     *
-     * **Flow:**
-     * - If only `amountOrCoin` is provided, it will lock the amount of existing not expired veSCA
-     * - If only `lockPeriodInDays` is provided, it will extend the lock period of existing not expired veSCA
-     *
-     * **Note:**
-     * - If one or both flow above is used on a expired veSCA, it will claim the unlocked SCA
-     *   and renew the veSCA first, and then flow continues
-     * - If users has no veSCA yet, they need to provide both `amountOrCoin` and `lockPeriodInDays` for initial lock
-     * @param amountOrCoin
-     * @param lockPeriodInDays
-     * @param autoCheck
-     */
-    lockScaQuick(amountOrCoin?: SuiObjectArg | number, lockPeriodInDays?: number, autoCheck?: boolean): Promise<void>;
-    extendLockPeriodQuick: (lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
-    extendLockAmountQuick: (scaAmount: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
-    renewExpiredVeScaQuick: (scaAmount: number, lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
-    redeemScaQuick: <T extends boolean>(veSCaKey?: SuiObjectArg, transferSca?: T) => Promise<RedeemScaQuickReturnType<T>>;
-};
-export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock & VeScaNormalMethods;
-export type VeScaTxBlock = SuiTxBlockWithVeScaNormalMethods & VeScaQuickMethods;
-export type GenerateVeScaNormalMethod = (params: {
-    builder: ScallopBuilder;
-    txBlock: SuiKitTxBlock;
-}) => VeScaNormalMethods;
-export type GenerateVeScaQuickMethod = (params: {
-    builder: ScallopBuilder;
-    txBlock: SuiTxBlockWithVeScaNormalMethods;
-}) => VeScaQuickMethods;

package/dist/types/constant/common.d.ts

@@ -1,24 +0,0 @@
-import { SUPPORT_POOLS, SUPPORT_COLLATERALS, SUPPORT_ORACLES, SUPPORT_PACKAGES, SUPPORT_SPOOLS, SUPPORT_SPOOLS_REWARDS, SUPPORT_BORROW_INCENTIVE_POOLS, SUPPORT_BORROW_INCENTIVE_REWARDS, SUPPORT_SCOIN, SUPPORT_SUI_BRIDGE, SUPPORT_WORMHOLE } from '../../constants';
-type ParseMarketCoins<T extends string> = `s${T}`;
-type ParseCoins<T extends string> = T extends `s${infer R}` ? R : never;
-export type SupportCoins = SupportAssetCoins | SupportMarketCoins | SupportStakeMarketCoins | SupportSCoin;
-export type SupportAssetCoins = SupportPoolCoins | SupportCollateralCoins | SupportStakeRewardCoins;
-export type SupportPoolCoins = (typeof SUPPORT_POOLS)[number];
-export type SupportCollateralCoins = (typeof SUPPORT_COLLATERALS)[number];
-export type SupportMarketCoins = ParseMarketCoins<SupportPoolCoins> | SupportStakeMarketCoins;
-export type SupportStakeMarketCoins = (typeof SUPPORT_SPOOLS)[number];
-export type SupportSuiBridgeCoins = (typeof SUPPORT_SUI_BRIDGE)[number];
-export type SupportWormholeCoins = (typeof SUPPORT_WORMHOLE)[number];
-export type SupportStakeCoins = Extract<SupportPoolCoins, ParseCoins<SupportStakeMarketCoins>>;
-export type SupportStakeRewardCoins = (typeof SUPPORT_SPOOLS_REWARDS)[number];
-export type SupportBorrowIncentiveCoins = (typeof SUPPORT_BORROW_INCENTIVE_POOLS)[number];
-export type SupportBorrowIncentiveRewardCoins = (typeof SUPPORT_BORROW_INCENTIVE_REWARDS)[number];
-export type SupportSCoin = (typeof SUPPORT_SCOIN)[number];
-export type SupportOracleType = (typeof SUPPORT_ORACLES)[number];
-export type SupportPackageType = (typeof SUPPORT_PACKAGES)[number];
-export type SupportCoinDecimals = Record<SupportCoins, number>;
-export type CoinWrappedType = {
-    from: string;
-    type: string;
-} | undefined;
-export {};

package/dist/types/constant/enum.d.ts

@@ -1,48 +0,0 @@
-import { SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportStakeRewardCoins, SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins, SupportSCoin, SupportSuiBridgeCoins } from './common';
-export type Coins = {
-    [K in SupportCoins]: K;
-};
-export type AssetCoins = {
-    [K in SupportAssetCoins]: K;
-};
-export type MarketCoins = {
-    [K in SupportMarketCoins]: K;
-};
-export type SCoins = {
-    [K in SupportSCoin]: K;
-};
-export type StakeMarketCoins = {
-    [K in SupportStakeMarketCoins]: K;
-};
-export type StakeRewardCoins = {
-    [key in SupportStakeMarketCoins]: SupportStakeRewardCoins;
-};
-export type SuiBridgeCoins = {
-    [K in SupportSuiBridgeCoins]: K;
-};
-export type BorrowIncentiveRewardCoins = {
-    [key in SupportBorrowIncentiveCoins]: SupportBorrowIncentiveRewardCoins[];
-};
-export type AssetCoinIds = {
-    [key in SupportAssetCoins]: string;
-};
-export type SCoinIds = {
-    [key in SupportSCoin]: string;
-};
-export type SCoinTreasuryCaps = {
-    [key in SupportSCoin]: string;
-};
-export type SCoinConverterTreasury = {
-    [key in SupportSCoin]: string;
-};
-type PickFromUnion<T, K extends string> = K extends T ? K : never;
-export type WormholeCoinIds = {
-    [key in PickFromUnion<SupportAssetCoins, 'weth' | 'wbtc' | 'wusdc' | 'wusdt' | 'wapt' | 'wsol'>]: string;
-};
-export type VoloCoinIds = {
-    [key in PickFromUnion<SupportAssetCoins, 'vsui'>]: string;
-};
-export type SuiBridgedCoinPackageIds = {
-    [key in SupportSuiBridgeCoins]: string;
-};
-export {};

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

@@ -1,3 +0,0 @@
-export type * from './common';
-export type * from './enum';
-export type * from './xOracle';

package/dist/types/constant/xOracle.d.ts

@@ -1,9 +0,0 @@
-import { SupportAssetCoins, SupportOracleType } from './common';
-export type xOracleRules = {
-    primary: SupportOracleType[];
-    secondary: SupportOracleType[];
-};
-export type xOracleRuleType = keyof xOracleRules;
-export type xOracleListType = {
-    [key in SupportAssetCoins]: xOracleRules;
-};

package/dist/types/index.d.ts

@@ -1,6 +0,0 @@
-export type * from './builder';
-export type * from './constant';
-export type * from './query';
-export type * from './address';
-export type * from './model';
-export type * from './utils';

package/dist/types/model.d.ts

@@ -1,60 +0,0 @@
-import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
-import type { Transaction, TransactionResult } from '@mysten/sui/transactions';
-import type { SuiKit, SuiKitParams, NetworkType } from '@scallop-io/sui-kit';
-import type { ScallopAddress, ScallopQuery, ScallopUtils, ScallopBuilder, ScallopIndexer } from '../models';
-import { ScallopCache } from 'src/models/scallopCache';
-import { AddressesInterface } from './address';
-import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
-export type ScallopClientFnReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : Transaction;
-export type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : {
-    tx: Transaction;
-    scaCoin: TransactionResult;
-};
-export type ScallopBaseInstanceParams = {
-    suiKit?: SuiKit;
-};
-export type ScallopCacheInstanceParams = ScallopBaseInstanceParams & {
-    queryClient?: QueryClient;
-};
-export type ScallopAddressInstanceParams = ScallopBaseInstanceParams & {
-    cache?: ScallopCache;
-};
-export type ScallopIndexerInstanceParams = {
-    cache?: ScallopCache;
-};
-export type ScallopUtilsInstanceParams = ScallopBaseInstanceParams & {
-    address?: ScallopAddress;
-};
-export type ScallopQueryInstanceParams = ScallopBaseInstanceParams & {
-    utils?: ScallopUtils;
-    indexer?: ScallopIndexer;
-};
-export type ScallopBuilderInstanceParams = ScallopBaseInstanceParams & {
-    query?: ScallopQuery;
-};
-export type ScallopClientInstanceParams = ScallopBaseInstanceParams & {
-    builder?: ScallopBuilder;
-};
-export type ScallopAddressParams = {
-    id: string;
-    auth?: string;
-    network?: NetworkType;
-    forceInterface?: Partial<Record<NetworkType, AddressesInterface>>;
-};
-export type ScallopParams = {
-    addressesId?: string;
-    forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
-    walletAddress?: string;
-} & SuiKitParams;
-export type ScallopClientParams = ScallopParams & ScallopBuilderParams & ScallopQueryParams & ScallopUtilsParams & ScallopCacheParams;
-export type ScallopBuilderParams = ScallopParams & {
-    pythEndpoints?: string[];
-    usePythPullModel?: boolean;
-} & ScallopQueryParams;
-export type ScallopQueryParams = ScallopParams & ScallopUtilsParams;
-export type ScallopUtilsParams = ScallopParams & {
-    pythEndpoints?: string[];
-};
-export type ScallopCacheParams = Omit<ScallopParams, 'addressId' | 'forceAddressesInterface'> & {
-    cacheOptions?: QueryClientConfig;
-};

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

@@ -1,124 +0,0 @@
-import type { SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins } from '../constant';
-export interface BorrowIncentiveAccountKey {
-    id: string;
-    onwerId: string;
-}
-type OptionalKeys<T> = {
-    [K in keyof T]?: T[K];
-};
-export type BorrowIncentivePools = OptionalKeys<Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>>;
-export type BorrowIncentivePoolPoints = {
-    symbol: string;
-    coinName: SupportBorrowIncentiveRewardCoins;
-    coinType: string;
-    coinDecimal: number;
-    coinPrice: number;
-} & Required<Pick<ParsedBorrowIncentivePoolPointData, 'points' | 'distributedPoint' | 'weightedAmount'>> & CalculatedBorrowIncentivePoolPointData;
-export type BorrowIncentivePool = {
-    coinName: SupportBorrowIncentiveCoins;
-    symbol: string;
-    coinType: string;
-    coinDecimal: number;
-    coinPrice: number;
-    stakedAmount: number;
-    stakedCoin: number;
-    stakedValue: number;
-    points: OptionalKeys<Record<SupportBorrowIncentiveRewardCoins, BorrowIncentivePoolPoints>>;
-};
-export type OriginBorrowIncentivePoolPointData = {
-    point_type: {
-        name: string;
-    };
-    distributed_point_per_period: string;
-    point_distribution_time: string;
-    distributed_point: string;
-    points: string;
-    index: string;
-    base_weight: string;
-    weighted_amount: string;
-    last_update: string;
-    created_at: string;
-};
-export type OriginBorrowIncentivePoolData = {
-    pool_type: {
-        name: string;
-    };
-    points: OriginBorrowIncentivePoolPointData[];
-    min_stakes: string;
-    max_stakes: string;
-    stakes: string;
-    created_at: string;
-};
-export type ParsedBorrowIncentivePoolPointData = {
-    pointType: string;
-    distributedPointPerPeriod: number;
-    period: number;
-    distributedPoint: number;
-    points: number;
-    index: number;
-    baseWeight: number;
-    weightedAmount: number;
-    lastUpdate: number;
-    createdAt: number;
-};
-export type ParsedBorrowIncentivePoolData = {
-    poolType: string;
-    poolPoints: OptionalKeys<Record<SupportBorrowIncentiveRewardCoins, ParsedBorrowIncentivePoolPointData>>;
-    minStakes: number;
-    maxStakes: number;
-    staked: number;
-};
-export type CalculatedBorrowIncentivePoolPointData = {
-    baseWeight: number;
-    weightedStakedAmount: number;
-    weightedStakedCoin: number;
-    weightedStakedValue: number;
-    distributedPointPerSec: number;
-    accumulatedPoints: number;
-    currentPointIndex: number;
-    currentTotalDistributedPoint: number;
-    rewardApr: number;
-    rewardPerSec: number;
-};
-export type BorrowIncentiveAccounts = OptionalKeys<Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>>;
-export type OriginBorrowIncentiveAccountPoolData = {
-    point_type: {
-        name: string;
-    };
-    weighted_amount: string;
-    points: string;
-    total_points: string;
-    index: string;
-};
-export type OriginBorrowIncentiveAccountData = {
-    points_list: OriginBorrowIncentiveAccountPoolData[];
-    pool_type: {
-        name: string;
-    };
-    debt_amount: string;
-};
-export type ParsedBorrowIncentiveAccountPoolData = {
-    pointType: string;
-    weightedAmount: number;
-    points: number;
-    totalPoints: number;
-    index: number;
-};
-export type ParsedBorrowIncentiveAccountData = {
-    pointList: OptionalKeys<Record<SupportBorrowIncentiveRewardCoins, ParsedBorrowIncentiveAccountPoolData>>;
-    poolType: string;
-    debtAmount: number;
-};
-/**
- * The query interface for `incentive_pools_query::incentive_pools_data` inspectTxn.
- */
-export interface BorrowIncentivePoolsQueryInterface {
-    incentive_pools: OriginBorrowIncentivePoolData[];
-}
-/**
- * The query interface for `incentive_account_query::incentive_account_data` inspectTxn.
- */
-export interface BorrowIncentiveAccountsQueryInterface {
-    pool_records: OriginBorrowIncentiveAccountData[];
-}
-export {};