@atomiqlabs/chain-evm 2.1.11 → 2.1.14

package/dist/evm/spv_swap/EVMSpvVaultContract.d.ts

@@ -8,39 +8,38 @@ import { EVMSigner } from "../wallet/EVMSigner";
 import { SpvVaultManager } from "./SpvVaultContractTypechain";
 import { EVMBtcRelay } from "../btcrelay/EVMBtcRelay";
 import { EVMChainInterface } from "../chain/EVMChainInterface";
-import { TransactionRequest } from "ethers";
 import { EVMSpvVaultData } from "./EVMSpvVaultData";
 import { EVMSpvWithdrawalData } from "./EVMSpvWithdrawalData";
 import { EVMBtcStoredHeader } from "../btcrelay/headers/EVMBtcStoredHeader";
+/**
+ * Packs vault owner and vault id into compact `owner+vaultId` event key format.
+ *
+ * @category Swaps
+ */
 export declare function packOwnerAndVaultId(owner: string, vaultId: bigint): string;
+/**
+ * Unpacks compact `owner+vaultId` event key format into owner and vault id.
+ *
+ * @category Swaps
+ */
 export declare function unpackOwnerAndVaultId(data: string): [string, bigint];
 /**
+ * EVM SPV vault (UTXO-controlled vault) contract representation.
+ *
  * @category Swaps
  */
 export declare class EVMSpvVaultContract<ChainId extends string> extends EVMContractBase<SpvVaultManager> implements SpvVaultContract<EVMTx, EVMSigner, ChainId, EVMSpvWithdrawalData, EVMSpvVaultData> {
-    static readonly GasCosts: {
-        DEPOSIT_BASE: number;
-        DEPOSIT_ERC20: number;
-        OPEN: number;
-        CLAIM_BASE: number;
-        CLAIM_NATIVE_TRANSFER: number;
-        CLAIM_ERC20_TRANSFER: number;
-        CLAIM_EXECUTION_SCHEDULE: number;
-        FRONT_BASE: number;
-        FRONT_NATIVE_TRANSFER: number;
-        FRONT_ERC20_TRANSFER: number;
-        FRONT_EXECUTION_SCHEDULE: number;
-    };
+    private static readonly GasCosts;
     readonly chainId: ChainId;
-    readonly btcRelay: EVMBtcRelay<any>;
-    readonly bitcoinRpc: BitcoinRpc<any>;
     readonly claimTimeout: number;
-    readonly logger: import("../../utils/Utils").LoggerType;
+    private readonly btcRelay;
+    private readonly bitcoinRpc;
+    private readonly logger;
     constructor(chainInterface: EVMChainInterface<ChainId>, btcRelay: EVMBtcRelay<any>, bitcoinRpc: BitcoinRpc<any>, contractAddress: string, contractDeploymentHeight?: number);
-    protected Open(signer: string, vault: EVMSpvVaultData, feeRate: string): Promise<TransactionRequest>;
-    protected Deposit(signer: string, vault: EVMSpvVaultData, rawAmounts: bigint[], feeRate: string): Promise<TransactionRequest>;
-    protected Front(signer: string, vault: EVMSpvVaultData, data: EVMSpvWithdrawalData, withdrawalSequence: number, feeRate: string): Promise<TransactionRequest>;
-    protected Claim(signer: string, vault: EVMSpvVaultData, data: EVMSpvWithdrawalData, blockheader: EVMBtcStoredHeader, merkle: Buffer[], position: number, feeRate: string): Promise<TransactionRequest>;
+    private Open;
+    private Deposit;
+    private Front;
+    private Claim;
     /**
      * @inheritDoc
      */
@@ -130,6 +129,11 @@ export declare class EVMSpvVaultContract<ChainId extends string> extends EVMCont
         rawAmounts: bigint[];
         executionHash?: string;
     };
+    /**
+     * Parses withdrawal params from OP_RETURN data.
+     *
+     * @param data Data as specified in the OP_RETURN output of the transaction
+     */
     static fromOpReturnData(data: Buffer): {
         recipient: string;
         rawAmounts: bigint[];
@@ -139,6 +143,13 @@ export declare class EVMSpvVaultContract<ChainId extends string> extends EVMCont
      * @inheritDoc
      */
     toOpReturnData(recipient: string, rawAmounts: bigint[], executionHash?: string): Buffer;
+    /**
+     * Serializes withdrawal params to OP_RETURN data.
+     *
+     * @param recipient Recipient of the withdrawn tokens
+     * @param rawAmounts Raw amount of tokens to withdraw
+     * @param executionHash Optional execution hash of the actions to execute
+     */
     static toOpReturnData(recipient: string, rawAmounts: bigint[], executionHash?: string): Buffer;
     /**
      * @inheritDoc
@@ -178,7 +189,21 @@ export declare class EVMSpvVaultContract<ChainId extends string> extends EVMCont
      * @inheritDoc
      */
     txsOpen(signer: string, vault: EVMSpvVaultData, feeRate?: string): Promise<EVMTx[]>;
+    /**
+     * Returns an estimated gas amount for a claim transaction.
+     *
+     * @param signer Signer address executing the claim
+     * @param vault Vault data used to determine transfer paths
+     * @param data Parsed withdrawal data
+     */
     getClaimGas(signer: string, vault?: EVMSpvVaultData, data?: EVMSpvWithdrawalData): number;
+    /**
+     * Returns an estimated gas amount for a front-liquidity transaction.
+     *
+     * @param signer Signer address executing the front action
+     * @param vault Vault data used to determine transfer paths
+     * @param data Parsed withdrawal data
+     */
     getFrontGas(signer: string, vault: EVMSpvVaultData, data?: EVMSpvWithdrawalData): number;
     /**
      * @inheritDoc

package/dist/evm/spv_swap/EVMSpvVaultContract.js

@@ -20,17 +20,29 @@ function decodeUtxo(utxo) {
         vout: BigInt(vout)
     };
 }
+/**
+ * Packs vault owner and vault id into compact `owner+vaultId` event key format.
+ *
+ * @category Swaps
+ */
 function packOwnerAndVaultId(owner, vaultId) {
     if (owner.length !== 42)
         throw new Error("Invalid owner address");
     return owner.toLowerCase() + base_1.BigIntBufferUtils.toBuffer(vaultId, "be", 12).toString("hex");
 }
 exports.packOwnerAndVaultId = packOwnerAndVaultId;
+/**
+ * Unpacks compact `owner+vaultId` event key format into owner and vault id.
+ *
+ * @category Swaps
+ */
 function unpackOwnerAndVaultId(data) {
     return [(0, ethers_1.getAddress)(data.substring(0, 42)), BigInt("0x" + data.substring(42, 66))];
 }
 exports.unpackOwnerAndVaultId = unpackOwnerAndVaultId;
 /**
+ * EVM SPV vault (UTXO-controlled vault) contract representation.
+ *
  * @category Swaps
  */
 class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
@@ -49,7 +61,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
         const tokens = vault.getTokenData();
         if (tokens.length !== 2)
             throw new Error("Must specify exactly 2 tokens for vault!");
-        const tx = await this.contract.open.populateTransaction(vault.vaultId, vault.getVaultParamsStruct(), txHash, vout);
+        const tx = await this.contract.open.populateTransaction(vault.vaultId, vault._getVaultParamsStruct(), txHash, vout);
         tx.from = signer;
         EVMFees_1.EVMFees.applyFeeRate(tx, EVMSpvVaultContract.GasCosts.OPEN, feeRate);
         return tx;
@@ -71,7 +83,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             if (rawAmounts[1] != null && rawAmounts[1] > 0n && vault.token0.token.toLowerCase() !== vault.token1.token.toLowerCase())
                 totalGas += EVMSpvVaultContract.GasCosts.DEPOSIT_ERC20;
         }
-        const tx = await this.contract.deposit.populateTransaction(vault.owner, vault.vaultId, vault.getVaultParamsStruct(), rawAmounts[0], rawAmounts[1] ?? 0n, { value });
+        const tx = await this.contract.deposit.populateTransaction(vault.owner, vault.vaultId, vault._getVaultParamsStruct(), rawAmounts[0], rawAmounts[1] ?? 0n, { value });
         tx.from = signer;
         EVMFees_1.EVMFees.applyFeeRate(tx, totalGas, feeRate);
         return tx;
@@ -83,13 +95,13 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             value += frontingAmount[0] * vault.token0.multiplier;
         if (vault.token1.token.toLowerCase() === this.Chain.getNativeCurrencyAddress().toLowerCase())
             value += (frontingAmount[1] ?? 0n) * vault.token1.multiplier;
-        const tx = await this.contract.front.populateTransaction(vault.owner, vault.vaultId, vault.getVaultParamsStruct(), withdrawalSequence, data.getTxHash(), data.serializeToStruct(), { value });
+        const tx = await this.contract.front.populateTransaction(vault.owner, vault.vaultId, vault._getVaultParamsStruct(), withdrawalSequence, data.getTxHash(), data.serializeToStruct(), { value });
         tx.from = signer;
         EVMFees_1.EVMFees.applyFeeRate(tx, this.getFrontGas(signer, vault, data), feeRate);
         return tx;
     }
     async Claim(signer, vault, data, blockheader, merkle, position, feeRate) {
-        const tx = await this.contract.claim.populateTransaction(vault.owner, vault.vaultId, vault.getVaultParamsStruct(), "0x" + data.btcTx.hex, blockheader.serializeToStruct(), merkle, position);
+        const tx = await this.contract.claim.populateTransaction(vault.owner, vault.vaultId, vault._getVaultParamsStruct(), "0x" + data.btcTx.hex, blockheader.serializeToStruct(), merkle, position);
         tx.from = signer;
         EVMFees_1.EVMFees.applyFeeRate(tx, this.getClaimGas(signer, vault, data), feeRate);
         return tx;
@@ -109,7 +121,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
         if (tokenData.length !== 2)
             throw new Error("Must specify 2 tokens in tokenData!");
         const vaultParams = {
-            btcRelayContract: this.btcRelay.contractAddress,
+            btcRelayContract: this.btcRelay._contractAddress,
             token0: tokenData[0].token,
             token1: tokenData[1].token,
             token0Multiplier: tokenData[0].multiplier,
@@ -149,7 +161,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             promises.push(this.getFronterAddress(owner, vaultId, withdrawal).then(val => {
                 result[withdrawal.getTxId()] = val;
             }));
-            if (promises.length >= this.Chain.config.maxParallelCalls) {
+            if (promises.length >= this.Chain._config.maxParallelCalls) {
                 await Promise.all(promises);
                 promises = [];
             }
@@ -166,7 +178,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             return null;
         const vaultParams = await this.vaultParamsCache.getOrComputeAsync(vaultState.spvVaultParametersCommitment, async () => {
             const blockheight = Number(vaultState.openBlockheight);
-            const events = await this.Events.getContractBlockEvents(["Opened"], [
+            const events = await this._Events.getContractBlockEvents(["Opened"], [
                 "0x" + owner.substring(2).padStart(64, "0"),
                 (0, ethers_1.hexlify)(base_1.BigIntBufferUtils.toBuffer(vaultId, "be", 32))
             ], blockheight);
@@ -175,7 +187,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
                 throw new Error("Valid open event not found!");
             return foundEvent.args.params;
         });
-        if (vaultParams.btcRelayContract.toLowerCase() !== this.btcRelay.contractAddress.toLowerCase())
+        if (vaultParams.btcRelayContract.toLowerCase() !== this.btcRelay._contractAddress.toLowerCase())
             return null;
         return new EVMSpvVaultData_1.EVMSpvVaultData(owner, vaultId, vaultState, vaultParams);
     }
@@ -191,7 +203,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
                 result[owner] ?? (result[owner] = {});
                 result[owner][vaultId.toString(10)] = val;
             }));
-            if (promises.length >= this.Chain.config.maxParallelCalls) {
+            if (promises.length >= this.Chain._config.maxParallelCalls) {
                 await Promise.all(promises);
                 promises = [];
             }
@@ -221,7 +233,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
                 result[owner] ?? (result[owner] = {});
                 result[owner][vaultId.toString(10)] = val;
             }));
-            if (promises.length >= this.Chain.config.maxParallelCalls) {
+            if (promises.length >= this.Chain._config.maxParallelCalls) {
                 await Promise.all(promises);
                 promises = [];
             }
@@ -234,7 +246,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
      */
     async getAllVaults(owner) {
         const openedVaults = new Map();
-        await this.Events.findInContractEventsForward(["Opened", "Closed"], owner == null ? null : [
+        await this._Events.findInContractEventsForward(["Opened", "Closed"], owner == null ? null : [
             "0x" + owner.substring(2).padStart(64, "0")
         ], (event) => {
             const vaultIdentifier = event.args.owner + ":" + event.args.vaultId.toString(10);
@@ -250,13 +262,15 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
         const vaults = [];
         let promises = [];
         for (let [identifier, vaultParams] of openedVaults.entries()) {
+            if (vaultParams.btcRelayContract.toLowerCase() !== this.btcRelay._contractAddress.toLowerCase())
+                continue;
             const [owner, vaultIdStr] = identifier.split(":");
             promises.push(this.contract.getVault(owner, BigInt(vaultIdStr)).then(vaultState => {
                 if (vaultState.spvVaultParametersCommitment === (0, EVMSpvVaultData_1.getVaultParamsCommitment)(vaultParams)) {
                     vaults.push(new EVMSpvVaultData_1.EVMSpvVaultData(owner, BigInt(vaultIdStr), vaultState, vaultParams));
                 }
             }));
-            if (promises.length >= this.Chain.config.maxParallelCalls) {
+            if (promises.length >= this.Chain._config.maxParallelCalls) {
                 await Promise.all(promises);
                 promises = [];
             }
@@ -326,12 +340,12 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
         const keys = [null, null, (0, ethers_1.hexlify)(txHash)];
         let result;
         if (scStartHeight == null) {
-            result = await this.Events.findInContractEvents(events, keys, async (event) => {
+            result = await this._Events.findInContractEvents(events, keys, async (event) => {
                 return this.parseWithdrawalEvent(event);
             });
         }
         else {
-            result = await this.Events.findInContractEventsForward(events, keys, async (event) => {
+            result = await this._Events.findInContractEventsForward(events, keys, async (event) => {
                 const result = this.parseWithdrawalEvent(event);
                 if (result == null)
                     return null;
@@ -357,8 +371,8 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
         var _a;
         const result = {};
         const events = ["Fronted", "Claimed", "Closed"];
-        for (let i = 0; i < withdrawalTxs.length; i += this.Chain.config.maxLogTopics) {
-            const checkWithdrawalTxs = withdrawalTxs.slice(i, i + this.Chain.config.maxLogTopics);
+        for (let i = 0; i < withdrawalTxs.length; i += this.Chain._config.maxLogTopics) {
+            const checkWithdrawalTxs = withdrawalTxs.slice(i, i + this.Chain._config.maxLogTopics);
             const checkWithdrawalTxsMap = new Map(checkWithdrawalTxs.map(val => [val.withdrawal.getTxId(), val.withdrawal]));
             let scStartHeight = null;
             for (let val of checkWithdrawalTxs) {
@@ -370,7 +384,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             }
             const keys = [null, null, checkWithdrawalTxs.map(withdrawal => (0, ethers_1.hexlify)(buffer_1.Buffer.from(withdrawal.withdrawal.getTxId(), "hex").reverse()))];
             if (scStartHeight == null) {
-                await this.Events.findInContractEvents(events, keys, async (event) => {
+                await this._Events.findInContractEvents(events, keys, async (event) => {
                     const _event = event;
                     const btcTxId = buffer_1.Buffer.from(_event.args.btcTxHash.substring(2), "hex").reverse().toString("hex");
                     if (!checkWithdrawalTxsMap.has(btcTxId)) {
@@ -387,7 +401,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
                 });
             }
             else {
-                await this.Events.findInContractEventsForward(events, keys, async (event) => {
+                await this._Events.findInContractEventsForward(events, keys, async (event) => {
                     const _event = event;
                     const btcTxId = buffer_1.Buffer.from(_event.args.btcTxHash.substring(2), "hex").reverse().toString("hex");
                     const withdrawalTx = checkWithdrawalTxsMap.get(btcTxId);
@@ -423,7 +437,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
     async getHistoricalWithdrawalStates(recipient, startBlockheight) {
         const { height: latestBlockheight } = await this.Chain.getFinalizedBlock();
         const withdrawals = {};
-        await this.Events.findInContractEventsForward(["Claimed", "Fronted"], [null, recipient], async (_event) => {
+        await this._Events.findInContractEventsForward(["Claimed", "Fronted"], [null, recipient], async (_event) => {
             const eventResult = this.parseWithdrawalEvent(_event);
             if (eventResult == null || eventResult.type === base_1.SpvWithdrawalStateType.CLOSED)
                 return null;
@@ -447,6 +461,11 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
     fromOpReturnData(data) {
         return EVMSpvVaultContract.fromOpReturnData(data);
     }
+    /**
+     * Parses withdrawal params from OP_RETURN data.
+     *
+     * @param data Data as specified in the OP_RETURN output of the transaction
+     */
     static fromOpReturnData(data) {
         let rawAmount0 = 0n;
         let rawAmount1 = 0n;
@@ -481,6 +500,13 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
     toOpReturnData(recipient, rawAmounts, executionHash) {
         return EVMSpvVaultContract.toOpReturnData(recipient, rawAmounts, executionHash);
     }
+    /**
+     * Serializes withdrawal params to OP_RETURN data.
+     *
+     * @param recipient Recipient of the withdrawn tokens
+     * @param rawAmounts Raw amount of tokens to withdraw
+     * @param executionHash Optional execution hash of the actions to execute
+     */
     static toOpReturnData(recipient, rawAmounts, executionHash) {
         if (!EVMAddresses_1.EVMAddresses.isValidAddress(recipient))
             throw new Error("Invalid recipient specified");
@@ -606,7 +632,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
                 requiredApprovals[vault.token1.token.toLowerCase()] += realAmount1;
             }
         }
-        const requiredApprovalTxns = await Promise.all(Object.keys(requiredApprovals).map(token => this.Chain.Tokens.checkAndGetApproveTx(signer, token, requiredApprovals[token], this.contractAddress, feeRate)));
+        const requiredApprovalTxns = await Promise.all(Object.keys(requiredApprovals).map(token => this.Chain.Tokens.checkAndGetApproveTx(signer, token, requiredApprovals[token], this._contractAddress, feeRate)));
         requiredApprovalTxns.forEach(tx => tx != null && txs.push(tx));
         txs.push(await this.Deposit(signer, vault, rawAmounts, feeRate));
         this.logger.debug("txsDeposit(): deposit TX created," +
@@ -642,7 +668,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
                 requiredApprovals[vault.token1.token.toLowerCase()] += realAmount1;
             }
         }
-        const requiredApprovalTxns = await Promise.all(Object.keys(requiredApprovals).map(token => this.Chain.Tokens.checkAndGetApproveTx(signer, token, requiredApprovals[token], this.contractAddress, feeRate)));
+        const requiredApprovalTxns = await Promise.all(Object.keys(requiredApprovals).map(token => this.Chain.Tokens.checkAndGetApproveTx(signer, token, requiredApprovals[token], this._contractAddress, feeRate)));
         requiredApprovalTxns.forEach(tx => tx != null && txs.push(tx));
         txs.push(await this.Front(signer, vault, realWithdrawalTx, withdrawSequence, feeRate));
         this.logger.debug("txsFrontLiquidity(): front TX created," +
@@ -662,6 +688,13 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             " vaultId: " + vault.getVaultId().toString(10));
         return [tx];
     }
+    /**
+     * Returns an estimated gas amount for a claim transaction.
+     *
+     * @param signer Signer address executing the claim
+     * @param vault Vault data used to determine transfer paths
+     * @param data Parsed withdrawal data
+     */
     getClaimGas(signer, vault, data) {
         let totalGas = EVMSpvVaultContract.GasCosts.CLAIM_BASE;
         if (data == null || (data.rawAmounts[0] != null && data.rawAmounts[0] > 0n)) {
@@ -686,6 +719,13 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
             totalGas += EVMSpvVaultContract.GasCosts.CLAIM_EXECUTION_SCHEDULE;
         return totalGas;
     }
+    /**
+     * Returns an estimated gas amount for a front-liquidity transaction.
+     *
+     * @param signer Signer address executing the front action
+     * @param vault Vault data used to determine transfer paths
+     * @param data Parsed withdrawal data
+     */
     getFrontGas(signer, vault, data) {
         let totalGas = EVMSpvVaultContract.GasCosts.FRONT_BASE;
         if (data == null || (data.rawAmounts[0] != null && data.rawAmounts[0] > 0n)) {
@@ -711,7 +751,7 @@ class EVMSpvVaultContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     async getFrontFee(signer, vault, withdrawalData, feeRate) {
-        vault ?? (vault = EVMSpvVaultData_1.EVMSpvVaultData.randomVault());
+        vault ?? (vault = EVMSpvVaultData_1.EVMSpvVaultData._randomVault());
         feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
         let totalFee = EVMFees_1.EVMFees.getGasFee(this.getFrontGas(signer, vault, withdrawalData), feeRate);
         if (withdrawalData == null || (withdrawalData.rawAmounts[0] != null && withdrawalData.rawAmounts[0] > 0n)) {

package/dist/evm/spv_swap/EVMSpvVaultData.d.ts

@@ -1,9 +1,21 @@
 import { SpvVaultClaimEvent, SpvVaultCloseEvent, SpvVaultData, SpvVaultDepositEvent, SpvVaultOpenEvent, SpvVaultTokenBalance, SpvVaultTokenData } from "@atomiqlabs/base";
 import { EVMSpvWithdrawalData } from "./EVMSpvWithdrawalData";
 import { SpvVaultParametersStruct, SpvVaultStateStruct } from "./SpvVaultContractTypechain";
+/**
+ * Computes the vault parameter commitment hash used by the on-chain SPV vault state.
+ *
+ * @category Swaps
+ */
 export declare function getVaultParamsCommitment(vaultParams: SpvVaultParametersStruct): string;
+/**
+ * Decodes UTXO reference (`txid:vout`) from the on-chain SPV vault state struct.
+ *
+ * @category Swaps
+ */
 export declare function getVaultUtxoFromState(state: SpvVaultStateStruct): string;
 /**
+ * Represents the state of the EVM SPV vault (UTXO-controlled vault).
+ *
  * @category Swaps
  */
 export declare class EVMSpvVaultData extends SpvVaultData<EVMSpvWithdrawalData> {
@@ -27,17 +39,60 @@ export declare class EVMSpvVaultData extends SpvVaultData<EVMSpvWithdrawalData>
     depositCount: number;
     constructor(owner: string, vaultId: bigint, state: SpvVaultStateStruct, params: SpvVaultParametersStruct, initialUtxo?: string);
     constructor(serializedObj: any);
+    /**
+     * @inheritDoc
+     */
     getBalances(): SpvVaultTokenBalance[];
+    /**
+     * @inheritDoc
+     */
     getConfirmations(): number;
+    /**
+     * @inheritDoc
+     */
     getOwner(): string;
+    /**
+     * @inheritDoc
+     */
     getTokenData(): SpvVaultTokenData[];
+    /**
+     * @inheritDoc
+     */
     getUtxo(): string;
+    /**
+     * @inheritDoc
+     */
     getVaultId(): bigint;
+    /**
+     * @inheritDoc
+     */
     getWithdrawalCount(): number;
+    /**
+     * @inheritDoc
+     */
     isOpened(): boolean;
+    /**
+     * @inheritDoc
+     */
     serialize(): any;
+    /**
+     * @inheritDoc
+     */
     updateState(withdrawalTxOrEvent: SpvVaultClaimEvent | SpvVaultCloseEvent | SpvVaultOpenEvent | SpvVaultDepositEvent | EVMSpvWithdrawalData): void;
+    /**
+     * @inheritDoc
+     */
     getDepositCount(): number;
-    getVaultParamsStruct(): SpvVaultParametersStruct;
-    static randomVault(): EVMSpvVaultData;
+    /**
+     * Serializes this spv vault data to a struct object which can be passed to the ether.js functions
+     *
+     * @internal
+     */
+    _getVaultParamsStruct(): SpvVaultParametersStruct;
+    /**
+     * Returns a dummy random vault that can be used for e.g. fee estimation
+     *
+     * @internal
+     */
+    static _randomVault(): EVMSpvVaultData;
 }

package/dist/evm/spv_swap/EVMSpvVaultData.js

@@ -7,16 +7,28 @@ const EVMSpvWithdrawalData_1 = require("./EVMSpvWithdrawalData");
 const ethers_1 = require("ethers");
 const ethers_2 = require("ethers");
 const EVMAddresses_1 = require("../chain/modules/EVMAddresses");
+/**
+ * Computes the vault parameter commitment hash used by the on-chain SPV vault state.
+ *
+ * @category Swaps
+ */
 function getVaultParamsCommitment(vaultParams) {
     return (0, ethers_2.keccak256)(ethers_2.AbiCoder.defaultAbiCoder().encode(["address", "address", "address", "uint192", "uint192", "uint256"], [vaultParams.btcRelayContract, vaultParams.token0, vaultParams.token1, vaultParams.token0Multiplier, vaultParams.token1Multiplier, vaultParams.confirmations]));
 }
 exports.getVaultParamsCommitment = getVaultParamsCommitment;
+/**
+ * Decodes UTXO reference (`txid:vout`) from the on-chain SPV vault state struct.
+ *
+ * @category Swaps
+ */
 function getVaultUtxoFromState(state) {
     const txHash = buffer_1.Buffer.from((0, ethers_1.hexlify)(state.utxoTxHash).substring(2), "hex");
     return txHash.reverse().toString("hex") + ":" + BigInt(state.utxoVout).toString(10);
 }
 exports.getVaultUtxoFromState = getVaultUtxoFromState;
 /**
+ * Represents the state of the EVM SPV vault (UTXO-controlled vault).
+ *
  * @category Swaps
  */
 class EVMSpvVaultData extends base_1.SpvVaultData {
@@ -69,33 +81,60 @@ class EVMSpvVaultData extends base_1.SpvVaultData {
             this.initialUtxo = ownerOrObj.initialUtxo;
         }
     }
+    /**
+     * @inheritDoc
+     */
     getBalances() {
         return [
             { ...this.token0, scaledAmount: this.token0.rawAmount * this.token0.multiplier },
             { ...this.token1, scaledAmount: this.token1.rawAmount * this.token1.multiplier }
         ];
     }
+    /**
+     * @inheritDoc
+     */
     getConfirmations() {
         return this.confirmations;
     }
+    /**
+     * @inheritDoc
+     */
     getOwner() {
         return this.owner;
     }
+    /**
+     * @inheritDoc
+     */
     getTokenData() {
         return [this.token0, this.token1];
     }
+    /**
+     * @inheritDoc
+     */
     getUtxo() {
         return this.isOpened() ? this.utxo : this.initialUtxo;
     }
+    /**
+     * @inheritDoc
+     */
     getVaultId() {
         return this.vaultId;
     }
+    /**
+     * @inheritDoc
+     */
     getWithdrawalCount() {
         return this.withdrawCount;
     }
+    /**
+     * @inheritDoc
+     */
     isOpened() {
         return this.utxo !== "0000000000000000000000000000000000000000000000000000000000000000:0";
     }
+    /**
+     * @inheritDoc
+     */
     serialize() {
         return {
             type: "EVM",
@@ -119,6 +158,9 @@ class EVMSpvVaultData extends base_1.SpvVaultData {
             initialUtxo: this.initialUtxo
         };
     }
+    /**
+     * @inheritDoc
+     */
     updateState(withdrawalTxOrEvent) {
         if (withdrawalTxOrEvent instanceof base_1.SpvVaultClaimEvent) {
             if (withdrawalTxOrEvent.withdrawCount <= this.withdrawCount)
@@ -155,10 +197,18 @@ class EVMSpvVaultData extends base_1.SpvVaultData {
             this.utxo = withdrawalTxOrEvent.btcTx.txid + ":0";
         }
     }
+    /**
+     * @inheritDoc
+     */
     getDepositCount() {
         return this.depositCount;
     }
-    getVaultParamsStruct() {
+    /**
+     * Serializes this spv vault data to a struct object which can be passed to the ether.js functions
+     *
+     * @internal
+     */
+    _getVaultParamsStruct() {
         return {
             btcRelayContract: this.relayContract,
             token0: this.token0.token,
@@ -168,7 +218,12 @@ class EVMSpvVaultData extends base_1.SpvVaultData {
             confirmations: this.confirmations
         };
     }
-    static randomVault() {
+    /**
+     * Returns a dummy random vault that can be used for e.g. fee estimation
+     *
+     * @internal
+     */
+    static _randomVault() {
         const spvVaultParams = {
             btcRelayContract: EVMAddresses_1.EVMAddresses.randomAddress(),
             token0: EVMAddresses_1.EVMAddresses.randomAddress(),

package/dist/evm/spv_swap/EVMSpvWithdrawalData.d.ts

@@ -4,6 +4,9 @@ import { SpvWithdrawalTransactionData } from "@atomiqlabs/base";
 import { Buffer } from "buffer";
 import { BitcoinVaultTransactionDataStruct } from "./SpvVaultContractTypechain";
 /**
+ * Represents parsed withdrawal data used for claiming assets from the EVM SPV vault
+ *  (UTXO-controlled vault).
+ *
  * @category Swaps
  */
 export declare class EVMSpvWithdrawalData extends SpvWithdrawalTransactionData {
@@ -24,11 +27,20 @@ export declare class EVMSpvWithdrawalData extends SpvWithdrawalTransactionData {
      * @inheritDoc
      */
     getFrontingId(): string;
+    /**
+     * @inheritDoc
+     */
     getTxHash(): string;
+    /**
+     * @inheritDoc
+     */
     getFrontingAmount(): bigint[];
     /**
      * @inheritDoc
      */
     serialize(): any;
+    /**
+     * Serializes the withdrawal data to the EVM contract struct representation.
+     */
     serializeToStruct(): BitcoinVaultTransactionDataStruct;
 }

package/dist/evm/spv_swap/EVMSpvWithdrawalData.js

@@ -6,6 +6,9 @@ const buffer_1 = require("buffer");
 const EVMSpvVaultContract_1 = require("./EVMSpvVaultContract");
 const ethers_1 = require("ethers");
 /**
+ * Represents parsed withdrawal data used for claiming assets from the EVM SPV vault
+ *  (UTXO-controlled vault).
+ *
  * @category Swaps
  */
 class EVMSpvWithdrawalData extends base_1.SpvWithdrawalTransactionData {
@@ -33,9 +36,15 @@ class EVMSpvWithdrawalData extends base_1.SpvWithdrawalTransactionData {
         const txDataHash = (0, ethers_1.keccak256)(ethers_1.AbiCoder.defaultAbiCoder().encode(["address", "uint64", "uint64", "uint64", "uint64", "uint64", "uint64", "uint64", "bytes32", "uint256"], [this.recipient, this.rawAmounts[0], this.rawAmounts[1], callerFee[0], callerFee[1], frontingFee[0], frontingFee[1], this.getExecutionFee()[0], this.getExecutionHashWith0x(), this.executionExpiry]));
         return (0, ethers_1.keccak256)(ethers_1.AbiCoder.defaultAbiCoder().encode(["bytes32", "bytes32"], [txDataHash, this.getTxHash()])).substring(2);
     }
+    /**
+     * @inheritDoc
+     */
     getTxHash() {
         return "0x" + buffer_1.Buffer.from(this.btcTx.txid, "hex").reverse().toString("hex");
     }
+    /**
+     * @inheritDoc
+     */
     getFrontingAmount() {
         return [this.rawAmounts[0] + this.getExecutionFee()[0], this.rawAmounts[1]];
     }
@@ -48,6 +57,9 @@ class EVMSpvWithdrawalData extends base_1.SpvWithdrawalTransactionData {
             ...super.serialize()
         };
     }
+    /**
+     * Serializes the withdrawal data to the EVM contract struct representation.
+     */
     serializeToStruct() {
         const callerFee = this.getCallerFee();
         const frontingFee = this.getFrontingFee();