@scallop-io/sui-scallop-sdk 1.3.4-alpha.3 → 1.3.4-alpha.5

package/dist/builders/borrowIncentiveBuilder.d.ts

@@ -0,0 +1,12 @@
+import { Transaction } from '@mysten/sui/transactions';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { ScallopBuilder } from 'src/models';
+import { ScallopTxBlock, BorrowIncentiveTxBlock } from 'src/types';
+/**
+ * Create an enhanced transaction block instance for interaction with borrow incentive modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop borrow incentive txBlock.
+ */
+export declare const newBorrowIncentiveTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => BorrowIncentiveTxBlock;

package/dist/builders/coreBuilder.d.ts

@@ -0,0 +1,12 @@
+import { Transaction } from '@mysten/sui/transactions';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { ScallopBuilder } from 'src/models';
+import { CoreTxBlock, ScallopTxBlock, SuiTxBlockWithSpool } from 'src/types';
+/**
+ * Create an enhanced transaction block instance for interaction with core modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop core txBlock.
+ */
+export declare const newCoreTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction | SuiTxBlockWithSpool) => CoreTxBlock;

package/dist/builders/index.d.ts

@@ -0,0 +1,12 @@
+import { Transaction } from '@mysten/sui/transactions';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { ScallopBuilder } from 'src/models';
+import { ScallopTxBlock } from 'src/types';
+/**
+ * Create a new ScallopTxBlock instance.
+ *
+ * @param builder - Scallop builder instance.
+ * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return ScallopTxBlock.
+ */
+export declare const newScallopTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => ScallopTxBlock;

package/dist/builders/loyaltyProgramBuilder.d.ts

@@ -0,0 +1,12 @@
+import { Transaction } from '@mysten/sui/transactions';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { ScallopBuilder } from 'src/models';
+import { LoyaltyProgramTxBlock, ScallopTxBlock } from 'src/types';
+/**
+ * Create an enhanced transaction block instance for interaction with loyalty program modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop loyalty program txBlock.
+ */
+export declare const newLoyaltyProgramTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => LoyaltyProgramTxBlock;

package/dist/builders/oracle.d.ts

@@ -0,0 +1,14 @@
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { ScallopBuilder } from 'src/models';
+import { SupportAssetCoins } from 'src/types';
+/**
+ * Update the price of the oracle for multiple coin.
+ *
+ * @param builder - The scallop builder.
+ * @param txBlock - TxBlock created by SuiKit.
+ * @param assetCoinNames - Specific an array of support asset coin name.
+ * @param options - The options for update oracles.
+ */
+export declare const updateOracles: (builder: ScallopBuilder, txBlock: SuiKitTxBlock, assetCoinNames?: SupportAssetCoins[], options?: {
+    usePythPullModel: boolean;
+}) => Promise<void>;

package/dist/builders/referralBuilder.d.ts

@@ -0,0 +1,12 @@
+import { ScallopBuilder } from 'src/models';
+import { ScallopTxBlock } from 'src/types';
+import { SuiTxBlock as SuiKitTxBlock, Transaction } from '@scallop-io/sui-kit';
+import { ReferralTxBlock } from 'src/types';
+/**
+ * Create an enhanced transaction block instance for interaction with borrow incentive modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop referral txBlock.
+ */
+export declare const newReferralTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => ReferralTxBlock;

package/dist/builders/sCoinBuilder.d.ts

@@ -0,0 +1,4 @@
+import { Transaction, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { ScallopBuilder } from 'src/models';
+import { BaseScallopTxBlock, SCoinTxBlock, ScallopTxBlock } from 'src/types';
+export declare const newSCoinTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction | BaseScallopTxBlock) => SCoinTxBlock;

package/dist/builders/spoolBuilder.d.ts

@@ -0,0 +1,12 @@
+import { Transaction } from '@mysten/sui/transactions';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { ScallopBuilder } from 'src/models';
+import { SpoolTxBlock, ScallopTxBlock, SuiTxBlockWithSCoin } from 'src/types';
+/**
+ * Create an enhanced transaction block instance for interaction with spool modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop spool txBlock.
+ */
+export declare const newSpoolTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction | SuiTxBlockWithSCoin) => SpoolTxBlock;

package/dist/builders/vescaBuilder.d.ts

@@ -0,0 +1,25 @@
+import { SuiTxBlock, Transaction, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { ScallopBuilder } from 'src/models';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
+import { ScallopTxBlock, VeScaTxBlock } from 'src/types';
+/**
+ * Check and get veSCA data from transaction block.
+ *
+ * @description
+ * If the veScaKey id is provided, directly return it.
+ * Otherwise, automatically get veScaKey from the sender.
+ *
+ * @param builder - Scallop builder instance.
+ * @param txBlock - TxBlock created by SuiKit.
+ * @param veScaKey - veSCA key.
+ * @return veSCA key, ID, locked amount and unlock at timestamp.
+ */
+export declare const requireVeSca: (builder: ScallopBuilder, SuiTxBlock: SuiTxBlock, veScaKey?: SuiObjectArg | undefined) => Promise<import("src/types").Vesca | undefined>;
+/**
+ * Create an enhanced transaction block instance for interaction with veSCA modules of the Scallop contract.
+ *
+ * @param builder - Scallop builder instance.
+ * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+ * @return Scallop borrow incentive txBlock.
+ */
+export declare const newVeScaTxBlock: (builder: ScallopBuilder, initTxBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction) => VeScaTxBlock;

package/dist/constants/cache.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Default cache options for the QueryClient.
+ * @type {QueryClientConfig}
+ * @description Default cache options for the QueryClient
+ * We set the default to 5s to prevent duplicate requests from being requested (e.g. query MarketObject, etc.)
+ */
+export declare const DEFAULT_CACHE_OPTIONS: {
+    defaultOptions: {
+        queries: {
+            staleTime: number;
+            gcTime: number;
+        };
+    };
+};

package/dist/constants/coinGecko.d.ts

@@ -0,0 +1,2 @@
+import { SupportPoolCoins } from 'src/types';
+export declare const COIN_GECKGO_IDS: Record<SupportPoolCoins, string>;

package/dist/constants/common.d.ts

@@ -0,0 +1,20 @@
+export declare const API_BASE_URL: "https://sui.apis.scallop.io";
+export declare const SDK_API_BASE_URL: "https://sdk.api.scallop.io";
+export declare const IS_VE_SCA_TEST: boolean;
+export declare const USE_TEST_ADDRESS: boolean;
+export declare const ADDRESSES_ID: "65fb07c39c845425d71d7b18" | "66f8e7ed9bb9e07fdfb86bbb";
+export declare const PROTOCOL_OBJECT_ID: "0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778" | "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
+export declare const BORROW_FEE_PROTOCOL_ID: "0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778" | "0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da";
+export declare const SCA_COIN_TYPE: "0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524::sca::SCA" | "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA";
+export declare const OLD_BORROW_INCENTIVE_PROTOCOL_ID: "0xc63072e7f5f4983a2efaf5bdba1480d5e7d74d57948e1c7cc436f8e22cbeb410";
+export declare const SUPPORT_POOLS: readonly ["usdc", "sbeth", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca"];
+export declare const SUPPORT_COLLATERALS: readonly ["usdc", "sbeth", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca"];
+export declare const SUPPORT_SPOOLS: readonly ["susdc", "sweth", "ssui", "swusdc", "swusdt", "scetus", "safsui", "shasui", "svsui"];
+export declare const SUPPORT_SCOIN: readonly ["susdc", "ssbeth", "ssui", "swusdc", "swusdt", "safsui", "shasui", "svsui", "sweth", "ssca", "scetus", "swsol", "swbtc"];
+export declare const SUPPORT_SUI_BRIDGE: readonly ["sbeth"];
+export declare const SUPPORT_WORMHOLE: readonly ["wusdc", "wusdt", "weth", "wbtc", "wapt", "wsol"];
+export declare const SUPPORT_SPOOLS_REWARDS: readonly ["sui"];
+export declare const SUPPORT_BORROW_INCENTIVE_POOLS: readonly ["sui", "wusdc", "wusdt", "afsui", "hasui", "vsui", "weth", "sbeth", "sca", "usdc"];
+export declare const SUPPORT_BORROW_INCENTIVE_REWARDS: readonly ["sui", "sca"];
+export declare const SUPPORT_ORACLES: readonly ["supra", "switchboard", "pyth"];
+export declare const SUPPORT_PACKAGES: readonly ["coinDecimalsRegistry", "math", "whitelist", "x", "protocol", "protocolWhitelist", "query", "supra", "pyth", "switchboard", "xOracle", "testCoin"];

package/dist/constants/enum.d.ts

@@ -0,0 +1,14 @@
+import type * as types from 'src/types';
+export declare const coinDecimals: types.SupportCoinDecimals;
+export declare const assetCoins: types.AssetCoins;
+export declare const marketCoins: types.MarketCoins;
+export declare const sCoins: types.SCoins;
+export declare const stakeMarketCoins: types.StakeMarketCoins;
+export declare const spoolRewardCoins: types.StakeRewardCoins;
+export declare const suiBridgeCoins: types.SuiBridgeCoins;
+export declare const borrowIncentiveRewardCoins: types.BorrowIncentiveRewardCoins;
+export declare const coinIds: types.AssetCoinIds;
+export declare const wormholeCoinIds: types.WormholeCoinIds;
+export declare const voloCoinIds: types.VoloCoinIds;
+export declare const sCoinIds: types.SCoinIds;
+export declare const sCoinTypeToName: Record<string, "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca">;

package/dist/constants/flashloan.d.ts

@@ -0,0 +1,2 @@
+import { OptionalKeys, SupportPoolCoins } from 'src/types';
+export declare const FlashLoanFeeObjectMap: OptionalKeys<Record<SupportPoolCoins, string>>;

package/dist/constants/index.d.ts

@@ -0,0 +1,12 @@
+export * from './cache';
+export * from './coinGecko';
+export * from './common';
+export * from './enum';
+export * from './flashloan';
+export * from './poolAddress';
+export * from './pyth';
+export * from './queryKeys';
+export * from './testAddress';
+export * from './tokenBucket';
+export * from './vesca';
+export * from './rpc';

package/dist/constants/poolAddress.d.ts

@@ -0,0 +1,5 @@
+import { SupportPoolCoins } from 'src/types';
+export declare const POOL_ADDRESSES: Record<SupportPoolCoins, {
+    lendingPoolAddress: string;
+    collateralPoolAddress: string;
+}>;

package/dist/constants/pyth.d.ts

@@ -0,0 +1,5 @@
+import { SupportPoolCoins } from 'src/types';
+export declare const PYTH_ENDPOINTS: {
+    [k in 'mainnet' | 'testnet']: string[];
+};
+export declare const PYTH_FEED_IDS: Record<SupportPoolCoins, string>;

package/dist/constants/queryKeys.d.ts

@@ -0,0 +1,56 @@
+import type { GetDynamicFieldObjectParams, GetDynamicFieldsParams, GetOwnedObjectsParams, SuiObjectData, SuiObjectDataOptions } from '@mysten/sui/client';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
+export declare const queryKeys: {
+    api: {
+        getAddresses: (addressesId?: string) => (string | {
+            addressesId: string | undefined;
+        })[];
+        getMarket: () => string[];
+        getSpools: () => string[];
+        getBorrowIncentivePool: () => string[];
+        getTotalValueLocked: () => string[];
+    };
+    rpc: {
+        getInspectTxn: (queryTarget?: string, args?: SuiObjectArg[], typeArgs?: any[]) => (string | {
+            queryTarget: string | undefined;
+            args: string;
+            typeArgs: string | undefined;
+        })[];
+        getObject: (objectId?: string, walletAddress?: string, options?: SuiObjectDataOptions) => (string | {
+            walletAddress: string | undefined;
+            options: SuiObjectDataOptions | undefined;
+            objectId: string | undefined;
+        })[];
+        getObjects: (objectIds?: string[], walletAddress?: string, options?: SuiObjectDataOptions) => (string | {
+            walletAddress: string | undefined;
+            options: SuiObjectDataOptions | undefined;
+            objectIds: string;
+        })[];
+        getOwnedObjects: (input?: Partial<GetOwnedObjectsParams>) => (string | {
+            walletAddress: string | undefined;
+            cursor: string | undefined;
+            options: SuiObjectDataOptions | undefined;
+            filter: string;
+            limit: number | undefined;
+        })[];
+        getDynamicFields: (input?: Partial<GetDynamicFieldsParams>) => (string | {
+            parentId: string | undefined;
+            cursor: string | undefined;
+            limit: number | undefined;
+        })[];
+        getDynamicFieldObject: (input?: Partial<GetDynamicFieldObjectParams>) => (string | {
+            parentId: string | undefined;
+            name: string;
+        })[];
+        getTotalVeScaTreasuryAmount: (refreshArgs?: any[], vescaAmountArgs?: (string | SuiObjectData)[]) => (string | {
+            refreshArgs: string;
+            vescaAmountArgs: string;
+        })[];
+        getAllCoinBalances: (owner?: string) => (string | {
+            owner: string | undefined;
+        })[];
+    };
+    oracle: {
+        getPythLatestPriceFeeds: () => string[];
+    };
+};

package/dist/constants/rpc.d.ts

@@ -0,0 +1 @@
+export declare const RPC_PROVIDERS: string[];

package/dist/constants/testAddress.d.ts

@@ -0,0 +1,2 @@
+import { AddressesInterface } from 'src/types';
+export declare const TEST_ADDRESSES: AddressesInterface;

package/dist/constants/tokenBucket.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_TOKENS_PER_INTERVAL = 10;
+export declare const DEFAULT_INTERVAL_IN_MS = 300;

package/dist/constants/vesca.d.ts

@@ -0,0 +1,5 @@
+export declare const UNLOCK_ROUND_DURATION: number;
+export declare const MAX_LOCK_ROUNDS: 1460;
+export declare const MAX_LOCK_DURATION: number;
+export declare const MIN_INITIAL_LOCK_AMOUNT: 10000000000;
+export declare const MIN_TOP_UP_AMOUNT: 1000000000;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './constants';
+export * from './models';
+export type * from './types';