@cetusprotocol/aggregator-sdk 0.4.1 → 0.4.2

package/dist/src/types/CoinAssist.d.ts

@@ -1,122 +0,0 @@
-import type { SuiMoveObject } from '@mysten/sui/client';
-import type { CoinAsset, SuiAddress } from './sui';
-export declare const DEFAULT_GAS_BUDGET_FOR_SPLIT = 1000;
-export declare const DEFAULT_GAS_BUDGET_FOR_MERGE = 500;
-export declare const DEFAULT_GAS_BUDGET_FOR_TRANSFER = 100;
-export declare const DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI = 100;
-export declare const DEFAULT_GAS_BUDGET_FOR_STAKE = 1000;
-export declare const GAS_TYPE_ARG = "0x2::sui::SUI";
-export declare const GAS_TYPE_ARG_LONG = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI";
-export declare const GAS_SYMBOL = "SUI";
-export declare const DEFAULT_NFT_TRANSFER_GAS_FEE = 450;
-export declare const SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000005";
-/**
- * This class provides helper methods for working with coins.
- */
-export declare class CoinUtils {
-    /**
-     * Get the coin type argument from a SuiMoveObject.
-     *
-     * @param obj The SuiMoveObject to get the coin type argument from.
-     * @returns The coin type argument, or null if it is not found.
-     */
-    static getCoinTypeArg(obj: SuiMoveObject): string | null;
-    /**
-     * Get whether a SuiMoveObject is a SUI coin.
-     *
-     * @param obj The SuiMoveObject to check.
-     * @returns Whether the SuiMoveObject is a SUI coin.
-     */
-    static isSUI(obj: SuiMoveObject): boolean;
-    /**
-     * Get the coin symbol from a coin type argument.
-     *
-     * @param coinTypeArg The coin type argument to get the symbol from.
-     * @returns The coin symbol.
-     */
-    static getCoinSymbol(coinTypeArg: string): string;
-    /**
-     * Get the balance of a SuiMoveObject.
-     *
-     * @param obj The SuiMoveObject to get the balance from.
-     * @returns The balance of the SuiMoveObject.
-     */
-    static getBalance(obj: SuiMoveObject): bigint;
-    /**
-     * Get the total balance of a list of CoinAsset objects for a given coin address.
-     *
-     * @param objs The list of CoinAsset objects to get the total balance for.
-     * @param coinAddress The coin address to get the total balance for.
-     * @returns The total balance of the CoinAsset objects for the given coin address.
-     */
-    static totalBalance(objs: CoinAsset[], coinAddress: SuiAddress): bigint;
-    /**
-     * Get the ID of a SuiMoveObject.
-     *
-     * @param obj The SuiMoveObject to get the ID from.
-     * @returns The ID of the SuiMoveObject.
-     */
-    static getID(obj: SuiMoveObject): string;
-    /**
-     * Get the coin type from a coin type argument.
-     *
-     * @param coinTypeArg The coin type argument to get the coin type from.
-     * @returns The coin type.
-     */
-    static getCoinTypeFromArg(coinTypeArg: string): string;
-    /**
-     * Get the CoinAsset objects for a given coin type.
-     *
-     * @param coinType The coin type to get the CoinAsset objects for.
-     * @param allSuiObjects The list of all SuiMoveObjects.
-     * @returns The CoinAsset objects for the given coin type.
-     */
-    static getCoinAssets(coinType: string, allSuiObjects: CoinAsset[]): CoinAsset[];
-    /**
-     * Get whether a coin address is a SUI coin.
-     *
-     * @param coinAddress The coin address to check.
-     * @returns Whether the coin address is a SUI coin.
-     */
-    static isSuiCoin(coinAddress: SuiAddress): boolean;
-    /**
-     * Select the CoinAsset objects from a list of CoinAsset objects that have a balance greater than or equal to a given amount.
-     *
-     * @param coins The list of CoinAsset objects to select from.
-     * @param amount The amount to select CoinAsset objects with a balance greater than or equal to.
-     * @param exclude A list of CoinAsset objects to exclude from the selection.
-     * @returns The CoinAsset objects that have a balance greater than or equal to the given amount.
-     */
-    static selectCoinObjectIdGreaterThanOrEqual(coins: CoinAsset[], amount: bigint, exclude?: string[]): {
-        objectArray: string[];
-        remainCoins: CoinAsset[];
-        amountArray: string[];
-    };
-    /**
-     * Select the CoinAsset objects from a list of CoinAsset objects that have a balance greater than or equal to a given amount.
-     *
-     * @param coins The list of CoinAsset objects to select from.
-     * @param amount The amount to select CoinAsset objects with a balance greater than or equal to.
-     * @param exclude A list of CoinAsset objects to exclude from the selection.
-     * @returns The CoinAsset objects that have a balance greater than or equal to the given amount.
-     */
-    static selectCoinAssetGreaterThanOrEqual(coins: CoinAsset[], amount: bigint, exclude?: string[]): {
-        selectedCoins: CoinAsset[];
-        remainingCoins: CoinAsset[];
-    };
-    /**
-     * Sort the CoinAsset objects by their balance.
-     *
-     * @param coins The CoinAsset objects to sort.
-     * @returns The sorted CoinAsset objects.
-     */
-    static sortByBalance(coins: CoinAsset[]): CoinAsset[];
-    static sortByBalanceDes(coins: CoinAsset[]): CoinAsset[];
-    /**
-     * Calculate the total balance of a list of CoinAsset objects.
-     *
-     * @param coins The list of CoinAsset objects to calculate the total balance for.
-     * @returns The total balance of the CoinAsset objects.
-     */
-    static calculateTotalBalance(coins: CoinAsset[]): bigint;
-}

package/dist/src/types/sui.d.ts

@@ -1,112 +0,0 @@
-import type { TransactionArgument } from '@mysten/sui/transactions';
-import Decimal from 'decimal.js';
-/**
- * Represents a SUI address, which is a string.
- */
-export type SuiAddress = string;
-/**
- * Represents a SUI object identifier, which is a string.
- */
-export type SuiObjectIdType = string;
-/**
- * Represents a BigNumber, which can be a Decimal.Value, number, or string.
- */
-export type BigNumber = Decimal.Value | number | string;
-/**
- * Represents a SUI resource, which can be of any type.
- */
-export type SuiResource = any;
-/**
- * Represents a Non-Fungible Token (NFT) with associated metadata.
- */
-export type NFT = {
-    /**
-     * The address or identifier of the creator of the NFT.
-     */
-    creator: string;
-    /**
-     * A description providing additional information about the NFT.
-     */
-    description: string;
-    /**
-     * The URL to the image representing the NFT visually.
-     */
-    image_url: string;
-    /**
-     * A link associated with the NFT, providing more details or interactions.
-     */
-    link: string;
-    /**
-     * The name or title of the NFT.
-     */
-    name: string;
-    /**
-     * The URL to the project or collection associated with the NFT.
-     */
-    project_url: string;
-};
-/**
- * Represents a SUI struct tag.
- */
-export 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 basic SUI data types.
- */
-export type SuiBasicTypes = 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256';
-/**
- * Represents a SUI transaction argument, which can be of various types.
- */
-export type SuiTxArg = TransactionArgument | string | number | bigint | boolean;
-/**
- * Represents input types for SUI data.
- */
-export type SuiInputTypes = 'object' | SuiBasicTypes;
-/**
- * Gets the default SUI input type based on the provided value.
- * @param value - The value to determine the default input type for.
- * @returns The default SUI input type.
- * @throws Error if the type of the value is unknown.
- */
-export declare const getDefaultSuiInputType: (value: any) => SuiInputTypes;
-/**
- * Represents a coin asset with address, object ID, and balance information.
- */
-export 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;
-};

package/dist/src/utils/api.d.ts

@@ -1 +0,0 @@
-export declare function processEndpoint(endpoint: string): string;

package/dist/src/utils/coin.d.ts

@@ -1,11 +0,0 @@
-import { CoinAsset } from "../types/sui";
-import { Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-export declare function completionCoin(s: string): string;
-export declare function compareCoins(coinA: string, coinB: string): boolean;
-export declare function mintZeroCoin(txb: Transaction, coinType: string): TransactionObjectArgument;
-export type BuildCoinResult = {
-    targetCoin: TransactionObjectArgument;
-    isMintZeroCoin: boolean;
-    targetCoinAmount: number;
-};
-export declare function buildInputCoin(txb: Transaction, allCoins: CoinAsset[], amount: bigint, coinType: string): BuildCoinResult;

package/dist/src/utils/contracts.d.ts

@@ -1,16 +0,0 @@
-import type { SuiAddress, SuiStructTag } from '../types/sui';
-export declare function isSortedSymbols(symbolX: string, symbolY: string): boolean;
-export declare function composeType(address: string, generics: SuiAddress[]): SuiAddress;
-export declare function composeType(address: string, struct: string, generics?: SuiAddress[]): SuiAddress;
-export declare function composeType(address: string, module: string, struct: string, generics?: SuiAddress[]): SuiAddress;
-export declare function extractAddressFromType(type: string): string;
-export declare function extractStructTagFromType(type: string): SuiStructTag;
-export declare function normalizeCoinType(coinType: string): string;
-export 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.
- */
-export declare function patchFixSuiObjectId(data: any): void;
-export declare function createTarget(packageName: string, moduleName: string, functionName: string): `${string}::${string}::${string}`;

package/dist/src/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from './contracts';
-export * from './msafe';
-export * from './api';
-export * from './coin';
-export * from './transaction';

package/dist/src/utils/msafe.d.ts

@@ -1,2 +0,0 @@
-export declare const dealWithFastRouterSwapParamsForMsafe: (data: any) => any;
-export declare const restituteMsafeFastRouterSwapParams: (data: any) => any;

package/dist/src/utils/transaction.d.ts

@@ -1,3 +0,0 @@
-import { Transaction } from "@mysten/sui/transactions";
-export declare function printTransaction(tx: Transaction, isPrint?: boolean): Promise<void>;
-export declare function checkInvalidSuiAddress(address: string): boolean;

package/dist/tests/math.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/router/alphafi.test.d.ts

@@ -1,2 +0,0 @@
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-export declare function buildTestAccount(): Ed25519Keypair;

package/dist/tests/router/metastable.test.d.ts

@@ -1,2 +0,0 @@
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-export declare function buildTestAccount(): Ed25519Keypair;

package/dist/tests/router/obric.test.d.ts

@@ -1,2 +0,0 @@
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-export declare function buildTestAccount(): Ed25519Keypair;

package/dist/tests/router/scallop.test.d.ts

@@ -1,2 +0,0 @@
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-export declare function buildTestAccount(): Ed25519Keypair;

package/dist/tests/router/steamm.test.d.ts

@@ -1,2 +0,0 @@
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-export declare function buildTestAccount(): Ed25519Keypair;

package/dist/tests/router.test.d.ts

@@ -1,2 +0,0 @@
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-export declare function buildTestAccount(): Ed25519Keypair;

package/dist/tests/test_data.test.d.ts

@@ -1,18 +0,0 @@
-export declare const T_USDC = "0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdc::USDC";
-export declare const T_USDT = "0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdt::USDT";
-export declare const T_DEEP = "0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP";
-export declare const T_DBUSDC = "0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC";
-export declare const T_DBUSDT = "0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDT::DBUSDT";
-export declare const M_USDC = "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC";
-export declare const M_wUSDC = "0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN";
-export declare const M_CETUS = "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS";
-export declare const M_NAVI = "0xa99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX";
-export declare const M_SUI = "0x2::sui::SUI";
-export declare const M_VSUI = "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT";
-export declare const M_VAPOR = "0xa1f2c11169f32165ad4efb4468ec5bdfc880cd66b22094024b32ab7b76d14d30::vapor::VAPOR";
-export declare const M_HASUI = "0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI";
-export declare const M_SSWP = "0x361dd589b98e8fcda9a7ee53b85efabef3569d00416640d2faa516e3801d7ffc::TOKEN::TOKEN";
-export declare const M_MICHI = "0x50d796fde5709a97883e29e00bf511d66f2656de958ea0c2ce4c1147cdd20a23::MICHI::MICHI";
-export declare const M_SSUI = "0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI";
-export declare const M_SHaSUI = "0x9a2376943f7d22f88087c259c5889925f332ca4347e669dc37d54c2bf651af3c::scallop_ha_sui::SCALLOP_HA_SUI";
-export declare const M_ETH = "0xd0e89b2af5e4910726fbcd8b8dd37bb79b29e5f83f7491bca830e94f7f226d29::eth::ETH";

package/dist/tests/wallet.test.d.ts

@@ -1 +0,0 @@
-export {};

package/example/package.json

@@ -1,17 +0,0 @@
-{
-  "name": "aggregator-example",
-  "version": "1.0.0",
-  "description": "Cetus Aggregator SDK usage example",
-  "main": "index.js",
-  "scripts": {
-    "swap": "ts-node swap.ts"
-  },
-  "dependencies": {
-    "@cetusprotocol/aggregator-sdk": "^0.3.18",
-    "@mysten/sui.js": "^0.49.1"
-  },
-  "devDependencies": {
-    "typescript": "^5.0.0",
-    "ts-node": "^10.9.1"
-  }
-}

package/example/swap.ts

@@ -1,21 +0,0 @@
-import { AggregatorClient } from "@cetusprotocol/aggregator-sdk"
-import BN from "bn.js"
-
-async function main() {
-  // default to mainnet
-  const client = new AggregatorClient()
-
-  const from = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI"
-  const target = "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS"
-
-  const routers = await client.findRouters({
-    from,
-    target,
-    amount: new BN(1000000000),
-    byAmountIn: true,
-  })
-
-  console.log(routers)
-}
-
-main()

package/example/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-      "target": "es2020",
-      "module": "commonjs",
-      "strict": true,
-      "esModuleInterop": true,
-      "skipLibCheck": true,
-      "forceConsistentCasingInFileNames": true,
-      "outDir": "./dist"
-  },
-  "include": ["examples/**/*"]
-}

package/jest.config.mjs

@@ -1,13 +0,0 @@
-// jest.config.mjs
-export default {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.tsx?$': ['ts-jest', {
-      tsconfig: './tsconfig.json'
-    }]
-  },
-  moduleNameMapper: {
-    '^~/(.*)$': '<rootDir>/src/$1'
-  }
-};