@cetusprotocol/aggregator-sdk 0.0.1

package/.env.example

@@ -0,0 +1,4 @@
+SUI_PRC=
+SUI_WALLET_SECRET=
+SUI_WALLET_MNEMONICS=
+CETUS_AGGREGATOR=

package/README.md

@@ -0,0 +1,128 @@
+# Cetus Aggregator Typescript SDK
+
+Cetus plus swap aggregator is a high-speed and easy-to-integrate solution designed to optimize your trading experience on the Sui blockchain. This aggregator integrates multiple mainstream decentralized exchanges (DEX) on the Sui chain, including various types of trading platforms, providing users with the best trading prices and the lowest slippage.
+
+Core Advantages:
+
+High-Speed Transactions: Thanks to advanced algorithms and efficient architecture, our aggregator can execute transactions at lightning speed, ensuring users get the best opportunities in a rapidly changing market.
+
+Easy Integration: The aggregator is designed to be simple and easy to integrate. Whether you are an individual developer or a large project team, you can quickly connect and deploy.
+
+Multi-Platform Support: Currently, we have integrated multiple mainstream DEXs on the Sui chain, including cetus, deepbook, kriya, flowx, aftermath, turbos etc, allowing users to enjoy a diversified trading experience on a single platform.
+
+By using our aggregator, you can trade more efficiently and securely on the Sui blockchain, fully leveraging the various opportunities brought by decentralized finance (DeFi).
+
+# Install
+
+The SDK is published to npm registry with experimental version. To use the SDK in your project, you can
+
+```
+npm install aggregator-sdk@0.0.0-experimental-20240521171554
+```
+
+# Usage
+
+## 1. Init client with rpc and package config
+
+```typescript
+// used to do simulate swap and swap
+const fullNodeURL = process.env.SUI_RPC!
+
+// used to do swap
+const secret = process.env.SUI_WALLET_SECRET!
+
+// provider by cetus
+const aggregatorURL = "https://api-sui.cetus.zone/router_v2"
+
+// process wallet secret
+const byte = Buffer.from(secret, "base64")
+const u8Array = new Uint8Array(byte)
+keypair = secret
+  ? Ed25519Keypair.fromSecretKey(u8Array.slice(1, 33))
+  : buildTestAccount()
+const wallet = keypair.getPublicKey().toSuiAddress()
+
+const aggregatorPackage = {
+  packageName: "aggregator",
+  packageId:
+    "0x640d44dbdc0ede165c7cc417d7f57f1b09648083109de7132c6b3fb15861f5ee",
+  publishedAt:
+    "0x640d44dbdc0ede165c7cc417d7f57f1b09648083109de7132c6b3fb15861f5ee",
+}
+
+const integratePackage = {
+  packageName: "integrate",
+  packageId:
+    "0x996c4d9480708fb8b92aa7acf819fb0497b5ec8e65ba06601cae2fb6db3312c3",
+  publishedAt:
+    "0x8faab90228e4c4df91c41626bbaefa19fc25c514405ac64de54578dec9e6f5ee",
+}
+
+const config = new AggregatorConfig(
+  aggregatorURL,
+  fullNodeURL,
+  wallet,
+  [aggregatorPackage, integratePackage],
+  ENV.MAINNET
+)
+const client = new AggregatorClient(config)
+```
+
+## 2. Get best router swap result from aggregator service
+
+```typescript
+const amount = new BN(1000000)
+
+const from = M_SUI // 0x2::sui::SUI
+const target = M_CETUS // 0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS
+
+const routerRes = await client.findRouter({
+  from,
+  target,
+  amount,
+  byAmountIn: true, // true means fix input amount, false means fix output amount
+  depth: 3, // max allow 3, means 3 hops
+  splitAlgorithm: null, // select split algotirhm, recommended default set null
+  splitFactor: null,
+  splitCount: 100, // set max expect split count
+  providers: [
+    "AFTERMATH",
+    "CETUS",
+    "DEEPBOOK",
+    "KRIYA",
+    "FLOWX",
+    "AFTERMATH",
+    "TRUBOS",
+  ], //  now max support above seven platform.
+})
+
+if (routerRes != null) {
+  console.log(JSON.stringify(res, null, 2))
+}
+```
+
+## 3. Confirm and do swap
+
+```typescript
+if (routerRes != null) {
+  const routerTx = await client.routerSwap({
+    routers: res.routes,
+    amountIn: res.amountIn,
+    amountOut: res.amountOut,
+    byAmountIn,
+    slippage: 0.01,
+    fromCoinType: from,
+    targetCoinType: target,
+    partner: undefined,
+    isMergeTragetCoin: true,
+  })
+
+  let result = await client.devInspectTransactionBlock(routerTx, keypair)
+
+  if (result.effects.status.status === "success") {
+    console.log("Sim exec transaction success")
+    const result = await client.signAndExecuteTransaction(routerTx, keypair)
+  }
+  console.log("result", result)
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,266 @@
+import * as _mysten_sui_client from '@mysten/sui/client';
+import { SuiClient } from '@mysten/sui/client';
+import Decimal from 'decimal.js';
+import { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
+import { Signer } from '@mysten/sui/dist/cjs/cryptography';
+import BN from 'bn.js';
+
+type Package = {
+    packageName: string;
+    packageId: string;
+    publishedAt: string;
+};
+declare enum ENV {
+    MAINNET = 0,
+    TESTNET = 1
+}
+declare class AggregatorConfig {
+    private aggregatorUrl;
+    private fullNodeUrl;
+    private wallet;
+    private packages;
+    private env;
+    constructor(aggregatorUrl: string, fullNodeUrl: string, wallet: string, packages: Package[], env: ENV);
+    getAggregatorUrl(): string;
+    getFullNodeUrl(): string;
+    getWallet(): string;
+    getENV(): ENV;
+    getPackages(): Package[];
+    getPackage(packageName: string): Package | undefined;
+    addPackage(newPackage: Package): void;
+    removePackageById(packageId: string): void;
+    findPackageById(packageId: string): Package | undefined;
+}
+
+/**
+ * Represents a SUI address, which is a string.
+ */
+type SuiAddress = string;
+/**
+ * Represents a SUI object identifier, which is a string.
+ */
+type SuiObjectIdType = string;
+/**
+ * Represents a SUI struct tag.
+ */
+type SuiStructTag = {
+    /**
+     * The full address of the struct.
+     */
+    full_address: string;
+    /**
+     * The source address of the struct.
+     */
+    source_address: string;
+    /**
+     * The address of the struct.
+     */
+    address: SuiAddress;
+    /**
+     * The module to which the struct belongs.
+     */
+    module: string;
+    /**
+     * The name of the struct.
+     */
+    name: string;
+    /**
+     * An array of type arguments (SUI addresses) for the struct.
+     */
+    type_arguments: SuiAddress[];
+};
+/**
+ * Represents a coin asset with address, object ID, and balance information.
+ */
+type CoinAsset = {
+    /**
+     * The address type of the coin asset.
+     */
+    coinAddress: SuiAddress;
+    /**
+     * The object identifier of the coin asset.
+     */
+    coinObjectId: SuiObjectIdType;
+    /**
+     * The balance amount of the coin asset.
+     */
+    balance: bigint;
+};
+
+type ExtendedDetails = {
+    aftermathPoolFlatness?: number;
+    aftermathLpSupplyType?: string;
+    turbosFeeType?: string;
+};
+type Path = {
+    id: string;
+    a2b: boolean;
+    provider: string;
+    from: string;
+    target: string;
+    feeRate: number;
+    amountIn: number;
+    amountOut: number;
+    extendedDetails?: ExtendedDetails;
+    version?: string;
+};
+type Router = {
+    path: Path[];
+    amountIn: BN;
+    amountOut: BN;
+    initialPrice: Decimal;
+};
+type RouterData = {
+    amountIn: BN;
+    amountOut: BN;
+    routes: Router[];
+};
+type AggregatorResponse = {
+    code: number;
+    msg: string;
+    data: RouterData;
+};
+type BuildRouterSwapParams = {
+    routers: Router[];
+    amountIn: BN;
+    amountOut: BN;
+    byAmountIn: boolean;
+    slippage: number;
+    fromCoinType: string;
+    targetCoinType: string;
+    partner?: string;
+    isMergeTragetCoin?: boolean;
+    refreshAllCoins?: boolean;
+};
+interface FindRouterParams {
+    from: string;
+    target: string;
+    amount: BN;
+    byAmountIn: boolean;
+    depth: number | null;
+    splitAlgorithm: string | null;
+    splitFactor: number | null;
+    splitCount: number | null;
+    providers: string[] | null;
+}
+interface SwapInPoolsParams {
+    from: string;
+    target: string;
+    amount: BN;
+    byAmountIn: boolean;
+    pools: string[];
+}
+interface SwapInPoolsResult {
+    isExceed: boolean;
+    routeData?: RouterData;
+}
+declare class AggregatorClient {
+    private config;
+    private wallet;
+    private client;
+    private allCoins;
+    constructor(config: AggregatorConfig);
+    getAllCoins(): Promise<CoinAsset[]>;
+    findRouter(fromRouterParams: FindRouterParams): Promise<RouterData | null>;
+    swapInPools(params: SwapInPoolsParams): Promise<SwapInPoolsResult | null>;
+    routerSwap(params: BuildRouterSwapParams): Promise<Transaction>;
+    signAndExecuteTransaction(txb: Transaction, signer: Signer): Promise<_mysten_sui_client.SuiTransactionBlockResponse>;
+    devInspectTransactionBlock(txb: Transaction, signer: Signer): Promise<_mysten_sui_client.DevInspectResults>;
+    sendTransaction(txb: Transaction, signer: Signer): Promise<_mysten_sui_client.SuiTransactionBlockResponse>;
+}
+
+declare function expectInputRouterSwap(client: SuiClient, params: BuildRouterSwapParams, txb: Transaction, fromCoin: TransactionObjectArgument, config: AggregatorConfig, partner?: string): Promise<TransactionObjectArgument[]>;
+declare function expectOutputRouterSwap(params: BuildRouterSwapParams, txb: Transaction, fromCoin: TransactionObjectArgument, config: AggregatorConfig, partner?: string): Promise<TransactionObjectArgument[]>;
+
+declare function isSortedSymbols(symbolX: string, symbolY: string): boolean;
+declare function composeType(address: string, generics: SuiAddress[]): SuiAddress;
+declare function composeType(address: string, struct: string, generics?: SuiAddress[]): SuiAddress;
+declare function composeType(address: string, module: string, struct: string, generics?: SuiAddress[]): SuiAddress;
+declare function extractAddressFromType(type: string): string;
+declare function extractStructTagFromType(type: string): SuiStructTag;
+declare function normalizeCoinType(coinType: string): string;
+declare function fixSuiObjectId(value: string): string;
+/**
+ * Recursively traverses the given data object and patches any string values that represent Sui object IDs.
+ *
+ * @param {any} data - The data object to be patched.
+ */
+declare function patchFixSuiObjectId(data: any): void;
+declare function createTarget(packageName: string, moduleName: string, functionName: string): `${string}::${string}::${string}`;
+
+/**
+ * The address representing the clock in the system.
+ */
+declare const CLOCK_ADDRESS = "0x0000000000000000000000000000000000000000000000000000000000000006";
+/**
+ * The address for CoinInfo module.
+ */
+declare const CoinInfoAddress = "0x1::coin::CoinInfo";
+/**
+ * The address for CoinStore module.
+ */
+declare const CoinStoreAddress = "0x1::coin::CoinStore";
+declare const SuiZeroCoinFn = "0x2::coin::zero";
+declare const AGGREGATOR = "aggregator";
+declare const CETUS_DEX = "CETUS";
+declare const DEEPBOOK_DEX = "DEEPBOOK";
+declare const KRIYA_DEX = "KRIYA";
+declare const FLOWX_AMM = "FLOWX";
+declare const TURBOS_DEX = "TURBOS";
+declare const AFTERMATH_AMM = "AFTERMATH";
+declare const INTEGRATE = "integrate";
+declare const CETUS_MODULE = "cetus";
+declare const DEEPBOOK_MODULE = "deepbook";
+declare const KRIYA_MODULE = "kriya";
+declare const UTILS_MODULE = "utils";
+declare const POOL_MODULT = "pool";
+declare const PAY_MODULE = "pay";
+declare const FLOWX_AMM_MODULE = "flowx_amm";
+declare const TURBOS_MODULE = "turbos";
+declare const AFTERMATH_MODULE = "aftermath";
+declare const DEEPBOOK_CUSTODIAN_V2_MODULE = "custodian_v2";
+declare const DEEPBOOK_CLOB_V2_MODULE = "clob_v2";
+declare const FlashSwapFunc = "flash_swap";
+declare const FlashSwapWithPartnerFunc = "flash_swap_with_partner";
+declare const RepayFalshSwapFunc = "repay_flash_swap";
+declare const RepayFlashSwapWithPartnerFunc = "repay_flash_swap_with_partner";
+declare const FlashSwapA2BFunc = "flash_swap_a2b";
+declare const FlashSwapB2AFunc = "flash_swap_b2a";
+declare const FlashSwapWithPartnerA2BFunc = "flash_swap_with_partner_a2b";
+declare const FlashSwapWithPartnerB2AFunc = "flash_swap_with_partner_b2a";
+declare const REPAY_FLASH_SWAP_A2B_FUNC = "repay_flash_swap_a2b";
+declare const REPAY_FLASH_SWAP_B2A_FUNC = "repay_flash_swap_b2a";
+declare const REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC = "repay_flash_swap_with_partner_a2b";
+declare const REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC = "repay_flash_swap_with_partner_b2a";
+declare const SWAP_A2B_FUNC = "swap_a2b";
+declare const SWAP_B2A_FUNC = "swap_b2a";
+declare const TRANSFER_OR_DESTORY_COIN_FUNC = "transfer_or_destroy_coin";
+declare const CHECK_COINS_THRESHOLD_FUNC = "check_coins_threshold";
+declare const JOIN_FUNC = "join_vec";
+declare const TRANSFER_ACCOUNT_CAP = "transfer_account_cap";
+declare const DEEPBOOK_PACKAGE_ID = "0x000000000000000000000000000000000000000000000000000000000000dee9";
+declare const DEEPBOOK_PUBLISHED_AT = "0x000000000000000000000000000000000000000000000000000000000000dee9";
+declare const CETUS_PUBLISHED_AT = "0x70968826ad1b4ba895753f634b0aea68d0672908ca1075a2abdf0fc9e0b2fc6a";
+declare const MAINNET_CETUS_GLOBAL_CONFIG_ID = "0xdaa46292632c3c4d8f31f23ea0f9b36a28ff3677e9684980e4438403a67a3d8f";
+declare const TESTNET_CETUS_GLOBAL_CONFIG_ID = "0x6f4149091a5aea0e818e7243a13adcfb403842d670b9a2089de058512620687a";
+declare const ZERO: BN;
+declare const ONE: BN;
+declare const TWO: BN;
+declare const U128: BN;
+declare const U64_MAX_BN: BN;
+declare const U64_MAX = "18446744073709551615";
+declare const MAINNET_FLOWX_AMM_CONTAINER_ID = "0xb65dcbf63fd3ad5d0ebfbf334780dc9f785eff38a4459e37ab08fa79576ee511";
+declare const TESTNET_FLOWX_AMM_CONTAINER_ID = "";
+declare const TURBOS_VERSIONED = "0xf1cf0e81048df168ebeb1b8030fad24b3e0b53ae827c25053fff0779c1445b6f";
+declare const MAINNET_AFTERMATH_REGISTRY_ID = "0xfcc774493db2c45c79f688f88d28023a3e7d98e4ee9f48bbf5c7990f651577ae";
+declare const TESTNET_AFTERMATH_REGISTRY_ID = "";
+declare const MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID = "0xf194d9b1bcad972e45a7dd67dd49b3ee1e3357a00a50850c52cd51bb450e13b4";
+declare const TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID = "";
+declare const MAINNET_AFTERMATH_TREASURY_ID = "0x28e499dff5e864a2eafe476269a4f5035f1c16f338da7be18b103499abf271ce";
+declare const TESTNET_AFTERMATH_TREASURY_ID = "";
+declare const MAINNET_AFTERMATH_INSURANCE_FUND_ID = "0xf0c40d67b078000e18032334c3325c47b9ec9f3d9ae4128be820d54663d14e3b";
+declare const TESTNET_AFTERMATH_INSURANCE_FUND_ID = "";
+declare const MAINNET_AFTERMATH_REFERRAL_VAULT_ID = "0x35d35b0e5b177593d8c3a801462485572fc30861e6ce96a55af6dc4730709278";
+declare const TESTNET_AFTERMATH_REFERRAL_VAULT_ID = "";
+
+export { AFTERMATH_AMM, AFTERMATH_MODULE, AGGREGATOR, AggregatorClient, AggregatorConfig, type AggregatorResponse, type BuildRouterSwapParams, CETUS_DEX, CETUS_MODULE, CETUS_PUBLISHED_AT, CHECK_COINS_THRESHOLD_FUNC, CLOCK_ADDRESS, CoinInfoAddress, CoinStoreAddress, DEEPBOOK_CLOB_V2_MODULE, DEEPBOOK_CUSTODIAN_V2_MODULE, DEEPBOOK_DEX, DEEPBOOK_MODULE, DEEPBOOK_PACKAGE_ID, DEEPBOOK_PUBLISHED_AT, ENV, type ExtendedDetails, FLOWX_AMM, FLOWX_AMM_MODULE, type FindRouterParams, FlashSwapA2BFunc, FlashSwapB2AFunc, FlashSwapFunc, FlashSwapWithPartnerA2BFunc, FlashSwapWithPartnerB2AFunc, FlashSwapWithPartnerFunc, INTEGRATE, JOIN_FUNC, KRIYA_DEX, KRIYA_MODULE, MAINNET_AFTERMATH_INSURANCE_FUND_ID, MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, MAINNET_AFTERMATH_REFERRAL_VAULT_ID, MAINNET_AFTERMATH_REGISTRY_ID, MAINNET_AFTERMATH_TREASURY_ID, MAINNET_CETUS_GLOBAL_CONFIG_ID, MAINNET_FLOWX_AMM_CONTAINER_ID, ONE, PAY_MODULE, POOL_MODULT, type Package, type Path, REPAY_FLASH_SWAP_A2B_FUNC, REPAY_FLASH_SWAP_B2A_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC, RepayFalshSwapFunc, RepayFlashSwapWithPartnerFunc, type Router, type RouterData, SWAP_A2B_FUNC, SWAP_B2A_FUNC, SuiZeroCoinFn, type SwapInPoolsParams, type SwapInPoolsResult, TESTNET_AFTERMATH_INSURANCE_FUND_ID, TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, TESTNET_AFTERMATH_REFERRAL_VAULT_ID, TESTNET_AFTERMATH_REGISTRY_ID, TESTNET_AFTERMATH_TREASURY_ID, TESTNET_CETUS_GLOBAL_CONFIG_ID, TESTNET_FLOWX_AMM_CONTAINER_ID, TRANSFER_ACCOUNT_CAP, TRANSFER_OR_DESTORY_COIN_FUNC, TURBOS_DEX, TURBOS_MODULE, TURBOS_VERSIONED, TWO, U128, U64_MAX, U64_MAX_BN, UTILS_MODULE, ZERO, composeType, createTarget, expectInputRouterSwap, expectOutputRouterSwap, extractAddressFromType, extractStructTagFromType, fixSuiObjectId, isSortedSymbols, normalizeCoinType, patchFixSuiObjectId };

package/dist/index.d.ts

@@ -0,0 +1,266 @@
+import * as _mysten_sui_client from '@mysten/sui/client';
+import { SuiClient } from '@mysten/sui/client';
+import Decimal from 'decimal.js';
+import { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
+import { Signer } from '@mysten/sui/dist/cjs/cryptography';
+import BN from 'bn.js';
+
+type Package = {
+    packageName: string;
+    packageId: string;
+    publishedAt: string;
+};
+declare enum ENV {
+    MAINNET = 0,
+    TESTNET = 1
+}
+declare class AggregatorConfig {
+    private aggregatorUrl;
+    private fullNodeUrl;
+    private wallet;
+    private packages;
+    private env;
+    constructor(aggregatorUrl: string, fullNodeUrl: string, wallet: string, packages: Package[], env: ENV);
+    getAggregatorUrl(): string;
+    getFullNodeUrl(): string;
+    getWallet(): string;
+    getENV(): ENV;
+    getPackages(): Package[];
+    getPackage(packageName: string): Package | undefined;
+    addPackage(newPackage: Package): void;
+    removePackageById(packageId: string): void;
+    findPackageById(packageId: string): Package | undefined;
+}
+
+/**
+ * Represents a SUI address, which is a string.
+ */
+type SuiAddress = string;
+/**
+ * Represents a SUI object identifier, which is a string.
+ */
+type SuiObjectIdType = string;
+/**
+ * Represents a SUI struct tag.
+ */
+type SuiStructTag = {
+    /**
+     * The full address of the struct.
+     */
+    full_address: string;
+    /**
+     * The source address of the struct.
+     */
+    source_address: string;
+    /**
+     * The address of the struct.
+     */
+    address: SuiAddress;
+    /**
+     * The module to which the struct belongs.
+     */
+    module: string;
+    /**
+     * The name of the struct.
+     */
+    name: string;
+    /**
+     * An array of type arguments (SUI addresses) for the struct.
+     */
+    type_arguments: SuiAddress[];
+};
+/**
+ * Represents a coin asset with address, object ID, and balance information.
+ */
+type CoinAsset = {
+    /**
+     * The address type of the coin asset.
+     */
+    coinAddress: SuiAddress;
+    /**
+     * The object identifier of the coin asset.
+     */
+    coinObjectId: SuiObjectIdType;
+    /**
+     * The balance amount of the coin asset.
+     */
+    balance: bigint;
+};
+
+type ExtendedDetails = {
+    aftermathPoolFlatness?: number;
+    aftermathLpSupplyType?: string;
+    turbosFeeType?: string;
+};
+type Path = {
+    id: string;
+    a2b: boolean;
+    provider: string;
+    from: string;
+    target: string;
+    feeRate: number;
+    amountIn: number;
+    amountOut: number;
+    extendedDetails?: ExtendedDetails;
+    version?: string;
+};
+type Router = {
+    path: Path[];
+    amountIn: BN;
+    amountOut: BN;
+    initialPrice: Decimal;
+};
+type RouterData = {
+    amountIn: BN;
+    amountOut: BN;
+    routes: Router[];
+};
+type AggregatorResponse = {
+    code: number;
+    msg: string;
+    data: RouterData;
+};
+type BuildRouterSwapParams = {
+    routers: Router[];
+    amountIn: BN;
+    amountOut: BN;
+    byAmountIn: boolean;
+    slippage: number;
+    fromCoinType: string;
+    targetCoinType: string;
+    partner?: string;
+    isMergeTragetCoin?: boolean;
+    refreshAllCoins?: boolean;
+};
+interface FindRouterParams {
+    from: string;
+    target: string;
+    amount: BN;
+    byAmountIn: boolean;
+    depth: number | null;
+    splitAlgorithm: string | null;
+    splitFactor: number | null;
+    splitCount: number | null;
+    providers: string[] | null;
+}
+interface SwapInPoolsParams {
+    from: string;
+    target: string;
+    amount: BN;
+    byAmountIn: boolean;
+    pools: string[];
+}
+interface SwapInPoolsResult {
+    isExceed: boolean;
+    routeData?: RouterData;
+}
+declare class AggregatorClient {
+    private config;
+    private wallet;
+    private client;
+    private allCoins;
+    constructor(config: AggregatorConfig);
+    getAllCoins(): Promise<CoinAsset[]>;
+    findRouter(fromRouterParams: FindRouterParams): Promise<RouterData | null>;
+    swapInPools(params: SwapInPoolsParams): Promise<SwapInPoolsResult | null>;
+    routerSwap(params: BuildRouterSwapParams): Promise<Transaction>;
+    signAndExecuteTransaction(txb: Transaction, signer: Signer): Promise<_mysten_sui_client.SuiTransactionBlockResponse>;
+    devInspectTransactionBlock(txb: Transaction, signer: Signer): Promise<_mysten_sui_client.DevInspectResults>;
+    sendTransaction(txb: Transaction, signer: Signer): Promise<_mysten_sui_client.SuiTransactionBlockResponse>;
+}
+
+declare function expectInputRouterSwap(client: SuiClient, params: BuildRouterSwapParams, txb: Transaction, fromCoin: TransactionObjectArgument, config: AggregatorConfig, partner?: string): Promise<TransactionObjectArgument[]>;
+declare function expectOutputRouterSwap(params: BuildRouterSwapParams, txb: Transaction, fromCoin: TransactionObjectArgument, config: AggregatorConfig, partner?: string): Promise<TransactionObjectArgument[]>;
+
+declare function isSortedSymbols(symbolX: string, symbolY: string): boolean;
+declare function composeType(address: string, generics: SuiAddress[]): SuiAddress;
+declare function composeType(address: string, struct: string, generics?: SuiAddress[]): SuiAddress;
+declare function composeType(address: string, module: string, struct: string, generics?: SuiAddress[]): SuiAddress;
+declare function extractAddressFromType(type: string): string;
+declare function extractStructTagFromType(type: string): SuiStructTag;
+declare function normalizeCoinType(coinType: string): string;
+declare function fixSuiObjectId(value: string): string;
+/**
+ * Recursively traverses the given data object and patches any string values that represent Sui object IDs.
+ *
+ * @param {any} data - The data object to be patched.
+ */
+declare function patchFixSuiObjectId(data: any): void;
+declare function createTarget(packageName: string, moduleName: string, functionName: string): `${string}::${string}::${string}`;
+
+/**
+ * The address representing the clock in the system.
+ */
+declare const CLOCK_ADDRESS = "0x0000000000000000000000000000000000000000000000000000000000000006";
+/**
+ * The address for CoinInfo module.
+ */
+declare const CoinInfoAddress = "0x1::coin::CoinInfo";
+/**
+ * The address for CoinStore module.
+ */
+declare const CoinStoreAddress = "0x1::coin::CoinStore";
+declare const SuiZeroCoinFn = "0x2::coin::zero";
+declare const AGGREGATOR = "aggregator";
+declare const CETUS_DEX = "CETUS";
+declare const DEEPBOOK_DEX = "DEEPBOOK";
+declare const KRIYA_DEX = "KRIYA";
+declare const FLOWX_AMM = "FLOWX";
+declare const TURBOS_DEX = "TURBOS";
+declare const AFTERMATH_AMM = "AFTERMATH";
+declare const INTEGRATE = "integrate";
+declare const CETUS_MODULE = "cetus";
+declare const DEEPBOOK_MODULE = "deepbook";
+declare const KRIYA_MODULE = "kriya";
+declare const UTILS_MODULE = "utils";
+declare const POOL_MODULT = "pool";
+declare const PAY_MODULE = "pay";
+declare const FLOWX_AMM_MODULE = "flowx_amm";
+declare const TURBOS_MODULE = "turbos";
+declare const AFTERMATH_MODULE = "aftermath";
+declare const DEEPBOOK_CUSTODIAN_V2_MODULE = "custodian_v2";
+declare const DEEPBOOK_CLOB_V2_MODULE = "clob_v2";
+declare const FlashSwapFunc = "flash_swap";
+declare const FlashSwapWithPartnerFunc = "flash_swap_with_partner";
+declare const RepayFalshSwapFunc = "repay_flash_swap";
+declare const RepayFlashSwapWithPartnerFunc = "repay_flash_swap_with_partner";
+declare const FlashSwapA2BFunc = "flash_swap_a2b";
+declare const FlashSwapB2AFunc = "flash_swap_b2a";
+declare const FlashSwapWithPartnerA2BFunc = "flash_swap_with_partner_a2b";
+declare const FlashSwapWithPartnerB2AFunc = "flash_swap_with_partner_b2a";
+declare const REPAY_FLASH_SWAP_A2B_FUNC = "repay_flash_swap_a2b";
+declare const REPAY_FLASH_SWAP_B2A_FUNC = "repay_flash_swap_b2a";
+declare const REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC = "repay_flash_swap_with_partner_a2b";
+declare const REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC = "repay_flash_swap_with_partner_b2a";
+declare const SWAP_A2B_FUNC = "swap_a2b";
+declare const SWAP_B2A_FUNC = "swap_b2a";
+declare const TRANSFER_OR_DESTORY_COIN_FUNC = "transfer_or_destroy_coin";
+declare const CHECK_COINS_THRESHOLD_FUNC = "check_coins_threshold";
+declare const JOIN_FUNC = "join_vec";
+declare const TRANSFER_ACCOUNT_CAP = "transfer_account_cap";
+declare const DEEPBOOK_PACKAGE_ID = "0x000000000000000000000000000000000000000000000000000000000000dee9";
+declare const DEEPBOOK_PUBLISHED_AT = "0x000000000000000000000000000000000000000000000000000000000000dee9";
+declare const CETUS_PUBLISHED_AT = "0x70968826ad1b4ba895753f634b0aea68d0672908ca1075a2abdf0fc9e0b2fc6a";
+declare const MAINNET_CETUS_GLOBAL_CONFIG_ID = "0xdaa46292632c3c4d8f31f23ea0f9b36a28ff3677e9684980e4438403a67a3d8f";
+declare const TESTNET_CETUS_GLOBAL_CONFIG_ID = "0x6f4149091a5aea0e818e7243a13adcfb403842d670b9a2089de058512620687a";
+declare const ZERO: BN;
+declare const ONE: BN;
+declare const TWO: BN;
+declare const U128: BN;
+declare const U64_MAX_BN: BN;
+declare const U64_MAX = "18446744073709551615";
+declare const MAINNET_FLOWX_AMM_CONTAINER_ID = "0xb65dcbf63fd3ad5d0ebfbf334780dc9f785eff38a4459e37ab08fa79576ee511";
+declare const TESTNET_FLOWX_AMM_CONTAINER_ID = "";
+declare const TURBOS_VERSIONED = "0xf1cf0e81048df168ebeb1b8030fad24b3e0b53ae827c25053fff0779c1445b6f";
+declare const MAINNET_AFTERMATH_REGISTRY_ID = "0xfcc774493db2c45c79f688f88d28023a3e7d98e4ee9f48bbf5c7990f651577ae";
+declare const TESTNET_AFTERMATH_REGISTRY_ID = "";
+declare const MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID = "0xf194d9b1bcad972e45a7dd67dd49b3ee1e3357a00a50850c52cd51bb450e13b4";
+declare const TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID = "";
+declare const MAINNET_AFTERMATH_TREASURY_ID = "0x28e499dff5e864a2eafe476269a4f5035f1c16f338da7be18b103499abf271ce";
+declare const TESTNET_AFTERMATH_TREASURY_ID = "";
+declare const MAINNET_AFTERMATH_INSURANCE_FUND_ID = "0xf0c40d67b078000e18032334c3325c47b9ec9f3d9ae4128be820d54663d14e3b";
+declare const TESTNET_AFTERMATH_INSURANCE_FUND_ID = "";
+declare const MAINNET_AFTERMATH_REFERRAL_VAULT_ID = "0x35d35b0e5b177593d8c3a801462485572fc30861e6ce96a55af6dc4730709278";
+declare const TESTNET_AFTERMATH_REFERRAL_VAULT_ID = "";
+
+export { AFTERMATH_AMM, AFTERMATH_MODULE, AGGREGATOR, AggregatorClient, AggregatorConfig, type AggregatorResponse, type BuildRouterSwapParams, CETUS_DEX, CETUS_MODULE, CETUS_PUBLISHED_AT, CHECK_COINS_THRESHOLD_FUNC, CLOCK_ADDRESS, CoinInfoAddress, CoinStoreAddress, DEEPBOOK_CLOB_V2_MODULE, DEEPBOOK_CUSTODIAN_V2_MODULE, DEEPBOOK_DEX, DEEPBOOK_MODULE, DEEPBOOK_PACKAGE_ID, DEEPBOOK_PUBLISHED_AT, ENV, type ExtendedDetails, FLOWX_AMM, FLOWX_AMM_MODULE, type FindRouterParams, FlashSwapA2BFunc, FlashSwapB2AFunc, FlashSwapFunc, FlashSwapWithPartnerA2BFunc, FlashSwapWithPartnerB2AFunc, FlashSwapWithPartnerFunc, INTEGRATE, JOIN_FUNC, KRIYA_DEX, KRIYA_MODULE, MAINNET_AFTERMATH_INSURANCE_FUND_ID, MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, MAINNET_AFTERMATH_REFERRAL_VAULT_ID, MAINNET_AFTERMATH_REGISTRY_ID, MAINNET_AFTERMATH_TREASURY_ID, MAINNET_CETUS_GLOBAL_CONFIG_ID, MAINNET_FLOWX_AMM_CONTAINER_ID, ONE, PAY_MODULE, POOL_MODULT, type Package, type Path, REPAY_FLASH_SWAP_A2B_FUNC, REPAY_FLASH_SWAP_B2A_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC, RepayFalshSwapFunc, RepayFlashSwapWithPartnerFunc, type Router, type RouterData, SWAP_A2B_FUNC, SWAP_B2A_FUNC, SuiZeroCoinFn, type SwapInPoolsParams, type SwapInPoolsResult, TESTNET_AFTERMATH_INSURANCE_FUND_ID, TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, TESTNET_AFTERMATH_REFERRAL_VAULT_ID, TESTNET_AFTERMATH_REGISTRY_ID, TESTNET_AFTERMATH_TREASURY_ID, TESTNET_CETUS_GLOBAL_CONFIG_ID, TESTNET_FLOWX_AMM_CONTAINER_ID, TRANSFER_ACCOUNT_CAP, TRANSFER_OR_DESTORY_COIN_FUNC, TURBOS_DEX, TURBOS_MODULE, TURBOS_VERSIONED, TWO, U128, U64_MAX, U64_MAX_BN, UTILS_MODULE, ZERO, composeType, createTarget, expectInputRouterSwap, expectOutputRouterSwap, extractAddressFromType, extractStructTagFromType, fixSuiObjectId, isSortedSymbols, normalizeCoinType, patchFixSuiObjectId };