aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/packages/router/router.d.ts

@@ -1,224 +0,0 @@
-import { ApiRouterTransactionForCompleteTradeRouteBody, RouterCompleteTradeRoute, ApiRouterTradeEventsBody, RouterTradeEvent, Balance, ApiRouterPartialCompleteTradeRouteBody, ApiRouterAddTransactionForCompleteTradeRouteBody, Slippage, CallerConfig } from "../../types";
-import { Caller } from "../../general/utils/caller";
-import { Transaction } from "@mysten/sui/transactions";
-/**
- * The `Router` class provides a collection of methods to interact with Aftermath's
- * smart order routing system on the Sui Network. It handles routing trades through
- * various liquidity pools to achieve the best possible execution price, retrieving
- * trade volume, managing supported coins, and more.
- *
- * @example
- * ```typescript
- * // Create provider
- * const router = (new Aftermath("MAINNET")).Router();
- * // Retrieve 24h volume
- * const volume24h = await router.getVolume24hrs();
- * // Get supported coins
- * const supportedCoins = await router.getSupportedCoins();
- * ```
- */
-export declare class Router extends Caller {
-    /**
-     * Contains static information about the router, such as the maximum
-     * allowable external fee percentage.
-     */
-    static readonly constants: {
-        /**
-         * The maximum external fee percentage that a third party can charge on router trades.
-         * @remarks 0.5 = 50%
-         */
-        maxExternalFeePercentage: number;
-    };
-    /**
-     * Creates a new `Router` instance to perform router-related calls on the
-     * Aftermath platform.
-     *
-     * @param config - Optional configuration settings, including network and access token.
-     * @returns A new `Router` instance.
-     *
-     * @example
-     * ```typescript
-     * const afSdk = new Aftermath("MAINNET");
-     * await afSdk.init(); // initialize provider
-     *
-     * const router = afSdk.Router();
-     * ```
-     */
-    constructor(config?: CallerConfig);
-    /**
-     * Retrieves the total trading volume in the last 24 hours.
-     *
-     * @returns A promise that resolves to a `number` representing the total volume in the last 24 hours.
-     *
-     * @example
-     * ```typescript
-     * const volume = await router.getVolume24hrs();
-     * console.log(volume); // e.g. 1234567.89
-     * ```
-     */
-    getVolume24hrs: () => Promise<number>;
-    /**
-     * Fetches a list of all coin types that are supported for trading through the router.
-     *
-     * @returns A promise that resolves to an array of coin types (`CoinType[]`).
-     *
-     * @example
-     * ```typescript
-     * const supportedCoins = await router.getSupportedCoins();
-     * console.log(supportedCoins); // ["0x2::sui::SUI", "0x<...>::coin::TOKEN", ...]
-     * ```
-     */
-    getSupportedCoins(): Promise<string[]>;
-    /**
-     * Searches the supported coins by applying a filter string.
-     *
-     * @param inputs - An object containing a `filter` string to match against supported coins.
-     * @param abortSignal - An optional `AbortSignal` to cancel the request if needed.
-     * @returns A promise that resolves to an array of coin types matching the filter.
-     *
-     * @example
-     * ```typescript
-     * const searchResult = await router.searchSupportedCoins({ filter: "SUI" });
-     * console.log(searchResult); // e.g. ["0x2::sui::SUI"]
-     * ```
-     */
-    searchSupportedCoins(inputs: {
-        filter: string;
-    }, abortSignal?: AbortSignal): Promise<string[]>;
-    /**
-     * Creates an optimal trade route for a given token input (`coinInType`) with a
-     * specified input amount (`coinInAmount`). This route may consist of multiple
-     * swaps across different DEX protocols to achieve the best price.
-     *
-     * @param inputs - Details required to construct the trade route, including `coinInType`, `coinOutType`, and `coinInAmount`.
-     * @param abortSignal - An optional signal to abort the request if needed.
-     * @returns A promise resolving to a `RouterCompleteTradeRoute` object containing the full route details.
-     *
-     * @example
-     * ```typescript
-     * const route = await router.getCompleteTradeRouteGivenAmountIn({
-     *   coinInType: "0x2::sui::SUI",
-     *   coinOutType: "0x<...>::coin::TOKEN",
-     *   coinInAmount: BigInt(10_000_000_000),
-     *   // optional fields:
-     *   referrer: "0x<referrer_address>",
-     *   externalFee: {
-     *     recipient: "0x<fee_collector>",
-     *     feePercentage: 0.01
-     *   },
-     *   protocolBlacklist: ["Cetus", "BlueMove"],
-     *   poolBlacklist: ["0x<pool_id>"]
-     * });
-     * console.log(route);
-     * ```
-     */
-    getCompleteTradeRouteGivenAmountIn(inputs: ApiRouterPartialCompleteTradeRouteBody & {
-        /**
-         * Amount of coin being given away
-         */
-        coinInAmount: Balance;
-    }, abortSignal?: AbortSignal): Promise<RouterCompleteTradeRoute>;
-    /**
-     * Creates an optimal trade route for a given token output (`coinOutType`) with a
-     * specified output amount (`coinOutAmount`). This route may consist of multiple
-     * swaps to achieve the target output amount, factoring in slippage.
-     *
-     * @param inputs - Details required to construct the trade route, including `coinInType`, `coinOutType`, `coinOutAmount`, and `slippage`.
-     * @param abortSignal - An optional signal to abort the request if needed.
-     * @returns A promise resolving to a `RouterCompleteTradeRoute` object containing the full route details.
-     *
-     * @example
-     * ```typescript
-     * const route = await router.getCompleteTradeRouteGivenAmountOut({
-     *   coinInType: "0x2::sui::SUI",
-     *   coinOutType: "0x<...>::coin::TOKEN",
-     *   coinOutAmount: BigInt(20_000_000),
-     *   slippage: 0.01, // 1%
-     *   protocolWhitelist: ["Aftermath", "Cetus"],
-     *   poolWhitelist: ["0x<pool_id>"]
-     * });
-     * console.log(route);
-     * ```
-     */
-    getCompleteTradeRouteGivenAmountOut(inputs: ApiRouterPartialCompleteTradeRouteBody & {
-        /**
-         * Amount of coin expected to receive
-         */
-        coinOutAmount: Balance;
-        slippage: Slippage;
-    }, abortSignal?: AbortSignal): Promise<RouterCompleteTradeRoute>;
-    /**
-     * Generates a transaction to execute a previously calculated complete trade route.
-     * This transaction can then be signed and executed by the user.
-     *
-     * @param inputs - An object containing the wallet address, the complete trade route, slippage tolerance, and optional sponsorship settings.
-     * @returns A promise resolving to a `Uint8Array` representing the serialized transaction.
-     *
-     * @example
-     * ```typescript
-     * const route = await router.getCompleteTradeRouteGivenAmountIn({ ... });
-     * const transactionBytes = await router.getTransactionForCompleteTradeRoute({
-     *   walletAddress: "0x<your_address>",
-     *   completeRoute: route,
-     *   slippage: 0.01
-     * });
-     * // The returned bytes can now be signed and executed using your chosen wallet.
-     * ```
-     */
-    getTransactionForCompleteTradeRoute(inputs: ApiRouterTransactionForCompleteTradeRouteBody): Promise<Transaction>;
-    /**
-     * Adds a trade route to an existing transaction, allowing you to build complex
-     * transactions containing multiple actions (swaps, transfers, etc.) in a single
-     * atomic transaction.
-     *
-     * @param inputs - Includes the existing `Transaction`, a complete route, slippage, wallet address, and an optional `coinInId`.
-     * @returns An object containing:
-     *  - `tx`: The updated `Transaction` including the route instructions
-     *  - `coinOutId`: A `TransactionObjectArgument` referencing the output coin after the swap
-     *
-     * @example
-     * ```typescript
-     * // 1) Create a route
-     * const route = await router.getCompleteTradeRouteGivenAmountIn({ ... });
-     *
-     * // 2) Initialize your transaction
-     * const tx = new Transaction();
-     *
-     * // 3) Add router instructions
-     * const { tx: updatedTx, coinOutId } =
-     *   await router.addTransactionForCompleteTradeRoute({
-     *     tx,
-     *     completeRoute: route,
-     *     slippage: 0.01,
-     *     walletAddress: "0x<your_address>"
-     * });
-     *
-     * // 4) Continue building your transaction with the resulting coinOutId, if desired
-     * updatedTx.transferObjects([coinOutId!], "0x<your_address>");
-     * ```
-     */
-    addTransactionForCompleteTradeRoute(inputs: Omit<ApiRouterAddTransactionForCompleteTradeRouteBody, "serializedTx"> & {
-        tx: Transaction;
-    }): Promise<{
-        tx: Transaction;
-        coinOutId: import("@mysten/sui/transactions").TransactionObjectArgument | undefined;
-    }>;
-    /**
-     * Retrieves trade events (interactions) for a given user based on router usage.
-     *
-     * @param inputs - Includes a `walletAddress`, cursor pagination, and limit.
-     * @returns A promise resolving to the user's `RouterTradeEvent`s, potentially paginated.
-     *
-     * @example
-     * ```typescript
-     * const events = await router.getInteractionEvents({
-     *   walletAddress: "0x<your_address>",
-     *   cursor: 0,
-     *   limit: 10
-     * });
-     * console.log(events);
-     * ```
-     */
-    getInteractionEvents(inputs: ApiRouterTradeEventsBody): Promise<import("../../types").IndexerEventsWithCursor<RouterTradeEvent>>;
-}
-//# sourceMappingURL=router.d.ts.map

package/dist/packages/router/router.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../../src/packages/router/router.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,6CAA6C,EAE7C,wBAAwB,EAExB,wBAAwB,EACxB,gBAAgB,EAChB,OAAO,EACP,sCAAsC,EACtC,gDAAgD,EAGhD,QAAQ,EAER,YAAY,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,MAAO,SAAQ,MAAM;IAKjC;;;OAGG;IACH,gBAAuB,SAAS;QAC/B;;;WAGG;;MAEF;IAMF;;;;;;;;;;;;;;OAcG;gBACS,MAAM,CAAC,EAAE,YAAY;IAYjC;;;;;;;;;;OAUG;IACI,cAAc,QAAa,OAAO,CAAC,MAAM,CAAC,CAE/C;IAEF;;;;;;;;;;OAUG;IACU,iBAAiB;IAI9B;;;;;;;;;;;;OAYG;IACU,oBAAoB,CAChC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAC1B,WAAW,CAAC,EAAE,WAAW;IAS1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,kCAAkC,CAC9C,MAAM,EAAE,sCAAsC,GAAG;QAChD;;WAEG;QACH,YAAY,EAAE,OAAO,CAAC;KACtB,EACD,WAAW,CAAC,EAAE,WAAW;IAQ1B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,mCAAmC,CAC/C,MAAM,EAAE,sCAAsC,GAAG;QAChD;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QACvB,QAAQ,EAAE,QAAQ,CAAC;KACnB,EACD,WAAW,CAAC,EAAE,WAAW;IAY1B;;;;;;;;;;;;;;;;;OAiBG;IACU,mCAAmC,CAC/C,MAAM,EAAE,6CAA6C;IAQtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,mCAAmC,CAC/C,MAAM,EAAE,IAAI,CACX,gDAAgD,EAChD,cAAc,CACd,GAAG;QACH,EAAE,EAAE,WAAW,CAAC;KAChB;;;;IAoBF;;;;;;;;;;;;;;;OAeG;IACU,oBAAoB,CAAC,MAAM,EAAE,wBAAwB;CAMlE"}

package/dist/packages/router/router.js

@@ -1,283 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Router = void 0;
-const caller_1 = require("../../general/utils/caller");
-const transactions_1 = require("@mysten/sui/transactions");
-/**
- * The `Router` class provides a collection of methods to interact with Aftermath's
- * smart order routing system on the Sui Network. It handles routing trades through
- * various liquidity pools to achieve the best possible execution price, retrieving
- * trade volume, managing supported coins, and more.
- *
- * @example
- * ```typescript
- * // Create provider
- * const router = (new Aftermath("MAINNET")).Router();
- * // Retrieve 24h volume
- * const volume24h = await router.getVolume24hrs();
- * // Get supported coins
- * const supportedCoins = await router.getSupportedCoins();
- * ```
- */
-class Router extends caller_1.Caller {
-    // =========================================================================
-    //  Constructor
-    // =========================================================================
-    /**
-     * Creates a new `Router` instance to perform router-related calls on the
-     * Aftermath platform.
-     *
-     * @param config - Optional configuration settings, including network and access token.
-     * @returns A new `Router` instance.
-     *
-     * @example
-     * ```typescript
-     * const afSdk = new Aftermath("MAINNET");
-     * await afSdk.init(); // initialize provider
-     *
-     * const router = afSdk.Router();
-     * ```
-     */
-    constructor(config) {
-        super(config, "router");
-        // =========================================================================
-        //  Public Methods
-        // =========================================================================
-        // =========================================================================
-        //  Inspections
-        // =========================================================================
-        /**
-         * Retrieves the total trading volume in the last 24 hours.
-         *
-         * @returns A promise that resolves to a `number` representing the total volume in the last 24 hours.
-         *
-         * @example
-         * ```typescript
-         * const volume = await router.getVolume24hrs();
-         * console.log(volume); // e.g. 1234567.89
-         * ```
-         */
-        this.getVolume24hrs = () => __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApi("volume-24hrs");
-        });
-    }
-    /**
-     * Fetches a list of all coin types that are supported for trading through the router.
-     *
-     * @returns A promise that resolves to an array of coin types (`CoinType[]`).
-     *
-     * @example
-     * ```typescript
-     * const supportedCoins = await router.getSupportedCoins();
-     * console.log(supportedCoins); // ["0x2::sui::SUI", "0x<...>::coin::TOKEN", ...]
-     * ```
-     */
-    getSupportedCoins() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApi("supported-coins");
-        });
-    }
-    /**
-     * Searches the supported coins by applying a filter string.
-     *
-     * @param inputs - An object containing a `filter` string to match against supported coins.
-     * @param abortSignal - An optional `AbortSignal` to cancel the request if needed.
-     * @returns A promise that resolves to an array of coin types matching the filter.
-     *
-     * @example
-     * ```typescript
-     * const searchResult = await router.searchSupportedCoins({ filter: "SUI" });
-     * console.log(searchResult); // e.g. ["0x2::sui::SUI"]
-     * ```
-     */
-    searchSupportedCoins(inputs, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApi(`supported-coins/${inputs.filter}`, undefined, abortSignal);
-        });
-    }
-    /**
-     * Creates an optimal trade route for a given token input (`coinInType`) with a
-     * specified input amount (`coinInAmount`). This route may consist of multiple
-     * swaps across different DEX protocols to achieve the best price.
-     *
-     * @param inputs - Details required to construct the trade route, including `coinInType`, `coinOutType`, and `coinInAmount`.
-     * @param abortSignal - An optional signal to abort the request if needed.
-     * @returns A promise resolving to a `RouterCompleteTradeRoute` object containing the full route details.
-     *
-     * @example
-     * ```typescript
-     * const route = await router.getCompleteTradeRouteGivenAmountIn({
-     *   coinInType: "0x2::sui::SUI",
-     *   coinOutType: "0x<...>::coin::TOKEN",
-     *   coinInAmount: BigInt(10_000_000_000),
-     *   // optional fields:
-     *   referrer: "0x<referrer_address>",
-     *   externalFee: {
-     *     recipient: "0x<fee_collector>",
-     *     feePercentage: 0.01
-     *   },
-     *   protocolBlacklist: ["Cetus", "BlueMove"],
-     *   poolBlacklist: ["0x<pool_id>"]
-     * });
-     * console.log(route);
-     * ```
-     */
-    getCompleteTradeRouteGivenAmountIn(inputs, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApi("trade-route", inputs, abortSignal);
-        });
-    }
-    /**
-     * Creates an optimal trade route for a given token output (`coinOutType`) with a
-     * specified output amount (`coinOutAmount`). This route may consist of multiple
-     * swaps to achieve the target output amount, factoring in slippage.
-     *
-     * @param inputs - Details required to construct the trade route, including `coinInType`, `coinOutType`, `coinOutAmount`, and `slippage`.
-     * @param abortSignal - An optional signal to abort the request if needed.
-     * @returns A promise resolving to a `RouterCompleteTradeRoute` object containing the full route details.
-     *
-     * @example
-     * ```typescript
-     * const route = await router.getCompleteTradeRouteGivenAmountOut({
-     *   coinInType: "0x2::sui::SUI",
-     *   coinOutType: "0x<...>::coin::TOKEN",
-     *   coinOutAmount: BigInt(20_000_000),
-     *   slippage: 0.01, // 1%
-     *   protocolWhitelist: ["Aftermath", "Cetus"],
-     *   poolWhitelist: ["0x<pool_id>"]
-     * });
-     * console.log(route);
-     * ```
-     */
-    getCompleteTradeRouteGivenAmountOut(inputs, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApi("trade-route", inputs, abortSignal);
-        });
-    }
-    // =========================================================================
-    //  Transactions
-    // =========================================================================
-    /**
-     * Generates a transaction to execute a previously calculated complete trade route.
-     * This transaction can then be signed and executed by the user.
-     *
-     * @param inputs - An object containing the wallet address, the complete trade route, slippage tolerance, and optional sponsorship settings.
-     * @returns A promise resolving to a `Uint8Array` representing the serialized transaction.
-     *
-     * @example
-     * ```typescript
-     * const route = await router.getCompleteTradeRouteGivenAmountIn({ ... });
-     * const transactionBytes = await router.getTransactionForCompleteTradeRoute({
-     *   walletAddress: "0x<your_address>",
-     *   completeRoute: route,
-     *   slippage: 0.01
-     * });
-     * // The returned bytes can now be signed and executed using your chosen wallet.
-     * ```
-     */
-    getTransactionForCompleteTradeRoute(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApiTransaction("transactions/trade", inputs);
-        });
-    }
-    /**
-     * Adds a trade route to an existing transaction, allowing you to build complex
-     * transactions containing multiple actions (swaps, transfers, etc.) in a single
-     * atomic transaction.
-     *
-     * @param inputs - Includes the existing `Transaction`, a complete route, slippage, wallet address, and an optional `coinInId`.
-     * @returns An object containing:
-     *  - `tx`: The updated `Transaction` including the route instructions
-     *  - `coinOutId`: A `TransactionObjectArgument` referencing the output coin after the swap
-     *
-     * @example
-     * ```typescript
-     * // 1) Create a route
-     * const route = await router.getCompleteTradeRouteGivenAmountIn({ ... });
-     *
-     * // 2) Initialize your transaction
-     * const tx = new Transaction();
-     *
-     * // 3) Add router instructions
-     * const { tx: updatedTx, coinOutId } =
-     *   await router.addTransactionForCompleteTradeRoute({
-     *     tx,
-     *     completeRoute: route,
-     *     slippage: 0.01,
-     *     walletAddress: "0x<your_address>"
-     * });
-     *
-     * // 4) Continue building your transaction with the resulting coinOutId, if desired
-     * updatedTx.transferObjects([coinOutId!], "0x<your_address>");
-     * ```
-     */
-    addTransactionForCompleteTradeRoute(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { tx } = inputs, otherInputs = __rest(inputs, ["tx"]);
-            const { tx: newTx, coinOutId } = yield this.fetchApi("transactions/add-trade", Object.assign(Object.assign({}, otherInputs), { serializedTx: tx.serialize() }));
-            return {
-                tx: transactions_1.Transaction.from(newTx),
-                coinOutId,
-            };
-        });
-    }
-    // =========================================================================
-    //  Events
-    // =========================================================================
-    /**
-     * Retrieves trade events (interactions) for a given user based on router usage.
-     *
-     * @param inputs - Includes a `walletAddress`, cursor pagination, and limit.
-     * @returns A promise resolving to the user's `RouterTradeEvent`s, potentially paginated.
-     *
-     * @example
-     * ```typescript
-     * const events = await router.getInteractionEvents({
-     *   walletAddress: "0x<your_address>",
-     *   cursor: 0,
-     *   limit: 10
-     * });
-     * console.log(events);
-     * ```
-     */
-    getInteractionEvents(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApiIndexerEvents("events-by-user", inputs);
-        });
-    }
-}
-exports.Router = Router;
-// =========================================================================
-//  Constants
-// =========================================================================
-/**
- * Contains static information about the router, such as the maximum
- * allowable external fee percentage.
- */
-Router.constants = {
-    /**
-     * The maximum external fee percentage that a third party can charge on router trades.
-     * @remarks 0.5 = 50%
-     */
-    maxExternalFeePercentage: 0.5,
-};