aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/packages/pools/pools.d.ts

@@ -1,405 +0,0 @@
-import { ApiCreatePoolBody, ApiPoolObjectIdForLpCoinTypeBody, ApiPublishLpCoinBody, Balance, CoinType, PoolDepositEvent, PoolWithdrawEvent, Slippage, ObjectId, PoolStats, ApiPoolsStatsBody, ApiPoolsOwnedDaoFeePoolOwnerCapsBody, PoolLpInfo, SuiAddress, ApiIndexerEventsBody, CallerConfig } from "../../types";
-import { Pool } from "./pool";
-import { Caller } from "../../general/utils/caller";
-import { AftermathApi } from "../../general/providers";
-/**
- * The `Pools` class provides a high-level interface for interacting with
- * Aftermath Finance liquidity pools. It allows fetching individual or multiple
- * pools, managing liquidity pool tokens (LP tokens), and creating new pools
- * if you have the required privileges.
- *
- * @example
- * ```typescript
- * const afSdk = new Aftermath("MAINNET");
- * await afSdk.init(); // initialize provider
- *
- * const pools = afSdk.Pools();
- *
- * // Fetch a single pool
- * const pool = await pools.getPool({ objectId: "0x<poolId>" });
- *
- * // Fetch multiple pools
- * const poolArray = await pools.getPools({ objectIds: ["0x<id1>", "0x<id2>"] });
- * ```
- */
-export declare class Pools extends Caller {
-    readonly Provider?: AftermathApi | undefined;
-    /**
-     * Static constants relevant to the pool logic, such as protocol fees,
-     * referral percentages, and bounds for trading/withdrawal percentages.
-     */
-    static readonly constants: {
-        /**
-         * Protocol fee structure: `totalProtocol` is the fraction of trades
-         * that is taken as a fee, which is split among `treasury`, `insuranceFund`,
-         * and `devWallet` in the given proportions.
-         */
-        feePercentages: {
-            /**
-             * The total fraction (as a decimal) of trades charged by the protocol.
-             * e.g., 0.00005 => 0.005%.
-             */
-            totalProtocol: number;
-            /**
-             * The fraction of `totalProtocol` allocated to the treasury.
-             */
-            treasury: number;
-            /**
-             * The fraction of `totalProtocol` allocated to the insurance fund.
-             */
-            insuranceFund: number;
-            /**
-             * The fraction of `totalProtocol` allocated to the dev wallet.
-             */
-            devWallet: number;
-        };
-        /**
-         * Referral fee structures, applying a discount/rebate to the user and
-         * referrer, taken from the treasury portion of protocol fees.
-         */
-        referralPercentages: {
-            /**
-             * The fraction of the treasury portion that discounts the user's fee.
-             */
-            discount: number;
-            /**
-             * The fraction of the treasury portion that acts as a rebate to the referrer.
-             */
-            rebate: number;
-        };
-        /**
-         * Various bounds used to prevent extreme trades or invalid pool configurations.
-         */
-        bounds: {
-            /**
-             * Maximum number of distinct coins allowed in a single pool.
-             */
-            maxCoinsInPool: number;
-            /**
-             * Maximum fraction (decimal) of a pool's balance that can be traded at once.
-             */
-            maxTradePercentageOfPoolBalance: number;
-            /**
-             * Maximum fraction (decimal) of a pool's balance that can be withdrawn at once.
-             */
-            maxWithdrawPercentageOfPoolBalance: number;
-            /**
-             * Minimum and maximum swap fees (0.01% to 10%).
-             */
-            minSwapFee: number;
-            maxSwapFee: number;
-            /**
-             * Minimum and maximum coin weight for weighted pools (1% to 99%).
-             */
-            minWeight: number;
-            maxWeight: number;
-            /**
-             * Minimum and maximum DAO fee (0% to 100%).
-             */
-            minDaoFee: number;
-            maxDaoFee: number;
-        };
-        /**
-         * Default parameter(s) used in the absence of explicit user or code settings.
-         */
-        defaults: {
-            /**
-             * Default decimals for LP coins if none are specified.
-             */
-            lpCoinDecimals: number;
-        };
-    };
-    /**
-     * Creates a new `Pools` instance for querying and managing AMM pools on Aftermath.
-     *
-     * @param config - Optional configuration object specifying network or access token.
-     * @param Provider - An optional `AftermathApi` instance providing advanced transaction building.
-     */
-    constructor(config?: CallerConfig, Provider?: AftermathApi | undefined);
-    /**
-     * Fetches a single pool by its on-chain `objectId` and returns a new `Pool` instance.
-     *
-     * @param inputs - An object containing `objectId`.
-     * @returns A promise that resolves to a `Pool` instance.
-     *
-     * @example
-     * ```typescript
-     * const pool = await pools.getPool({ objectId: "0x<poolId>" });
-     * console.log(pool.pool.lpCoinType, pool.pool.name);
-     * ```
-     */
-    getPool(inputs: {
-        objectId: ObjectId;
-    }): Promise<Pool>;
-    /**
-     * Fetches multiple pools by their on-chain `objectIds` and returns an array of `Pool` instances.
-     *
-     * @param inputs - An object containing an array of `objectIds`.
-     * @returns A promise that resolves to an array of `Pool` instances.
-     *
-     * @example
-     * ```typescript
-     * const poolArray = await pools.getPools({ objectIds: ["0x<id1>", "0x<id2>"] });
-     * console.log(poolArray.length);
-     * ```
-     */
-    getPools(inputs: {
-        objectIds: ObjectId[];
-    }): Promise<Pool[]>;
-    /**
-     * Retrieves all pools recognized by the Aftermath API, returning an array of `Pool` objects.
-     *
-     * @returns An array of `Pool` instances.
-     *
-     * @example
-     * ```typescript
-     * const allPools = await pools.getAllPools();
-     * console.log(allPools.map(p => p.pool.name));
-     * ```
-     */
-    getAllPools(): Promise<Pool[]>;
-    /**
-     * Fetches information about all owned LP coins for a given wallet address.
-     * This indicates the user's liquidity positions across multiple pools.
-     *
-     * @param inputs - An object containing the `walletAddress`.
-     * @returns A `PoolLpInfo` object summarizing the user's LP balances.
-     *
-     * @example
-     * ```typescript
-     * const lpCoins = await pools.getOwnedLpCoins({ walletAddress: "0x<address>" });
-     * console.log(lpCoins);
-     * ```
-     */
-    getOwnedLpCoins(inputs: {
-        walletAddress: SuiAddress;
-    }): Promise<PoolLpInfo>;
-    /**
-     * Constructs or fetches a transaction to publish a new LP coin package,
-     * typically used by advanced users or devs establishing new liquidity pools.
-     *
-     * @param inputs - Includes the user `walletAddress` and the `lpCoinDecimals`.
-     * @returns A transaction object (or data) that can be signed and published to Sui.
-     *
-     * @example
-     * ```typescript
-     * const publishTx = await pools.getPublishLpCoinTransaction({
-     *   walletAddress: "0x<address>",
-     *   lpCoinDecimals: 9
-     * });
-     * ```
-     */
-    getPublishLpCoinTransaction(inputs: ApiPublishLpCoinBody): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Constructs a transaction to create a brand new pool on-chain, given coin types,
-     * initial weights, fees, and possible DAO fee info.
-     *
-     * @param inputs - The body describing how to form the new pool.
-     * @returns A transaction object that can be signed and executed.
-     *
-     * @example
-     * ```typescript
-     * const createPoolTx = await pools.getCreatePoolTransaction({
-     *   walletAddress: "0x<address>",
-     *   lpCoinType: "0x<lpCoin>",
-     *   lpCoinMetadata: {
-     *     name: "MyPool LP",
-     *     symbol: "MYPLP"
-     *   },
-     *   coinsInfo: [
-     *     {
-     *       coinType: "0x<coinA>",
-     *       weight: 0.5,
-     *       decimals: 9,
-     *       tradeFeeIn: 0.003,
-     *       initialDeposit: 1_000_000_000n
-     *     },
-     *     // ...
-     *   ],
-     *   poolName: "My Weighted Pool",
-     *   createPoolCapId: "0x<capId>",
-     *   respectDecimals: true,
-     * });
-     * ```
-     */
-    getCreatePoolTransaction(inputs: ApiCreatePoolBody): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Retrieves the on-chain pool object ID corresponding to a specific LP coin type.
-     *
-     * @param inputs - Contains the `lpCoinType` string.
-     * @returns The pool object ID if it exists.
-     *
-     * @example
-     * ```typescript
-     * const poolId = await pools.getPoolObjectIdForLpCoinType({
-     *   lpCoinType: "0x<lpCoinType>"
-     * });
-     * console.log(poolId);
-     * ```
-     */
-    getPoolObjectIdForLpCoinType: (inputs: {
-        lpCoinType: CoinType;
-    }) => Promise<(string | undefined)[]>;
-    /**
-     * Retrieves multiple pool object IDs given an array of LP coin types.
-     * If a given LP coin type has no associated pool, it might return `undefined`.
-     *
-     * @param inputs - Contains an array of `lpCoinTypes`.
-     * @returns An array of `ObjectId | undefined` of matching length.
-     *
-     * @example
-     * ```typescript
-     * const poolIds = await pools.getPoolObjectIdsForLpCoinTypes({
-     *   lpCoinTypes: ["0x<lpCoinA>", "0x<lpCoinB>"]
-     * });
-     * console.log(poolIds);
-     * ```
-     */
-    getPoolObjectIdsForLpCoinTypes(inputs: ApiPoolObjectIdForLpCoinTypeBody): Promise<(ObjectId | undefined)[]>;
-    /**
-     * Checks if a given coin type is recognized as an LP coin.
-     * Internally calls `getPoolObjectIdForLpCoinType`.
-     *
-     * @param inputs - Contains the `lpCoinType` to check.
-     * @returns `true` if the coin is an LP token, `false` otherwise.
-     */
-    isLpCoinType: (inputs: {
-        lpCoinType: CoinType;
-    }) => Promise<boolean>;
-    /**
-     * Retrieves the total volume across all pools in the last 24 hours.
-     *
-     * @returns A promise resolving to a numeric volume (e.g., in USD).
-     *
-     * @example
-     * ```typescript
-     * const totalVol24 = await pools.getTotalVolume24hrs();
-     * console.log("Protocol-wide 24h volume:", totalVol24);
-     * ```
-     */
-    getTotalVolume24hrs: () => Promise<number>;
-    /**
-     * Retrieves the total value locked (TVL) across all or specific pool IDs.
-     *
-     * @param inputs - Optionally provide an array of specific `poolIds`. If omitted, returns global TVL.
-     * @returns A promise resolving to a numeric TVL (e.g., in USD).
-     *
-     * @example
-     * ```typescript
-     * const allTvl = await pools.getTVL();
-     * const subsetTvl = await pools.getTVL({ poolIds: ["0x<id1>", "0x<id2>"] });
-     * ```
-     */
-    getTVL(inputs?: {
-        poolIds?: ObjectId[];
-    }): Promise<number>;
-    /**
-     * Fetches an array of `PoolStats` objects for a given set of pools,
-     * including volume, fees, TVL, and other metrics.
-     *
-     * @param inputs - Must include an array of `poolIds`.
-     * @returns An array of `PoolStats` in matching order.
-     *
-     * @example
-     * ```typescript
-     * const stats = await pools.getPoolsStats({ poolIds: ["0x<id1>", "0x<id2>"] });
-     * console.log(stats[0].volume, stats[1].tvl);
-     * ```
-     */
-    getPoolsStats(inputs: ApiPoolsStatsBody): Promise<PoolStats[]>;
-    /**
-     * Returns all DAO fee pool owner capabilities owned by a particular user.
-     * This is used to see which pools' DAO fees the user can update.
-     *
-     * @param inputs - An object with user `walletAddress`.
-     * @returns Data about each `DaoFeePoolOwnerCapObject` the user owns.
-     *
-     * @example
-     * ```typescript
-     * const daoCaps = await pools.getOwnedDaoFeePoolOwnerCaps({
-     *   walletAddress: "0x<address>"
-     * });
-     * console.log(daoCaps);
-     * ```
-     */
-    getOwnedDaoFeePoolOwnerCaps(inputs: ApiPoolsOwnedDaoFeePoolOwnerCapsBody): Promise<import("./poolsTypes").DaoFeePoolOwnerCapObject[]>;
-    /**
-     * Fetches user-specific interaction events (deposits, withdrawals) across pools,
-     * optionally with pagination.
-     *
-     * @param inputs - An object containing `walletAddress`, plus optional pagination (`cursor`, `limit`).
-     * @returns An event set with a cursor for further queries if available.
-     *
-     * @example
-     * ```typescript
-     * const userEvents = await pools.getInteractionEvents({
-     *   walletAddress: "0x...",
-     *   limit: 10,
-     * });
-     * console.log(userEvents.events, userEvents.nextCursor);
-     * ```
-     */
-    getInteractionEvents(inputs: ApiIndexerEventsBody & {
-        walletAddress: SuiAddress;
-    }): Promise<import("../../types").IndexerEventsWithCursor<PoolDepositEvent | PoolWithdrawEvent>>;
-    /**
-     * Returns how much coin remains **after** applying the protocol fees
-     * (and referral discount if `withReferral` is `true`).
-     *
-     * @param inputs - The original `amount` and an optional referral flag.
-     * @returns The post-fee (net) amount as a bigint.
-     *
-     * @example
-     * ```typescript
-     * const netAmount = Pools.getAmountWithProtocolFees({ amount: 1_000_000n });
-     * ```
-     */
-    static getAmountWithProtocolFees: (inputs: {
-        amount: Balance;
-        withReferral?: boolean;
-    }) => bigint;
-    /**
-     * The inverse calculation: given a net amount (post-fees), figure out
-     * the original gross amount. Used when we already have fees subtracted
-     * but need to restore an original quantity.
-     *
-     * @param inputs - The net `amount` after fees, plus an optional referral flag.
-     * @returns The original gross amount as a bigint.
-     */
-    static getAmountWithoutProtocolFees: (inputs: {
-        amount: Balance;
-        withReferral?: boolean;
-    }) => bigint;
-    /**
-     * A helper to transform a user-provided slippage fraction, e.g. 0.01,
-     * into a 1 - slippage format, if needed for certain math operations.
-     *
-     * @param slippage - The decimal fraction of slippage tolerance, e.g. 0.01 => 1%.
-     * @returns A big integer representing `1 - slippage` in a fixed context.
-     */
-    static normalizeInvertSlippage: (slippage: Slippage) => bigint;
-    /**
-     * Produces a user-friendly string for an LP coin type, e.g. "Sui Coin LP"
-     * by analyzing the coin type symbol. Typically used in UIs or logs.
-     *
-     * @param lpCoinType - The coin type for the LP token.
-     * @returns A string representation for display, e.g. "Af_lp_abc" => "Abc LP".
-     */
-    static displayLpCoinType: (lpCoinType: CoinType) => string;
-    /**
-     * A quick heuristic check to see if the given `lpCoinType` string
-     * might represent an Aftermath LP token. This is not a full on-chain validation.
-     *
-     * @param inputs - An object containing `lpCoinType`.
-     * @returns `true` if it matches a known pattern; otherwise `false`.
-     */
-    static isPossibleLpCoinType: (inputs: {
-        lpCoinType: CoinType;
-    }) => boolean;
-    /**
-     * Provides a typed reference to the `Pools` part of the `AftermathApi`,
-     * throwing an error if not defined.
-     */
-    private useProvider;
-}
-//# sourceMappingURL=pools.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"pools.d.ts","sourceRoot":"","sources":["../../../src/packages/pools/pools.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EAEjB,gCAAgC,EAChC,oBAAoB,EACpB,OAAO,EACP,QAAQ,EACR,gBAAgB,EAIhB,iBAAiB,EACjB,QAAQ,EAGR,QAAQ,EACR,SAAS,EACT,iBAAiB,EACjB,oCAAoC,EACpC,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,YAAY,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,KAAM,SAAQ,MAAM;aAuGf,QAAQ,CAAC,EAAE,YAAY;IAlGxC;;;OAGG;IACH,gBAAuB,SAAS;QAC/B;;;;WAIG;;YAEF;;;eAGG;;YAEH;;eAEG;;YAEH;;eAEG;;YAEH;;eAEG;;;QAGJ;;;WAGG;;YAEF;;eAEG;;YAEH;;eAEG;;;QAGJ;;WAEG;;YAEF;;eAEG;;YAEH;;eAEG;;YAEH;;eAEG;;YAEH;;eAEG;;;YAGH;;eAEG;;;YAGH;;eAEG;;;;QAIJ;;WAEG;;YAEF;;eAEG;;;MAGH;IAMF;;;;;OAKG;gBAEF,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,EAAE,YAAY,YAAA;IAaxC;;;;;;;;;;;OAWG;IACU,OAAO,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE;IAKnD;;;;;;;;;;;OAWG;IACU,QAAQ,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,QAAQ,EAAE,CAAA;KAAE;IAYvD;;;;;;;;;;OAUG;IACU,WAAW;IAKxB;;;;;;;;;;;;OAYG;IACU,eAAe,CAAC,MAAM,EAAE;QACpC,aAAa,EAAE,UAAU,CAAC;KAC1B,GAAG,OAAO,CAAC,UAAU,CAAC;IAQvB;;;;;;;;;;;;;;OAcG;IACU,2BAA2B,CAAC,MAAM,EAAE,oBAAoB;IAIrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACU,wBAAwB,CAAC,MAAM,EAAE,iBAAiB;IAQ/D;;;;;;;;;;;;;OAaG;IACI,4BAA4B,GAAI,QAAQ;QAC9C,UAAU,EAAE,QAAQ,CAAC;KACrB,qCAIC;IAEF;;;;;;;;;;;;;;OAcG;IACU,8BAA8B,CAC1C,MAAM,EAAE,gCAAgC,GACtC,OAAO,CAAC,CAAC,QAAQ,GAAG,SAAS,CAAC,EAAE,CAAC;IAOpC;;;;;;OAMG;IACI,YAAY,GAAU,QAAQ;QAAE,UAAU,EAAE,QAAQ,CAAA;KAAE,sBAO3D;IAEF;;;;;;;;;;OAUG;IACI,mBAAmB,QAAa,OAAO,CAAC,MAAM,CAAC,CAEpD;IAEF;;;;;;;;;;;OAWG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE;;;;;;;;;;;;OAYG;IACU,aAAa,CACzB,MAAM,EAAE,iBAAiB,GACvB,OAAO,CAAC,SAAS,EAAE,CAAC;IAIvB;;;;;;;;;;;;;;OAcG;IACU,2BAA2B,CACvC,MAAM,EAAE,oCAAoC;IAS7C;;;;;;;;;;;;;;;OAeG;IACU,oBAAoB,CAChC,MAAM,EAAE,oBAAoB,GAAG;QAC9B,aAAa,EAAE,UAAU,CAAC;KAC1B;IAcF;;;;;;;;;;;OAWG;IACH,OAAc,yBAAyB,GAAI,QAAQ;QAClD,MAAM,EAAE,OAAO,CAAC;QAChB,YAAY,CAAC,EAAE,OAAO,CAAC;KACvB,YAeC;IAEF;;;;;;;OAOG;IACH,OAAc,4BAA4B,GAAI,QAAQ;QACrD,MAAM,EAAE,OAAO,CAAC;QAChB,YAAY,CAAC,EAAE,OAAO,CAAC;KACvB,YAgBC;IAEF;;;;;;OAMG;IACH,OAAc,uBAAuB,GAAI,UAAU,QAAQ,YACpB;IAMvC;;;;;;OAMG;IACH,OAAc,iBAAiB,GAAI,YAAY,QAAQ,KAAG,MAAM,CAM3C;IAMrB;;;;;;OAMG;IACH,OAAc,oBAAoB,GAAI,QAAQ;QAAE,UAAU,EAAE,QAAQ,CAAA;KAAE,aAOpE;IAMF;;;OAGG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}