@scallop-io/sui-scallop-sdk 1.3.4-alpha.6 → 1.3.4-alpha.7

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 type { BorrowIncentiveTxBlock, ScallopTxBlock } from '../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 '../models';
+import type { CoreTxBlock, ScallopTxBlock, SuiTxBlockWithSpool } from '../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 '../models';
+import type { ScallopTxBlock } from '../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 '../models';
+import type { SupportAssetCoins } from '../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/builder/referral';
+/**
+ * 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 '../models';
+import type { SpoolTxBlock, ScallopTxBlock, SuiTxBlockWithSCoin } from '../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 '../models';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
+import type { 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/constant/common';
+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 '../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 './rpc';
+export * from './testAddress';
+export * from './tokenBucket';
+export * from './vesca';

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';

package/dist/models/index.d.ts

@@ -0,0 +1,8 @@
+export * from './scallop';
+export * from './scallopAddress';
+export * from './scallopClient';
+export * from './scallopBuilder';
+export * from './scallopQuery';
+export * from './scallopUtils';
+export * from './scallopIndexer';
+export * from './scallopCache';

package/dist/models/scallop.d.ts

@@ -0,0 +1,74 @@
+import { SuiKit } from '@scallop-io/sui-kit';
+import { ScallopAddress } from './scallopAddress';
+import { ScallopClient } from './scallopClient';
+import { ScallopBuilder } from './scallopBuilder';
+import { ScallopQuery } from './scallopQuery';
+import { ScallopUtils } from './scallopUtils';
+import type { ScallopBuilderParams, ScallopClientParams, ScallopParams, ScallopQueryParams, ScallopUtilsParams } from '../types/';
+import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
+import { QueryClientConfig } from '@tanstack/query-core';
+import { TokenBucket } from 'src/utils';
+import type { QueryClient } from '@tanstack/query-core';
+/**
+ * @argument params - The parameters for the Scallop instance.
+ * @argument cacheOptions - The cache options for the QueryClient.
+ *
+ * @description
+ * The main instance that controls interaction with the Scallop contract.
+ *
+ * @example
+ * ```typescript
+ * const sdk = new Scallop(<parameters>);
+ * const scallopAddress = await sdk.getScallopAddress();
+ * const scallopBuilder = await sdk.createScallopBuilder();
+ * const scallopClient = await sdk.createScallopClient();
+ * const scallopIndexer= await sdk.createScallopIndexer();
+ * const scallopUtils= await sdk.createScallopUtils();
+ * ```
+ */
+export declare class Scallop {
+    params: ScallopParams;
+    suiKit: SuiKit;
+    cache: ScallopCache;
+    private address;
+    constructor(params: ScallopParams, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket, queryClient?: QueryClient);
+    /**
+     * Get a scallop address instance that already has read addresses.
+     *
+     * @param id - The API id of the addresses.
+     * @return Scallop Address.
+     */
+    getScallopAddress(id?: string): Promise<ScallopAddress>;
+    /**
+     * Create a scallop builder instance that already has initial data.
+     *
+     * @return Scallop Builder.
+     */
+    createScallopBuilder(params?: ScallopBuilderParams): Promise<ScallopBuilder>;
+    /**
+     * Create a scallop client instance that already has initial data.
+     *
+     * @param walletAddress - When user cannot provide a secret key or mnemonic, the scallop client cannot directly derive the address of the transaction the user wants to sign. This argument specifies the wallet address for signing the transaction.
+     * @return Scallop Client.
+     */
+    createScallopClient(params?: ScallopClientParams): Promise<ScallopClient>;
+    /**
+     * Create a scallop query instance.
+     *
+     * @return Scallop Query.
+     */
+    createScallopQuery(params?: ScallopQueryParams): Promise<ScallopQuery>;
+    /**
+     * Create a scallop indexer instance.
+     *
+     * @return Scallop Indexer.
+     */
+    createScallopIndexer(): Promise<ScallopIndexer>;
+    /**
+     * Create a scallop utils instance.
+     *
+     * @return Scallop Utils.
+     */
+    createScallopUtils(params?: ScallopUtilsParams): Promise<ScallopUtils>;
+}

package/dist/models/scallopAddress.d.ts

@@ -0,0 +1,150 @@
+import { type NetworkType } from '@scallop-io/sui-kit';
+import type { ScallopAddressParams, AddressesInterface, AddressStringPath, ScallopAddressInstanceParams } from '../types';
+import { ScallopCache } from './scallopCache';
+/**
+ * @description
+ * It provides methods for managing addresses.
+ *
+ * @example
+ * ```typescript
+ * const scallopAddress = new ScallopAddress(<parameters>);
+ * scallopAddress.<address functions>();
+ * await scallopAddress.<address async functions>();
+ * ```
+ */
+export declare class ScallopAddress {
+    private readonly _auth?;
+    private readonly _requestClient;
+    private _id?;
+    private _network;
+    private _currentAddresses?;
+    private _addressesMap;
+    cache: ScallopCache;
+    constructor(params: ScallopAddressParams, instance?: ScallopAddressInstanceParams);
+    /**
+     * Get addresses API id.
+     *
+     * @return The addresses API id.
+     */
+    getId(): string | undefined;
+    /**
+     * Get the address at the provided path.
+     *
+     * @param path - The path of the address to get.
+     * @return The address at the provided path.
+     */
+    get(path: AddressStringPath): any;
+    /**
+     * Sets the address for the specified path, it does not interact with the API.
+     *
+     * @param path - The path of the address to set.
+     * @param address - The address be setted to the tartget path.
+     * @return The addresses.
+     */
+    set(path: AddressStringPath, address: string): AddressesInterface | undefined;
+    /**
+     * Synchronize the specified network addresses from the addresses map to the
+     * current addresses and change the default network to specified network.
+     *
+     * @param network - Specifies which network's addresses you want to get.
+     * @return Current addresses.
+     */
+    switchCurrentAddresses(network: NetworkType): AddressesInterface | undefined;
+    /**
+     * Get the addresses, If `network` is not provided, returns the current
+     * addresses or the default network addresses in the addresses map.
+     *
+     * @param network - Specifies which network's addresses you want to get.
+     */
+    getAddresses(network?: NetworkType): AddressesInterface | undefined;
+    /**
+     * Set the addresses into addresses map. If the specified network is the same
+     * as the current network, the current addresses will be updated at the same time.
+     *
+     * @param addresses - The addresses be setted to the tartget network.
+     * @param network - Specifies which network's addresses you want to set.
+     * @return The addresses.
+     */
+    setAddresses(addresses: AddressesInterface, network?: NetworkType): void;
+    /**
+     * Get all addresses.
+     *
+     * @return All addresses.
+     */
+    getAllAddresses(): {
+        [k: string]: AddressesInterface;
+    };
+    /**
+     * Create a new addresses through the API and synchronize it back to the
+     * instance.
+     *
+     * @description
+     * If the `network` is not specified, the mainnet is used by default.
+     * If no `addresses` from instance or parameter is provided, an addresses with
+     * all empty strings is created by default.
+     *
+     * This function only allows for one addresses to be input into a specific network
+     * at a time, and does not provide an addresses map for setting addresses
+     * across all networks at once.
+     *
+     * @param params.addresses - The addresses be setted to the tartget network.
+     * @param params.network - Specifies which network's addresses you want to set.
+     * @param params.auth - The authentication API key.
+     * @param params.memo - Add memo to the addresses created in the API.
+     * @return All addresses.
+     */
+    create(params?: {
+        addresses?: AddressesInterface | undefined;
+        network?: NetworkType | undefined;
+        auth?: string | undefined;
+        memo?: string | undefined;
+    }): Promise<{
+        [k: string]: AddressesInterface;
+    }>;
+    /**
+     * Read and synchronizes all addresses from the API into instance.
+     *
+     * @param id - The id of the addresses to get.
+     * @return All addresses.
+     */
+    read(id?: string): Promise<{
+        [k: string]: AddressesInterface;
+    }>;
+    /**
+     * Update the addresses through the API and synchronize it back to the
+     * instance.
+     *
+     * @description
+     * If the `network` is not specified, the mainnet is used by default.
+     * If no `addresses` from instance or parameter is provided, an addresses with
+     * all empty strings is created by default.
+     *
+     * This function only allows for one addresses to be input into a specific network
+     * at a time, and does not provide an addresses map for setting addresses
+     * across all networks at once.
+     *
+     * @param params.id - The id of the addresses to update.
+     * @param params.addresses - The addresses be setted to the tartget network.
+     * @param params.network - Specifies which network's addresses you want to set.
+     * @param params.auth - The authentication api key.
+     * @param params.memo - Add memo to the addresses created in the API.
+     * @return All addresses.
+     */
+    update(params?: {
+        id?: string;
+        addresses?: AddressesInterface | undefined;
+        network?: NetworkType | undefined;
+        auth?: string | undefined;
+        memo?: string | undefined;
+    }): Promise<{
+        [k: string]: AddressesInterface;
+    }>;
+    /**
+     * Deletes all addresses of a specified id through the API and clear all
+     * addresses in the instance.
+     *
+     * @param id - The id of the addresses to delete.
+     * @param auth - The authentication API key.
+     */
+    delete(id?: string, auth?: string): Promise<void>;
+}

package/dist/models/scallopBuilder.d.ts

@@ -0,0 +1,89 @@
+import { SuiKit } from '@scallop-io/sui-kit';
+import { ScallopAddress } from './scallopAddress';
+import { ScallopQuery } from './scallopQuery';
+import { ScallopUtils } from './scallopUtils';
+import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
+import type { Transaction } from '@mysten/sui/transactions';
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import type { ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin, ScallopBuilderInstanceParams, SelectCoinReturnType } from '../types';
+import { ScallopCache } from './scallopCache';
+/**
+ * @description
+ * It provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
+ *
+ * @example
+ * ```typescript
+ * const scallopBuilder = new ScallopBuilder(<parameters>);
+ * await scallopBuilder.init();
+ * const txBlock = scallopBuilder.<builder functions>();
+ * ```
+ */
+export declare class ScallopBuilder {
+    readonly params: ScallopBuilderParams;
+    readonly isTestnet: boolean;
+    suiKit: SuiKit;
+    address: ScallopAddress;
+    query: ScallopQuery;
+    utils: ScallopUtils;
+    walletAddress: string;
+    cache: ScallopCache;
+    constructor(params: ScallopBuilderParams, instance?: ScallopBuilderInstanceParams);
+    /**
+     * Request the scallop API to initialize data.
+     *
+     * @param force - Whether to force initialization.
+     * @param address - ScallopAddress instance.
+     */
+    init(force?: boolean, address?: ScallopAddress): Promise<void>;
+    /**
+     * Create a scallop txBlock instance that enhances transaction block.
+     *
+     * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+     * @return Scallop txBlock.
+     */
+    createTxBlock(txBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction): ScallopTxBlock;
+    /**
+     * Specifying the sender's amount of coins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param assetCoinName - Specific support asset coin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectCoin<T extends SupportAssetCoins>(txBlock: ScallopTxBlock | SuiKitTxBlock, assetCoinName: T, amount: number, sender?: string): Promise<SelectCoinReturnType<T>>;
+    /**
+     * Specifying the sender's amount of market coins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param marketCoinName - Specific support market coin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectMarketCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender?: string): Promise<{
+        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        totalAmount: number;
+    }>;
+    /**
+     * Specifying the sender's amount of sCoins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param marketCoinName - Specific support sCoin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectSCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, sCoinName: SupportSCoin, amount: number, sender?: string): Promise<{
+        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        totalAmount: number;
+    }>;
+    /**
+     * Execute Scallop txBlock using the `signAndSendTxn` methods in suikit.
+     *
+     * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+     */
+    signAndSendTxBlock(txBlock: ScallopTxBlock | SuiKitTxBlock | Transaction): Promise<SuiTransactionBlockResponse>;
+}