@ember-finance/sdk 2.31.0 → 2.34.0

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

@@ -62,6 +62,12 @@ export declare class SuiAtomicLiquidityReader {
     private readTableValue;
     /** Rate value (1e9) of any vault object (ALV or source EmberVault). */
     private rateValue;
+    /**
+     * Platform fee a collection would settle at `atMs` (epoch ms), in collateral base units.
+     * @param vaultId The id of the atomic vault
+     * @param atMs Time to project the fee to
+     */
+    getPlatformFeeDue(vaultId: string, atMs: bigint): Promise<bigint>;
     /** Per-source-share EmberShare config from the `ember_share_configs` table. */
     getEmberShareConfig(vaultId: string, sourceVaultId: string): Promise<{
         whitelisted: boolean;

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

@@ -131,6 +131,27 @@ export class SuiAtomicLiquidityReader {
         const fields = unwrapMoveFields(res.object?.json);
         return toBig(unwrapMoveFields(fields?.rate)?.value);
     }
+    /**
+     * Platform fee a collection would settle at `atMs` (epoch ms), in collateral base units.
+     * @param vaultId The id of the atomic vault
+     * @param atMs Time to project the fee to
+     */
+    async getPlatformFeeDue(vaultId, atMs) {
+        // collect_platform_fee charges the time since last_charged_at before settling:
+        // accrued + tvl' * fee_percentage * elapsed_ms / 31_536_000e12, where tvl' is
+        // TVL (div(total_shares, rate)) net of the already-accrued fee.
+        const fields = await this.vaultFields(vaultId);
+        const fee = unwrapMoveFields(fields.fee) ?? {};
+        const accrued = toBig(fee.accrued);
+        const lastChargedAt = toBig(fee.last_charged_at);
+        const feePercentage = toBig(fields.fee_percentage);
+        if (atMs <= lastChargedAt || feePercentage === 0n)
+            return accrued;
+        const tvl = divFloor(toBig(fields.total_shares), toBig(unwrapMoveFields(fields.rate)?.value));
+        const base = tvl > accrued ? tvl - accrued : 0n;
+        return (accrued +
+            (base * feePercentage * (atMs - lastChargedAt)) / 31536000000000000000n);
+    }
     /** Per-source-share EmberShare config from the `ember_share_configs` table. */
     async getEmberShareConfig(vaultId, sourceVaultId) {
         const fields = await this.vaultFields(vaultId);

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

@@ -139,7 +139,8 @@ export declare class OperatorCalls extends OnChainCalls {
      */
     atomicProcessWithdrawalRequestsUpToTimestamp(vaultId: string, timestamp: NumStr, options?: IVaultOptionalParams & SuiTransactionBlockResponseOptions): Promise<OnChainCallResponse>;
     /**
-     * Collect the platform fee of an atomic vault
+     * Collect the platform fee of an atomic vault. On a strategy vault, pulls any
+     * shortfall from the strategy first, in the same transaction.
      * @param vaultId The id of the atomic vault
      * @param loss The reported loss amount
      * @param options Optional tx execution params
@@ -244,6 +245,16 @@ export declare class OperatorCalls extends OnChainCalls {
      * @returns OnChainCallResponse
      */
     atomicDepositFromSubAccount(vaultId: string, tokenId: string, subAccount: string, options?: IVaultOptionalParams & SuiTransactionBlockResponseOptions): Promise<OnChainCallResponse>;
+    /**
+     * Deposit collateral back into an atomic vault from its accumulator
+     * (address) balance, where `send_funds` transfers land
+     * @param vaultId The id of the atomic vault
+     * @param amount The amount to redeem from the vault's accumulator balance
+     * @param subAccount The sub account address
+     * @param options Optional tx execution params
+     * @returns OnChainCallResponse
+     */
+    atomicDepositFromSubAccountV2(vaultId: string, amount: NumStr, subAccount: string, options?: IVaultOptionalParams & SuiTransactionBlockResponseOptions): Promise<OnChainCallResponse>;
     /**
      * Redeem collected ember shares from an atomic vault against a source vault
      * @param vaultId The id of the atomic vault

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

@@ -252,7 +252,8 @@ export class OperatorCalls extends OnChainCalls {
         return this.execCall(txb, options);
     }
     /**
-     * Collect the platform fee of an atomic vault
+     * Collect the platform fee of an atomic vault. On a strategy vault, pulls any
+     * shortfall from the strategy first, in the same transaction.
      * @param vaultId The id of the atomic vault
      * @param loss The reported loss amount
      * @param options Optional tx execution params
@@ -260,6 +261,24 @@ export class OperatorCalls extends OnChainCalls {
      */
     async atomicCollectPlatformFee(vaultId, loss, options) {
         const txb = options?.txBlock || new TransactionBlock();
+        // Unlike EVM's collectPlatformFee, the Sui collection pays from idle balance only
+        // and aborts when it is short, so the strategy is drawn on first. The fee keeps
+        // accruing until the tx lands, so it is projected a few minutes ahead; whatever
+        // is pulled beyond the payout stays idle in the vault.
+        const reader = new SuiAtomicLiquidityReader(this.suiClient);
+        const target = await reader.getStrategyTarget(vaultId);
+        if (target.strategy === "suilend") {
+            const landsBy = BigInt(Date.now() + 10 * 60 * 1000);
+            const due = await reader.getPlatformFeeDue(vaultId, landsBy);
+            const payout = due > BigInt(loss) ? due - BigInt(loss) : 0n;
+            const shortfall = payout - target.idleCollateral;
+            if (shortfall > 0n) {
+                const withdraw = isSuiCoinType(target.collateralType)
+                    ? this.txBuilder.atomicWithdrawFromSuilendStrategySui.bind(this.txBuilder)
+                    : this.txBuilder.atomicWithdrawFromSuilendStrategy.bind(this.txBuilder);
+                withdraw(vaultId, target.suilendPoolType, target.suilendMarketId, shortfall.toString(), { ...options, txBlock: txb });
+            }
+        }
         this.txBuilder.atomicCollectPlatformFee(vaultId, loss, {
             ...options,
             txBlock: txb
@@ -405,6 +424,23 @@ export class OperatorCalls extends OnChainCalls {
         });
         return this.execCall(txb, options);
     }
+    /**
+     * Deposit collateral back into an atomic vault from its accumulator
+     * (address) balance, where `send_funds` transfers land
+     * @param vaultId The id of the atomic vault
+     * @param amount The amount to redeem from the vault's accumulator balance
+     * @param subAccount The sub account address
+     * @param options Optional tx execution params
+     * @returns OnChainCallResponse
+     */
+    async atomicDepositFromSubAccountV2(vaultId, amount, subAccount, options) {
+        const txb = options?.txBlock || new TransactionBlock();
+        this.txBuilder.atomicDepositFromSubAccountV2(vaultId, amount, subAccount, {
+            ...options,
+            txBlock: txb
+        });
+        return this.execCall(txb, options);
+    }
     /**
      * Redeem collected ember shares from an atomic vault against a source vault
      * @param vaultId The id of the atomic vault

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

@@ -758,6 +758,16 @@ export declare class TxBuilder {
      * @returns TransactionBlock
      */
     atomicDepositFromSubAccount(vaultId: string, tokenId: string, subAccount: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Deposits collateral back into an atomic vault from its accumulator
+     * (address) balance, where `send_funds` transfers land
+     * @param vaultId Id of the atomic vault
+     * @param amount Amount to redeem from the vault's accumulator balance
+     * @param subAccount Sub account address
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    atomicDepositFromSubAccountV2(vaultId: string, amount: NumStr, subAccount: string, options?: ITxBuilderOptionalParams): TransactionBlock;
     /**
      * Collects the platform fee of an atomic vault
      * @param vaultId Id of the atomic vault

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

@@ -2184,6 +2184,33 @@ export class TxBuilder {
             txb.setSenderIfNotSet(options.sender);
         return txb;
     }
+    /**
+     * Deposits collateral back into an atomic vault from its accumulator
+     * (address) balance, where `send_funds` transfers land
+     * @param vaultId Id of the atomic vault
+     * @param amount Amount to redeem from the vault's accumulator balance
+     * @param subAccount Sub account address
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    atomicDepositFromSubAccountV2(vaultId, amount, subAccount, options) {
+        const txb = options?.txBlock || new TransactionBlock();
+        txb.moveCall({
+            arguments: [
+                txb.object(vaultId),
+                txb.object(this.parser.getProtocolConfig()),
+                txb.pure.u64(amount),
+                txb.pure.address(subAccount)
+            ],
+            typeArguments: [this.parser.getAtomicCollateralType(vaultId)],
+            target: `${this.parser.getPackageId()}::gateway::atomic_deposit_from_sub_account_v2`
+        });
+        if (options?.gasBudget)
+            txb.setGasBudget(options.gasBudget);
+        if (options?.sender)
+            txb.setSenderIfNotSet(options.sender);
+        return txb;
+    }
     /**
      * Collects the platform fee of an atomic vault
      * @param vaultId Id of the atomic vault

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

@@ -5,6 +5,7 @@ import { OnChainCallResponse, Signer, SuiAddress, SuiTransactionBlockResponseOpt
 import { TransactionObjectArgument } from "@mysten/sui/transactions";
 export declare class UserCalls extends OnChainCalls {
     constructor(_network: string, _suiClient: SuiClient, _deployment: ISuiDeployment, _signer?: Signer, _walletAddress?: string, _isUIWallet?: boolean);
+    private walletCoin;
     /**
      * Deposit asset into a vault
      * @param vaultId The id of the vault to deposit into

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

@@ -1,12 +1,23 @@
 import { OnChainCalls } from "./onchain-calls.js";
 import { TransactionBlock, bigNumber, CoinUtils, SUI_NATIVE_BASE } from "@firefly-exchange/library-sui";
 import { Vault } from "./vault.js";
+import { coinWithBalance } from "@mysten/sui/transactions";
 import { SuiAtomicLiquidityReader } from "./atomic-liquidity.js";
 import { isSuiCoinType } from "../utils/common.js";
 export class UserCalls extends OnChainCalls {
     constructor(_network, _suiClient, _deployment, _signer, _walletAddress, _isUIWallet) {
         super(_network, _suiClient, _deployment, _signer, _walletAddress, _isUIWallet);
     }
+    walletCoin(txb, coinType, amount) {
+        // `send_funds` credits the wallet's address balance, which coin
+        // enumeration cannot see. The intent draws on coin objects and that
+        // balance together, resolved when the tx is built.
+        txb.setSenderIfNotSet(this.walletAddress);
+        return txb.add(coinWithBalance({
+            type: coinType,
+            balance: BigInt(bigNumber(amount).toFixed(0))
+        }));
+    }
     /**
      * Deposit asset into a vault
      * @param vaultId The id of the vault to deposit into
@@ -21,7 +32,7 @@ export class UserCalls extends OnChainCalls {
         let merged;
         if (!coinId) {
             const coinType = this.parser.getDepositCoinType(vaultId);
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, bigNumber(amount).toFixed(0), coinType, this.walletAddress);
+            split = this.walletCoin(txb, coinType, bigNumber(amount).toFixed(0));
             coinId = split;
         }
         else {
@@ -71,7 +82,7 @@ export class UserCalls extends OnChainCalls {
         let merged;
         if (!coinId) {
             const coinType = this.parser.getDepositCoinType(vaultId);
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, assetAmountRequired, coinType, this.walletAddress);
+            split = this.walletCoin(txb, coinType, assetAmountRequired);
             coinId = split;
         }
         else {
@@ -98,7 +109,7 @@ export class UserCalls extends OnChainCalls {
         let split;
         if (!coinId) {
             const coinType = this.parser.getReceiptCoinType(vaultId);
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, bigNumber(amountOfShares).toFixed(0), coinType, this.walletAddress);
+            split = this.walletCoin(txb, coinType, bigNumber(amountOfShares).toFixed(0));
             coinId = split;
         }
         else {
@@ -144,7 +155,7 @@ export class UserCalls extends OnChainCalls {
         let merged;
         if (!coinId) {
             const coinType = this.parser.getAtomicCollateralType(vaultId);
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, bigNumber(amount).toFixed(0), coinType, this.walletAddress);
+            split = this.walletCoin(txb, coinType, bigNumber(amount).toFixed(0));
             coinId = split;
         }
         else {
@@ -249,7 +260,7 @@ export class UserCalls extends OnChainCalls {
         let split;
         let merged;
         if (!coinId) {
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, bigNumber(amount).toFixed(0), sourceReceiptType, this.walletAddress);
+            split = this.walletCoin(txb, sourceReceiptType, bigNumber(amount).toFixed(0));
             coinId = split;
         }
         else {
@@ -298,7 +309,7 @@ export class UserCalls extends OnChainCalls {
         let split;
         let merged;
         if (!coinId) {
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, bigNumber(amount).toFixed(0), sourceReceiptType, this.walletAddress);
+            split = this.walletCoin(txb, sourceReceiptType, bigNumber(amount).toFixed(0));
             coinId = split;
         }
         else {
@@ -343,7 +354,7 @@ export class UserCalls extends OnChainCalls {
         let split;
         let merged;
         if (!coinId) {
-            [split, merged] = await CoinUtils.createCoinWithBalance(this.suiClient, txb, bigNumber(amount).toFixed(0), sourceReceiptType, this.walletAddress);
+            split = this.walletCoin(txb, sourceReceiptType, bigNumber(amount).toFixed(0));
             coinId = split;
         }
         else {

package/package.json

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