aftermath-ts-sdk 1.2.51 → 1.2.52-perps.3

package/dist/packages/faucet/api/faucetApi.js

@@ -16,6 +16,7 @@ const coin_1 = require("../../coin");
 const transactionsApiHelpers_1 = require("../../../general/apiHelpers/transactionsApiHelpers");
 const eventsApiHelpers_1 = require("../../../general/apiHelpers/eventsApiHelpers");
 const sui_1 = require("../../sui");
+const utils_1 = require("../../../general/utils");
 class FaucetApi {
     // =========================================================================
     //  Constructor
@@ -23,61 +24,39 @@ class FaucetApi {
     constructor(Provider) {
         this.Provider = Provider;
         // =========================================================================
-        //  Transaction Builders
+        //  Inspections
         // =========================================================================
-        this.fetchRequestCustomCoinAmountTx = (inputs) => __awaiter(this, void 0, void 0, function* () {
-            const { walletAddress, coinType, amount } = inputs;
-            const tx = new transactions_1.Transaction();
-            tx.setSender(walletAddress);
-            this.requestCoinAmountTx({
-                tx,
-                coinType,
-                amount,
-            });
-            return tx;
-        });
-        this.fetchBuildMintSuiFrenTx = (inputs) => __awaiter(this, void 0, void 0, function* () {
-            const { walletAddress, mintFee, suiFrenType } = inputs;
-            const tx = new transactions_1.Transaction();
-            tx.setSender(walletAddress);
-            const suiPaymentCoinId = yield this.Provider.Coin().fetchCoinWithAmountTx({
-                tx,
-                walletAddress,
-                coinType: coin_1.Coin.constants.suiCoinType,
-                coinAmount: mintFee,
-            });
-            this.mintSuiFrenTx({ tx, suiPaymentCoinId, suiFrenType });
-            return tx;
+        this.fetchSupportedCoins = () => __awaiter(this, void 0, void 0, function* () {
+            const addCoinEvents = yield this.fetchAddCoinEvents({});
+            const coins = addCoinEvents.events.map((event) => "0x" + event.coinType);
+            return coins;
         });
         // =========================================================================
-        //  Transcation Commands
+        //  Transaction Commands
         // =========================================================================
-        this.addCoinTx = (inputs) => {
-            const { tx, treasuryCapId, treasuryCapType } = inputs;
-            return tx.moveCall({
-                target: transactionsApiHelpers_1.TransactionsApiHelpers.createTxTarget(this.addresses.packages.faucet, FaucetApi.constants.moduleNames.faucet, "add_coin"),
-                typeArguments: [treasuryCapType],
-                arguments: [
-                    tx.object(this.addresses.objects.faucet),
-                    tx.object(treasuryCapId),
-                ],
-            });
-        };
-        this.requestCoinAmountTx = (inputs) => {
-            const { tx, coinType, amount } = inputs;
-            return tx.moveCall({
-                target: transactionsApiHelpers_1.TransactionsApiHelpers.createTxTarget(this.addresses.packages.faucet, FaucetApi.constants.moduleNames.faucet, "request_coin_amount"),
-                typeArguments: [coinType],
-                arguments: [
-                    tx.object(this.addresses.objects.faucet),
-                    tx.pure.u64(amount),
-                ],
-            });
-        };
+        // public addCoinTx = (inputs: {
+        // 	tx: Transaction;
+        // 	treasuryCapId: ObjectId;
+        // 	treasuryCapType: AnyObjectType;
+        // }) => {
+        // 	const { tx, treasuryCapId, treasuryCapType } = inputs;
+        // 	return tx.moveCall({
+        // 		target: TransactionsApiHelpers.createTxTarget(
+        // 			this.addresses.packages.faucet,
+        // 			FaucetApi.constants.moduleNames.faucet,
+        // 			"add_coin"
+        // 		),
+        // 		typeArguments: [treasuryCapType],
+        // 		arguments: [
+        // 			tx.object(this.addresses.objects.faucet),
+        // 			tx.object(treasuryCapId),
+        // 		],
+        // 	});
+        // };
         this.requestCoinTx = (inputs) => {
             const { tx, coinType } = inputs;
             return tx.moveCall({
-                target: transactionsApiHelpers_1.TransactionsApiHelpers.createTxTarget(this.addresses.packages.faucet, FaucetApi.constants.moduleNames.faucet, "request_coin"),
+                target: transactionsApiHelpers_1.TransactionsApiHelpers.createTxTarget(this.addresses.packages.faucet, FaucetApi.constants.moduleNames.faucet, "request_default_amount"),
                 typeArguments: [coinType],
                 arguments: [tx.object(this.addresses.objects.faucet)],
             });
@@ -97,6 +76,23 @@ class FaucetApi {
             });
         };
         // =========================================================================
+        //  Transaction Builders
+        // =========================================================================
+        this.buildRequestCoinTx = utils_1.Helpers.transactions.createBuildTxFunc(this.requestCoinTx);
+        this.fetchBuildMintSuiFrenTx = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { walletAddress, mintFee, suiFrenType } = inputs;
+            const tx = new transactions_1.Transaction();
+            tx.setSender(walletAddress);
+            const suiPaymentCoinId = yield this.Provider.Coin().fetchCoinWithAmountTx({
+                tx,
+                walletAddress,
+                coinType: coin_1.Coin.constants.suiCoinType,
+                coinAmount: mintFee,
+            });
+            this.mintSuiFrenTx({ tx, suiPaymentCoinId, suiFrenType });
+            return tx;
+        });
+        // =========================================================================
         //  Events
         // =========================================================================
         // TODO: add to indexer
@@ -140,7 +136,6 @@ exports.FaucetApi = FaucetApi;
 FaucetApi.constants = {
     moduleNames: {
         faucet: "faucet",
-        faucetRegistry: "faucet_registry",
         suiFrensGenesisWrapper: "genesis_wrapper",
     },
     eventNames: {

package/dist/packages/faucet/api/faucetApiCasting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"faucetApiCasting.d.ts","sourceRoot":"","sources":["../../../../src/packages/faucet/api/faucetApiCasting.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,yBAAyB,EACzB,0BAA0B,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAEzE,qBAAa,gBAAgB;IAK5B,OAAc,8BAA8B,gDAEzC,mBAAmB,CAUpB;IAEF,OAAc,6BAA6B,+CAExC,kBAAkB,CASnB;CACF"}
+{"version":3,"file":"faucetApiCasting.d.ts","sourceRoot":"","sources":["../../../../src/packages/faucet/api/faucetApiCasting.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,yBAAyB,EACzB,0BAA0B,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAIzE,qBAAa,gBAAgB;IAK5B,OAAc,8BAA8B,gDAEzC,mBAAmB,CAapB;IAEF,OAAc,6BAA6B,+CAExC,kBAAkB,CAWnB;CACF"}

package/dist/packages/faucet/api/faucetApiCasting.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FaucetApiCasting = void 0;
+const utils_1 = require("../../../general/utils");
+const coin_1 = require("../../coin");
 class FaucetApiCasting {
 }
 exports.FaucetApiCasting = FaucetApiCasting;
@@ -9,10 +11,11 @@ exports.FaucetApiCasting = FaucetApiCasting;
 // =========================================================================
 FaucetApiCasting.faucetMintCoinEventFromOnChain = (eventOnChain) => {
     const fields = eventOnChain.parsedJson;
+    const coinType = utils_1.Helpers.addLeadingZeroesToType(new coin_1.Coin(eventOnChain.type).innerCoinType);
     return {
-        minter: fields.user,
-        coinMinted: fields.type,
-        balanceMinted: BigInt(fields.amount),
+        coinType,
+        minter: utils_1.Helpers.addLeadingZeroesToType(fields.user),
+        amount: BigInt(fields.amount),
         timestamp: eventOnChain.timestampMs,
         txnDigest: eventOnChain.id.txDigest,
         type: eventOnChain.type,
@@ -20,9 +23,9 @@ FaucetApiCasting.faucetMintCoinEventFromOnChain = (eventOnChain) => {
 };
 FaucetApiCasting.faucetAddCoinEventFromOnChain = (eventOnChain) => {
     const fields = eventOnChain.parsedJson;
+    const coinType = utils_1.Helpers.addLeadingZeroesToType(new coin_1.Coin(eventOnChain.type).innerCoinType);
     return {
-        coinSymbol: fields.symbol,
-        coinType: fields.type,
+        coinType,
         timestamp: eventOnChain.timestampMs,
         txnDigest: eventOnChain.id.txDigest,
         type: eventOnChain.type,

package/dist/packages/faucet/api/faucetApiCastingTypes.d.ts

@@ -1,13 +1,10 @@
 import { BigIntAsString, SuiAddress } from "../../../general/types/generalTypes";
 import { EventOnChain } from "../../../general/types/castingTypes";
-import { CoinType } from "../../coin/coinTypes";
 export type FaucetMintCoinEventOnChain = EventOnChain<{
     amount: BigIntAsString;
-    type: CoinType;
     user: SuiAddress;
 }>;
 export type FaucetAddCoinEventOnChain = EventOnChain<{
-    symbol: string;
-    type: CoinType;
+    default_mint_amount: BigIntAsString;
 }>;
 //# sourceMappingURL=faucetApiCastingTypes.d.ts.map

package/dist/packages/faucet/api/faucetApiCastingTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"faucetApiCastingTypes.d.ts","sourceRoot":"","sources":["../../../../src/packages/faucet/api/faucetApiCastingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,cAAc,EACd,UAAU,EACV,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAMhD,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;CACf,CAAC,CAAC"}
+{"version":3,"file":"faucetApiCastingTypes.d.ts","sourceRoot":"","sources":["../../../../src/packages/faucet/api/faucetApiCastingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,cAAc,EACd,UAAU,EACV,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAOnE,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC;IACpD,mBAAmB,EAAE,cAAc,CAAC;CACpC,CAAC,CAAC"}

package/dist/packages/faucet/faucet.d.ts

@@ -3,7 +3,7 @@ import { Caller } from "../../general/utils/caller";
 import { AftermathApi } from "../../general/providers";
 import { Transaction } from "@mysten/sui/transactions";
 export declare class Faucet extends Caller {
-    private readonly Provider?;
+    readonly Provider?: AftermathApi | undefined;
     static readonly constants: {
         defaultRequestAmountUsd: number;
     };

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

@@ -1 +1 @@
-{"version":3,"file":"faucet.d.ts","sourceRoot":"","sources":["../../../src/packages/faucet/faucet.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EAGR,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,qBAAa,MAAO,SAAQ,MAAM;IAehC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAV3B,gBAAuB,SAAS;;MAE9B;gBAOD,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IAS5B,iBAAiB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAcxC,yBAAyB,CACrC,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,WAAW,CAAC;IAIV,yBAAyB,CAAC,MAAM,EAAE,wBAAwB;IAQvE,OAAO,CAAC,WAAW,CAIjB;CACF"}
+{"version":3,"file":"faucet.d.ts","sourceRoot":"","sources":["../../../src/packages/faucet/faucet.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EAGR,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,qBAAa,MAAO,SAAQ,MAAM;aAehB,QAAQ,CAAC;IAV1B,gBAAuB,SAAS;;MAE9B;gBAOD,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,0BAAc;IAS3B,iBAAiB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAcxC,yBAAyB,CAAC,MAAM,EAAE,oBAAoB;IAItD,yBAAyB,CAAC,MAAM,EAAE,wBAAwB;IAQvE,OAAO,CAAC,WAAW,CAIjB;CACF"}

package/dist/packages/faucet/faucet.js

@@ -46,7 +46,7 @@ class Faucet extends caller_1.Caller {
     // =========================================================================
     getRequestCoinTransaction(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.fetchApiTransaction("request", inputs);
+            return this.useProvider().buildRequestCoinTx(inputs);
         });
     }
     getMintSuiFrenTransaction(inputs) {

package/dist/packages/faucet/faucetTypes.d.ts

@@ -2,11 +2,10 @@ import { AnyObjectType, Balance, Event, SuiAddress } from "../../general/types/g
 import { CoinType } from "../coin/coinTypes";
 export interface FaucetMintCoinEvent extends Event {
     minter: SuiAddress;
-    coinMinted: CoinType;
-    balanceMinted: BigInt;
+    coinType: CoinType;
+    amount: Balance;
 }
 export interface FaucetAddCoinEvent extends Event {
-    coinSymbol: string;
     coinType: CoinType;
 }
 export interface ApiFaucetRequestBody {

package/dist/packages/faucet/faucetTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"faucetTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/faucet/faucetTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,aAAa,EACb,OAAO,EACP,KAAK,EACL,UAAU,EACV,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAM7C,MAAM,WAAW,mBAAoB,SAAQ,KAAK;IACjD,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,QAAQ,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAmB,SAAQ,KAAK;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACnB;AAMD,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,aAAa,CAAC;IAC3B,aAAa,EAAE,UAAU,CAAC;CAC1B"}
+{"version":3,"file":"faucetTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/faucet/faucetTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,aAAa,EACb,OAAO,EACP,KAAK,EACL,UAAU,EACV,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAM7C,MAAM,WAAW,mBAAoB,SAAQ,KAAK;IACjD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,KAAK;IAChD,QAAQ,EAAE,QAAQ,CAAC;CACnB;AAMD,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,aAAa,CAAC;IAC3B,aAAa,EAAE,UAAU,CAAC;CAC1B"}

package/dist/packages/limitOrders/api/limitOrdersApi.d.ts

@@ -0,0 +1,12 @@
+import { AftermathApi } from "../../../general/providers";
+import { AnyObjectType, LimitAddresses } from "../../../types";
+export declare class LimitOrdersApi {
+    private readonly Provider;
+    readonly addresses: LimitAddresses;
+    readonly eventTypes: {
+        createdOrder: AnyObjectType;
+    };
+    constructor(Provider: AftermathApi);
+    private createdOrderEventType;
+}
+//# sourceMappingURL=limitOrdersApi.d.ts.map

package/dist/packages/limitOrders/api/limitOrdersApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"limitOrdersApi.d.ts","sourceRoot":"","sources":["../../../../src/packages/limitOrders/api/limitOrdersApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAG/D,qBAAa,cAAc;IAcd,OAAO,CAAC,QAAQ,CAAC,QAAQ;IATrC,SAAgB,SAAS,EAAE,cAAc,CAAC;IAC1C,SAAgB,UAAU,EAAE;QAC3B,YAAY,EAAE,aAAa,CAAC;KAC5B,CAAC;gBAM2B,QAAQ,EAAE,YAAY;IAkBnD,OAAO,CAAC,qBAAqB,CAK1B;CACH"}

package/dist/packages/limitOrders/api/limitOrdersApi.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitOrdersApi = void 0;
+const eventsApiHelpers_1 = require("../../../general/apiHelpers/eventsApiHelpers");
+class LimitOrdersApi {
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
+    constructor(Provider) {
+        this.Provider = Provider;
+        // =========================================================================
+        // Events
+        // =========================================================================
+        this.createdOrderEventType = () => eventsApiHelpers_1.EventsApiHelpers.createEventType(this.addresses.packages.events, "events", "CreatedOrderEventV1");
+        const addresses = this.Provider.addresses.limitOrders;
+        if (!addresses) {
+            throw new Error("not all required addresses have been set in provider");
+        }
+        this.addresses = addresses;
+        this.eventTypes = {
+            createdOrder: this.createdOrderEventType(),
+        };
+    }
+}
+exports.LimitOrdersApi = LimitOrdersApi;

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

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

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

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

package/dist/packages/limitOrders/index.js

@@ -0,0 +1,17 @@
+"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("./limitOrders"), exports);

package/dist/packages/limitOrders/limitOrders.d.ts

@@ -0,0 +1,143 @@
+import { CallerConfig, ObjectId, SuiAddress } from "../../types";
+import { Caller } from "../../general/utils/caller";
+import { ApiLimitOrdersCreateOrderTransactionBody, ApiLimitOrdersCancelOrderTransactionBody, LimitOrderObject, ApiLimitOrdersActiveOrdersOwnedBody } from "./limitOrdersTypes";
+import { Transaction } from "@mysten/sui/transactions";
+/**
+ * The `LimitOrders` class manages creation, cancellation, and querying of
+ * limit orders on the Aftermath platform. Limit orders allow you to buy or
+ * sell at a specified price, giving more control over your trades compared
+ * to market execution.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const limitOrders = afSdk.LimitOrders();
+ * ```
+ */
+export declare class LimitOrders extends Caller {
+    /**
+     * Static configuration constants, including a default gas amount for
+     * limit order transactions (50 SUI).
+     */
+    static readonly constants: {
+        /**
+         * The default gas budget for limit orders. This may be subject to change.
+         */
+        gasAmount: bigint;
+    };
+    /**
+     * Creates a new `LimitOrders` instance for interacting with limit order functionality
+     * on Aftermath.
+     *
+     * @param config - Optional configuration, including network and access token.
+     */
+    constructor(config?: CallerConfig);
+    /**
+     * Fetches the list of **active** limit orders for a given user. The user must
+     * provide a signature for identification.
+     *
+     * @param inputs - Contains the `walletAddress`, as well as `bytes` and `signature` if needed for auth.
+     * @returns A promise resolving to an array of `LimitOrderObject`, representing the active orders.
+     *
+     * @example
+     * ```typescript
+     * const activeOrders = await limitOrders.getActiveLimitOrders({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>"
+     * });
+     * ```
+     */
+    getActiveLimitOrders(inputs: ApiLimitOrdersActiveOrdersOwnedBody): Promise<LimitOrderObject[]>;
+    /**
+     * Fetches the list of **past** limit orders for a given user (e.g., completed, canceled, or expired).
+     *
+     * @param inputs - An object containing the `walletAddress`.
+     * @returns A promise resolving to an array of `LimitOrderObject` representing past orders.
+     *
+     * @example
+     * ```typescript
+     * const pastOrders = await limitOrders.getPastLimitOrders({
+     *   walletAddress: "0x<address>",
+     * });
+     * ```
+     */
+    getPastLimitOrders(inputs: {
+        walletAddress: SuiAddress;
+    }): Promise<LimitOrderObject[]>;
+    /**
+     * Constructs a limit order creation transaction on the Aftermath API, returning a `Transaction`
+     * object that can be signed and submitted to the network.
+     *
+     * @param inputs - The limit order details, including coin types, amounts, expiry, etc.
+     * @returns A promise resolving to a `Transaction` that can be locally signed and executed.
+     *
+     * @example
+     * ```typescript
+     * const tx = await limitOrders.getCreateLimitOrderTx({
+     *   walletAddress: "0x<address>",
+     *   allocateCoinType: "0x<coin>",
+     *   allocateCoinAmount: BigInt(1000),
+     *   buyCoinType: "0x<other_coin>",
+     *   expiryDurationMs: 3600000, // 1 hour
+     *   outputToInputExchangeRate: 0.5,
+     * });
+     * // sign and execute the transaction
+     * ```
+     */
+    getCreateLimitOrderTx(inputs: ApiLimitOrdersCreateOrderTransactionBody): Promise<Transaction>;
+    /**
+     * Cancels an existing limit order by sending a request to the Aftermath API
+     * with the user's signed cancellation message.
+     *
+     * @param inputs - Contains the user's `walletAddress`, plus `bytes` and `signature`.
+     * @returns A boolean indicating whether the cancellation was successful.
+     *
+     * @example
+     * ```typescript
+     * const success = await limitOrders.cancelLimitOrder({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>",
+     * });
+     * ```
+     */
+    cancelLimitOrder(inputs: ApiLimitOrdersCancelOrderTransactionBody): Promise<boolean>;
+    /**
+     * Generates the JSON message needed to cancel one or more limit orders. The user
+     * signs this message (converted to bytes), and the resulting signature is passed
+     * to `cancelLimitOrder`.
+     *
+     * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
+     * @returns A JSON structure with the action and order IDs to be canceled.
+     *
+     * @example
+     * ```typescript
+     * const msg = limitOrders.cancelLimitOrdersMessageToSign({
+     *   orderIds: ["0x<order1>", "0x<order2>"]
+     * });
+     * // user signs this JSON
+     * ```
+     */
+    cancelLimitOrdersMessageToSign(inputs: {
+        orderIds: ObjectId[];
+    }): {
+        action: string;
+        order_object_ids: string[];
+    };
+    /**
+     * Retrieves the minimum allowable order size (in USD) for limit orders on Aftermath.
+     *
+     * @returns A promise resolving to a `number` (USD value) or `undefined` if not configured.
+     *
+     * @example
+     * ```typescript
+     * const minSize = await limitOrders.getMinOrderSizeUsd();
+     * console.log("Minimum order size in USD:", minSize);
+     * ```
+     */
+    getMinOrderSizeUsd(): Promise<number | undefined>;
+}
+//# sourceMappingURL=limitOrders.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"limitOrders.d.ts","sourceRoot":"","sources":["../../../src/packages/limitOrders/limitOrders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAY,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAEN,wCAAwC,EACxC,wCAAwC,EACxC,gBAAgB,EAChB,mCAAmC,EACnC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAY,SAAQ,MAAM;IAKtC;;;OAGG;IACH,gBAAuB,SAAS;QAC/B;;WAEG;;MAEF;IAMF;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;;OAeG;IACU,oBAAoB,CAChC,MAAM,EAAE,mCAAmC;IAQ5C;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAWrE;;;;;;;;;;;;;;;;;;;OAmBG;IACU,qBAAqB,CACjC,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;;OAeG;IACU,gBAAgB,CAC5B,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;;;;;;;;;;;;OAeG;IACI,8BAA8B,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG;QACxE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;KAC3B;IAWD;;;;;;;;;;OAUG;IACU,kBAAkB;CAG/B"}

package/dist/packages/limitOrders/limitOrders.js

@@ -0,0 +1,190 @@
+"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.LimitOrders = void 0;
+const caller_1 = require("../../general/utils/caller");
+/**
+ * The `LimitOrders` class manages creation, cancellation, and querying of
+ * limit orders on the Aftermath platform. Limit orders allow you to buy or
+ * sell at a specified price, giving more control over your trades compared
+ * to market execution.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const limitOrders = afSdk.LimitOrders();
+ * ```
+ */
+class LimitOrders extends caller_1.Caller {
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
+    /**
+     * Creates a new `LimitOrders` instance for interacting with limit order functionality
+     * on Aftermath.
+     *
+     * @param config - Optional configuration, including network and access token.
+     */
+    constructor(config) {
+        super(config, "limit-orders");
+    }
+    // =========================================================================
+    //  Class Objects
+    // =========================================================================
+    /**
+     * Fetches the list of **active** limit orders for a given user. The user must
+     * provide a signature for identification.
+     *
+     * @param inputs - Contains the `walletAddress`, as well as `bytes` and `signature` if needed for auth.
+     * @returns A promise resolving to an array of `LimitOrderObject`, representing the active orders.
+     *
+     * @example
+     * ```typescript
+     * const activeOrders = await limitOrders.getActiveLimitOrders({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>"
+     * });
+     * ```
+     */
+    getActiveLimitOrders(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("active", inputs);
+        });
+    }
+    /**
+     * Fetches the list of **past** limit orders for a given user (e.g., completed, canceled, or expired).
+     *
+     * @param inputs - An object containing the `walletAddress`.
+     * @returns A promise resolving to an array of `LimitOrderObject` representing past orders.
+     *
+     * @example
+     * ```typescript
+     * const pastOrders = await limitOrders.getPastLimitOrders({
+     *   walletAddress: "0x<address>",
+     * });
+     * ```
+     */
+    getPastLimitOrders(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("past", inputs);
+        });
+    }
+    // =========================================================================
+    //  Transactions
+    // =========================================================================
+    /**
+     * Constructs a limit order creation transaction on the Aftermath API, returning a `Transaction`
+     * object that can be signed and submitted to the network.
+     *
+     * @param inputs - The limit order details, including coin types, amounts, expiry, etc.
+     * @returns A promise resolving to a `Transaction` that can be locally signed and executed.
+     *
+     * @example
+     * ```typescript
+     * const tx = await limitOrders.getCreateLimitOrderTx({
+     *   walletAddress: "0x<address>",
+     *   allocateCoinType: "0x<coin>",
+     *   allocateCoinAmount: BigInt(1000),
+     *   buyCoinType: "0x<other_coin>",
+     *   expiryDurationMs: 3600000, // 1 hour
+     *   outputToInputExchangeRate: 0.5,
+     * });
+     * // sign and execute the transaction
+     * ```
+     */
+    getCreateLimitOrderTx(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApiTransaction("transactions/create-order", inputs);
+        });
+    }
+    /**
+     * Cancels an existing limit order by sending a request to the Aftermath API
+     * with the user's signed cancellation message.
+     *
+     * @param inputs - Contains the user's `walletAddress`, plus `bytes` and `signature`.
+     * @returns A boolean indicating whether the cancellation was successful.
+     *
+     * @example
+     * ```typescript
+     * const success = await limitOrders.cancelLimitOrder({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>",
+     * });
+     * ```
+     */
+    cancelLimitOrder(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi(`cancel`, inputs);
+        });
+    }
+    // =========================================================================
+    //  Interactions
+    // =========================================================================
+    /**
+     * Generates the JSON message needed to cancel one or more limit orders. The user
+     * signs this message (converted to bytes), and the resulting signature is passed
+     * to `cancelLimitOrder`.
+     *
+     * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
+     * @returns A JSON structure with the action and order IDs to be canceled.
+     *
+     * @example
+     * ```typescript
+     * const msg = limitOrders.cancelLimitOrdersMessageToSign({
+     *   orderIds: ["0x<order1>", "0x<order2>"]
+     * });
+     * // user signs this JSON
+     * ```
+     */
+    cancelLimitOrdersMessageToSign(inputs) {
+        return {
+            action: "CANCEL_LIMIT_ORDERS",
+            order_object_ids: inputs.orderIds,
+        };
+    }
+    // =========================================================================
+    //  Configuration
+    // =========================================================================
+    /**
+     * Retrieves the minimum allowable order size (in USD) for limit orders on Aftermath.
+     *
+     * @returns A promise resolving to a `number` (USD value) or `undefined` if not configured.
+     *
+     * @example
+     * ```typescript
+     * const minSize = await limitOrders.getMinOrderSizeUsd();
+     * console.log("Minimum order size in USD:", minSize);
+     * ```
+     */
+    getMinOrderSizeUsd() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("min-order-size-usd", {});
+        });
+    }
+}
+exports.LimitOrders = LimitOrders;
+// =========================================================================
+//  Constants
+// =========================================================================
+/**
+ * Static configuration constants, including a default gas amount for
+ * limit order transactions (50 SUI).
+ */
+LimitOrders.constants = {
+    /**
+     * The default gas budget for limit orders. This may be subject to change.
+     */
+    gasAmount: BigInt(50000000),
+};