@ember-finance/sdk 2.5.0-pre.9 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/dist/src/abis/ERC20Token.json +2 -2
  2. package/dist/src/abis/EmberETHVault.json +5 -279
  3. package/dist/src/abis/EmberProtocolConfig.json +2 -170
  4. package/dist/src/abis/EmberVault.json +2 -2
  5. package/dist/src/abis/EmberVaultMintBurnOFTAdapter.json +2 -43
  6. package/dist/src/api/models/poc-report-asset.d.ts +6 -0
  7. package/dist/src/api/models/poc-report-protocol.d.ts +30 -0
  8. package/dist/src/api/models/poc-report-token.d.ts +36 -0
  9. package/dist/src/api/models/poc-report-wallet.d.ts +10 -4
  10. package/dist/src/api/v2/apis/accounts-api.d.ts +0 -5
  11. package/dist/src/api/v2/apis/accounts-api.js +1 -6
  12. package/dist/src/api/v2/apis/vaults-api.d.ts +43 -16
  13. package/dist/src/api/v2/apis/vaults-api.js +84 -21
  14. package/dist/src/api/v2/models/account-transaction-transaction-data.d.ts +1 -5
  15. package/dist/src/api/v2/models/account-transaction.d.ts +0 -5
  16. package/dist/src/api/v2/models/account-transaction.js +1 -6
  17. package/dist/src/api/v2/models/chain-vault-details.d.ts +13 -14
  18. package/dist/src/api/v2/models/chain-vault-details.js +6 -1
  19. package/dist/src/api/v2/models/evm-contracts.d.ts +0 -16
  20. package/dist/src/api/v2/models/index.d.ts +4 -9
  21. package/dist/src/api/v2/models/index.js +4 -9
  22. package/dist/src/api/v2/models/poc-report-asset.d.ts +6 -0
  23. package/dist/src/api/v2/models/poc-report-protocol.d.ts +30 -0
  24. package/dist/src/api/v2/models/poc-report-token.d.ts +36 -0
  25. package/dist/src/api/v2/models/poc-report-wallet.d.ts +10 -4
  26. package/dist/src/api/v2/models/transparency-group.d.ts +67 -0
  27. package/dist/src/api/v2/models/transparency-row.d.ts +138 -0
  28. package/dist/src/api/v2/models/{fee-multiplier-tier.js → transparency-row.js} +10 -1
  29. package/dist/src/api/v2/models/transparency-view.d.ts +22 -0
  30. package/dist/src/api/v2/models/{evm-atomic-vault.js → transparency-view.js} +10 -1
  31. package/dist/src/api/v2/models/vault-detail.d.ts +0 -11
  32. package/dist/src/api/v2/models/vault-detail.js +0 -4
  33. package/dist/src/api/v2/models/vault-transparency-report.d.ts +82 -0
  34. package/dist/src/ember-vaults.d.ts +1 -2
  35. package/dist/src/evm-vaults/on-chain-calls/index.d.ts +0 -1
  36. package/dist/src/evm-vaults/on-chain-calls/index.js +0 -1
  37. package/dist/src/evm-vaults/on-chain-calls/operator.d.ts +0 -10
  38. package/dist/src/evm-vaults/on-chain-calls/operator.js +0 -28
  39. package/dist/src/evm-vaults/on-chain-calls/tx-builder.d.ts +0 -109
  40. package/dist/src/evm-vaults/on-chain-calls/tx-builder.js +0 -281
  41. package/dist/src/evm-vaults/on-chain-calls/user.d.ts +0 -50
  42. package/dist/src/evm-vaults/on-chain-calls/user.js +0 -75
  43. package/dist/src/evm-vaults/on-chain-calls/vault-admin.d.ts +0 -55
  44. package/dist/src/evm-vaults/on-chain-calls/vault-admin.js +0 -122
  45. package/dist/src/evm-vaults/on-chain-calls/vault-reader.d.ts +0 -6
  46. package/dist/src/evm-vaults/on-chain-calls/vault-reader.js +0 -9
  47. package/dist/src/evm-vaults/utils/deployment-parser.d.ts +0 -8
  48. package/dist/src/evm-vaults/utils/deployment-parser.js +0 -11
  49. package/dist/src/sui-vaults/interfaces/index.d.ts +0 -15
  50. package/dist/src/sui-vaults/on-chain-calls/admin.d.ts +1 -37
  51. package/dist/src/sui-vaults/on-chain-calls/admin.js +0 -56
  52. package/dist/src/sui-vaults/on-chain-calls/index.d.ts +0 -1
  53. package/dist/src/sui-vaults/on-chain-calls/index.js +0 -1
  54. package/dist/src/sui-vaults/on-chain-calls/onchain-calls.d.ts +1 -2
  55. package/dist/src/sui-vaults/on-chain-calls/operator.d.ts +1 -129
  56. package/dist/src/sui-vaults/on-chain-calls/operator.js +0 -210
  57. package/dist/src/sui-vaults/on-chain-calls/tx-builder.d.ts +0 -482
  58. package/dist/src/sui-vaults/on-chain-calls/tx-builder.js +0 -1430
  59. package/dist/src/sui-vaults/on-chain-calls/user.d.ts +1 -107
  60. package/dist/src/sui-vaults/on-chain-calls/user.js +0 -190
  61. package/dist/src/sui-vaults/on-chain-calls/vault-admin.d.ts +1 -229
  62. package/dist/src/sui-vaults/on-chain-calls/vault-admin.js +0 -391
  63. package/dist/src/sui-vaults/on-chain-calls/vault.d.ts +1 -2
  64. package/dist/src/sui-vaults/utils/common.d.ts +1 -2
  65. package/dist/src/sui-vaults/utils/deployment-parser.d.ts +0 -12
  66. package/dist/src/sui-vaults/utils/deployment-parser.js +0 -24
  67. package/package.json +2 -3
  68. package/dist/src/abis/AtomicLiquidity.json +0 -4050
  69. package/dist/src/api/v2/models/escrow-claim-transaction.d.ts +0 -56
  70. package/dist/src/api/v2/models/evm-atomic-liquidity-lib.d.ts +0 -48
  71. package/dist/src/api/v2/models/evm-atomic-vault.d.ts +0 -102
  72. package/dist/src/api/v2/models/fee-multiplier-tier.d.ts +0 -30
  73. package/dist/src/api/v2/models/holdback-release-transaction.d.ts +0 -56
  74. package/dist/src/api/v2/models/holdback-release-transaction.js +0 -14
  75. package/dist/src/api/v2/models/instant-withdraw-config.d.ts +0 -109
  76. package/dist/src/api/v2/models/instant-withdraw-config.js +0 -14
  77. package/dist/src/api/v2/models/instant-withdraw-transaction.d.ts +0 -74
  78. package/dist/src/api/v2/models/instant-withdraw-transaction.js +0 -14
  79. package/dist/src/api/v2/models/instant-withdraw-via-swap-transaction.d.ts +0 -74
  80. package/dist/src/api/v2/models/instant-withdraw-via-swap-transaction.js +0 -14
  81. package/dist/src/api/v2/models/supported-ember-vault.d.ts +0 -42
  82. package/dist/src/api/v2/models/supported-ember-vault.js +0 -14
  83. package/dist/src/atomic/instant-withdraw.d.ts +0 -125
  84. package/dist/src/atomic/instant-withdraw.js +0 -122
  85. package/dist/src/evm-vaults/on-chain-calls/atomic-liquidity.d.ts +0 -98
  86. package/dist/src/evm-vaults/on-chain-calls/atomic-liquidity.js +0 -212
  87. package/dist/src/sui-vaults/on-chain-calls/atomic-liquidity.d.ts +0 -62
  88. package/dist/src/sui-vaults/on-chain-calls/atomic-liquidity.js +0 -174
  89. /package/dist/src/api/v2/models/{escrow-claim-transaction.js → transparency-group.js} +0 -0
  90. /package/dist/src/api/v2/models/{evm-atomic-liquidity-lib.js → vault-transparency-report.js} +0 -0
@@ -1,125 +0,0 @@
1
- /**
2
- * Chain-agnostic Atomic Liquidity Vault (ALV) instant-withdraw quote core (BET-4111).
3
- *
4
- * There is NO on-chain preview/quote function on the ALV, so the SDK computes the
5
- * quote client-side by mirroring the exact contract math. Both chains use the same
6
- * formulas with a different fixed-point scale, so this module is parameterised by
7
- * `scale` (EVM = 1e18, Sui = 1e9) and consumed by both the EVM and Sui readers, which
8
- * supply the live on-chain inputs (rate/TVL/held-value/config) via RPC.
9
- *
10
- * Mirrors:
11
- * - swap-with-holdback: EVM `AtomicLiquidityLib.swapEmberShares`,
12
- * Sui `atomic_liquidity_vault::swap_ember_shares`
13
- * - plain instant withdraw: EVM `AtomicLiquidity.instantWithdraw`,
14
- * Sui `do_instant_withdraw_core`
15
- * - fixed point: `Math.mul = (a*b)/scale`, `Math.div = (a*scale)/b` (floor)
16
- * - fee curve: `_lookupFeeMultiplier` (ascending tiers; highest threshold <= utilization wins; 1x default)
17
- */
18
- /** Fixed-point multiply: `(a * b) / scale`, floor (matches Solidity/Move `Math.mul`). */
19
- export declare function mulFp(a: bigint, b: bigint, scale: bigint): bigint;
20
- /** Fixed-point divide: `(a * scale) / b`, floor (matches Solidity/Move `Math.div`). */
21
- export declare function divFp(a: bigint, b: bigint, scale: bigint): bigint;
22
- /** A single (threshold, multiplier) tier of the fee-multiplier curve (fixed-point at `scale`). */
23
- export interface FeeMultiplierTier {
24
- threshold: bigint;
25
- multiplier: bigint;
26
- }
27
- /**
28
- * Resolve the fee multiplier from an ascending curve at a given utilization.
29
- * Returns the multiplier of the highest tier whose `threshold <= utilization`, or `scale`
30
- * (1x) when the curve is empty / no tier matches. Mirrors `_lookupFeeMultiplier`.
31
- */
32
- export declare function lookupFeeMultiplier(curve: FeeMultiplierTier[], utilization: bigint, scale: bigint): bigint;
33
- /** Per-source-share EmberShare swap config (fixed-point percentages at `scale`). */
34
- export interface EmberShareSwapConfig {
35
- feePercentage: bigint;
36
- holdbackPercentage: bigint;
37
- maxUtilizationPercentage: bigint;
38
- feeMultiplierCurve: FeeMultiplierTier[];
39
- /**
40
- * Minimum gross collateral value per swap (collateral units). A swap with
41
- * `gross < minSwapGross` reverts `SwapAmountTooSmall`. 0/undefined disables the floor.
42
- * EVM-only (no Sui equivalent yet) — omit on Sui.
43
- */
44
- minSwapGross?: bigint;
45
- /**
46
- * TVL-independent absolute ceiling on this source share's post-swap held value
47
- * (collateral units). A swap pushing `currentHeldValue + gross` above it reverts
48
- * `EmberShareHeldValueCapExceeded`. 0/undefined disables it. EVM-only — omit on Sui.
49
- */
50
- maxHeldValueAbsolute?: bigint;
51
- }
52
- export interface SwapQuoteInputs {
53
- /** Fixed-point scale: 1e18 (EVM) / 1e9 (Sui). */
54
- scale: bigint;
55
- /** Gross collateral value of the source shares: `source.convertToAssets(shareAmount)`. */
56
- grossAmount: bigint;
57
- /** Source shares being swapped (for `resultingShares`). */
58
- shareAmount: bigint;
59
- /** Caller's current source-share balance (for `resultingShares`). */
60
- userShareBalance: bigint;
61
- /** Collateral value the ALV already holds for this source share (pre-swap). */
62
- currentHeldValue: bigint;
63
- /** ALV `totalAssets()`. */
64
- vaultTotalAssets: bigint;
65
- /** Remaining epoch capacity for this source share: `availableEmberShareCapacity(share)`. */
66
- availableCapacity: bigint;
67
- config: EmberShareSwapConfig;
68
- feeWaived?: boolean;
69
- holdbackWaived?: boolean;
70
- }
71
- export interface InstantWithdrawQuote {
72
- /** Gross collateral value of the redeemed shares. */
73
- grossAmount: bigint;
74
- /** Paid to the receiver immediately (`gross - fee - holdback`). */
75
- instantlyReceive: bigint;
76
- /** Held back, released later by the operator (0 for the plain path). */
77
- lockedAmount: bigint;
78
- /** Fee charged (collateral units). */
79
- feeAmount: bigint;
80
- /** Effective fee % applied (base * curve multiplier), fixed-point at `scale`. */
81
- effectiveFeePercentage: bigint;
82
- /** Holdback % applied, fixed-point at `scale` (0 for the plain path). */
83
- holdbackPercentage: bigint;
84
- /** Post-swap utilization used for the cap + fee-multiplier (0 for the plain path). */
85
- utilizationAtSwap: bigint;
86
- /** Caller's source-share balance after the withdraw. */
87
- resultingShares: bigint;
88
- /** True if the swap/withdraw would succeed against ALL caps (utilization, epoch capacity,
89
- * absolute held-value, min-swap floor). Use the granular flags below to explain a `false`. */
90
- withinCapacity: boolean;
91
- /** True if `gross < minSwapGross` — the swap would revert `SwapAmountTooSmall`.
92
- * Always false for the plain path and when no floor is configured. */
93
- belowMinSwap: boolean;
94
- /** True if the post-swap held value is within `maxHeldValueAbsolute` (or the cap is disabled).
95
- * Always true for the plain path. */
96
- withinHeldValueCap: boolean;
97
- }
98
- /**
99
- * Quote the EmberShare swap-with-holdback path (source tokenized vault -> ALV).
100
- * Mirrors `swapEmberShares` exactly: post-swap utilization drives the fee multiplier,
101
- * `net = gross - fee - holdback` is paid now, the holdback is queued for later release.
102
- */
103
- export declare function computeSwapQuote(inputs: SwapQuoteInputs): InstantWithdrawQuote;
104
- export interface PlainInstantQuoteInputs {
105
- /** Fixed-point scale: 1e18 (EVM) / 1e9 (Sui). */
106
- scale: bigint;
107
- /** Gross collateral value of the shares: ALV `convertToAssets(shareAmount)`. */
108
- grossAmount: bigint;
109
- /** ALV shares being instantly withdrawn. */
110
- shareAmount: bigint;
111
- /** Caller's current ALV share balance (for `resultingShares`). */
112
- userShareBalance: bigint;
113
- /** `instantWithdrawFeePercentage`, fixed-point at `scale`. */
114
- instantWithdrawFeePercentage: bigint;
115
- /** `cumulativeInstantWithdrawShares`. */
116
- cumulativeInstantWithdrawShares: bigint;
117
- /** `maxInstantWithdrawShares` (cumulative cap). */
118
- maxInstantWithdrawShares: bigint;
119
- }
120
- /**
121
- * Quote the ALV's own plain `instantWithdraw` path (atomic-share holders).
122
- * Mirrors the contract: `net = gross - fee`, no holdback; capped by
123
- * `cumulative + shares <= maxInstantWithdrawShares`.
124
- */
125
- export declare function computePlainInstantQuote(inputs: PlainInstantQuoteInputs): InstantWithdrawQuote;
@@ -1,122 +0,0 @@
1
- /**
2
- * Chain-agnostic Atomic Liquidity Vault (ALV) instant-withdraw quote core (BET-4111).
3
- *
4
- * There is NO on-chain preview/quote function on the ALV, so the SDK computes the
5
- * quote client-side by mirroring the exact contract math. Both chains use the same
6
- * formulas with a different fixed-point scale, so this module is parameterised by
7
- * `scale` (EVM = 1e18, Sui = 1e9) and consumed by both the EVM and Sui readers, which
8
- * supply the live on-chain inputs (rate/TVL/held-value/config) via RPC.
9
- *
10
- * Mirrors:
11
- * - swap-with-holdback: EVM `AtomicLiquidityLib.swapEmberShares`,
12
- * Sui `atomic_liquidity_vault::swap_ember_shares`
13
- * - plain instant withdraw: EVM `AtomicLiquidity.instantWithdraw`,
14
- * Sui `do_instant_withdraw_core`
15
- * - fixed point: `Math.mul = (a*b)/scale`, `Math.div = (a*scale)/b` (floor)
16
- * - fee curve: `_lookupFeeMultiplier` (ascending tiers; highest threshold <= utilization wins; 1x default)
17
- */
18
- /** Fixed-point multiply: `(a * b) / scale`, floor (matches Solidity/Move `Math.mul`). */
19
- export function mulFp(a, b, scale) {
20
- if (a === 0n || b === 0n)
21
- return 0n;
22
- return (a * b) / scale;
23
- }
24
- /** Fixed-point divide: `(a * scale) / b`, floor (matches Solidity/Move `Math.div`). */
25
- export function divFp(a, b, scale) {
26
- if (b === 0n)
27
- return 0n;
28
- return (a * scale) / b;
29
- }
30
- /**
31
- * Resolve the fee multiplier from an ascending curve at a given utilization.
32
- * Returns the multiplier of the highest tier whose `threshold <= utilization`, or `scale`
33
- * (1x) when the curve is empty / no tier matches. Mirrors `_lookupFeeMultiplier`.
34
- */
35
- export function lookupFeeMultiplier(curve, utilization, scale) {
36
- let multiplier = scale; // 1x
37
- for (const tier of curve) {
38
- if (utilization >= tier.threshold) {
39
- multiplier = tier.multiplier;
40
- }
41
- else {
42
- break; // ascending: once utilization < threshold, all later tiers are higher
43
- }
44
- }
45
- return multiplier;
46
- }
47
- /**
48
- * Quote the EmberShare swap-with-holdback path (source tokenized vault -> ALV).
49
- * Mirrors `swapEmberShares` exactly: post-swap utilization drives the fee multiplier,
50
- * `net = gross - fee - holdback` is paid now, the holdback is queued for later release.
51
- */
52
- export function computeSwapQuote(inputs) {
53
- const { scale, grossAmount, config, feeWaived, holdbackWaived } = inputs;
54
- const newHeldValue = inputs.currentHeldValue + grossAmount;
55
- const utilizationAtSwap = inputs.vaultTotalAssets === 0n
56
- ? 0n
57
- : divFp(newHeldValue, inputs.vaultTotalAssets, scale);
58
- const feeMultiplier = lookupFeeMultiplier(config.feeMultiplierCurve, utilizationAtSwap, scale);
59
- const effectiveFeePercentage = mulFp(config.feePercentage, feeMultiplier, scale);
60
- const feeAmount = feeWaived ? 0n : mulFp(grossAmount, effectiveFeePercentage, scale);
61
- const holdbackAmount = holdbackWaived
62
- ? 0n
63
- : mulFp(grossAmount, config.holdbackPercentage, scale);
64
- // Mirror the contract's underflow guard.
65
- const instantlyReceive = feeAmount + holdbackAmount > grossAmount
66
- ? 0n
67
- : grossAmount - feeAmount - holdbackAmount;
68
- const withinUtilization = utilizationAtSwap <= config.maxUtilizationPercentage;
69
- const withinEpochCapacity = grossAmount <= inputs.availableCapacity;
70
- // Absolute held-value cap (0/undefined disables it); mirrors EmberShareHeldValueCapExceeded.
71
- const maxHeldValueAbsolute = config.maxHeldValueAbsolute ?? 0n;
72
- const withinHeldValueCap = maxHeldValueAbsolute === 0n || newHeldValue <= maxHeldValueAbsolute;
73
- // Per-swap dust floor (0/undefined disables it); mirrors SwapAmountTooSmall.
74
- const minSwapGross = config.minSwapGross ?? 0n;
75
- const belowMinSwap = minSwapGross > 0n && grossAmount < minSwapGross;
76
- return {
77
- grossAmount,
78
- instantlyReceive,
79
- lockedAmount: holdbackAmount,
80
- feeAmount,
81
- effectiveFeePercentage,
82
- holdbackPercentage: holdbackWaived ? 0n : config.holdbackPercentage,
83
- utilizationAtSwap,
84
- resultingShares: inputs.userShareBalance >= inputs.shareAmount
85
- ? inputs.userShareBalance - inputs.shareAmount
86
- : 0n,
87
- belowMinSwap,
88
- withinHeldValueCap,
89
- withinCapacity: withinUtilization &&
90
- withinEpochCapacity &&
91
- withinHeldValueCap &&
92
- !belowMinSwap &&
93
- feeAmount + holdbackAmount <= grossAmount
94
- };
95
- }
96
- /**
97
- * Quote the ALV's own plain `instantWithdraw` path (atomic-share holders).
98
- * Mirrors the contract: `net = gross - fee`, no holdback; capped by
99
- * `cumulative + shares <= maxInstantWithdrawShares`.
100
- */
101
- export function computePlainInstantQuote(inputs) {
102
- const { scale, grossAmount, shareAmount } = inputs;
103
- const feeAmount = mulFp(grossAmount, inputs.instantWithdrawFeePercentage, scale);
104
- const instantlyReceive = feeAmount > grossAmount ? 0n : grossAmount - feeAmount;
105
- const withinCapacity = inputs.cumulativeInstantWithdrawShares + shareAmount <=
106
- inputs.maxInstantWithdrawShares;
107
- return {
108
- grossAmount,
109
- instantlyReceive,
110
- lockedAmount: 0n,
111
- feeAmount,
112
- effectiveFeePercentage: inputs.instantWithdrawFeePercentage,
113
- holdbackPercentage: 0n,
114
- utilizationAtSwap: 0n,
115
- resultingShares: inputs.userShareBalance >= shareAmount
116
- ? inputs.userShareBalance - shareAmount
117
- : 0n,
118
- belowMinSwap: false,
119
- withinHeldValueCap: true,
120
- withinCapacity
121
- };
122
- }
@@ -1,98 +0,0 @@
1
- import { Provider } from "ethers";
2
- import { FeeMultiplierTier, InstantWithdrawQuote } from "../../atomic/instant-withdraw.js";
3
- /**
4
- * Read-only views for the Atomic Liquidity Vault (BFE-817/818).
5
- *
6
- * Write calls live on the role classes (EVMUserCalls.instantWithdraw /
7
- * swapEmberShares, EVMOperatorCalls.supplyToStrategy / withdrawFromStrategy /
8
- * redeemCollectedEmberShares / releaseUsersHoldback, EVMVaultAdminCalls.setStrategy /
9
- * setEmberShareWhitelist / setSwapWaiver / setMaxInstantWithdrawShares /
10
- * setInstantWithdrawFeePercentage). Shared lifecycle calls (deposit, redeemShares,
11
- * cancelPendingWithdrawalRequest, processWithdrawalRequests, collectPlatformFee,
12
- * updateVaultRate, pause/role/cap setters) reuse the existing EmberVault methods on
13
- * those same classes.
14
- *
15
- * This reader uses an ethers Contract against the bundled AtomicLiquidity ABI and
16
- * provides typed convenience getters plus a generic `read` for any view not covered.
17
- *
18
- * @example
19
- * ```typescript
20
- * const reader = new EVMAtomicLiquidityReader(provider);
21
- * const rate = await reader.rate(vault);
22
- * const supplied = await reader.getStrategyAssets(vault);
23
- * const cfg = await reader.read(vault, "emberShareConfigs", [sourceShare]);
24
- * ```
25
- */
26
- export declare class EVMAtomicLiquidityReader {
27
- provider: Provider;
28
- constructor(_provider: Provider);
29
- private contract;
30
- /** A source EmberShare vault (ERC-4626) for read-only convertToAssets/balanceOf/accounts. */
31
- private shareContract;
32
- /** Generic view call for any function on the AtomicLiquidity ABI. */
33
- read(vaultAddress: string, functionName: string, args?: unknown[]): Promise<unknown>;
34
- /** roles() -> { admin, operator, rateManager }. */
35
- roles(vaultAddress: string): Promise<unknown>;
36
- /** rate() -> { value, maxRateChangePerUpdate, rateUpdateInterval, lastUpdatedAt }. */
37
- rate(vaultAddress: string): Promise<unknown>;
38
- /** Current external strategy address (zero if none). */
39
- strategy(vaultAddress: string): Promise<string>;
40
- /** Assets currently supplied to the strategy. */
41
- getStrategyAssets(vaultAddress: string): Promise<bigint>;
42
- /** Total assets (idle + strategy + outstanding). */
43
- totalAssets(vaultAddress: string): Promise<bigint>;
44
- /**
45
- * Solvency margin (collateral units, signed): `totalAssets - totalLiabilities`. Negative
46
- * means the vault is under-collateralised. Monitoring view added with the audit fixes.
47
- */
48
- solvencyMargin(vaultAddress: string): Promise<bigint>;
49
- /** Total non-transferable shares in circulation. */
50
- totalShares(vaultAddress: string): Promise<bigint>;
51
- /** Non-transferable share balance of `account`. */
52
- shareOf(vaultAddress: string, account: string): Promise<bigint>;
53
- /** Cumulative instant-withdraw shares used. */
54
- cumulativeInstantWithdrawShares(vaultAddress: string): Promise<bigint>;
55
- /** Configured instant-withdraw cap (shares). */
56
- maxInstantWithdrawShares(vaultAddress: string): Promise<bigint>;
57
- /** Remaining instant-withdraw headroom (shares). */
58
- availableInstantWithdrawShares(vaultAddress: string): Promise<bigint>;
59
- /** Per-source-share swap config. */
60
- emberShareConfigs(vaultAddress: string, share: string): Promise<unknown>;
61
- /** Remaining swap capacity for a source share in the current epoch. */
62
- availableEmberShareCapacity(vaultAddress: string, share: string): Promise<bigint>;
63
- /** Length of the holdback FIFO for a source share. */
64
- getHoldbackQueueLength(vaultAddress: string, share: string): Promise<bigint>;
65
- /**
66
- * Escrowed (deferred) holdback collateral claimable by `account` — accrued when a
67
- * holdback payout couldn't be transferred to it during `releaseUsersHoldback` (e.g. a
68
- * token-level blocklist). Claim via user `claimHoldback` / `claimHoldbackFor`. 0 if none.
69
- */
70
- unclaimedHoldback(vaultAddress: string, account: string): Promise<bigint>;
71
- /** Whether `operation` ("deposits" | "withdrawals" | "privilegedOperations") is paused. */
72
- pauseStatus(vaultAddress: string, operation: string): Promise<boolean>;
73
- /** Per-account state (shares + pending withdrawals). */
74
- getAccountState(vaultAddress: string, account: string): Promise<unknown>;
75
- /** Convert a share amount to assets at the current rate. */
76
- convertToAssets(vaultAddress: string, shares: bigint): Promise<bigint>;
77
- /** Convert an asset amount to shares at the current rate. */
78
- convertToShares(vaultAddress: string, assets: bigint): Promise<bigint>;
79
- /** Contract version string. */
80
- version(vaultAddress: string): Promise<string>;
81
- /**
82
- * Live quote for the EmberShare swap-with-holdback "instant withdraw": a holder of a
83
- * source vault's shares (`share`) swaps `shareAmount` into this ALV, receiving most of
84
- * the value instantly with a small % held back for later operator release.
85
- *
86
- * All dynamic inputs (rate, TVL, held value, epoch capacity, waivers) are read live via
87
- * RPC. The fee-multiplier curve has no on-chain getter (the public `emberShareConfigs`
88
- * getter omits the dynamic array), so pass it from bfvs `instantWithdrawConfig`; an empty
89
- * curve means a 1x multiplier (matches the contract default).
90
- */
91
- previewSwapInstantWithdraw(vaultAddress: string, share: string, shareAmount: bigint, owner: string, feeMultiplierCurve?: FeeMultiplierTier[]): Promise<InstantWithdrawQuote>;
92
- /**
93
- * Live quote for the ALV's own plain `instantWithdraw` (atomic-share holders): burn
94
- * `shareAmount` ALV shares for `gross - fee`, no holdback, capped by
95
- * `maxInstantWithdrawShares`. All inputs read live via RPC.
96
- */
97
- previewPlainInstantWithdraw(vaultAddress: string, shareAmount: bigint, owner: string): Promise<InstantWithdrawQuote>;
98
- }
@@ -1,212 +0,0 @@
1
- import { Contract } from "ethers";
2
- import AtomicLiquidityABI from "../../abis/AtomicLiquidity.json" with { type: "json" };
3
- import EmberVaultABI from "../../abis/EmberVault.json" with { type: "json" };
4
- import { computeSwapQuote, computePlainInstantQuote } from "../../atomic/instant-withdraw.js";
5
- /** EVM fixed-point scale (1e18) used by the AtomicLiquidity contract math. */
6
- const EVM_SCALE = 10n ** 18n;
7
- /**
8
- * Read-only views for the Atomic Liquidity Vault (BFE-817/818).
9
- *
10
- * Write calls live on the role classes (EVMUserCalls.instantWithdraw /
11
- * swapEmberShares, EVMOperatorCalls.supplyToStrategy / withdrawFromStrategy /
12
- * redeemCollectedEmberShares / releaseUsersHoldback, EVMVaultAdminCalls.setStrategy /
13
- * setEmberShareWhitelist / setSwapWaiver / setMaxInstantWithdrawShares /
14
- * setInstantWithdrawFeePercentage). Shared lifecycle calls (deposit, redeemShares,
15
- * cancelPendingWithdrawalRequest, processWithdrawalRequests, collectPlatformFee,
16
- * updateVaultRate, pause/role/cap setters) reuse the existing EmberVault methods on
17
- * those same classes.
18
- *
19
- * This reader uses an ethers Contract against the bundled AtomicLiquidity ABI and
20
- * provides typed convenience getters plus a generic `read` for any view not covered.
21
- *
22
- * @example
23
- * ```typescript
24
- * const reader = new EVMAtomicLiquidityReader(provider);
25
- * const rate = await reader.rate(vault);
26
- * const supplied = await reader.getStrategyAssets(vault);
27
- * const cfg = await reader.read(vault, "emberShareConfigs", [sourceShare]);
28
- * ```
29
- */
30
- export class EVMAtomicLiquidityReader {
31
- constructor(_provider) {
32
- this.provider = _provider;
33
- }
34
- contract(vaultAddress) {
35
- return new Contract(vaultAddress, AtomicLiquidityABI.abi, this.provider);
36
- }
37
- /** A source EmberShare vault (ERC-4626) for read-only convertToAssets/balanceOf/accounts. */
38
- shareContract(share) {
39
- return new Contract(share, EmberVaultABI.abi, this.provider);
40
- }
41
- /** Generic view call for any function on the AtomicLiquidity ABI. */
42
- async read(vaultAddress, functionName, args = []) {
43
- return this.contract(vaultAddress)[functionName](...args);
44
- }
45
- /** roles() -> { admin, operator, rateManager }. */
46
- async roles(vaultAddress) {
47
- return this.contract(vaultAddress).roles();
48
- }
49
- /** rate() -> { value, maxRateChangePerUpdate, rateUpdateInterval, lastUpdatedAt }. */
50
- async rate(vaultAddress) {
51
- return this.contract(vaultAddress).rate();
52
- }
53
- /** Current external strategy address (zero if none). */
54
- async strategy(vaultAddress) {
55
- return this.contract(vaultAddress).strategy();
56
- }
57
- /** Assets currently supplied to the strategy. */
58
- async getStrategyAssets(vaultAddress) {
59
- return this.contract(vaultAddress).getStrategyAssets();
60
- }
61
- /** Total assets (idle + strategy + outstanding). */
62
- async totalAssets(vaultAddress) {
63
- return this.contract(vaultAddress).totalAssets();
64
- }
65
- /**
66
- * Solvency margin (collateral units, signed): `totalAssets - totalLiabilities`. Negative
67
- * means the vault is under-collateralised. Monitoring view added with the audit fixes.
68
- */
69
- async solvencyMargin(vaultAddress) {
70
- return this.contract(vaultAddress).solvencyMargin();
71
- }
72
- /** Total non-transferable shares in circulation. */
73
- async totalShares(vaultAddress) {
74
- return this.contract(vaultAddress).totalShares();
75
- }
76
- /** Non-transferable share balance of `account`. */
77
- async shareOf(vaultAddress, account) {
78
- return this.contract(vaultAddress).shareOf(account);
79
- }
80
- /** Cumulative instant-withdraw shares used. */
81
- async cumulativeInstantWithdrawShares(vaultAddress) {
82
- return this.contract(vaultAddress).cumulativeInstantWithdrawShares();
83
- }
84
- /** Configured instant-withdraw cap (shares). */
85
- async maxInstantWithdrawShares(vaultAddress) {
86
- return this.contract(vaultAddress).maxInstantWithdrawShares();
87
- }
88
- /** Remaining instant-withdraw headroom (shares). */
89
- async availableInstantWithdrawShares(vaultAddress) {
90
- return this.contract(vaultAddress).availableInstantWithdrawShares();
91
- }
92
- /** Per-source-share swap config. */
93
- async emberShareConfigs(vaultAddress, share) {
94
- return this.contract(vaultAddress).emberShareConfigs(share);
95
- }
96
- /** Remaining swap capacity for a source share in the current epoch. */
97
- async availableEmberShareCapacity(vaultAddress, share) {
98
- return this.contract(vaultAddress).availableEmberShareCapacity(share);
99
- }
100
- /** Length of the holdback FIFO for a source share. */
101
- async getHoldbackQueueLength(vaultAddress, share) {
102
- return this.contract(vaultAddress).getHoldbackQueueLength(share);
103
- }
104
- /**
105
- * Escrowed (deferred) holdback collateral claimable by `account` — accrued when a
106
- * holdback payout couldn't be transferred to it during `releaseUsersHoldback` (e.g. a
107
- * token-level blocklist). Claim via user `claimHoldback` / `claimHoldbackFor`. 0 if none.
108
- */
109
- async unclaimedHoldback(vaultAddress, account) {
110
- return this.contract(vaultAddress).unclaimedHoldback(account);
111
- }
112
- /** Whether `operation` ("deposits" | "withdrawals" | "privilegedOperations") is paused. */
113
- async pauseStatus(vaultAddress, operation) {
114
- return this.contract(vaultAddress).pauseStatus(operation);
115
- }
116
- /** Per-account state (shares + pending withdrawals). */
117
- async getAccountState(vaultAddress, account) {
118
- return this.contract(vaultAddress).getAccountState(account);
119
- }
120
- /** Convert a share amount to assets at the current rate. */
121
- async convertToAssets(vaultAddress, shares) {
122
- return this.contract(vaultAddress).convertToAssets(shares);
123
- }
124
- /** Convert an asset amount to shares at the current rate. */
125
- async convertToShares(vaultAddress, assets) {
126
- return this.contract(vaultAddress).convertToShares(assets);
127
- }
128
- /** Contract version string. */
129
- async version(vaultAddress) {
130
- return this.contract(vaultAddress).version();
131
- }
132
- /**
133
- * Live quote for the EmberShare swap-with-holdback "instant withdraw": a holder of a
134
- * source vault's shares (`share`) swaps `shareAmount` into this ALV, receiving most of
135
- * the value instantly with a small % held back for later operator release.
136
- *
137
- * All dynamic inputs (rate, TVL, held value, epoch capacity, waivers) are read live via
138
- * RPC. The fee-multiplier curve has no on-chain getter (the public `emberShareConfigs`
139
- * getter omits the dynamic array), so pass it from bfvs `instantWithdrawConfig`; an empty
140
- * curve means a 1x multiplier (matches the contract default).
141
- */
142
- async previewSwapInstantWithdraw(vaultAddress, share, shareAmount, owner, feeMultiplierCurve = []) {
143
- const vault = this.contract(vaultAddress);
144
- const src = this.shareContract(share);
145
- const [grossAmount, cfg, vaultTotalAssets, availableCapacity, custodied, hasRedemption, feeWaived, holdbackWaived, userShareBalance] = await Promise.all([
146
- src.convertToAssets(shareAmount),
147
- vault.emberShareConfigs(share),
148
- vault.totalAssets(),
149
- vault.availableEmberShareCapacity(share),
150
- src.balanceOf(vaultAddress),
151
- vault.hasActiveRedemptionHistory(),
152
- vault.feeWaivedAddresses(owner),
153
- vault.holdbackWaivedAddresses(owner),
154
- src.balanceOf(owner)
155
- ]);
156
- // currentHeldValue mirrors _heldShareValueInCollateral: custodied + pending
157
- // (pending only when the ALV has an active redemption history), valued via the
158
- // source vault's convertToAssets.
159
- let heldShares = custodied;
160
- if (hasRedemption) {
161
- // EmberVault.accounts(address) has a single uint256 output
162
- // (totalPendingWithdrawalShares); ethers v6 returns the bare bigint for
163
- // single-output calls, not a named struct.
164
- const pendingWithdrawalShares = (await src.accounts(vaultAddress));
165
- heldShares += pendingWithdrawalShares;
166
- }
167
- const currentHeldValue = heldShares === 0n ? 0n : (await src.convertToAssets(heldShares));
168
- return computeSwapQuote({
169
- scale: EVM_SCALE,
170
- grossAmount,
171
- shareAmount,
172
- userShareBalance,
173
- currentHeldValue,
174
- vaultTotalAssets,
175
- availableCapacity,
176
- config: {
177
- feePercentage: cfg.feePercentage,
178
- holdbackPercentage: cfg.holdbackPercentage,
179
- maxUtilizationPercentage: cfg.maxUtilizationPercentage,
180
- minSwapGross: cfg.minSwapGross,
181
- maxHeldValueAbsolute: cfg.maxHeldValueAbsolute,
182
- feeMultiplierCurve
183
- },
184
- feeWaived,
185
- holdbackWaived
186
- });
187
- }
188
- /**
189
- * Live quote for the ALV's own plain `instantWithdraw` (atomic-share holders): burn
190
- * `shareAmount` ALV shares for `gross - fee`, no holdback, capped by
191
- * `maxInstantWithdrawShares`. All inputs read live via RPC.
192
- */
193
- async previewPlainInstantWithdraw(vaultAddress, shareAmount, owner) {
194
- const vault = this.contract(vaultAddress);
195
- const [grossAmount, instantWithdrawFeePercentage, cumulativeInstantWithdrawShares, maxInstantWithdrawShares, userShareBalance] = await Promise.all([
196
- vault.convertToAssets(shareAmount),
197
- vault.instantWithdrawFeePercentage(),
198
- vault.cumulativeInstantWithdrawShares(),
199
- vault.maxInstantWithdrawShares(),
200
- vault.shareOf(owner)
201
- ]);
202
- return computePlainInstantQuote({
203
- scale: EVM_SCALE,
204
- grossAmount,
205
- shareAmount,
206
- userShareBalance,
207
- instantWithdrawFeePercentage,
208
- cumulativeInstantWithdrawShares,
209
- maxInstantWithdrawShares
210
- });
211
- }
212
- }
@@ -1,62 +0,0 @@
1
- import { BaseClient as SuiClient } from "@mysten/sui/client";
2
- import { FeeMultiplierTier, InstantWithdrawQuote } from "../../atomic/instant-withdraw.js";
3
- /**
4
- * Read-only views + instant-withdraw quotes for the Sui Atomic Liquidity Vault (BET-4111).
5
- *
6
- * There is no on-chain preview function and no off-chain view calls on Sui, so this reads
7
- * the ALV (and source vault) object fields directly and replicates the Move math
8
- * (`calculate_amount_from_shares`, `get_vault_tvl`, `swap_ember_shares`,
9
- * `do_instant_withdraw_core`) via the shared chain-agnostic quote core at scale 1e9.
10
- *
11
- * @example
12
- * ```ts
13
- * const reader = new SuiAtomicLiquidityReader(suiClient);
14
- * const q = await reader.previewSwapInstantWithdraw(vaultId, sourceVaultId, 100_000000n, owner);
15
- * ```
16
- */
17
- export declare class SuiAtomicLiquidityReader {
18
- suiClient: SuiClient;
19
- constructor(suiClient: SuiClient);
20
- /** Raw Move fields of the AtomicLiquidityVault object. */
21
- private vaultFields;
22
- /**
23
- * Read a `Table<K, V>` entry value. Table entries are plain dynamic fields, so we
24
- * resolve the `Field<K,V>` object id via `getDynamicField`, then fetch its json
25
- * (`{ name, value }`). Returns the unwrapped `value`, or null if absent.
26
- */
27
- private readTableValue;
28
- /** Rate value (1e9) of any vault object (ALV or source EmberVault). */
29
- private rateValue;
30
- /** Per-source-share EmberShare config from the `ember_share_configs` table. */
31
- getEmberShareConfig(vaultId: string, sourceVaultId: string): Promise<{
32
- whitelisted: boolean;
33
- feePercentage: bigint;
34
- holdbackPercentage: bigint;
35
- maxCapacityPercentage: bigint;
36
- maxUtilizationPercentage: bigint;
37
- epochStartedAt: bigint;
38
- epochUsedAmount: bigint;
39
- feeMultiplierCurve: FeeMultiplierTier[];
40
- } | null>;
41
- /** Caller's ALV (non-transferable) share balance from the `shares` table. */
42
- shareOf(vaultId: string, account: string): Promise<bigint>;
43
- /**
44
- * Live quote for the EmberShare swap-with-holdback "instant withdraw" on Sui.
45
- * Reads ALV + source vault fields and replicates `swap_ember_shares` math.
46
- *
47
- * `currentHeldValue` defaults to 0 (the common case before any swap); pass it when the
48
- * ALV already custodies source shares. `availableCapacity` (remaining 24h epoch capacity,
49
- * collateral units) is bfvs-sourced when precise epoch accounting is required — when
50
- * omitted, only the utilization cap gates `withinCapacity`.
51
- */
52
- previewSwapInstantWithdraw(vaultId: string, sourceVaultId: string, shareAmount: bigint, owner: string, opts?: {
53
- availableCapacity?: bigint;
54
- currentHeldValue?: bigint;
55
- userShareBalance?: bigint;
56
- }): Promise<InstantWithdrawQuote>;
57
- /**
58
- * Live quote for the ALV's own plain `instant_withdraw` on Sui (atomic-share holders).
59
- * `net = gross - fee`, no holdback, capped by `max_instant_withdraw_shares`.
60
- */
61
- previewPlainInstantWithdraw(vaultId: string, shareAmount: bigint, owner: string): Promise<InstantWithdrawQuote>;
62
- }