@atomiqlabs/chain-evm 2.1.11 → 2.1.14

package/dist/evm/swaps/EVMSwapContract.d.ts

@@ -17,6 +17,9 @@ import { EVMPreFetchVerification, EVMSwapInit } from "./modules/EVMSwapInit";
 import { EVMSwapRefund } from "./modules/EVMSwapRefund";
 import { EVMSwapClaim } from "./modules/EVMSwapClaim";
 /**
+ * EVM swap contract (escrow manager) representation handling PrTLC (on-chain) and HTLC (lightning)
+ *  based swaps.
+ *
  * @category Swaps
  */
 export declare class EVMSwapContract<ChainId extends string = string> extends EVMContractBase<EscrowManager> implements SwapContract<EVMSwapData, EVMTx, never, EVMPreFetchVerification, EVMSigner, ChainId> {
@@ -25,24 +28,54 @@ export declare class EVMSwapContract<ChainId extends string = string> extends EV
     readonly claimWithSecretTimeout: number;
     readonly claimWithTxDataTimeout: number;
     readonly refundTimeout: number;
-    readonly claimGracePeriod: number;
-    readonly refundGracePeriod: number;
-    readonly authGracePeriod: number;
-    readonly Init: EVMSwapInit;
-    readonly Refund: EVMSwapRefund;
-    readonly Claim: EVMSwapClaim;
-    readonly LpVault: EVMLpVault;
-    readonly claimHandlersByAddress: {
+    private readonly claimGracePeriod;
+    private readonly refundGracePeriod;
+    /**
+     * @internal
+     */
+    readonly _authGracePeriod: number;
+    /**
+     * @internal
+     */
+    readonly _Init: EVMSwapInit;
+    /**
+     * @internal
+     */
+    readonly _Refund: EVMSwapRefund;
+    /**
+     * @internal
+     */
+    readonly _Claim: EVMSwapClaim;
+    /**
+     * @internal
+     */
+    readonly _LpVault: EVMLpVault;
+    /**
+     * @internal
+     */
+    readonly _claimHandlersByAddress: {
         [address: string]: IClaimHandler<any, any>;
     };
-    readonly claimHandlersBySwapType: {
+    /**
+     * @internal
+     */
+    readonly _claimHandlersBySwapType: {
         [type in ChainSwapType]?: IClaimHandler<any, any>;
     };
-    readonly refundHandlersByAddress: {
+    /**
+     * @internal
+     */
+    readonly _refundHandlersByAddress: {
         [address: string]: IHandler<any, any>;
     };
-    readonly timelockRefundHandler: IHandler<any, any>;
-    readonly btcRelay: EVMBtcRelay<any>;
+    /**
+     * @internal
+     */
+    readonly _timelockRefundHandler: IHandler<any, any>;
+    /**
+     * @internal
+     */
+    readonly _btcRelay: EVMBtcRelay<any>;
     constructor(chainInterface: EVMChainInterface<ChainId>, btcRelay: EVMBtcRelay<any>, contractAddress: string, handlerAddresses: {
         refund: {
             timelock: string;
@@ -136,6 +169,9 @@ export declare class EVMSwapContract<ChainId extends string = string> extends EV
     }[]): Promise<{
         [p: string]: SwapCommitState;
     }>;
+    /**
+     * @inheritDoc
+     */
     getHistoricalSwaps(signer: string, startBlockheight?: number): Promise<{
         swaps: {
             [escrowHash: string]: {
@@ -156,6 +192,15 @@ export declare class EVMSwapContract<ChainId extends string = string> extends EV
      * @inheritDoc
      */
     createSwapData(type: ChainSwapType, offerer: string, claimer: string, token: string, amount: bigint, paymentHash: string, sequence: bigint, expiry: bigint, payIn: boolean, payOut: boolean, securityDeposit: bigint, claimerBounty: bigint, depositToken?: string): Promise<EVMSwapData>;
+    /**
+     * Recursively scans call traces and extracts swap data from `initialize(...)` calldata
+     * for the specified escrow hash.
+     *
+     * @param call Trace call node to inspect
+     * @param escrowHash Escrow hash to match
+     * @param claimHandler Claim handler used to deserialize claim-specific fields
+     * @private
+     */
     findInitSwapData(call: EVMTxTrace, escrowHash: string, claimHandler: IClaimHandler<any, any>): EVMSwapData | null;
     /**
      * @inheritDoc
@@ -172,7 +217,7 @@ export declare class EVMSwapContract<ChainId extends string = string> extends EV
      * @inheritDoc
      */
     getIntermediaryReputation(address: string, token: string): Promise<IntermediaryReputationType>;
-    getIntermediaryBalance(address: string, token: string): Promise<bigint>;
+    private getIntermediaryBalance;
     /**
      * @inheritDoc
      */

package/dist/evm/swaps/EVMSwapContract.js

@@ -20,6 +20,9 @@ const ESCROW_STATE_CLAIMED = 2;
 const ESCROW_STATE_REFUNDED = 3;
 const logger = (0, Utils_1.getLogger)("EVMSwapContract: ");
 /**
+ * EVM swap contract (escrow manager) representation handling PrTLC (on-chain) and HTLC (lightning)
+ *  based swaps.
+ *
  * @category Swaps
  */
 class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
@@ -33,25 +36,37 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
         this.refundTimeout = 180;
         this.claimGracePeriod = 10 * 60;
         this.refundGracePeriod = 10 * 60;
-        this.authGracePeriod = 30;
+        /**
+         * @internal
+         */
+        this._authGracePeriod = 30;
         ////////////////////////
         //// Handlers
-        this.claimHandlersByAddress = {};
-        this.claimHandlersBySwapType = {};
-        this.refundHandlersByAddress = {};
+        /**
+         * @internal
+         */
+        this._claimHandlersByAddress = {};
+        /**
+         * @internal
+         */
+        this._claimHandlersBySwapType = {};
+        /**
+         * @internal
+         */
+        this._refundHandlersByAddress = {};
         this.chainId = chainInterface.chainId;
-        this.Init = new EVMSwapInit_1.EVMSwapInit(chainInterface, this);
-        this.Refund = new EVMSwapRefund_1.EVMSwapRefund(chainInterface, this);
-        this.Claim = new EVMSwapClaim_1.EVMSwapClaim(chainInterface, this);
-        this.LpVault = new EVMLpVault_1.EVMLpVault(chainInterface, this);
-        this.btcRelay = btcRelay;
+        this._Init = new EVMSwapInit_1.EVMSwapInit(chainInterface, this);
+        this._Refund = new EVMSwapRefund_1.EVMSwapRefund(chainInterface, this);
+        this._Claim = new EVMSwapClaim_1.EVMSwapClaim(chainInterface, this);
+        this._LpVault = new EVMLpVault_1.EVMLpVault(chainInterface, this);
+        this._btcRelay = btcRelay;
         ClaimHandlers_1.claimHandlersList.forEach(handlerCtor => {
             const handler = new handlerCtor(handlerAddresses.claim[handlerCtor.type]);
-            this.claimHandlersByAddress[handler.address.toLowerCase()] = handler;
-            this.claimHandlersBySwapType[handlerCtor.type] = handler;
+            this._claimHandlersByAddress[handler.address.toLowerCase()] = handler;
+            this._claimHandlersBySwapType[handlerCtor.type] = handler;
         });
-        this.timelockRefundHandler = new TimelockRefundHandler_1.TimelockRefundHandler(handlerAddresses.refund.timelock);
-        this.refundHandlersByAddress[this.timelockRefundHandler.address.toLowerCase()] = this.timelockRefundHandler;
+        this._timelockRefundHandler = new TimelockRefundHandler_1.TimelockRefundHandler(handlerAddresses.refund.timelock);
+        this._refundHandlersByAddress[this._timelockRefundHandler.address.toLowerCase()] = this._timelockRefundHandler;
     }
     /**
      * @inheritDoc
@@ -64,43 +79,43 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     preFetchForInitSignatureVerification() {
-        return this.Init.preFetchForInitSignatureVerification();
+        return this._Init.preFetchForInitSignatureVerification();
     }
     /**
      * @inheritDoc
      */
     getInitSignature(signer, swapData, authorizationTimeout, preFetchedBlockData, feeRate) {
-        return this.Init.signSwapInitialization(signer, swapData, authorizationTimeout);
+        return this._Init.signSwapInitialization(signer, swapData, authorizationTimeout);
     }
     /**
      * @inheritDoc
      */
     isValidInitAuthorization(sender, swapData, signature, feeRate, preFetchedData) {
-        return this.Init.isSignatureValid(sender, swapData, signature.timeout, signature.prefix, signature.signature, preFetchedData);
+        return this._Init.isSignatureValid(sender, swapData, signature.timeout, signature.prefix, signature.signature, preFetchedData);
     }
     /**
      * @inheritDoc
      */
     getInitAuthorizationExpiry(swapData, signature, preFetchedData) {
-        return this.Init.getSignatureExpiry(signature.timeout);
+        return this._Init.getSignatureExpiry(signature.timeout);
     }
     /**
      * @inheritDoc
      */
     isInitAuthorizationExpired(swapData, signature) {
-        return this.Init.isSignatureExpired(signature.timeout);
+        return this._Init.isSignatureExpired(signature.timeout);
     }
     /**
      * @inheritDoc
      */
     getRefundSignature(signer, swapData, authorizationTimeout) {
-        return this.Refund.signSwapRefund(signer, swapData, authorizationTimeout);
+        return this._Refund.signSwapRefund(signer, swapData, authorizationTimeout);
     }
     /**
      * @inheritDoc
      */
     isValidRefundAuthorization(swapData, signature) {
-        return this.Refund.isSignatureValid(swapData, signature.timeout, signature.prefix, signature.signature);
+        return this._Refund.isSignatureValid(swapData, signature.timeout, signature.prefix, signature.signature);
     }
     /**
      * @inheritDoc
@@ -159,13 +174,13 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     getHashForTxId(txId, confirmations) {
-        const chainTxIdHandler = this.claimHandlersBySwapType[base_1.ChainSwapType.CHAIN_TXID];
+        const chainTxIdHandler = this._claimHandlersBySwapType[base_1.ChainSwapType.CHAIN_TXID];
         if (chainTxIdHandler == null)
             throw new Error("Claim handler for CHAIN_TXID not found!");
         return buffer_1.Buffer.from(chainTxIdHandler.getCommitment({
             txId,
             confirmations,
-            btcRelay: this.btcRelay
+            btcRelay: this._btcRelay
         }).slice(2), "hex");
     }
     /**
@@ -174,18 +189,18 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
     getHashForOnchain(outputScript, amount, confirmations, nonce) {
         let result;
         if (nonce == null || nonce === 0n) {
-            const chainHandler = this.claimHandlersBySwapType[base_1.ChainSwapType.CHAIN];
+            const chainHandler = this._claimHandlersBySwapType[base_1.ChainSwapType.CHAIN];
             if (chainHandler == null)
                 throw new Error("Claim handler for CHAIN not found!");
             result = chainHandler.getCommitment({
                 output: outputScript,
                 amount,
                 confirmations,
-                btcRelay: this.btcRelay
+                btcRelay: this._btcRelay
             });
         }
         else {
-            const chainNoncedHandler = this.claimHandlersBySwapType[base_1.ChainSwapType.CHAIN_NONCED];
+            const chainNoncedHandler = this._claimHandlersBySwapType[base_1.ChainSwapType.CHAIN_NONCED];
             if (chainNoncedHandler == null)
                 throw new Error("Claim handler for CHAIN_NONCED not found!");
             result = chainNoncedHandler.getCommitment({
@@ -193,7 +208,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
                 amount,
                 nonce,
                 confirmations,
-                btcRelay: this.btcRelay
+                btcRelay: this._btcRelay
             });
         }
         return buffer_1.Buffer.from(result.slice(2), "hex");
@@ -202,7 +217,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     getHashForHtlc(paymentHash) {
-        const htlcHandler = this.claimHandlersBySwapType[base_1.ChainSwapType.HTLC];
+        const htlcHandler = this._claimHandlersBySwapType[base_1.ChainSwapType.HTLC];
         if (htlcHandler == null)
             throw new Error("Claim handler for HTLC not found!");
         return buffer_1.Buffer.from(htlcHandler.getCommitment(paymentHash).slice(2), "hex");
@@ -248,13 +263,13 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
                         };
                     },
                     getClaimResult: async () => {
-                        const events = await this.Events.getContractBlockEvents(["Claim"], [null, null, "0x" + escrowHash], blockHeight, blockHeight);
+                        const events = await this._Events.getContractBlockEvents(["Claim"], [null, null, "0x" + escrowHash], blockHeight, blockHeight);
                         if (events.length === 0)
                             throw new Error("Claim event not found!");
                         return events[0].args.witnessResult;
                     },
                     getClaimTxId: async () => {
-                        const events = await this.Events.getContractBlockEvents(["Claim"], [null, null, "0x" + escrowHash], blockHeight, blockHeight);
+                        const events = await this._Events.getContractBlockEvents(["Claim"], [null, null, "0x" + escrowHash], blockHeight, blockHeight);
                         if (events.length === 0)
                             throw new Error("Claim event not found!");
                         return events[0].transactionHash;
@@ -270,7 +285,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
                         };
                     },
                     getRefundTxId: async () => {
-                        const events = await this.Events.getContractBlockEvents(["Refund"], [null, null, "0x" + escrowHash], blockHeight, blockHeight);
+                        const events = await this._Events.getContractBlockEvents(["Refund"], [null, null, "0x" + escrowHash], blockHeight, blockHeight);
                         if (events.length === 0)
                             throw new Error("Refund event not found!");
                         return events[0].transactionHash;
@@ -293,7 +308,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
             promises.push(this.getCommitStatus(signer, swapData).then(val => {
                 result[swapData.getEscrowHash()] = val;
             }));
-            if (promises.length >= this.Chain.config.maxParallelCalls) {
+            if (promises.length >= this.Chain._config.maxParallelCalls) {
                 await Promise.all(promises);
                 promises = [];
             }
@@ -301,6 +316,9 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
         await Promise.all(promises);
         return result;
     }
+    /**
+     * @inheritDoc
+     */
     async getHistoricalSwaps(signer, startBlockheight) {
         const { height: latestBlockheight } = await this.Chain.getFinalizedBlock();
         const swapsOpened = {};
@@ -310,7 +328,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
             if (_event.eventName === "Initialize") {
                 const event = _event;
                 const claimHandlerHex = event.args.claimHandler;
-                const claimHandler = this.claimHandlersByAddress[claimHandlerHex.toLowerCase()];
+                const claimHandler = this._claimHandlersByAddress[claimHandlerHex.toLowerCase()];
                 if (claimHandler == null) {
                     logger.warn(`getHistoricalSwaps(): Unknown claim handler in tx ${event.transactionHash} with claim handler: ` + claimHandlerHex);
                     return null;
@@ -372,8 +390,8 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
             }
         };
         //We have to fetch separately the different directions
-        await this.Events.findInContractEventsForward(["Initialize", "Claim", "Refund"], [signer, null], processor, startBlockheight);
-        await this.Events.findInContractEventsForward(["Initialize", "Claim", "Refund"], [null, signer], processor, startBlockheight);
+        await this._Events.findInContractEventsForward(["Initialize", "Claim", "Refund"], [signer, null], processor, startBlockheight);
+        await this._Events.findInContractEventsForward(["Initialize", "Claim", "Refund"], [null, signer], processor, startBlockheight);
         logger.debug(`getHistoricalSwaps(): Found ${Object.keys(resultingSwaps).length} settled swaps!`);
         logger.debug(`getHistoricalSwaps(): Found ${Object.keys(swapsOpened).length} unsettled swaps!`);
         for (let escrowHash in swapsOpened) {
@@ -396,14 +414,23 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     createSwapData(type, offerer, claimer, token, amount, paymentHash, sequence, expiry, payIn, payOut, securityDeposit, claimerBounty, depositToken = this.Chain.Tokens.getNativeCurrencyAddress()) {
-        const claimHandler = this.claimHandlersBySwapType?.[type];
+        const claimHandler = this._claimHandlersBySwapType?.[type];
         if (claimHandler == null)
             throw new Error(`Claim handler unknown for swap type: ${base_1.ChainSwapType[type]}!`);
-        return Promise.resolve(new EVMSwapData_1.EVMSwapData(offerer, claimer, token, this.timelockRefundHandler.address, claimHandler.address, payOut, payIn, payIn, //For now track reputation for all payIn swaps
+        return Promise.resolve(new EVMSwapData_1.EVMSwapData(offerer, claimer, token, this._timelockRefundHandler.address, claimHandler.address, payOut, payIn, payIn, //For now track reputation for all payIn swaps
         sequence, "0x" + paymentHash, (0, ethers_1.hexlify)(base_1.BigIntBufferUtils.toBuffer(expiry, "be", 32)), amount, depositToken, securityDeposit, claimerBounty, type));
     }
+    /**
+     * Recursively scans call traces and extracts swap data from `initialize(...)` calldata
+     * for the specified escrow hash.
+     *
+     * @param call Trace call node to inspect
+     * @param escrowHash Escrow hash to match
+     * @param claimHandler Claim handler used to deserialize claim-specific fields
+     * @private
+     */
     findInitSwapData(call, escrowHash, claimHandler) {
-        if (call.to.toLowerCase() === this.contractAddress.toLowerCase()) {
+        if (call.to.toLowerCase() === this._contractAddress.toLowerCase()) {
             const _result = this.parseCalldata(call.input);
             if (_result != null && _result.name === "initialize") {
                 const result = _result;
@@ -440,16 +467,16 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     getIntermediaryData(address, token) {
-        return this.LpVault.getIntermediaryData(address, token);
+        return this._LpVault.getIntermediaryData(address, token);
     }
     /**
      * @inheritDoc
      */
     getIntermediaryReputation(address, token) {
-        return this.LpVault.getIntermediaryReputation(address, token);
+        return this._LpVault.getIntermediaryReputation(address, token);
     }
     getIntermediaryBalance(address, token) {
-        return this.LpVault.getIntermediaryBalance(address, token);
+        return this._LpVault.getIntermediaryBalance(address, token);
     }
     ////////////////////////////////////////////
     //// Transaction initializers
@@ -457,43 +484,43 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     async txsClaimWithSecret(signer, swapData, secret, checkExpiry, initAta, feeRate, skipAtaCheck) {
-        return this.Claim.txsClaimWithSecret(typeof (signer) === "string" ? signer : signer.getAddress(), swapData, secret, checkExpiry, feeRate);
+        return this._Claim.txsClaimWithSecret(typeof (signer) === "string" ? signer : signer.getAddress(), swapData, secret, checkExpiry, feeRate);
     }
     /**
      * @inheritDoc
      */
     async txsClaimWithTxData(signer, swapData, tx, requiredConfirmations, vout, commitedHeader, synchronizer, initAta, feeRate) {
-        return this.Claim.txsClaimWithTxData(typeof (signer) === "string" ? signer : signer.getAddress(), swapData, tx, requiredConfirmations, vout, commitedHeader, synchronizer, feeRate);
+        return this._Claim.txsClaimWithTxData(typeof (signer) === "string" ? signer : signer.getAddress(), swapData, tx, requiredConfirmations, vout, commitedHeader, synchronizer, feeRate);
     }
     /**
      * @inheritDoc
      */
     txsRefund(signer, swapData, check, initAta, feeRate) {
-        return this.Refund.txsRefund(signer, swapData, check, feeRate);
+        return this._Refund.txsRefund(signer, swapData, check, feeRate);
     }
     /**
      * @inheritDoc
      */
     txsRefundWithAuthorization(signer, swapData, signature, check, initAta, feeRate) {
-        return this.Refund.txsRefundWithAuthorization(signer, swapData, signature.timeout, signature.prefix, signature.signature, check, feeRate);
+        return this._Refund.txsRefundWithAuthorization(signer, swapData, signature.timeout, signature.prefix, signature.signature, check, feeRate);
     }
     /**
      * @inheritDoc
      */
     txsInit(signer, swapData, signature, skipChecks, feeRate) {
-        return this.Init.txsInit(signer, swapData, signature.timeout, signature.prefix, signature.signature, skipChecks, feeRate);
+        return this._Init.txsInit(signer, swapData, signature.timeout, signature.prefix, signature.signature, skipChecks, feeRate);
     }
     /**
      * @inheritDoc
      */
     txsWithdraw(signer, token, amount, feeRate) {
-        return this.LpVault.txsWithdraw(signer, token, amount, feeRate);
+        return this._LpVault.txsWithdraw(signer, token, amount, feeRate);
     }
     /**
      * @inheritDoc
      */
     txsDeposit(signer, token, amount, feeRate) {
-        return this.LpVault.txsDeposit(signer, token, amount, feeRate);
+        return this._LpVault.txsDeposit(signer, token, amount, feeRate);
     }
     ////////////////////////////////////////////
     //// Executors
@@ -501,7 +528,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     async claimWithSecret(signer, swapData, secret, checkExpiry, initAta, txOptions) {
-        const result = await this.Claim.txsClaimWithSecret(signer.getAddress(), swapData, secret, checkExpiry, txOptions?.feeRate);
+        const result = await this._Claim.txsClaimWithSecret(signer.getAddress(), swapData, secret, checkExpiry, txOptions?.feeRate);
         const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
         return signature;
     }
@@ -509,7 +536,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     async claimWithTxData(signer, swapData, tx, requiredConfirmations, vout, commitedHeader, synchronizer, initAta, txOptions) {
-        const txs = await this.Claim.txsClaimWithTxData(signer.getAddress(), swapData, tx, requiredConfirmations, vout, commitedHeader, synchronizer, txOptions?.feeRate);
+        const txs = await this._Claim.txsClaimWithTxData(signer.getAddress(), swapData, tx, requiredConfirmations, vout, commitedHeader, synchronizer, txOptions?.feeRate);
         if (txs === null)
             throw new Error("Btc relay not synchronized to required blockheight!");
         const txHashes = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal);
@@ -551,7 +578,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     async withdraw(signer, token, amount, txOptions) {
-        const txs = await this.LpVault.txsWithdraw(signer.getAddress(), token, amount, txOptions?.feeRate);
+        const txs = await this._LpVault.txsWithdraw(signer.getAddress(), token, amount, txOptions?.feeRate);
         const [txId] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
         return txId;
     }
@@ -559,7 +586,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     async deposit(signer, token, amount, txOptions) {
-        const txs = await this.LpVault.txsDeposit(signer.getAddress(), token, amount, txOptions?.feeRate);
+        const txs = await this._LpVault.txsDeposit(signer.getAddress(), token, amount, txOptions?.feeRate);
         const [txId] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
         return txId;
     }
@@ -593,19 +620,19 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
      * @inheritDoc
      */
     getClaimFee(signer, swapData, feeRate) {
-        return this.Claim.getClaimFee(swapData, feeRate);
+        return this._Claim.getClaimFee(swapData, feeRate);
     }
     /**
      * @inheritDoc
      */
     getCommitFee(signer, swapData, feeRate) {
-        return this.Init.getInitFee(swapData, feeRate);
+        return this._Init.getInitFee(swapData, feeRate);
     }
     /**
      * @inheritDoc
      */
     getRefundFee(signer, swapData, feeRate) {
-        return this.Refund.getRefundFee(swapData, feeRate);
+        return this._Refund.getRefundFee(swapData, feeRate);
     }
 }
 exports.EVMSwapContract = EVMSwapContract;

package/dist/evm/swaps/EVMSwapData.d.ts

@@ -2,15 +2,12 @@ import { SwapData, ChainSwapType } from "@atomiqlabs/base";
 import { EscrowDataStruct } from "./EscrowManagerTypechain";
 import { IClaimHandler } from "./handlers/claim/ClaimHandlers";
 /**
+ * Represents swap data for executing PrTLC (on-chain) or HTLC (lightning) based swaps.
+ *
  * @category Swaps
  */
 export declare class EVMSwapData extends SwapData {
-    static toFlags(val: bigint): {
-        payOut: boolean;
-        payIn: boolean;
-        reputation: boolean;
-        sequence: bigint;
-    };
+    private static toFlags;
     private getFlags;
     offerer: string;
     claimer: string;
@@ -144,17 +141,41 @@ export declare class EVMSwapData extends SwapData {
      * @inheritDoc
      */
     isOfferer(address: string): boolean;
+    /**
+     * Checks whether the passed address is specified as the refund handler for the swap.
+     *
+     * @param address
+     */
     isRefundHandler(address: string): boolean;
+    /**
+     * Checks whether the passed address is specified as the claim handler for the swap.
+     *
+     * @param address
+     */
     isClaimHandler(address: string): boolean;
+    /**
+     * Checks if the passed data matches the swap's claim data.
+     *
+     * @param data
+     */
     isClaimData(data: string): boolean;
     /**
      * @inheritDoc
      */
     equals(other: EVMSwapData): boolean;
+    /**
+     * Serializes the swap data into the EVM escrow-manager struct representation.
+     */
     toEscrowStruct(): EscrowDataStruct;
     /**
      * @inheritDoc
      */
     hasSuccessAction(): boolean;
+    /**
+     * Deserializes swap data from an on-chain escrow struct.
+     *
+     * @param struct Escrow struct as returned by the contract
+     * @param claimHandlerImpl Claim handler implementation used to resolve swap type
+     */
     static deserializeFromStruct(struct: EscrowDataStruct, claimHandlerImpl: IClaimHandler<any, any>): EVMSwapData;
 }

package/dist/evm/swaps/EVMSwapData.js

@@ -8,6 +8,8 @@ const FLAG_PAY_OUT = 0x01n;
 const FLAG_PAY_IN = 0x02n;
 const FLAG_REPUTATION = 0x04n;
 /**
+ * Represents swap data for executing PrTLC (on-chain) or HTLC (lightning) based swaps.
+ *
  * @category Swaps
  */
 class EVMSwapData extends base_1.SwapData {
@@ -325,16 +327,31 @@ class EVMSwapData extends base_1.SwapData {
             address = "0x" + address;
         return this.offerer.toLowerCase() === address.toLowerCase();
     }
+    /**
+     * Checks whether the passed address is specified as the refund handler for the swap.
+     *
+     * @param address
+     */
     isRefundHandler(address) {
         if (!address.startsWith("0x"))
             address = "0x" + address;
         return this.refundHandler.toLowerCase() === address.toLowerCase();
     }
+    /**
+     * Checks whether the passed address is specified as the claim handler for the swap.
+     *
+     * @param address
+     */
     isClaimHandler(address) {
         if (!address.startsWith("0x"))
             address = "0x" + address;
         return this.claimHandler.toLowerCase() === address.toLowerCase();
     }
+    /**
+     * Checks if the passed data matches the swap's claim data.
+     *
+     * @param data
+     */
     isClaimData(data) {
         if (!data.startsWith("0x"))
             data = "0x" + data;
@@ -360,6 +377,9 @@ class EVMSwapData extends base_1.SwapData {
             other.claimerBounty === this.claimerBounty &&
             other.successActionCommitment.toLowerCase() === this.successActionCommitment.toLowerCase();
     }
+    /**
+     * Serializes the swap data into the EVM escrow-manager struct representation.
+     */
     toEscrowStruct() {
         return {
             offerer: this.offerer,
@@ -383,6 +403,12 @@ class EVMSwapData extends base_1.SwapData {
     hasSuccessAction() {
         return this.successActionCommitment !== ethers_1.ZeroHash;
     }
+    /**
+     * Deserializes swap data from an on-chain escrow struct.
+     *
+     * @param struct Escrow struct as returned by the contract
+     * @param claimHandlerImpl Claim handler implementation used to resolve swap type
+     */
     static deserializeFromStruct(struct, claimHandlerImpl) {
         const { payOut, payIn, reputation, sequence } = EVMSwapData.toFlags(BigInt(struct.flags));
         return new EVMSwapData(struct.offerer, struct.claimer, struct.token, struct.refundHandler, struct.claimHandler, payOut, payIn, reputation, sequence, (0, ethers_1.hexlify)(struct.claimData), (0, ethers_1.hexlify)(struct.refundData), BigInt(struct.amount), struct.depositToken, BigInt(struct.securityDeposit), BigInt(struct.claimerBounty), claimHandlerImpl.getType(), undefined, struct.successActionCommitment);

package/dist/evm/swaps/EVMSwapModule.d.ts

@@ -2,6 +2,11 @@ import { EscrowManager } from "./EscrowManagerTypechain";
 import { EVMContractModule } from "../contract/EVMContractModule";
 import { EVMSwapContract } from "./EVMSwapContract";
 import { EVMChainInterface } from "../chain/EVMChainInterface";
+/**
+ * Base class for EVM swap submodules operating on the escrow manager contract.
+ *
+ * @category Internal/Swaps
+ */
 export declare class EVMSwapModule extends EVMContractModule<EscrowManager, EVMSwapContract> {
     readonly swapContract: EscrowManager;
     constructor(chainInterface: EVMChainInterface, contract: EVMSwapContract);

package/dist/evm/swaps/EVMSwapModule.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EVMSwapModule = void 0;
 const EVMContractModule_1 = require("../contract/EVMContractModule");
+/**
+ * Base class for EVM swap submodules operating on the escrow manager contract.
+ *
+ * @category Internal/Swaps
+ */
 class EVMSwapModule extends EVMContractModule_1.EVMContractModule {
     constructor(chainInterface, contract) {
         super(chainInterface, contract);

package/dist/evm/swaps/handlers/IHandler.d.ts

@@ -2,6 +2,11 @@
 /// <reference types="node" />
 import { EVMSwapData } from "../EVMSwapData";
 import { EVMTx } from "../../chain/modules/EVMTransactions";
+/**
+ * Generic swap handler interface for commitment and witness generation.
+ *
+ * @category Internal/Handlers
+ */
 export interface IHandler<TCommitmentData, TWitnessData> {
     readonly address: string;
     getCommitment(data: TCommitmentData): string;