@ember-finance/sdk 2.5.0-pre.8 → 2.5.0

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

@@ -1,174 +0,0 @@
-import { bcs } from "@mysten/sui/bcs";
-import { computeSwapQuote, computePlainInstantQuote } from "../../atomic/instant-withdraw.js";
-/** Sui fixed-point scale (1e9) used by the Atomic Liquidity Vault Move math. */
-const SUI_SCALE = 1000000000n;
-const unwrapMoveFields = (value) => value?.fields ?? value;
-const toBig = (v) => v === undefined || v === null ? 0n : BigInt(v);
-/** `math::div(a, b)` = floor(a * scale / b). */
-const divFloor = (a, b) => (b === 0n ? 0n : (a * SUI_SCALE) / b);
-/** `math::div_ceil(a, b)` = ceil(a * scale / b) — used by `calculate_amount_from_shares`. */
-const divCeil = (a, b) => b === 0n ? 0n : (a * SUI_SCALE + (b - 1n)) / b;
-/**
- * Read-only views + instant-withdraw quotes for the Sui Atomic Liquidity Vault (BET-4111).
- *
- * There is no on-chain preview function and no off-chain view calls on Sui, so this reads
- * the ALV (and source vault) object fields directly and replicates the Move math
- * (`calculate_amount_from_shares`, `get_vault_tvl`, `swap_ember_shares`,
- * `do_instant_withdraw_core`) via the shared chain-agnostic quote core at scale 1e9.
- *
- * @example
- * ```ts
- * const reader = new SuiAtomicLiquidityReader(suiClient);
- * const q = await reader.previewSwapInstantWithdraw(vaultId, sourceVaultId, 100_000000n, owner);
- * ```
- */
-export class SuiAtomicLiquidityReader {
-    constructor(suiClient) {
-        this.suiClient = suiClient;
-    }
-    /** Raw Move fields of the AtomicLiquidityVault object. */
-    async vaultFields(vaultId) {
-        const res = await this.suiClient.core.getObject({
-            objectId: vaultId,
-            include: { json: true }
-        });
-        const fields = unwrapMoveFields(res.object?.json);
-        if (!fields)
-            throw new Error(`Atomic vault ${vaultId} not found`);
-        return fields;
-    }
-    /**
-     * Read a `Table<K, V>` entry value. Table entries are plain dynamic fields, so we
-     * resolve the `Field<K,V>` object id via `getDynamicField`, then fetch its json
-     * (`{ name, value }`). Returns the unwrapped `value`, or null if absent.
-     */
-    async readTableValue(parentId, nameType, keyAddress) {
-        try {
-            const df = await this.suiClient.core.getDynamicField({
-                parentId,
-                name: { type: nameType, bcs: bcs.Address.serialize(keyAddress).toBytes() }
-            });
-            const fieldId = df?.dynamicField?.fieldId;
-            if (!fieldId)
-                return null;
-            const obj = await this.suiClient.core.getObject({
-                objectId: fieldId,
-                include: { json: true }
-            });
-            return unwrapMoveFields(obj.object?.json)?.value;
-        }
-        catch {
-            return null;
-        }
-    }
-    /** Rate value (1e9) of any vault object (ALV or source EmberVault). */
-    async rateValue(vaultId) {
-        const res = await this.suiClient.core.getObject({
-            objectId: vaultId,
-            include: { json: true }
-        });
-        const fields = unwrapMoveFields(res.object?.json);
-        return toBig(unwrapMoveFields(fields?.rate)?.value);
-    }
-    /** Per-source-share EmberShare config from the `ember_share_configs` table. */
-    async getEmberShareConfig(vaultId, sourceVaultId) {
-        const fields = await this.vaultFields(vaultId);
-        const tableId = unwrapMoveFields(fields.ember_share_configs)?.id?.id;
-        if (!tableId)
-            return null;
-        {
-            const cfg = unwrapMoveFields(await this.readTableValue(tableId, "0x2::object::ID", sourceVaultId));
-            if (!cfg)
-                return null;
-            const curve = (cfg.fee_multiplier_curve || []).map((t) => {
-                const tf = unwrapMoveFields(t);
-                return {
-                    threshold: toBig(tf.threshold),
-                    multiplier: toBig(tf.multiplier)
-                };
-            });
-            return {
-                whitelisted: !!cfg.whitelisted,
-                feePercentage: toBig(cfg.fee_percentage),
-                holdbackPercentage: toBig(cfg.holdback_percentage),
-                maxCapacityPercentage: toBig(cfg.max_capacity_percentage),
-                maxUtilizationPercentage: toBig(cfg.max_utilization_percentage),
-                epochStartedAt: toBig(cfg.epoch_started_at),
-                epochUsedAmount: toBig(cfg.epoch_used_amount),
-                feeMultiplierCurve: curve
-            };
-        }
-    }
-    /** Caller's ALV (non-transferable) share balance from the `shares` table. */
-    async shareOf(vaultId, account) {
-        const fields = await this.vaultFields(vaultId);
-        const tableId = unwrapMoveFields(fields.shares)?.id?.id;
-        if (!tableId)
-            return 0n;
-        return toBig(await this.readTableValue(tableId, "address", account));
-    }
-    /**
-     * Live quote for the EmberShare swap-with-holdback "instant withdraw" on Sui.
-     * Reads ALV + source vault fields and replicates `swap_ember_shares` math.
-     *
-     * `currentHeldValue` defaults to 0 (the common case before any swap); pass it when the
-     * ALV already custodies source shares. `availableCapacity` (remaining 24h epoch capacity,
-     * collateral units) is bfvs-sourced when precise epoch accounting is required — when
-     * omitted, only the utilization cap gates `withinCapacity`.
-     */
-    async previewSwapInstantWithdraw(vaultId, sourceVaultId, shareAmount, owner, opts = {}) {
-        const fields = await this.vaultFields(vaultId);
-        const atomicRate = toBig(unwrapMoveFields(fields.rate)?.value);
-        const totalShares = toBig(fields.total_shares);
-        const feeWaived = fields.fee_waived_addresses || [];
-        const holdbackWaived = fields.holdback_waived_addresses || [];
-        const [config, sourceRate] = await Promise.all([
-            this.getEmberShareConfig(vaultId, sourceVaultId),
-            this.rateValue(sourceVaultId)
-        ]);
-        if (!config)
-            throw new Error(`source vault ${sourceVaultId} not whitelisted`);
-        // gross = calculate_amount_from_shares(source, shareAmount) = div_ceil(shares, sourceRate)
-        const grossAmount = divCeil(shareAmount, sourceRate);
-        // tvl = get_vault_tvl(atomic) = div(total_shares, atomicRate)
-        const vaultTotalAssets = divFloor(totalShares, atomicRate);
-        return computeSwapQuote({
-            scale: SUI_SCALE,
-            grossAmount,
-            shareAmount,
-            userShareBalance: opts.userShareBalance ?? 0n,
-            currentHeldValue: opts.currentHeldValue ?? 0n,
-            vaultTotalAssets,
-            // Default to "epoch capacity not binding" when not supplied; the on-chain
-            // swap still enforces it. Pass from bfvs for an exact pre-check.
-            availableCapacity: opts.availableCapacity ?? grossAmount,
-            config: {
-                feePercentage: config.feePercentage,
-                holdbackPercentage: config.holdbackPercentage,
-                maxUtilizationPercentage: config.maxUtilizationPercentage,
-                feeMultiplierCurve: config.feeMultiplierCurve
-            },
-            feeWaived: feeWaived.includes(owner),
-            holdbackWaived: holdbackWaived.includes(owner)
-        });
-    }
-    /**
-     * Live quote for the ALV's own plain `instant_withdraw` on Sui (atomic-share holders).
-     * `net = gross - fee`, no holdback, capped by `max_instant_withdraw_shares`.
-     */
-    async previewPlainInstantWithdraw(vaultId, shareAmount, owner) {
-        const fields = await this.vaultFields(vaultId);
-        const atomicRate = toBig(unwrapMoveFields(fields.rate)?.value);
-        const grossAmount = divCeil(shareAmount, atomicRate);
-        const userShareBalance = await this.shareOf(vaultId, owner);
-        return computePlainInstantQuote({
-            scale: SUI_SCALE,
-            grossAmount,
-            shareAmount,
-            userShareBalance,
-            instantWithdrawFeePercentage: toBig(fields.instant_withdraw_fee_percentage),
-            cumulativeInstantWithdrawShares: toBig(fields.cumulative_instant_withdraw_shares),
-            maxInstantWithdrawShares: toBig(fields.max_instant_withdraw_shares)
-        });
-    }
-}