aftermath-ts-sdk 1.3.23-perps.32 → 1.3.23-perps.34

package/dist/packages/perpetuals/perpetualsVault.d.ts

@@ -1,21 +1,51 @@
 import { Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
 import { AftermathApi } from "../../general/providers";
 import { Caller } from "../../general/utils/caller";
-import { Balance, CallerConfig, PerpetualsMarketId, PerpetualsVaultObject, SuiAddress, ApiPerpetualsVaultOwnerWithdrawPerformanceFeesTxResponse, PerpetualsVaultWithdrawRequest, ApiPerpetualsVaultPreviewCreateWithdrawRequestResponse, ApiPerpetualsVaultPreviewDepositResponse, ApiPerpetualsVaultPreviewProcessForceWithdrawRequestResponse, ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse, ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesResponse, ApiTransactionResponse, PerpetualsPartialVaultCap, ApiPerpetualsVaultPreviewOwnerWithdrawCollateralResponse, ApiPerpetualsVaultOwnerWithdrawCollateralTxResponse, ApiPerpetualsVaultProcessForceWithdrawRequestTxResponse } from "../../types";
+import { Balance, CallerConfig, PerpetualsMarketId, PerpetualsVaultObject, SuiAddress, ApiPerpetualsVaultOwnerWithdrawPerformanceFeesTxResponse, PerpetualsVaultWithdrawRequest, ApiPerpetualsVaultPreviewCreateWithdrawRequestResponse, ApiPerpetualsVaultPreviewDepositResponse, ApiPerpetualsVaultPreviewProcessForceWithdrawRequestResponse, ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse, ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesResponse, ApiTransactionResponse, PerpetualsPartialVaultCap, ApiPerpetualsVaultPreviewOwnerWithdrawCollateralResponse, ApiPerpetualsVaultsWithdrawRequestsResponse, ApiPerpetualsVaultOwnerWithdrawCollateralTxResponse, ApiPerpetualsVaultProcessForceWithdrawRequestTxResponse, PerpetualsAccountObject } from "../../types";
 import { PerpetualsAccount } from "./perpetualsAccount";
 export declare class PerpetualsVault extends Caller {
     readonly vaultObject: PerpetualsVaultObject;
     readonly Provider?: AftermathApi | undefined;
     static readonly constants: {
+        /**
+         * Maximum lock period in milliseconds.
+         */
         maxLockPeriodMs: number;
+        /**
+         * Minimum lock period in milliseconds.
+         */
         minLockPeriodMs: number;
+        /**
+         * Maximum period for force withdraw delay in milliseconds.
+         */
         maxForceWithdrawDelayMs: number;
+        /**
+         * Minimum period for force withdraw delay in milliseconds.
+         */
         minForceWithdrawDelayMs: number;
+        /**
+         * Minimum vault fee.
+         */
         minPerformanceFeePercentage: number;
+        /**
+         * Maximum vault fee.
+         */
         maxPerformanceFeePercentage: number;
+        /**
+         * Minimum USD value required for users deposits.
+         */
         minDepositUsd: number;
+        /**
+         * Minimum USD value required to be locked by vault owner during vault creation.
+         */
         minOwnerLockUsd: number;
+        /**
+         * The maximum number of distinct `ClearingHouse`.
+         */
         maxMarketsInVault: number;
+        /**
+         * The maximum number of pending orders allowed for a single position in the `Vault`.
+         */
         maxPendingOrdersPerPosition: number;
     };
     constructor(vaultObject: PerpetualsVaultObject, config?: CallerConfig, Provider?: AftermathApi | undefined);
@@ -98,7 +128,7 @@ export declare class PerpetualsVault extends Caller {
     })): Promise<Omit<ApiTransactionResponse, "txKind"> & {
         tx: Transaction;
     }>;
-    getAllWithdrawRequests(): Promise<PerpetualsVaultWithdrawRequest[]>;
+    getAllWithdrawRequests(): Promise<ApiPerpetualsVaultsWithdrawRequestsResponse>;
     getPreviewOwnerProcessWithdrawRequests(inputs: {
         userAddresses: SuiAddress[];
     }): Promise<ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse>;
@@ -118,8 +148,12 @@ export declare class PerpetualsVault extends Caller {
     }): Promise<ApiPerpetualsVaultPreviewProcessForceWithdrawRequestResponse>;
     getLpCoinPrice(): Promise<number>;
     partialVaultCap(): PerpetualsPartialVaultCap;
-    getAccountObject(): Promise<import("./perpetualsTypes").PerpetualsAccountObject>;
-    getAccount(): Promise<PerpetualsAccount>;
+    getAccountObject(): Promise<{
+        account: PerpetualsAccountObject;
+    }>;
+    getAccount(): Promise<{
+        account: PerpetualsAccount;
+    }>;
     /**
      * Checks if a string is a valid LP coin name.
      *

package/dist/packages/perpetuals/perpetualsVault.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"perpetualsVault.d.ts","sourceRoot":"","sources":["../../../src/packages/perpetuals/perpetualsVault.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,WAAW,EACX,yBAAyB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAKN,OAAO,EACP,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EAEV,wDAAwD,EAExD,8BAA8B,EAQ9B,sDAAsD,EACtD,wCAAwC,EAExC,4DAA4D,EAE5D,6DAA6D,EAE7D,6DAA6D,EAG7D,sBAAsB,EAEtB,yBAAyB,EACzB,wDAAwD,EAGxD,mDAAmD,EACnD,uDAAuD,EACvD,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,qBAAa,eAAgB,SAAQ,MAAM;aAsCzB,WAAW,EAAE,qBAAqB;aAElC,QAAQ,CAAC,EAAE,YAAY;IAnCxC,gBAAuB,SAAS;;;;;;;;;;;MA0B9B;gBAOe,WAAW,EAAE,qBAAqB,EAClD,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,EAAE,YAAY,YAAA;IAa3B,gCAAgC,CAAC,MAAM,EAAE;QACrD,aAAa,EAAE,UAAU,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAClD,gBAAgB,CAAC,EAAE,UAAU,CAAC;QAC9B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAwBY,kCAAkC,CAAC,MAAM,EAAE;QACvD,sBAAsB,EAAE,OAAO,CAAC;QAChC,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IA2BY,kCAAkC,CAAC,MAAM,EAAE;QACvD,oBAAoB,EAAE,MAAM,CAAC;QAC7B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,0BAA0B,CAAC,MAAM,EAAE;QAC/C,YAAY,EAAE,MAAM,CAAC;QACrB,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,8BAA8B,CAAC,MAAM,EAAE;QACnD,wBAAwB,EAAE,MAAM,CAAC;QACjC,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IA2BY,iCAAiC,CAAC,MAAM,EAAE;QACtD,aAAa,EAAE,UAAU,EAAE,CAAC;QAC5B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAwBY,iCAAiC,CAAC,MAAM,EAAE;QACtD,cAAc,EAAE,OAAO,CAAC;QACxB,gBAAgB,CAAC,EAAE,UAAU,CAAC;QAC9B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,4BAA4B,CAAC,MAAM,EAAE;QACjD,gBAAgB,EAAE,OAAO,CAAC;QAC1B,sBAAsB,EAAE,OAAO,CAAC;QAChC,gBAAgB,CAAC,EAAE,UAAU,CAAC;QAC9B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IA2BY,0BAA0B,CAAC,MAAM,EAAE;QAC/C,aAAa,EAAE,UAAU,CAAC;QAC1B,gBAAgB,EAAE,OAAO,CAAC;QAC1B,sBAAsB,EAAE,OAAO,CAAC;QAChC,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,0BAA0B,CAAC,MAAM,EAAE;QAC/C,aAAa,EAAE,UAAU,CAAC;QAC1B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAwBY,YAAY,CACxB,MAAM,EAAE;QACP,aAAa,EAAE,UAAU,CAAC;QAC1B,cAAc,EAAE,OAAO,CAAC;QACxB,EAAE,CAAC,EAAE,WAAW,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,CACD;QACA,aAAa,EAAE,OAAO,CAAC;KACtB,GACD;QACA,cAAc,EAAE,yBAAyB,CAAC;KACzC,CACH;;;IAyCK,sBAAsB,IAAI,OAAO,CAAC,8BAA8B,EAAE,CAAC;IA2B7D,sCAAsC,CAAC,MAAM,EAAE;QAE3D,aAAa,EAAE,UAAU,EAAE,CAAC;KAC5B;IAUY,sCAAsC;IAStC,iCAAiC,CAAC,MAAM,EAAE;QACtD,gBAAgB,EAAE,OAAO,CAAC;KAC1B;IAcY,+BAA+B,CAAC,MAAM,EAAE;QACpD,aAAa,EAAE,UAAU,CAAC;QAC1B,gBAAgB,EAAE,OAAO,CAAC;KAC1B;IAUY,iBAAiB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE;IAUpD,qCAAqC,CAAC,MAAM,EAAE;QAC1D,aAAa,EAAE,UAAU,CAAC;KAC1B;IAcY,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAYvC,eAAe,IAAI,yBAAyB;IAUtC,gBAAgB;IAShB,UAAU;IAUvB;;;;;OAKG;IACH,OAAc,iBAAiB,GAAI,OAAO,MAAM,KAAG,OAAO,CAExD;IAEF;;;;;OAKG;IACH,OAAc,uBAAuB,GAAI,OAAO,MAAM,KAAG,OAAO,CAE9D;IAMF,OAAc,2BAA2B,GAAI,QAAQ;QACpD,eAAe,EAAE,8BAA8B,CAAC;KAChD,YAOC;CACF"}
+{"version":3,"file":"perpetualsVault.d.ts","sourceRoot":"","sources":["../../../src/packages/perpetuals/perpetualsVault.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,WAAW,EACX,yBAAyB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAKN,OAAO,EACP,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EAEV,wDAAwD,EAExD,8BAA8B,EAQ9B,sDAAsD,EACtD,wCAAwC,EAExC,4DAA4D,EAE5D,6DAA6D,EAE7D,6DAA6D,EAG7D,sBAAsB,EAEtB,yBAAyB,EACzB,wDAAwD,EAGxD,2CAA2C,EAC3C,mDAAmD,EACnD,uDAAuD,EACvD,uBAAuB,EACvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,qBAAa,eAAgB,SAAQ,MAAM;aA0DzB,WAAW,EAAE,qBAAqB;aAElC,QAAQ,CAAC,EAAE,YAAY;IAvDxC,gBAAuB,SAAS;QAM/B;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;MAEF;gBAOe,WAAW,EAAE,qBAAqB,EAClD,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,EAAE,YAAY,YAAA;IAa3B,gCAAgC,CAAC,MAAM,EAAE;QACrD,aAAa,EAAE,UAAU,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAClD,gBAAgB,CAAC,EAAE,UAAU,CAAC;QAC9B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAwBY,kCAAkC,CAAC,MAAM,EAAE;QACvD,sBAAsB,EAAE,OAAO,CAAC;QAChC,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IA2BY,kCAAkC,CAAC,MAAM,EAAE;QACvD,oBAAoB,EAAE,MAAM,CAAC;QAC7B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,0BAA0B,CAAC,MAAM,EAAE;QAC/C,YAAY,EAAE,MAAM,CAAC;QACrB,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,8BAA8B,CAAC,MAAM,EAAE;QACnD,wBAAwB,EAAE,MAAM,CAAC;QACjC,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IA2BY,iCAAiC,CAAC,MAAM,EAAE;QACtD,aAAa,EAAE,UAAU,EAAE,CAAC;QAC5B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAwBY,iCAAiC,CAAC,MAAM,EAAE;QACtD,cAAc,EAAE,OAAO,CAAC;QACxB,gBAAgB,CAAC,EAAE,UAAU,CAAC;QAC9B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,4BAA4B,CAAC,MAAM,EAAE;QACjD,gBAAgB,EAAE,OAAO,CAAC;QAC1B,sBAAsB,EAAE,OAAO,CAAC;QAChC,gBAAgB,CAAC,EAAE,UAAU,CAAC;QAC9B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IA2BY,0BAA0B,CAAC,MAAM,EAAE;QAC/C,aAAa,EAAE,UAAU,CAAC;QAC1B,gBAAgB,EAAE,OAAO,CAAC;QAC1B,sBAAsB,EAAE,OAAO,CAAC;QAChC,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAuBY,0BAA0B,CAAC,MAAM,EAAE;QAC/C,aAAa,EAAE,UAAU,CAAC;QAC1B,EAAE,CAAC,EAAE,WAAW,CAAC;KACjB;;;IAwBY,YAAY,CACxB,MAAM,EAAE;QACP,aAAa,EAAE,UAAU,CAAC;QAC1B,cAAc,EAAE,OAAO,CAAC;QACxB,EAAE,CAAC,EAAE,WAAW,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,CACD;QACA,aAAa,EAAE,OAAO,CAAC;KACtB,GACD;QACA,cAAc,EAAE,yBAAyB,CAAC;KACzC,CACH;;;IAyCK,sBAAsB,IAAI,OAAO,CAAC,2CAA2C,CAAC;IA2BxE,sCAAsC,CAAC,MAAM,EAAE;QAE3D,aAAa,EAAE,UAAU,EAAE,CAAC;KAC5B;IAUY,sCAAsC;IAStC,iCAAiC,CAAC,MAAM,EAAE;QACtD,gBAAgB,EAAE,OAAO,CAAC;KAC1B;IAcY,+BAA+B,CAAC,MAAM,EAAE;QACpD,aAAa,EAAE,UAAU,CAAC;QAC1B,gBAAgB,EAAE,OAAO,CAAC;KAC1B;IAUY,iBAAiB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE;IAUpD,qCAAqC,CAAC,MAAM,EAAE;QAC1D,aAAa,EAAE,UAAU,CAAC;KAC1B;IAcY,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAYvC,eAAe,IAAI,yBAAyB;IAUtC,gBAAgB,IAAI,OAAO,CAAC;QACxC,OAAO,EAAE,uBAAuB,CAAC;KACjC,CAAC;IAaW,UAAU,IAAI,OAAO,CAAC;QAClC,OAAO,EAAE,iBAAiB,CAAC;KAC3B,CAAC;IAUF;;;;;OAKG;IACH,OAAc,iBAAiB,GAAI,OAAO,MAAM,KAAG,OAAO,CAExD;IAEF;;;;;OAKG;IACH,OAAc,uBAAuB,GAAI,OAAO,MAAM,KAAG,OAAO,CAE9D;IAMF,OAAc,2BAA2B,GAAI,QAAQ;QACpD,eAAe,EAAE,8BAA8B,CAAC;KAChD,YAOC;CACF"}

package/dist/packages/perpetuals/perpetualsVault.js

@@ -185,7 +185,7 @@ class PerpetualsVault extends caller_1.Caller {
     // =========================================================================
     //  Objects
     // =========================================================================
-    // TODO: move to `Perpetuals` ?
+    // TODO: move to `Perpetuals` (as well) ?
     getAllWithdrawRequests() {
         return this.fetchApi("vaults/withdraw-requests", {
             vaultIds: [this.vaultObject.objectId],
@@ -248,7 +248,7 @@ class PerpetualsVault extends caller_1.Caller {
         return __awaiter(this, void 0, void 0, function* () {
             return (yield new perpetuals_1.Perpetuals(this.config, this.Provider).getLpCoinPrices({
                 vaultIds: [this.vaultObject.objectId],
-            }))[0];
+            })).lpCoinPrices[0];
         });
     }
     // =========================================================================
@@ -265,10 +265,11 @@ class PerpetualsVault extends caller_1.Caller {
     }
     getAccountObject() {
         return __awaiter(this, void 0, void 0, function* () {
-            return (yield new perpetuals_1.Perpetuals(this.config, this.Provider).getAccountObjects({
-                accountIds: [this.vaultObject.accountId],
-                collateralCoinType: this.vaultObject.collateralCoinType,
-            }))[0];
+            return {
+                account: (yield new perpetuals_1.Perpetuals(this.config, this.Provider).getAccountObjects({
+                    accountIds: [this.vaultObject.accountId],
+                })).accounts[0],
+            };
         });
     }
     getAccount() {
@@ -287,25 +288,45 @@ PerpetualsVault.constants = {
     // NOTE: what is this ?
     // /// Time necessary for the next vault's params update
     // vaultParamsUpdateFrequency: (u64 = 86400000),
-    /// Maximum lock period in milliseconds.
+    /**
+     * Maximum lock period in milliseconds.
+     */
     maxLockPeriodMs: 604800000, // 1 week
-    /// Minimum lock period in milliseconds.
+    /**
+     * Minimum lock period in milliseconds.
+     */
     minLockPeriodMs: 3600000, // 1 hour
-    /// Maximum period for force withdraw delay in milliseconds.
+    /**
+     * Maximum period for force withdraw delay in milliseconds.
+     */
     maxForceWithdrawDelayMs: 86400000, // 1 day
-    /// Minimum period for force withdraw delay in milliseconds.
+    /**
+     * Minimum period for force withdraw delay in milliseconds.
+     */
     minForceWithdrawDelayMs: 3600000, // 1 hour
-    /// Minimum vault fee.
+    /**
+     * Minimum vault fee.
+     */
     minPerformanceFeePercentage: 0.0, // 0%
-    /// Maximum vault fee.
+    /**
+     * Maximum vault fee.
+     */
     maxPerformanceFeePercentage: 0.2, // 20%
-    // Minimum USD value required for users deposits.
+    /**
+     * Minimum USD value required for users deposits.
+     */
     minDepositUsd: 1,
-    // Minimum USD value required to be locked by vault owner during vault creation.
+    /**
+     * Minimum USD value required to be locked by vault owner during vault creation.
+     */
     minOwnerLockUsd: 10,
-    /// The maximum number of distinct `ClearingHouse`.
+    /**
+     * The maximum number of distinct `ClearingHouse`.
+     */
     maxMarketsInVault: 12,
-    /// The maximum number of pending orders allowed for a single position in the `Vault`.
+    /**
+     * The maximum number of pending orders allowed for a single position in the `Vault`.
+     */
     maxPendingOrdersPerPosition: 70,
 };
 // =========================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "aftermath-ts-sdk",
-	"version": "1.3.23-perps.32",
+	"version": "1.3.23-perps.34",
 	"description": "Aftermath TypeScript SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",