@ember-finance/sdk 2.21.0 → 2.22.0

package/dist/src/sui-vaults/on-chain-calls/operator.d.ts

@@ -6,12 +6,21 @@ import { NumStr } from "@firefly-exchange/library-sui";
 export declare class OperatorCalls extends OnChainCalls {
     constructor(_network: string, _suiClient: SuiClient, _deployment: ISuiDeployment, _signer?: Signer, _walletAddress?: string);
     /**
-     * Collect platform fee from a vault
+     * Collect platform fee from a vault, through whichever entry the protocol's
+     * current version accepts: `collect_platform_fee_v2` from VERSION 6, the
+     * legacy `collect_platform_fee` before it.
      * @param vaultId The id of the vault to collect platform fee from
      * @param options Optional tx execution params
      * @returns OnChainCallResponse
      */
     collectPlatformFee(vaultId: string, options?: IVaultOptionalParams & SuiTransactionBlockResponseOptions): Promise<OnChainCallResponse>;
+    /**
+     * Collect platform fee from a vault via `collect_platform_fee_v2` (VERSION 6+)
+     * @param vaultId The id of the vault to collect platform fee from
+     * @param options Optional tx execution params
+     * @returns OnChainCallResponse
+     */
+    collectPlatformFeeV2(vaultId: string, options?: IVaultOptionalParams & SuiTransactionBlockResponseOptions): Promise<OnChainCallResponse>;
     /**
      * Charge platform fee from a vault
      * @param vaultId The id of the vault to charge platform fee from

package/dist/src/sui-vaults/on-chain-calls/operator.js

@@ -1,19 +1,39 @@
 import { OnChainCalls } from "./onchain-calls.js";
 import { TransactionBlock } from "@firefly-exchange/library-sui";
 import { CoinUtils } from "@firefly-exchange/library-sui";
+import { SuiProtocolConfigReader, usesCollectPlatformFeeV2 } from "./protocol-config-reader.js";
 export class OperatorCalls extends OnChainCalls {
     constructor(_network, _suiClient, _deployment, _signer, _walletAddress) {
         super(_network, _suiClient, _deployment, _signer, _walletAddress);
     }
     /**
-     * Collect platform fee from a vault
+     * Collect platform fee from a vault, through whichever entry the protocol's
+     * current version accepts: `collect_platform_fee_v2` from VERSION 6, the
+     * legacy `collect_platform_fee` before it.
      * @param vaultId The id of the vault to collect platform fee from
      * @param options Optional tx execution params
      * @returns OnChainCallResponse
      */
     async collectPlatformFee(vaultId, options) {
+        const { version } = await new SuiProtocolConfigReader(this.suiClient, this.parser.getProtocolConfig()).getProtocolConfigState();
         const txb = options?.txBlock || new TransactionBlock();
-        this.txBuilder.collectPlatformFee(vaultId, { ...options, txBlock: txb });
+        if (usesCollectPlatformFeeV2(version)) {
+            this.txBuilder.collectPlatformFeeV2(vaultId, { ...options, txBlock: txb });
+        }
+        else {
+            this.txBuilder.collectPlatformFee(vaultId, { ...options, txBlock: txb });
+        }
+        return this.execCall(txb, options);
+    }
+    /**
+     * Collect platform fee from a vault via `collect_platform_fee_v2` (VERSION 6+)
+     * @param vaultId The id of the vault to collect platform fee from
+     * @param options Optional tx execution params
+     * @returns OnChainCallResponse
+     */
+    async collectPlatformFeeV2(vaultId, options) {
+        const txb = options?.txBlock || new TransactionBlock();
+        this.txBuilder.collectPlatformFeeV2(vaultId, { ...options, txBlock: txb });
         return this.execCall(txb, options);
     }
     /**

package/dist/src/sui-vaults/on-chain-calls/protocol-config-reader.d.ts

@@ -2,6 +2,14 @@ import { BaseClient as SuiClient } from "@mysten/sui/client";
 import { IProtocolConfigState } from "../interfaces/index.js";
 /** The protocol's sentinel for "no guardian". */
 export declare const SUI_ZERO_ADDRESS: string;
+/** First ProtocolConfig.version whose package aborts `collect_platform_fee`. */
+export declare const SUI_COLLECT_PLATFORM_FEE_V2_VERSION = 6;
+/**
+ * Whether platform fees must be collected through `collect_platform_fee_v2`.
+ * @param protocolVersion ProtocolConfig.version
+ * @returns True from VERSION 6 on
+ */
+export declare function usesCollectPlatformFeeV2(protocolVersion: string | number): boolean;
 export declare class SuiProtocolConfigReader {
     suiClient: SuiClient;
     protocolConfigId: string;

package/dist/src/sui-vaults/on-chain-calls/protocol-config-reader.js

@@ -4,6 +4,16 @@ import { normalizeSuiAddress } from "@mysten/sui/utils";
 const GUARDIAN_FIELD_KEY = "guardian";
 /** The protocol's sentinel for "no guardian". */
 export const SUI_ZERO_ADDRESS = normalizeSuiAddress("0x0");
+/** First ProtocolConfig.version whose package aborts `collect_platform_fee`. */
+export const SUI_COLLECT_PLATFORM_FEE_V2_VERSION = 6;
+/**
+ * Whether platform fees must be collected through `collect_platform_fee_v2`.
+ * @param protocolVersion ProtocolConfig.version
+ * @returns True from VERSION 6 on
+ */
+export function usesCollectPlatformFeeV2(protocolVersion) {
+    return Number(protocolVersion) >= SUI_COLLECT_PLATFORM_FEE_V2_VERSION;
+}
 /** gRPC flattens Move structs; JSON-RPC keeps a `fields` wrapper. */
 const unwrapMoveFields = (value) => value?.fields ?? value;
 export class SuiProtocolConfigReader {

package/dist/src/sui-vaults/on-chain-calls/tx-builder.d.ts

@@ -353,6 +353,13 @@ export declare class TxBuilder {
      * @returns TransactionBlock
      */
     collectPlatformFee(vaultId: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Collect platform fee (package VERSION 6+, where `collect_platform_fee` aborts)
+     * @param vaultId Id of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    collectPlatformFeeV2(vaultId: string, options?: ITxBuilderOptionalParams): TransactionBlock;
     /**
      * Deposit asset
      * @param vaultId Id of the vault

package/dist/src/sui-vaults/on-chain-calls/tx-builder.js

@@ -1041,6 +1041,32 @@ export class TxBuilder {
             txb.setSenderIfNotSet(options.sender);
         return txb;
     }
+    /**
+     * Collect platform fee (package VERSION 6+, where `collect_platform_fee` aborts)
+     * @param vaultId Id of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    collectPlatformFeeV2(vaultId, options) {
+        const txb = options?.txBlock || new TransactionBlock();
+        txb.moveCall({
+            arguments: [
+                txb.object(vaultId),
+                txb.object(this.parser.getProtocolConfig()),
+                txb.object(SUI_CLOCK_OBJECT_ID)
+            ],
+            typeArguments: [
+                this.parser.getDepositCoinType(vaultId),
+                this.parser.getReceiptCoinType(vaultId)
+            ],
+            target: `${this.targetPackageId(options)}::gateway::collect_platform_fee_v2`
+        });
+        if (options?.gasBudget)
+            txb.setGasBudget(options.gasBudget);
+        if (options?.sender)
+            txb.setSenderIfNotSet(options.sender);
+        return txb;
+    }
     /**
      * Deposit asset
      * @param vaultId Id of the vault

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ember-finance/sdk",
     "description": "Ember Protocol SDK",
-    "version": "2.21.0",
+    "version": "2.22.0",
     "type": "module",
     "module": "./dist/index.js",
     "main": "./dist/index.js",