aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/packages/dca/dcaTypes.d.ts

@@ -1,319 +0,0 @@
-import { ObjectId, SuiAddress } from "../../types";
-import { CoinType } from "../coin/coinTypes";
-import { Balance, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
-/**
- * Describes an optional integrator fee configuration for advanced usage,
- * allowing a portion of DCA trades to be collected by a third party.
- */
-export interface DcaIntegratorFeeData {
-    /**
-     * The fee in basis points (bps). e.g., 100 => 1%.
-     */
-    feeBps: number;
-    /**
-     * The Sui address that will receive the fee portion.
-     */
-    feeRecipient: SuiAddress;
-}
-/**
- * Optional DCA order strategy parameters, typically bounding min & max
- * acceptable prices for the trades.
- */
-export interface DcaOrderStrategyData {
-    /**
-     * The minimum acceptable spot price for the trade, as a bigint scaled by 1e9 or 1e18 depending on usage.
-     */
-    minPrice: Balance;
-    /**
-     * The maximum acceptable spot price for the trade, similarly scaled.
-     */
-    maxPrice: Balance;
-}
-/**
- * The inputs required to create a new DCA order. This includes all relevant
- * coin types, amounts, frequency, trade count, etc.
- */
-export interface ApiDcaTransactionForCreateOrderBody {
-    /**
-     * The user's address that owns & initiates the DCA order.
-     */
-    walletAddress: SuiAddress;
-    /**
-     * The coin type from which funds will be allocated (sold).
-     */
-    allocateCoinType: CoinType;
-    /**
-     * The total amount of the allocate coin to be used across trades.
-     */
-    allocateCoinAmount: Balance;
-    /**
-     * The coin type that will be purchased periodically.
-     */
-    buyCoinType: CoinType;
-    /**
-     * The frequency (in ms) at which trades occur, e.g. every hour => 3600000.
-     */
-    frequencyMs: Timestamp;
-    /**
-     * The total number of trades to execute before concluding the DCA plan.
-     */
-    tradesAmount: number;
-    /**
-     * An optional bounding strategy specifying min & max acceptable prices.
-     */
-    strategy?: DcaOrderStrategyData;
-    /**
-     * If `true`, indicates a partially or fully sponsored transaction, removing gas burden from the user.
-     */
-    isSponsoredTx?: boolean;
-    /**
-     * A delay (in ms) before the first trade executes. If `0`, it starts immediately.
-     */
-    delayTimeMs: Timestamp;
-    /**
-     * The maximum allowable slippage (in basis points) for each trade, e.g. 100 => 1%.
-     */
-    maxAllowableSlippageBps: number;
-    /**
-     * The per-trade amount of `allocateCoinType` to be used, e.g. each trade uses 2 SUI if this is `2e9`.
-     */
-    coinPerTradeAmount: Balance;
-    /**
-     * An optional alternate address to receive the purchased coin. Defaults to `walletAddress` if undefined.
-     */
-    customRecipient?: SuiAddress;
-    /**
-     * Optional integrator fee data. If provided, a portion of each trade is allocated to the integrator.
-     */
-    integratorFee?: DcaIntegratorFeeData;
-}
-/**
- * The request body for closing a DCA order, typically requiring a signature
- * over a JSON message specifying which orders to cancel.
- */
-export interface ApiDcaTransactionForCloseOrderBody {
-    /**
-     * The user's address initiating the close/cancel action.
-     */
-    walletAddress: SuiAddress;
-    /**
-     * The signed bytes of the cancellation message.
-     */
-    bytes: string;
-    /**
-     * The user's signature corresponding to `bytes`.
-     */
-    signature: string;
-}
-/**
- * Represents parameters for a manual order close workflow. Typically not
- * used in the standard approach.
- */
-export type ApiDcaManualCloseOrderBody = {
-    walletAddress: SuiAddress;
-    buyCoinType: CoinType;
-    allocateCoinType: CoinType;
-    orderId: SuiAddress;
-};
-/**
- * Enumerates reasons that a DCA trade might fail, e.g., the price was out of bounds
- * or the user lacked enough gas.
- */
-export type DcaFailedTradeReason = "INTERNAL" | "STRATEGY" | "GAS_CAP" | "UNKNOWN_USER" | "SLIPPAGE";
-/**
- * Represents data for a successful trade that occurred in a DCA sequence,
- * including the amounts of allocated/buy coins, the final transaction info, etc.
- */
-export interface DcaOrderTradeObject {
-    /**
-     * The coin & amount that was spent in this trade (e.g., SUI).
-     */
-    allocatedCoin: {
-        coin: CoinType;
-        amount: Balance;
-    };
-    /**
-     * The coin & amount that was purchased (e.g., USDC).
-     */
-    buyCoin: {
-        coin: CoinType;
-        amount: Balance;
-    };
-    /**
-     * The final transaction digest for this trade. (Deprecated field `tnxDigest` also present.)
-     */
-    txnDigest: TransactionDigest;
-    /** @deprecated use `txnDigest` instead */
-    tnxDigest: TransactionDigest;
-    /**
-     * The timestamp (in ms) when this trade was executed. (Deprecated field `tnxDate` also present.)
-     */
-    txnTimestamp: Timestamp;
-    /** @deprecated use `txnTimestamp` instead */
-    tnxDate: Timestamp;
-    /**
-     * The effective rate of the trade, if available, e.g. "0.95" or "1.10".
-     */
-    rate: number | undefined;
-}
-/**
- * Represents a failed trade attempt in a DCA sequence, including time
- * of failure and the reason code.
- */
-export interface DcaOrderFailedTradeObject {
-    timestamp: number;
-    reason: DcaFailedTradeReason | undefined;
-}
-/**
- * Summarizes the main details of a DCA order, including how much coin is allocated
- * and how many trades remain.
- */
-export interface DcaOrderOverviewObject {
-    /**
-     * The coin & amount the user allocated for the entire DCA cycle.
-     */
-    allocatedCoin: {
-        coin: CoinType;
-        amount: Balance;
-    };
-    /**
-     * The coin & amount that is being purchased in each periodic trade.
-     */
-    buyCoin: {
-        coin: CoinType;
-        amount: Balance;
-    };
-    /**
-     * The total amount of allocateCoin actually spent so far.
-     */
-    totalSpent: Balance;
-    /**
-     * The interval (in ms) between each trade, e.g., every hour => 3600000.
-     */
-    intervalMs: Timestamp;
-    /**
-     * The total number of trades that were planned.
-     */
-    totalTrades: number;
-    /**
-     * The number of remaining trades that have not yet executed.
-     */
-    tradesRemaining: number;
-    /**
-     * The maximum slippage (bps) allowed for each trade.
-     */
-    maxSlippageBps: number;
-    /**
-     * Optional bounding strategy with min/max acceptable prices.
-     */
-    strategy?: DcaOrderStrategyData;
-    /**
-     * The address to receive the purchased coin. Defaults to the DCA owner's address if unspecified.
-     */
-    recipient: SuiAddress;
-    /**
-     * Represents how far along the DCA has progressed, typically out of `totalTrades`.
-     */
-    progress: number;
-    /**
-     * Details about when & how the DCA was created. Contains timestamps and transaction references.
-     */
-    created: {
-        timestamp: Timestamp;
-        /** @deprecated use `timestamp` instead */
-        time: Timestamp;
-        txnDigest: TransactionDigest;
-        /** @deprecated use `txnDigest` instead */
-        tnxDigest: TransactionDigest;
-    };
-    /**
-     * If the next trade is scheduled in the future, indicates when that trade will occur.
-     */
-    nextTrade?: {
-        timestamp: Timestamp;
-        /** @deprecated use `timestamp` instead */
-        time: Timestamp;
-        txnDigest: TransactionDigest;
-        /** @deprecated use `txnDigest` instead */
-        tnxDigest: TransactionDigest;
-    };
-    /**
-     * If at least one trade has already executed, shows when & how the last one occurred.
-     */
-    lastExecutedTrade?: {
-        timestamp: Timestamp;
-        /** @deprecated use `timestamp` instead */
-        time: Timestamp;
-        txnDigest: TransactionDigest;
-        /** @deprecated use `txnDigest` instead */
-        tnxDigest: TransactionDigest;
-    };
-    /**
-     * Optional integrator fee settings that might apply to each trade.
-     */
-    integratorFee?: DcaIntegratorFeeData;
-}
-/**
- * Represents a single DCA order, including overview data, all successful trades, and all failed trades.
- */
-export interface DcaOrderObject {
-    /**
-     * The on-chain object ID representing this DCA order.
-     */
-    objectId: ObjectId;
-    /**
-     * Summary of the DCA (allocated amounts, trades remaining, etc.).
-     */
-    overview: DcaOrderOverviewObject;
-    /**
-     * An array of all completed trades.
-     */
-    trades: DcaOrderTradeObject[];
-    /**
-     * An array of attempted trades that failed, along with reasons/timestamps.
-     */
-    failed: DcaOrderFailedTradeObject[];
-}
-/**
- * Represents a grouping of DCA orders, typically used in the older or combined approach.
- * Contains both `active` and `past` arrays.
- */
-export interface DcaOrdersObject {
-    /**
-     * Active DCA orders.
-     */
-    active: DcaOrderObject[];
-    /**
-     * Past (completed or canceled) DCA orders.
-     */
-    past: DcaOrderObject[];
-}
-/**
- * **Deprecated**. Body for creating a user public key in the old DCA system.
- * Use `ApiUserDataCreateUserBody` from `userData` package instead.
- */
-export interface ApiDcaCreateUserBody {
-    /**
-     * The Sui address of the user.
-     */
-    walletAddress: SuiAddress;
-    /**
-     * The message bytes that the user is signing (in hex or base64).
-     */
-    bytes: string;
-    /**
-     * The resulting signature from signing `bytes`.
-     */
-    signature: string;
-}
-/**
- * **Deprecated**. Body for fetching the DCA orders owned by a specific user.
- * Use separate `getActiveDcaOrders` and `getPastDcaOrders` calls instead.
- */
-export interface ApiDCAsOwnedBody {
-    /**
-     * The user's Sui address whose DCA orders should be fetched.
-     */
-    walletAddress: SuiAddress;
-}
-//# sourceMappingURL=dcaTypes.d.ts.map

package/dist/packages/dca/dcaTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dcaTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dcaTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EACN,OAAO,EACP,SAAS,EAET,iBAAiB,EAGjB,MAAM,kCAAkC,CAAC;AAM1C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IACnD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,QAAQ,CAAC;IAC3B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAMD;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,UAAU,CAAC;IAC1B,WAAW,EAAE,QAAQ,CAAC;IACtB,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC;AAMF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC7B,UAAU,GACV,UAAU,GACV,SAAS,GACT,cAAc,GACd,UAAU,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B,0CAA0C;IAC1C,SAAS,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;IACxB,6CAA6C;IAC7C,OAAO,EAAE,SAAS,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE;QACR,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,EAAE;QACX,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,iBAAiB,CAAC,EAAE;QACnB,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,sBAAsB,CAAC;IACjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,cAAc,EAAE,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B"}

package/dist/packages/dca/dcaTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/packages/dca/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./dca";
-//# sourceMappingURL=index.d.ts.map

package/dist/packages/dca/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC"}

package/dist/packages/dca/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./dca"), exports);