aftermath-ts-sdk 5.0.1 → 5.0.2-dev.199e2ab

package/dist/index.d.ts

@@ -691,8 +691,8 @@ interface PoolsAddresses {
     };
     /** Optional data required to publish LP-coin packages. */
     other?: {
-        /** JSON-serialized Move modules and dependencies keyed by LP-coin decimals. */
-        createLpCoinPackageCompilations: Record<CoinDecimal, string>;
+        /** Serialized Move package compilation templated per pool for LP-coin publishing. */
+        createLpCoinPackageCompilation: string;
     };
 }
 /** Package and object addresses used by DAO fee-pool operations. */
@@ -3047,8 +3047,13 @@ interface PerpetualsVaultObject {
         /** Minimum position margin (USD) to trigger full close during force withdraw. */
         minForceWithdrawValueUsd: number;
     };
-    /** Owner address of the vault. */
-    ownerAddress: SuiAddress;
+    /**
+     * Owner address of the vault.
+     *
+     * `null` when the vault's owner cap, or its owner address, cannot be
+     * resolved. The field is always present; only its value may be null.
+     */
+    ownerAddress: SuiAddress | null;
     /** Creation timestamp of the vault. */
     creationTimestamp: Timestamp | undefined;
     /** Underlying perpetuals account ID that the vault uses. */
@@ -7584,6 +7589,8 @@ interface PoolCreationLpCoinMetadata {
     symbol: string;
     /** An optional URL for the LP coin icon. */
     iconUrl?: Url;
+    /** An optional description templated into the LP coin package. */
+    description?: string;
 }
 /**
  * A data structure used for integration with CoinGecko, representing
@@ -7694,10 +7701,23 @@ interface ApiPoolAllCoinWithdrawBody {
  * typically specifying the coin's decimals.
  */
 interface ApiPublishLpCoinBody {
-    /** The wallet that publishes and receives the LP coin package upgrade cap. */
+    /** The wallet that publishes the LP coin package and receives the pool-creation cap. */
     walletAddress: SuiAddress;
-    /** The decimal precision compiled into the LP coin package. */
-    lpCoinDecimals: number;
+    /** Name, symbol, optional icon, and optional description templated into the LP coin. */
+    lpCoinMetadata: PoolCreationLpCoinMetadata;
+    /** Per-coin type, weight, and decimals templated into the LP coin package. */
+    coinsInfo: {
+        /** The fully qualified coin type deposited into the pool. */
+        coinType: CoinType;
+        /** The decimal weight for this coin. Weights must sum to `1`. */
+        weight: Percentage;
+        /** Optional display precision stored for this coin. */
+        decimals?: number;
+    }[];
+    /** The pool curve mode passed to Move as a flatness value. */
+    poolFlatness: 0 | 1;
+    /** Whether the supplied coin decimals are preserved for the LP coin. */
+    respectDecimals: boolean;
 }
 /**
  * Request body for creating a new pool, specifying coin information,
@@ -7708,8 +7728,6 @@ interface ApiCreatePoolBody {
     walletAddress: SuiAddress;
     /** The fully qualified LP coin type used by the new pool. */
     lpCoinType: CoinType;
-    /** Metadata for the LP coin published for the pool. */
-    lpCoinMetadata: PoolCreationLpCoinMetadata;
     /** Per-coin weights, fees, decimal metadata, and initial deposits. */
     coinsInfo: {
         /** The fully qualified coin type deposited into the pool. */
@@ -7731,8 +7749,6 @@ interface ApiCreatePoolBody {
     createPoolCapId: ObjectId;
     /** Whether the transaction should preserve the supplied coin decimals. */
     respectDecimals: boolean;
-    /** Optional decimal precision forced for the LP coin. */
-    forceLpDecimals?: CoinDecimal;
     /** Whether coin selection is prepared for a sponsored transaction. */
     isSponsoredTx?: boolean;
     /** Whether the LP coin is burned as part of the creation flow. */
@@ -11288,20 +11304,29 @@ declare class Pools extends Caller {
         walletAddress: SuiAddress;
     }): Promise<PoolLpInfo[]>;
     /**
-     * Builds an unsigned transaction that publishes the compiled LP coin package.
+     * Builds an unsigned transaction that publishes an LP coin package templated
+     * for this pool and mints its `CreatePoolCapV2`.
      *
-     * The transaction transfers the resulting upgrade capability to
-     * `walletAddress`. It is not signed, submitted, or serialized by this method.
+     * The API templates the LP coin package with the pool's metadata, weights,
+     * decimals, and flatness, publishes it, and transfers the resulting cap and
+     * upgrade capability to `walletAddress`. This method does not sign, submit, or
+     * serialize the returned `Transaction`.
      *
-     * @param inputs - Publisher address and compiled LP coin decimal precision.
+     * @param inputs - Publisher address, LP coin metadata, and pool configuration.
      * @returns A promise for the unsigned publish `Transaction`.
-     * @throws `Error` when the provider lacks the compiled package for the requested decimals.
+     * @throws `AftermathTransportError` when the API cannot build or decode the transaction.
      *
      * @example
      * ```typescript
      * const publishTx = await pools.getPublishLpCoinTransaction({
      *   walletAddress: "0x<address>",
-     *   lpCoinDecimals: 9
+     *   lpCoinMetadata: { name: "MyPool LP", symbol: "MYPLP" },
+     *   coinsInfo: [
+     *     { weight: 0.5, decimals: 9 },
+     *     { weight: 0.5, decimals: 6 },
+     *   ],
+     *   poolFlatness: 0,
+     *   respectDecimals: true,
      * });
      * ```
      */
@@ -19591,15 +19616,6 @@ declare class PoolsApi implements MoveErrorsInterface {
         coinTypes: CoinType[];
         withTransfer?: boolean;
     }) => TransactionObjectArgument[];
-    /**
-     * Publishes a transaction block for creating a liquidity pool coin.
-     * @param inputs An object containing the transaction block and the decimal value of the liquidity pool coin.
-     * @returns A promise that resolves to the result of the transaction publishing.
-     */
-    publishLpCoinTx: (inputs: {
-        tx: Transaction;
-        lpCoinDecimals: CoinDecimal;
-    }) => _mysten_sui_transactions.TransactionResult;
     /**
      * Creates a transaction to create a new pool.
      * @param inputs - An object containing the necessary inputs to create the pool.
@@ -19618,14 +19634,10 @@ declare class PoolsApi implements MoveErrorsInterface {
             depositFee: PoolDepositFee;
             withdrawFee: PoolWithdrawFee;
         }[];
-        lpCoinMetadata: PoolCreationLpCoinMetadata;
-        lpCoinIconUrl: Url;
         createPoolCapId: ObjectId | TransactionObjectArgument;
         poolName: PoolName;
         poolFlatness: PoolFlatness;
-        lpCoinDescription: string;
         respectDecimals: boolean;
-        forceLpDecimals?: CoinDecimal;
         withTransfer?: boolean;
     }) => TransactionObjectArgument[];
     /**
@@ -19826,12 +19838,6 @@ declare class PoolsApi implements MoveErrorsInterface {
         lpCoinAmount: Balance;
         referrer?: SuiAddress;
     }) => Promise<Transaction>;
-    /**
-     * Builds a transaction block for publishing an LP coin.
-     * @param inputs - The input parameters for the transaction.
-     * @returns The built transaction block.
-     */
-    buildPublishLpCoinTx: (inputs: ApiPublishLpCoinBody) => Transaction;
     /**
      * Builds a standalone transaction that updates a DAO fee in basis points.
      *

package/dist/index.js

@@ -10810,25 +10810,35 @@ var init_pools = __esm({
       //  Transactions
       // =========================================================================
       /**
-       * Builds an unsigned transaction that publishes the compiled LP coin package.
+       * Builds an unsigned transaction that publishes an LP coin package templated
+       * for this pool and mints its `CreatePoolCapV2`.
        *
-       * The transaction transfers the resulting upgrade capability to
-       * `walletAddress`. It is not signed, submitted, or serialized by this method.
+       * The API templates the LP coin package with the pool's metadata, weights,
+       * decimals, and flatness, publishes it, and transfers the resulting cap and
+       * upgrade capability to `walletAddress`. This method does not sign, submit, or
+       * serialize the returned `Transaction`.
        *
-       * @param inputs - Publisher address and compiled LP coin decimal precision.
+       * @param inputs - Publisher address, LP coin metadata, and pool configuration.
        * @returns A promise for the unsigned publish `Transaction`.
-       * @throws `Error` when the provider lacks the compiled package for the requested decimals.
+       * @throws `AftermathTransportError` when the API cannot build or decode the transaction.
        *
        * @example
        * ```typescript
        * const publishTx = await pools.getPublishLpCoinTransaction({
        *   walletAddress: "0x<address>",
-       *   lpCoinDecimals: 9
+       *   lpCoinMetadata: { name: "MyPool LP", symbol: "MYPLP" },
+       *   coinsInfo: [
+       *     { weight: 0.5, decimals: 9 },
+       *     { weight: 0.5, decimals: 6 },
+       *   ],
+       *   poolFlatness: 0,
+       *   respectDecimals: true,
        * });
        * ```
        */
       async getPublishLpCoinTransaction(inputs) {
-        return this.poolsApi().buildPublishLpCoinTx(inputs);
+        const { tx } = await this.fetchApiTxObject("transactions/publish-lp-coin", inputs);
+        return tx;
       }
       /**
        * Builds an unsigned transaction that creates a new pool on chain.
@@ -10867,7 +10877,8 @@ var init_pools = __esm({
        * ```
        */
       async getCreatePoolTransaction(inputs) {
-        return this.fetchApiTransaction("transactions/create-pool", inputs);
+        const { tx } = await this.fetchApiTxObject("transactions/create-pool", inputs);
+        return tx;
       }
       /**
        * Resolves LP coin types to pool object IDs.
@@ -14516,7 +14527,7 @@ var init_perpetualsVault = __esm({
       partialVaultCap() {
         return {
           vaultId: this.vaultObject.objectId,
-          ownerAddress: this.vaultObject.ownerAddress,
+          ownerAddress: this.vaultObject.ownerAddress ?? "",
           accountId: this.vaultObject.accountId,
           accountObjectId: this.vaultObject.accountObjectId,
           collateralCoinType: this.vaultObject.collateralCoinType
@@ -23818,7 +23829,6 @@ import { bcs as bcs2 } from "@mysten/sui/bcs";
 import {
   Transaction as Transaction12
 } from "@mysten/sui/transactions";
-import { fromBase64 as fromBase642, normalizeSuiObjectId } from "@mysten/sui/utils";
 var _PoolsApi, PoolsApi;
 var init_poolsApi = __esm({
   "src/packages/pools/api/poolsApi.ts"() {
@@ -24022,29 +24032,6 @@ var init_poolsApi = __esm({
             ]
           });
         };
-        /**
-         * Publishes a transaction block for creating a liquidity pool coin.
-         * @param inputs An object containing the transaction block and the decimal value of the liquidity pool coin.
-         * @returns A promise that resolves to the result of the transaction publishing.
-         */
-        this.publishLpCoinTx = (inputs) => {
-          const compilations = this.addresses.pools.other?.createLpCoinPackageCompilations;
-          if (!compilations) {
-            throw new Error(
-              "not all required addresses have been set in provider for lp coin publishing (requires package compilations)"
-            );
-          }
-          const { tx, lpCoinDecimals } = inputs;
-          const compiledModulesAndDeps = JSON.parse(compilations[lpCoinDecimals]);
-          return tx.publish({
-            modules: compiledModulesAndDeps.modules.map(
-              (m) => Array.from(fromBase642(m))
-            ),
-            dependencies: compiledModulesAndDeps.dependencies.map(
-              (addr) => normalizeSuiObjectId(addr)
-            )
-          });
-        };
         // TODO: handle bounds checks here instead of just on-chain ?
         /**
          * Creates a transaction to create a new pool.
@@ -24052,16 +24039,7 @@ var init_poolsApi = __esm({
          * @returns A transaction block to create the pool.
          */
         this.createPoolTx = (inputs) => {
-          const {
-            tx,
-            lpCoinType,
-            createPoolCapId,
-            coinsInfo,
-            lpCoinMetadata,
-            lpCoinDescription,
-            lpCoinIconUrl,
-            withTransfer
-          } = inputs;
+          const { tx, lpCoinType, createPoolCapId, coinsInfo, withTransfer } = inputs;
           const poolSize = coinsInfo.length;
           const coinTypes = coinsInfo.map((coin) => coin.coinType);
           const decimals = coinsInfo.map((coin) => coin.decimals);
@@ -24069,7 +24047,7 @@ var init_poolsApi = __esm({
             target: Helpers.transactions.createTxTarget(
               withTransfer ? this.addresses.pools.packages.ammInterface : this.addresses.pools.packages.amm,
               withTransfer ? _PoolsApi.constants.moduleNames.interface : _PoolsApi.constants.moduleNames.poolFactory,
-              `create_pool_${poolSize}_coins`
+              `create_pool_${poolSize}_coins_v2`
             ),
             typeArguments: [lpCoinType, ...coinTypes],
             arguments: [
@@ -24078,25 +24056,6 @@ var init_poolsApi = __esm({
               tx.pure(
                 bcs2.vector(bcs2.u8()).serialize(Casting.u8VectorFromString(inputs.poolName))
               ),
-              tx.pure(
-                bcs2.vector(bcs2.u8()).serialize(
-                  Casting.u8VectorFromString(lpCoinMetadata.name.toString())
-                )
-              ),
-              tx.pure(
-                bcs2.vector(bcs2.u8()).serialize(
-                  Casting.u8VectorFromString(
-                    lpCoinMetadata.symbol.toString().toUpperCase()
-                  )
-                )
-              ),
-              tx.pure(
-                bcs2.vector(bcs2.u8()).serialize(Casting.u8VectorFromString(lpCoinDescription))
-              ),
-              tx.pure(
-                bcs2.vector(bcs2.u8()).serialize(Casting.u8VectorFromString(lpCoinIconUrl))
-              ),
-              // lp_icon_url
               tx.pure(
                 bcs2.vector(bcs2.u64()).serialize(coinsInfo.map((coin) => coin.weight))
               ),
@@ -24121,11 +24080,7 @@ var init_poolsApi = __esm({
                   decimals.includes(void 0) ? void 0 : decimals
                 )
               ),
-              // decimals
-              tx.pure.bool(inputs.respectDecimals),
-              // respect_decimals
-              tx.pure(bcs2.option(bcs2.u8()).serialize(inputs.forceLpDecimals))
-              // force_lp_decimals
+              tx.pure.bool(inputs.respectDecimals)
             ]
           });
         };
@@ -24641,19 +24596,6 @@ var init_poolsApi = __esm({
           }
           return tx;
         };
-        /**
-         * Builds a transaction block for publishing an LP coin.
-         * @param inputs - The input parameters for the transaction.
-         * @returns The built transaction block.
-         */
-        this.buildPublishLpCoinTx = (inputs) => {
-          const { lpCoinDecimals } = inputs;
-          const tx = new Transaction12();
-          tx.setSender(inputs.walletAddress);
-          const upgradeCap = this.publishLpCoinTx({ tx, lpCoinDecimals });
-          tx.transferObjects([upgradeCap], inputs.walletAddress);
-          return tx;
-        };
         /**
          * Builds a standalone transaction that updates a DAO fee in basis points.
          *