aftermath-ts-sdk 2.1.0-perps.4 → 2.1.0-perps.6

package/dist/index.d.ts

@@ -488,6 +488,7 @@ interface FaucetAddresses {
     };
     objects: {
         faucet: ObjectId;
+        config: ObjectId;
         suiFrensMint: ObjectId;
     };
 }
@@ -3465,31 +3466,38 @@ type SdkPerpetualsCreateTwapOrdersInputs = Omit<ApiPerpetualsCreateTwapOrdersBod
     tx?: Transaction;
 };
 /**
- * Request body for creating TWAP orders via the API.
+ * Request body for creating TWAP orders via the API, for an
+ * account or vault.
  */
-interface ApiPerpetualsCreateTwapOrdersBody {
-    accountId: PerpetualsAccountId;
-    accountCapId?: ObjectId;
+type ApiPerpetualsCreateTwapOrdersBody = {
     walletAddress: SuiAddress;
     twapOrders: PerpetualsTwapOrderDetails[];
     gasCoinArg?: TransactionObjectArgument;
     txKind?: SerializedTransaction;
     isSponsoredTx?: boolean;
     sponsor?: PerpetualsSponsorConfig;
-}
+} & ({
+    accountId: PerpetualsAccountId;
+    accountCapId?: ObjectId;
+} | {
+    vaultId: ObjectId;
+});
 /**
  * Request body for editing existing TWAP orders via the API.
  *
  * `newTwapOrders` maps each TWAP order object id to the edit to apply.
  */
-interface ApiPerpetualsEditTwapOrdersBody {
-    accountId: PerpetualsAccountId;
-    accountCapId?: ObjectId;
+type ApiPerpetualsEditTwapOrdersBody = {
     walletAddress: SuiAddress;
     newTwapOrders: Record<ObjectId, PerpetualsTwapOrderEdit>;
     txKind?: SerializedTransaction;
     sponsor?: PerpetualsSponsorConfig;
-}
+} & ({
+    accountId: PerpetualsAccountId;
+    accountCapId?: ObjectId;
+} | {
+    vaultId: ObjectId;
+});
 /**
  * SDK-level inputs for editing existing TWAP orders — the request body without
  * the auto-filled fields, plus an optional transaction to extend.
@@ -3498,16 +3506,20 @@ type SdkPerpetualsEditTwapOrdersInputs = Omit<ApiPerpetualsEditTwapOrdersBody, P
     tx?: Transaction;
 };
 /**
- * Request body for canceling TWAP orders identified by object IDs.
+ * Request body for canceling TWAP orders identified by object IDs, for an
+ * account or vault.
  */
-interface ApiPerpetualsCancelTwapOrdersBody {
-    accountId: PerpetualsAccountId;
-    accountCapId?: ObjectId;
+type ApiPerpetualsCancelTwapOrdersBody = {
     walletAddress: SuiAddress;
     twapOrderIds: ObjectId[];
     txKind?: SerializedTransaction;
     sponsor?: PerpetualsSponsorConfig;
-}
+} & ({
+    accountId: PerpetualsAccountId;
+    accountCapId?: ObjectId;
+} | {
+    vaultId: ObjectId;
+});
 /**
  * SDK-level inputs for canceling TWAP orders — the request body without the
  * auto-filled fields, plus an optional transaction to extend.
@@ -3519,13 +3531,16 @@ type SdkPerpetualsCancelTwapOrdersInputs = Omit<ApiPerpetualsCancelTwapOrdersBod
  * Request body for fetching the TWAP orders of an account, validated using a
  * wallet signature.
  */
-interface ApiPerpetualsTwapOrderDatasBody {
-    accountId: PerpetualsAccountId;
+type ApiPerpetualsTwapOrderDatasBody = {
     walletAddress: SuiAddress;
     bytes: string;
     signature: string;
     marketIds?: PerpetualsMarketId[];
-}
+} & ({
+    accountId: PerpetualsAccountId;
+} | {
+    vaultId: ObjectId;
+});
 /**
  * Response payload for TWAP-order queries.
  */
@@ -5175,7 +5190,8 @@ interface PerpetualsWsUpdatesMarketSubscriptionType {
 }
 /**
  * Websocket subscription payload for subscribing to user/account updates,
- * optionally including stop-order data (via signature).
+ * optionally including special-order (stop and TWAP order) data (via
+ * signature).
  */
 interface PerpetualsWsUpdatesUserSubscriptionType {
     user: {
@@ -5317,11 +5333,13 @@ interface PerpetualsWsUpdatesTopOfOrderbookPayload {
     maxBidPrice: number | undefined;
 }
 /**
- * Websocket payload for user account and stop-order updates.
+ * Websocket payload for user account and special-order (stop and TWAP order)
+ * updates.
  */
 interface PerpetualsWsUpdatesUserPayload {
     account: PerpetualsAccountObject;
     stopOrders: PerpetualsStopOrderData[] | undefined;
+    twapOrders: PerpetualsTwapOrderData[] | undefined;
 }
 /**
  * Websocket subscription message format sent by clients to manage
@@ -8537,13 +8555,10 @@ declare class Farms extends Caller {
 
 declare class Faucet extends Caller {
     readonly api?: AftermathApi | undefined;
-    static readonly constants: {
-        defaultRequestAmountUsd: number;
-    };
     constructor(config?: CallerConfig, api?: AftermathApi | undefined);
     getSupportedCoins(): Promise<CoinType[]>;
-    getRequestCoinTransaction(inputs: ApiFaucetRequestBody): Promise<_mysten_sui_transactions.Transaction>;
-    getMintSuiFrenTransaction(inputs: ApiFaucetMintSuiFrenBody): Promise<_mysten_sui_transactions.Transaction>;
+    getRequestCoinTransaction(inputs: ApiFaucetRequestBody): Transaction;
+    getMintSuiFrenTransaction(inputs: ApiFaucetMintSuiFrenBody): Promise<Transaction>;
     private readonly faucetApi;
 }
 
@@ -12268,6 +12283,14 @@ declare class Perpetuals extends Caller {
             priceBucketSize: number;
             bucketsNumber: number;
         }) => void;
+        subscribeMarketCandles: ({ marketId, interval, }: {
+            marketId: PerpetualsMarketId;
+            interval: PerpetualsCandleResolution;
+        }) => void;
+        unsubscribeMarketCandles: ({ marketId, interval, }: {
+            marketId: PerpetualsMarketId;
+            interval: PerpetualsCandleResolution;
+        }) => void;
         close: () => void;
     };
     /**
@@ -16298,6 +16321,11 @@ declare class FaucetApi {
     };
     constructor(api: AftermathApi);
     fetchSupportedCoins: () => Promise<CoinType[]>;
+    /**
+     * Mints `coinType`'s configured default amount and returns the resulting
+     * `Coin<T>`. Use {@link buildRequestCoinTx} to mint and transfer it to a
+     * wallet in one transaction.
+     */
     requestCoinTx: (inputs: {
         tx: Transaction;
         coinType: CoinType;
@@ -16307,12 +16335,7 @@ declare class FaucetApi {
         suiPaymentCoinId: ObjectId | TransactionArgument;
         suiFrenType: AnyObjectType;
     }) => _mysten_sui_transactions.TransactionResult;
-    buildRequestCoinTx: (inputs: {
-        walletAddress: SuiAddress;
-    } & Omit<{
-        tx: Transaction;
-        coinType: CoinType;
-    }, "tx">) => Transaction;
+    buildRequestCoinTx: (inputs: ApiFaucetRequestBody) => Transaction;
     fetchBuildMintSuiFrenTx: (inputs: ApiFaucetMintSuiFrenBody) => Promise<Transaction>;
     fetchMintCoinEvents: (inputs: EventsInputs) => Promise<EventsWithCursor<FaucetMintCoinEvent>>;
     fetchAddCoinEvents: (inputs: EventsInputs) => Promise<EventsWithCursor<FaucetAddCoinEvent>>;

package/dist/index.js

@@ -5896,29 +5896,19 @@ var init_faucet = __esm({
       // =========================================================================
       //  Inspections
       // =========================================================================
-      async getSupportedCoins() {
+      getSupportedCoins() {
         return this.fetchApi("supported-coins");
       }
       // =========================================================================
-      //  Events
-      // =========================================================================
-      // TODO: add mint coin event getter ?
-      // =========================================================================
       //  Transactions
       // =========================================================================
-      async getRequestCoinTransaction(inputs) {
+      getRequestCoinTransaction(inputs) {
         return this.faucetApi().buildRequestCoinTx(inputs);
       }
-      async getMintSuiFrenTransaction(inputs) {
+      getMintSuiFrenTransaction(inputs) {
         return this.faucetApi().fetchBuildMintSuiFrenTx(inputs);
       }
     };
-    // =========================================================================
-    //  Constants
-    // =========================================================================
-    Faucet.constants = {
-      defaultRequestAmountUsd: 10
-    };
   }
 });
 
@@ -9649,18 +9639,21 @@ var init_perpetualsAccount = __esm({
        * @returns Transaction response containing `tx`.
        */
       async getCreateTwapOrdersTx(inputs) {
-        if ("vaultId" in this.accountCap) {
-          throw new Error("TWAP orders are not yet supported for vault accounts");
-        }
         const { tx, ...otherInputs } = inputs;
         return this.fetchApiTxObject(
-          "account/transactions/create-twap-orders",
+          `${this.vaultId ? "vault" : "account"}/transactions/create-twap-orders`,
           {
             ...otherInputs,
             txKind: await this.api?.Transactions().fetchBase64TxKindFromTx({ tx }),
             walletAddress: this.ownerAddress(),
-            accountId: this.accountCap.accountId,
-            accountCapId: this.accountCap.objectId
+            ..."vaultId" in this.accountCap ? {
+              vaultId: this.accountCap.vaultId,
+              accountId: void 0
+            } : {
+              accountId: this.accountCap.accountId,
+              accountCapId: this.accountCap.objectId,
+              vaultId: void 0
+            }
           },
           void 0,
           {
@@ -9678,18 +9671,21 @@ var init_perpetualsAccount = __esm({
        * @returns Transaction response containing `tx`.
        */
       async getEditTwapOrdersTx(inputs) {
-        if ("vaultId" in this.accountCap) {
-          throw new Error("TWAP orders are not yet supported for vault accounts");
-        }
         const { tx, ...otherInputs } = inputs;
         return this.fetchApiTxObject(
-          "account/transactions/edit-twap-orders",
+          `${this.vaultId ? "vault" : "account"}/transactions/edit-twap-orders`,
           {
             ...otherInputs,
             txKind: await this.api?.Transactions().fetchBase64TxKindFromTx({ tx }),
             walletAddress: this.ownerAddress(),
-            accountId: this.accountCap.accountId,
-            accountCapId: this.accountCap.objectId
+            ..."vaultId" in this.accountCap ? {
+              vaultId: this.accountCap.vaultId,
+              accountId: void 0
+            } : {
+              accountId: this.accountCap.accountId,
+              accountCapId: this.accountCap.objectId,
+              vaultId: void 0
+            }
           },
           void 0,
           {
@@ -9707,18 +9703,21 @@ var init_perpetualsAccount = __esm({
        * @returns Transaction response containing `tx`.
        */
       async getCancelTwapOrdersTx(inputs) {
-        if ("vaultId" in this.accountCap) {
-          throw new Error("TWAP orders are not yet supported for vault accounts");
-        }
         const { tx, ...otherInputs } = inputs;
         return this.fetchApiTxObject(
-          "account/transactions/cancel-twap-orders",
+          `${this.vaultId ? "vault" : "account"}/transactions/cancel-twap-orders`,
           {
             ...otherInputs,
             txKind: await this.api?.Transactions().fetchBase64TxKindFromTx({ tx }),
             walletAddress: this.ownerAddress(),
-            accountId: this.accountCap.accountId,
-            accountCapId: this.accountCap.objectId
+            ..."vaultId" in this.accountCap ? {
+              vaultId: this.accountCap.vaultId,
+              accountId: void 0
+            } : {
+              accountId: this.accountCap.accountId,
+              accountCapId: this.accountCap.objectId,
+              vaultId: void 0
+            }
           },
           void 0,
           {
@@ -9736,16 +9735,17 @@ var init_perpetualsAccount = __esm({
        * @returns {@link ApiPerpetualsTwapOrderDatasResponse} containing `twapOrderDatas`.
        */
       async getTwapOrderDatas(inputs) {
-        if ("vaultId" in this.accountCap) {
-          throw new Error("TWAP orders are not yet supported for vault accounts");
-        }
         const { bytes, signature, marketIds } = inputs;
-        return await this.fetchApi("account/twap-order-datas", {
+        return await this.fetchApi(`${this.vaultId ? "vault" : "account"}/twap-order-datas`, {
           bytes,
           signature,
           walletAddress: this.ownerAddress(),
           marketIds: marketIds ?? [],
-          accountId: this.accountCap.accountId
+          ..."vaultId" in this.accountCap ? {
+            vaultId: this.accountCap.vaultId
+          } : {
+            accountId: this.accountCap.accountId
+          }
         });
       }
       // public async getReduceOrderTx(inputs: {
@@ -12980,6 +12980,20 @@ var init_perpetuals = __esm({
             }
           }
         });
+        const subscribeMarketCandles = ({
+          marketId,
+          interval
+        }) => ctl.send({
+          action: "subscribe",
+          subscriptionType: { marketCandles: { marketId, interval } }
+        });
+        const unsubscribeMarketCandles = ({
+          marketId,
+          interval
+        }) => ctl.send({
+          action: "unsubscribe",
+          subscriptionType: { marketCandles: { marketId, interval } }
+        });
         return {
           ws: ctl.ws,
           subscribeMarket,
@@ -12998,6 +13012,8 @@ var init_perpetuals = __esm({
           unsubscribeUserCollateralChanges,
           subscribeTopOfOrderbook,
           unsubscribeTopOfOrderbook,
+          subscribeMarketCandles,
+          unsubscribeMarketCandles,
           close: ctl.close
         };
       }
@@ -17757,7 +17773,6 @@ var init_faucetApi = __esm({
     "use strict";
     init_eventsApiHelpers();
     init_transactionsApiHelpers();
-    init_utils();
     init_coin2();
     init_sui2();
     init_faucetApiCasting();
@@ -17778,35 +17793,24 @@ var init_faucetApi = __esm({
         // =========================================================================
         //  Transaction Commands
         // =========================================================================
-        // 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),
-        // 		],
-        // 	});
-        // };
+        /**
+         * Mints `coinType`'s configured default amount and returns the resulting
+         * `Coin<T>`. Use {@link buildRequestCoinTx} to mint and transfer it to a
+         * wallet in one transaction.
+         */
         this.requestCoinTx = (inputs) => {
           const { tx, coinType } = inputs;
           return tx.moveCall({
             target: TransactionsApiHelpers.createTxTarget(
               this.addresses.packages.faucet,
               _FaucetApi.constants.moduleNames.faucet,
-              "request_default_amount"
+              "mint"
             ),
             typeArguments: [coinType],
-            arguments: [tx.object(this.addresses.objects.faucet)]
+            arguments: [
+              tx.object(this.addresses.objects.faucet),
+              tx.object(this.addresses.objects.config)
+            ]
           });
         };
         this.mintSuiFrenTx = (inputs) => {
@@ -17831,9 +17835,14 @@ var init_faucetApi = __esm({
         // =========================================================================
         //  Transaction Builders
         // =========================================================================
-        this.buildRequestCoinTx = Helpers.transactions.createBuildTxFunc(
-          this.requestCoinTx
-        );
+        this.buildRequestCoinTx = (inputs) => {
+          const { walletAddress, coinType } = inputs;
+          const tx = new Transaction9();
+          tx.setSender(walletAddress);
+          const coin = this.requestCoinTx({ tx, coinType });
+          tx.transferObjects([coin], walletAddress);
+          return tx;
+        };
         this.fetchBuildMintSuiFrenTx = async (inputs) => {
           const { walletAddress, mintFee, suiFrenType } = inputs;
           const tx = new Transaction9();
@@ -17850,7 +17859,6 @@ var init_faucetApi = __esm({
         // =========================================================================
         //  Events
         // =========================================================================
-        // TODO: add to indexer
         this.fetchMintCoinEvents = async (inputs) => await this.api.Events().fetchCastEventsWithCursor({
           ...inputs,
           query: {
@@ -17858,7 +17866,6 @@ var init_faucetApi = __esm({
           },
           eventFromEventOnChain: FaucetApiCasting.faucetMintCoinEventFromOnChain
         });
-        // TODO: add to indexer
         this.fetchAddCoinEvents = async (inputs) => await this.api.Events().fetchCastEventsWithCursor(
           {
             ...inputs,
@@ -17909,7 +17916,7 @@ var init_faucetApi = __esm({
       },
       eventNames: {
         mintCoin: "MintedCoin",
-        addCoin: "AddedCoinEvent"
+        addCoin: "AddedCoin"
       }
     };
     FaucetApi = _FaucetApi;