aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/general/prices/prices.d.ts

@@ -1,92 +0,0 @@
-import { CoinPriceInfo, CoinType, CoinsToPrice, CoinsToPriceInfo } from "../../packages/coin/coinTypes";
-import { Caller } from "../utils/caller";
-import { CallerConfig } from "../types";
-/**
- * The `Prices` class provides methods for fetching price information for various
- * coins on the Sui network, including single-coin or multi-coin queries.
- */
-export declare class Prices extends Caller {
-    /**
-     * Creates a new `Prices` instance for retrieving coin price data from
-     * Aftermath's backend or other data sources.
-     *
-     * @param config - Optional configuration, including network and access token.
-     */
-    constructor(config?: CallerConfig);
-    /**
-     * Retrieves detailed price information (including current price and 24h change)
-     * for a single coin.
-     *
-     * @param inputs - Contains the `coin` type (e.g., "0x2::sui::SUI").
-     * @returns A promise resolving to a `CoinPriceInfo` object.
-     *
-     * @example
-     * ```typescript
-     *
-     * const afSdk = new Aftermath("MAINNET");
-     * await afSdk.init(); // initialize provider
-     *
-     * const prices = afSdk.Prices();
-     *
-     * const suiPriceInfo = await prices.getCoinPriceInfo({
-     *   coin: "0x2::sui::SUI"
-     * });
-     * console.log(suiPriceInfo.price, suiPriceInfo.priceChange24HoursPercentage);
-     * ```
-     */
-    getCoinPriceInfo(inputs: {
-        coin: CoinType;
-    }): Promise<CoinPriceInfo>;
-    /**
-     * Retrieves detailed price information for multiple coins simultaneously,
-     * returning a record keyed by `CoinType`.
-     *
-     * @param inputs - An object containing an array of `coins`.
-     * @returns A promise resolving to a `CoinsToPriceInfo` mapping each coin type to its price info.
-     *
-     * @example
-     * ```typescript
-     * const prices = new Prices();
-     * const info = await prices.getCoinsToPriceInfo({
-     *   coins: ["0x2::sui::SUI", "0x<some_other_coin>"]
-     * });
-     * console.log(info);
-     * ```
-     */
-    getCoinsToPriceInfo(inputs: {
-        coins: CoinType[];
-    }): Promise<CoinsToPriceInfo>;
-    /**
-     * Fetches only the current price in USD for a single coin.
-     *
-     * @param inputs - Contains the `coin` type.
-     * @returns A promise resolving to a `number` representing the price in USD.
-     *
-     * @example
-     * ```typescript
-     * const prices = new Prices();
-     * const suiPrice = await prices.getCoinPrice({ coin: "0x2::sui::SUI" });
-     * console.log("SUI price in USD:", suiPrice);
-     * ```
-     */
-    getCoinPrice(inputs: {
-        coin: CoinType;
-    }): Promise<number>;
-    /**
-     * Fetches current prices in USD for multiple coins, returning a record keyed by `CoinType`.
-     *
-     * @param inputs - Contains an array of `coins`.
-     * @returns A promise resolving to a `CoinsToPrice` object mapping coin types to their prices in USD.
-     *
-     * @example
-     * ```typescript
-     * const prices = new Prices();
-     * const multiPrices = await prices.getCoinsToPrice({ coins: ["0x2::sui::SUI", "0x<other>"] });
-     * console.log(multiPrices["0x2::sui::SUI"]); // e.g. 1.23
-     * ```
-     */
-    getCoinsToPrice(inputs: {
-        coins: CoinType[];
-    }): Promise<CoinsToPrice>;
-}
-//# sourceMappingURL=prices.d.ts.map

package/dist/general/prices/prices.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"prices.d.ts","sourceRoot":"","sources":["../../../src/general/prices/prices.ts"],"names":[],"mappings":"AACA,OAAO,EACN,aAAa,EAGb,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAO,MAAM,UAAU,CAAC;AAE7C;;;GAGG;AACH,qBAAa,MAAO,SAAQ,MAAM;IAKjC;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,gBAAgB,CAAC,MAAM,EAAE;QACrC,IAAI,EAAE,QAAQ,CAAC;KACf,GAAG,OAAO,CAAC,aAAa,CAAC;IAO1B;;;;;;;;;;;;;;;OAeG;IACU,mBAAmB,CAAC,MAAM,EAAE;QACxC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7B;;;;;;;;;;;;OAYG;IACU,YAAY,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAKtE;;;;;;;;;;;;OAYG;IACU,eAAe,CAAC,MAAM,EAAE;QACpC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,YAAY,CAAC;CAazB"}

package/dist/general/prices/prices.js

@@ -1,124 +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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Prices = void 0;
-const caller_1 = require("../utils/caller");
-/**
- * The `Prices` class provides methods for fetching price information for various
- * coins on the Sui network, including single-coin or multi-coin queries.
- */
-class Prices extends caller_1.Caller {
-    // =========================================================================
-    //  Constructor
-    // =========================================================================
-    /**
-     * Creates a new `Prices` instance for retrieving coin price data from
-     * Aftermath's backend or other data sources.
-     *
-     * @param config - Optional configuration, including network and access token.
-     */
-    constructor(config) {
-        super(config, "price-info");
-    }
-    // =========================================================================
-    //  Prices
-    // =========================================================================
-    /**
-     * Retrieves detailed price information (including current price and 24h change)
-     * for a single coin.
-     *
-     * @param inputs - Contains the `coin` type (e.g., "0x2::sui::SUI").
-     * @returns A promise resolving to a `CoinPriceInfo` object.
-     *
-     * @example
-     * ```typescript
-     *
-     * const afSdk = new Aftermath("MAINNET");
-     * await afSdk.init(); // initialize provider
-     *
-     * const prices = afSdk.Prices();
-     *
-     * const suiPriceInfo = await prices.getCoinPriceInfo({
-     *   coin: "0x2::sui::SUI"
-     * });
-     * console.log(suiPriceInfo.price, suiPriceInfo.priceChange24HoursPercentage);
-     * ```
-     */
-    getCoinPriceInfo(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const coinsToPriceInfo = yield this.getCoinsToPriceInfo({
-                coins: [inputs.coin],
-            });
-            return Object.values(coinsToPriceInfo)[0];
-        });
-    }
-    /**
-     * Retrieves detailed price information for multiple coins simultaneously,
-     * returning a record keyed by `CoinType`.
-     *
-     * @param inputs - An object containing an array of `coins`.
-     * @returns A promise resolving to a `CoinsToPriceInfo` mapping each coin type to its price info.
-     *
-     * @example
-     * ```typescript
-     * const prices = new Prices();
-     * const info = await prices.getCoinsToPriceInfo({
-     *   coins: ["0x2::sui::SUI", "0x<some_other_coin>"]
-     * });
-     * console.log(info);
-     * ```
-     */
-    getCoinsToPriceInfo(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApi("", inputs);
-        });
-    }
-    /**
-     * Fetches only the current price in USD for a single coin.
-     *
-     * @param inputs - Contains the `coin` type.
-     * @returns A promise resolving to a `number` representing the price in USD.
-     *
-     * @example
-     * ```typescript
-     * const prices = new Prices();
-     * const suiPrice = await prices.getCoinPrice({ coin: "0x2::sui::SUI" });
-     * console.log("SUI price in USD:", suiPrice);
-     * ```
-     */
-    getCoinPrice(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const priceInfo = yield this.getCoinPriceInfo(inputs);
-            return priceInfo.price;
-        });
-    }
-    /**
-     * Fetches current prices in USD for multiple coins, returning a record keyed by `CoinType`.
-     *
-     * @param inputs - Contains an array of `coins`.
-     * @returns A promise resolving to a `CoinsToPrice` object mapping coin types to their prices in USD.
-     *
-     * @example
-     * ```typescript
-     * const prices = new Prices();
-     * const multiPrices = await prices.getCoinsToPrice({ coins: ["0x2::sui::SUI", "0x<other>"] });
-     * console.log(multiPrices["0x2::sui::SUI"]); // e.g. 1.23
-     * ```
-     */
-    getCoinsToPrice(inputs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const coinsToPriceInfo = yield this.getCoinsToPriceInfo(inputs);
-            const coinsToPrice = Object.entries(coinsToPriceInfo).reduce((acc, [coinType, info]) => (Object.assign(Object.assign({}, acc), { [coinType]: info.price })), {});
-            return coinsToPrice;
-        });
-    }
-}
-exports.Prices = Prices;

package/dist/general/providers/aftermath.d.ts

@@ -1,200 +0,0 @@
-import { Auth, LeveragedStaking, NftAmm, ReferralVault, Router, Sui } from "../../packages";
-import { Coin } from "../../packages/coin/coin";
-import { Dca } from "../../packages/dca/dca";
-import { Farms } from "../../packages/farms/farms";
-import { Faucet } from "../../packages/faucet/faucet";
-import { LimitOrders } from "../../packages/limitOrders/limitOrders";
-import { Multisig } from "../../packages/multisig/multisig";
-import { Perpetuals } from "../../packages/perpetuals";
-import { Pools } from "../../packages/pools/pools";
-import { Referrals } from "../../packages/referrals/referrals";
-import { Rewards } from "../../packages/rewards/rewards";
-import { Staking } from "../../packages/staking/staking";
-import { SuiFrens } from "../../packages/suiFrens/suiFrens";
-import { UserData } from "../../packages/userData/userData";
-import type { CoinType, ConfigAddresses, SuiAddress, SuiNetwork, Url } from "../../types";
-import { DynamicGas } from "../dynamicGas/dynamicGas";
-import { Prices } from "../prices/prices";
-import { Caller } from "../utils/caller";
-import { Casting } from "../utils/casting";
-import { Helpers } from "../utils/helpers";
-import { Wallet } from "../wallet/wallet";
-import { AftermathApi } from "./aftermathApi";
-/**
- * The `Aftermath` class serves as the primary entry point for interacting with
- * the Aftermath Finance protocols and utilities on the Sui blockchain.
- * It provides various sub-providers (e.g. `Router`, `Staking`, `Farms`)
- * initialized under the specified network environment (MAINNET, TESTNET, etc).
- *
- * @example
- * ```typescript
- * // Create provider
- * const aftermath = new Aftermath("MAINNET");
- * // Create package provider
- * const router = aftermath.Router();
- * // Call sdk from package provider
- * const supportedCoins = await router.getSupportedCoins();
- *
- * // Or do it all in one go
- * const supportedCoins = await (new Aftermath("MAINNET")).Router().getSupportedCoins();
- * ```
- */
-export declare class Aftermath extends Caller {
-    private readonly network?;
-    private Provider?;
-    /**
-     * Creates an `Aftermath` provider instance to call the Aftermath Finance APIs
-     * and interact with Sui-based protocols.
-     *
-     * @param network - The target Sui network ("MAINNET", "TESTNET", "DEVNET", or "LOCAL").
-     * @param Provider - Optionally pass a custom `AftermathApi` instance if you already have one.
-     */
-    constructor(network?: SuiNetwork | undefined, Provider?: AftermathApi | undefined);
-    /**
-     * Initializes the Aftermath provider by fetching addresses from the backend
-     * and configuring the Sui fullnode client. This method must be called before
-     * performing many API operations.
-     *
-     * @param inputs - Optional object allowing you to override the default `fullnodeUrl`.
-     * @example
-     * ```typescript
-     * const afSdk = new Aftermath("MAINNET");
-     * await afSdk.init(); // sets up internal providers
-     * ```
-     */
-    init(inputs?: {
-        fullnodeUrl: Url;
-    }): Promise<void>;
-    /**
-     * Retrieves the Aftermath-specific on-chain addresses (object IDs, packages, etc.).
-     *
-     * @returns A `ConfigAddresses` object containing relevant addresses for the protocol.
-     *
-     * @example
-     * ```typescript
-     * const addresses = await aftermath.getAddresses();
-     * console.log(addresses); // { routerPackageId: "...", someOtherPackageId: "..." }
-     * ```
-     */
-    getAddresses(): Promise<ConfigAddresses>;
-    /**
-     * Returns the base URL used for Aftermath API calls.
-     *
-     * @returns The base URL for this instance's API.
-     *
-     * @example
-     * ```typescript
-     * const apiBaseUrl = aftermath.getApiBaseUrl();
-     * console.log(apiBaseUrl); // "https://api.after..."
-     * ```
-     */
-    getApiBaseUrl(): string | undefined;
-    /**
-     * Returns an instance of the `Pools` class, which handles DEX pool operations
-     * within the Aftermath platform (if supported).
-     */
-    Pools: () => Pools;
-    /**
-     * Returns an instance of the `Staking` class for Aftermath's staking and unstaking features.
-     */
-    Staking: () => Staking;
-    /**
-     * Returns an instance of `LeveragedStaking` for advanced leveraged staking workflows (if supported).
-     */
-    LeveragedStaking: () => LeveragedStaking;
-    /**
-     * Returns an instance of `SuiFrens`, a specialized package for social or utility services.
-     */
-    SuiFrens: () => SuiFrens;
-    /**
-     * Returns an instance of `Faucet`, allowing test/dev networks to dispense tokens.
-     */
-    Faucet: () => Faucet;
-    /**
-     * Returns an instance of the `Router` class, which handles smart order routing
-     * across multiple DEX protocols.
-     */
-    Router: () => Router;
-    /**
-     * Returns an instance of `NftAmm`, which supports NFT AMM (automated market maker) features.
-     */
-    NftAmm: () => NftAmm;
-    /**
-     * Returns an instance of `ReferralVault` for referral-based interactions in the protocol.
-     * @deprecated Use `Referrals` instead
-     */
-    ReferralVault: () => ReferralVault;
-    /**
-     * Returns an instance of `Referrals` for referral-based interactions in the protocol.
-     */
-    Referrals: () => Referrals;
-    /**
-     * Returns an instance of `Perpetuals` for futures or perpetual contract interactions.
-     */
-    Perpetuals: () => Perpetuals;
-    /**
-     * Returns an instance of `Rewards` for querying user reward points.
-     */
-    Rewards: () => Rewards;
-    /**
-     * Returns an instance of `Farms` for yield farming or liquidity mining functionalities.
-     */
-    Farms: () => Farms;
-    /**
-     * Returns an instance of the `Dca` class, supporting dollar-cost averaging logic.
-     */
-    Dca: () => Dca;
-    /**
-     * Returns an instance of `Multisig`, enabling multi-signature address creation and management.
-     */
-    Multisig: () => Multisig;
-    /**
-     * Returns an instance of `LimitOrders`, supporting limit order placement on certain DEX protocols.
-     */
-    LimitOrders: () => LimitOrders;
-    /**
-     * Returns an instance of `UserData` for creating and managing user-specific data or key storage.
-     */
-    UserData: () => UserData;
-    /**
-     * Returns an instance of `Sui` for low-level Sui chain information and utilities.
-     */
-    Sui: () => Sui;
-    /**
-     * Returns an instance of `Prices`, which provides coin price data from external or internal feeds.
-     */
-    Prices: () => Prices;
-    /**
-     * Creates a new `Wallet` instance for a specific user address, enabling you to fetch balances,
-     * transaction history, etc.
-     *
-     * @param address - The Sui address of the wallet (e.g., "0x<32_byte_hex>").
-     */
-    Wallet: (address: SuiAddress) => Wallet;
-    /**
-     * Returns an instance of the `Coin` class, which handles coin metadata, decimal conversions,
-     * and other coin-related utilities for a specified `CoinType`.
-     *
-     * @param coinType - Optionally specify a coin type for immediate usage in coin methods.
-     */
-    Coin: (coinType?: CoinType) => Coin;
-    /**
-     * Returns an instance of `DynamicGas`, enabling dynamic assignment of gas
-     * objects or sponsored transactions for user operations.
-     */
-    DynamicGas: () => DynamicGas;
-    /**
-     * Returns an instance of `Auth`, handling user authentication or token-based flows (if applicable).
-     */
-    Auth: () => Auth;
-    /**
-     * Exposes a set of helper functions for general-purpose usage across
-     * the Aftermath ecosystem. Includes utilities for math, logging, etc.
-     */
-    static helpers: typeof Helpers;
-    /**
-     * Exposes a set of casting utilities for data type conversions (e.g., BigInt <-> fixed).
-     */
-    static casting: typeof Casting;
-}
-//# sourceMappingURL=aftermath.d.ts.map

package/dist/general/providers/aftermath.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"aftermath.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermath.ts"],"names":[],"mappings":"AACA,OAAO,EACN,IAAI,EACJ,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,MAAM,EACN,GAAG,EACH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,KAAK,EACX,QAAQ,EACR,eAAe,EACf,UAAU,EACV,UAAU,EACV,GAAG,EACH,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,SAAU,SAAQ,MAAM;IAanC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC;IATlB;;;;;;OAMG;gBAEe,OAAO,CAAC,EAAE,UAAU,YAAA,EAC7B,QAAQ,CAAC,EAAE,YAAY,YAAA;IAYhC;;;;;;;;;;;OAWG;IACU,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,GAAG,CAAA;KAAE;IAyB/C;;;;;;;;;;OAUG;IACU,YAAY;IAIzB;;;;;;;;;;OAUG;IACI,aAAa;IAYpB;;;OAGG;IACI,KAAK,cAA+C;IAE3D;;OAEG;IACI,OAAO,gBAAiD;IAE/D;;OAEG;IACI,gBAAgB,yBAA2C;IAElE;;OAEG;IACI,QAAQ,iBAAkD;IAEjE;;OAEG;IACI,MAAM,eAAgD;IAE7D;;;OAGG;IACI,MAAM,eAAiC;IAC9C;;OAEG;IACI,MAAM,eAAgD;IAE7D;;;OAGG;IACI,aAAa,sBAAwC;IAE5D;;OAEG;IACI,SAAS,kBAAoC;IAEpD;;OAEG;IACI,UAAU,mBAAoD;IAErE;;OAEG;IACI,OAAO,gBAAiD;IAE/D;;OAEG;IACI,KAAK,cAA+C;IAE3D;;OAEG;IACI,GAAG,YAA8B;IAExC;;OAEG;IACI,QAAQ,iBAAkD;IAEjE;;OAEG;IACI,WAAW,oBAAsC;IAExD;;OAEG;IACI,QAAQ,iBAAmC;IAMlD;;OAEG;IACI,GAAG,YAA6C;IAEvD;;OAEG;IACI,MAAM,eAAiC;IAE9C;;;;;OAKG;IACI,MAAM,GAAI,SAAS,UAAU,YACa;IAEjD;;;;;OAKG;IACI,IAAI,GAAI,WAAW,QAAQ,UACc;IAEhD;;;OAGG;IACI,UAAU,mBAAqC;IAEtD;;OAEG;IACI,IAAI,aAA+B;IAM1C;;;OAGG;IACH,OAAc,OAAO,iBAAW;IAEhC;;OAEG;IACH,OAAc,OAAO,iBAAW;CAChC"}