@atomiqlabs/chain-evm 1.0.0-dev.35 → 1.0.0-dev.37

package/src/evm/spv_swap/EVMSpvVaultData.ts

@@ -1,224 +1,224 @@
-import {
-    SpvVaultClaimEvent,
-    SpvVaultCloseEvent,
-    SpvVaultData, SpvVaultDepositEvent, SpvVaultOpenEvent,
-    SpvVaultTokenBalance,
-    SpvVaultTokenData
-} from "@atomiqlabs/base";
-import {Buffer} from "buffer";
-import { EVMSpvWithdrawalData } from "./EVMSpvWithdrawalData";
-import {
-    SpvVaultParametersStruct,
-    SpvVaultStateStruct
-} from "./SpvVaultContractTypechain";
-import {hexlify, randomBytes} from "ethers";
-import {AbiCoder, keccak256} from "ethers";
-import {EVMAddresses} from "../chain/modules/EVMAddresses";
-import type {AddressLike, BigNumberish, BytesLike} from "ethers/lib.esm";
-
-export function getVaultParamsCommitment(vaultParams: SpvVaultParametersStruct) {
-    return keccak256(AbiCoder.defaultAbiCoder().encode(
-        ["address", "address", "address", "uint192", "uint192", "uint256"],
-        [vaultParams.btcRelayContract, vaultParams.token0, vaultParams.token1, vaultParams.token0Multiplier, vaultParams.token1Multiplier, vaultParams.confirmations]
-    ));
-}
-
-export class EVMSpvVaultData extends SpvVaultData<EVMSpvWithdrawalData> {
-
-    readonly owner: string;
-    readonly vaultId: bigint;
-
-    readonly relayContract: string;
-    readonly token0: {
-        token: string,
-        multiplier: bigint,
-        rawAmount: bigint
-    }
-    readonly token1: {
-        token: string,
-        multiplier: bigint,
-        rawAmount: bigint
-    };
-    readonly initialUtxo: string;
-    utxo: string;
-    readonly confirmations: number;
-    withdrawCount: number;
-    depositCount: number;
-
-    constructor(owner: string, vaultId: bigint, state: SpvVaultStateStruct, params: SpvVaultParametersStruct, initialUtxo?: string);
-    constructor(serializedObj: any);
-    constructor(ownerOrObj: string | any, vaultId?: bigint, state?: SpvVaultStateStruct, params?: SpvVaultParametersStruct, initialUtxo?: string) {
-        super();
-        if(typeof(ownerOrObj) === "string") {
-            this.owner = ownerOrObj;
-            this.vaultId = vaultId;
-            this.relayContract = params.btcRelayContract as string;
-            this.token0 = {
-                token: params.token0 as string,
-                multiplier: BigInt(params.token0Multiplier),
-                rawAmount: BigInt(state.token0Amount)
-            };
-            this.token1 = {
-                token: params.token1 as string,
-                multiplier: BigInt(params.token1Multiplier),
-                rawAmount: BigInt(state.token1Amount)
-            };
-            const txHash = Buffer.from(hexlify(state.utxoTxHash).substring(2), "hex");
-            this.utxo = txHash.reverse().toString("hex")+":"+BigInt(state.utxoVout).toString(10);
-            this.confirmations = Number(params.confirmations);
-            this.withdrawCount = Number(state.withdrawCount);
-            this.depositCount = Number(state.depositCount);
-            this.initialUtxo = initialUtxo;
-        } else {
-            this.owner = ownerOrObj.owner;
-            this.vaultId = BigInt(ownerOrObj.vaultId);
-            this.relayContract = ownerOrObj.relayContract;
-            this.token0 = {
-                token: ownerOrObj.token0.token,
-                multiplier: BigInt(ownerOrObj.token0.multiplier),
-                rawAmount: BigInt(ownerOrObj.token0.rawAmount)
-            }
-            this.token1 = {
-                token: ownerOrObj.token1.token,
-                multiplier: BigInt(ownerOrObj.token1.multiplier),
-                rawAmount: BigInt(ownerOrObj.token1.rawAmount)
-            };
-            this.utxo = ownerOrObj.utxo;
-            this.confirmations = ownerOrObj.confirmations;
-            this.withdrawCount = ownerOrObj.withdrawCount;
-            this.depositCount = ownerOrObj.depositCount;
-            this.initialUtxo = ownerOrObj.initialUtxo;
-        }
-    }
-
-    getBalances(): SpvVaultTokenBalance[] {
-        return [
-            {...this.token0, scaledAmount: this.token0.rawAmount * this.token0.multiplier},
-            {...this.token1, scaledAmount: this.token1.rawAmount * this.token1.multiplier}
-        ];
-    }
-
-    getConfirmations(): number {
-        return this.confirmations;
-    }
-
-    getOwner(): string {
-        return this.owner;
-    }
-
-    getTokenData(): SpvVaultTokenData[] {
-        return [this.token0, this.token1];
-    }
-
-    getUtxo(): string {
-        return this.isOpened() ? this.utxo : this.initialUtxo;
-    }
-
-    getVaultId(): bigint {
-        return this.vaultId;
-    }
-
-    getWithdrawalCount(): number {
-        return this.withdrawCount;
-    }
-
-    isOpened(): boolean {
-        return this.utxo!=="0000000000000000000000000000000000000000000000000000000000000000:0";
-    }
-
-    serialize(): any {
-        return {
-            type: "EVM",
-            owner: this.owner,
-            vaultId: this.vaultId.toString(10),
-            relayContract: this.relayContract,
-            token0: {
-                token: this.token0.token,
-                multiplier: this.token0.multiplier.toString(10),
-                rawAmount: this.token0.rawAmount.toString(10)
-            },
-            token1: {
-                token: this.token1.token,
-                multiplier: this.token1.multiplier.toString(10),
-                rawAmount: this.token1.rawAmount.toString(10)
-            },
-            utxo: this.utxo,
-            confirmations: this.confirmations,
-            withdrawCount: this.withdrawCount,
-            depositCount: this.depositCount,
-            initialUtxo: this.initialUtxo
-        }
-    }
-
-    updateState(withdrawalTxOrEvent: SpvVaultClaimEvent | SpvVaultCloseEvent | SpvVaultOpenEvent | SpvVaultDepositEvent | EVMSpvWithdrawalData): void {
-        if(withdrawalTxOrEvent instanceof SpvVaultClaimEvent) {
-            if(withdrawalTxOrEvent.withdrawCount <= this.withdrawCount) return;
-            this.token0.rawAmount -= withdrawalTxOrEvent.amounts[0];
-            this.token1.rawAmount -= withdrawalTxOrEvent.amounts[1];
-            this.withdrawCount = withdrawalTxOrEvent.withdrawCount;
-            this.utxo = withdrawalTxOrEvent.btcTxId+":0";
-        }
-        if(withdrawalTxOrEvent instanceof SpvVaultCloseEvent) {
-            this.token0.rawAmount = 0n;
-            this.token1.rawAmount = 0n;
-            this.utxo = "0000000000000000000000000000000000000000000000000000000000000000:0";
-        }
-        if(withdrawalTxOrEvent instanceof SpvVaultOpenEvent) {
-            if(this.isOpened()) return;
-            this.utxo = withdrawalTxOrEvent.btcTxId+":"+withdrawalTxOrEvent.vout;
-        }
-        if(withdrawalTxOrEvent instanceof SpvVaultDepositEvent) {
-            if(withdrawalTxOrEvent.depositCount <= this.depositCount) return;
-            this.token0.rawAmount += withdrawalTxOrEvent.amounts[0];
-            this.token1.rawAmount += withdrawalTxOrEvent.amounts[1];
-            this.depositCount = withdrawalTxOrEvent.depositCount;
-        }
-        if(withdrawalTxOrEvent instanceof EVMSpvWithdrawalData) {
-            if(withdrawalTxOrEvent.getSpentVaultUtxo()!==this.utxo) return;
-            const amounts = withdrawalTxOrEvent.getTotalOutput();
-            this.token0.rawAmount -= amounts[0];
-            this.token1.rawAmount -= amounts[1];
-            this.withdrawCount++;
-            this.utxo = withdrawalTxOrEvent.btcTx.txid+":0";
-        }
-    }
-
-    getDepositCount(): number {
-        return this.depositCount;
-    }
-
-    getVaultParamsStruct(): SpvVaultParametersStruct {
-        return {
-            btcRelayContract: this.relayContract,
-            token0: this.token0.token,
-            token1: this.token1.token,
-            token0Multiplier: this.token0.multiplier,
-            token1Multiplier: this.token1.multiplier,
-            confirmations: this.confirmations
-        }
-    }
-
-    static randomVault(): EVMSpvVaultData {
-        const spvVaultParams = {
-            btcRelayContract: EVMAddresses.randomAddress(),
-            token0: EVMAddresses.randomAddress(),
-            token1: EVMAddresses.randomAddress(),
-            token0Multiplier: 1n,
-            token1Multiplier: 1n,
-            confirmations: 3n,
-        }
-        return new EVMSpvVaultData(EVMAddresses.randomAddress(), 0n, {
-            spvVaultParametersCommitment: getVaultParamsCommitment(spvVaultParams),
-            utxoTxHash: randomBytes(32),
-            utxoVout: 0n,
-            openBlockheight: 0n,
-            withdrawCount: 0n,
-            depositCount: 0n,
-            token0Amount: 0n,
-            token1Amount: 0n
-        }, spvVaultParams);
-    }
-
-}
-
-SpvVaultData.deserializers["EVM"] = EVMSpvVaultData;
+import {
+    SpvVaultClaimEvent,
+    SpvVaultCloseEvent,
+    SpvVaultData, SpvVaultDepositEvent, SpvVaultOpenEvent,
+    SpvVaultTokenBalance,
+    SpvVaultTokenData
+} from "@atomiqlabs/base";
+import {Buffer} from "buffer";
+import { EVMSpvWithdrawalData } from "./EVMSpvWithdrawalData";
+import {
+    SpvVaultParametersStruct,
+    SpvVaultStateStruct
+} from "./SpvVaultContractTypechain";
+import {hexlify, randomBytes} from "ethers";
+import {AbiCoder, keccak256} from "ethers";
+import {EVMAddresses} from "../chain/modules/EVMAddresses";
+import type {AddressLike, BigNumberish, BytesLike} from "ethers/lib.esm";
+
+export function getVaultParamsCommitment(vaultParams: SpvVaultParametersStruct) {
+    return keccak256(AbiCoder.defaultAbiCoder().encode(
+        ["address", "address", "address", "uint192", "uint192", "uint256"],
+        [vaultParams.btcRelayContract, vaultParams.token0, vaultParams.token1, vaultParams.token0Multiplier, vaultParams.token1Multiplier, vaultParams.confirmations]
+    ));
+}
+
+export class EVMSpvVaultData extends SpvVaultData<EVMSpvWithdrawalData> {
+
+    readonly owner: string;
+    readonly vaultId: bigint;
+
+    readonly relayContract: string;
+    readonly token0: {
+        token: string,
+        multiplier: bigint,
+        rawAmount: bigint
+    }
+    readonly token1: {
+        token: string,
+        multiplier: bigint,
+        rawAmount: bigint
+    };
+    readonly initialUtxo: string;
+    utxo: string;
+    readonly confirmations: number;
+    withdrawCount: number;
+    depositCount: number;
+
+    constructor(owner: string, vaultId: bigint, state: SpvVaultStateStruct, params: SpvVaultParametersStruct, initialUtxo?: string);
+    constructor(serializedObj: any);
+    constructor(ownerOrObj: string | any, vaultId?: bigint, state?: SpvVaultStateStruct, params?: SpvVaultParametersStruct, initialUtxo?: string) {
+        super();
+        if(typeof(ownerOrObj) === "string") {
+            this.owner = ownerOrObj;
+            this.vaultId = vaultId;
+            this.relayContract = params.btcRelayContract as string;
+            this.token0 = {
+                token: params.token0 as string,
+                multiplier: BigInt(params.token0Multiplier),
+                rawAmount: BigInt(state.token0Amount)
+            };
+            this.token1 = {
+                token: params.token1 as string,
+                multiplier: BigInt(params.token1Multiplier),
+                rawAmount: BigInt(state.token1Amount)
+            };
+            const txHash = Buffer.from(hexlify(state.utxoTxHash).substring(2), "hex");
+            this.utxo = txHash.reverse().toString("hex")+":"+BigInt(state.utxoVout).toString(10);
+            this.confirmations = Number(params.confirmations);
+            this.withdrawCount = Number(state.withdrawCount);
+            this.depositCount = Number(state.depositCount);
+            this.initialUtxo = initialUtxo;
+        } else {
+            this.owner = ownerOrObj.owner;
+            this.vaultId = BigInt(ownerOrObj.vaultId);
+            this.relayContract = ownerOrObj.relayContract;
+            this.token0 = {
+                token: ownerOrObj.token0.token,
+                multiplier: BigInt(ownerOrObj.token0.multiplier),
+                rawAmount: BigInt(ownerOrObj.token0.rawAmount)
+            }
+            this.token1 = {
+                token: ownerOrObj.token1.token,
+                multiplier: BigInt(ownerOrObj.token1.multiplier),
+                rawAmount: BigInt(ownerOrObj.token1.rawAmount)
+            };
+            this.utxo = ownerOrObj.utxo;
+            this.confirmations = ownerOrObj.confirmations;
+            this.withdrawCount = ownerOrObj.withdrawCount;
+            this.depositCount = ownerOrObj.depositCount;
+            this.initialUtxo = ownerOrObj.initialUtxo;
+        }
+    }
+
+    getBalances(): SpvVaultTokenBalance[] {
+        return [
+            {...this.token0, scaledAmount: this.token0.rawAmount * this.token0.multiplier},
+            {...this.token1, scaledAmount: this.token1.rawAmount * this.token1.multiplier}
+        ];
+    }
+
+    getConfirmations(): number {
+        return this.confirmations;
+    }
+
+    getOwner(): string {
+        return this.owner;
+    }
+
+    getTokenData(): SpvVaultTokenData[] {
+        return [this.token0, this.token1];
+    }
+
+    getUtxo(): string {
+        return this.isOpened() ? this.utxo : this.initialUtxo;
+    }
+
+    getVaultId(): bigint {
+        return this.vaultId;
+    }
+
+    getWithdrawalCount(): number {
+        return this.withdrawCount;
+    }
+
+    isOpened(): boolean {
+        return this.utxo!=="0000000000000000000000000000000000000000000000000000000000000000:0";
+    }
+
+    serialize(): any {
+        return {
+            type: "EVM",
+            owner: this.owner,
+            vaultId: this.vaultId.toString(10),
+            relayContract: this.relayContract,
+            token0: {
+                token: this.token0.token,
+                multiplier: this.token0.multiplier.toString(10),
+                rawAmount: this.token0.rawAmount.toString(10)
+            },
+            token1: {
+                token: this.token1.token,
+                multiplier: this.token1.multiplier.toString(10),
+                rawAmount: this.token1.rawAmount.toString(10)
+            },
+            utxo: this.utxo,
+            confirmations: this.confirmations,
+            withdrawCount: this.withdrawCount,
+            depositCount: this.depositCount,
+            initialUtxo: this.initialUtxo
+        }
+    }
+
+    updateState(withdrawalTxOrEvent: SpvVaultClaimEvent | SpvVaultCloseEvent | SpvVaultOpenEvent | SpvVaultDepositEvent | EVMSpvWithdrawalData): void {
+        if(withdrawalTxOrEvent instanceof SpvVaultClaimEvent) {
+            if(withdrawalTxOrEvent.withdrawCount <= this.withdrawCount) return;
+            this.token0.rawAmount -= withdrawalTxOrEvent.amounts[0];
+            this.token1.rawAmount -= withdrawalTxOrEvent.amounts[1];
+            this.withdrawCount = withdrawalTxOrEvent.withdrawCount;
+            this.utxo = withdrawalTxOrEvent.btcTxId+":0";
+        }
+        if(withdrawalTxOrEvent instanceof SpvVaultCloseEvent) {
+            this.token0.rawAmount = 0n;
+            this.token1.rawAmount = 0n;
+            this.utxo = "0000000000000000000000000000000000000000000000000000000000000000:0";
+        }
+        if(withdrawalTxOrEvent instanceof SpvVaultOpenEvent) {
+            if(this.isOpened()) return;
+            this.utxo = withdrawalTxOrEvent.btcTxId+":"+withdrawalTxOrEvent.vout;
+        }
+        if(withdrawalTxOrEvent instanceof SpvVaultDepositEvent) {
+            if(withdrawalTxOrEvent.depositCount <= this.depositCount) return;
+            this.token0.rawAmount += withdrawalTxOrEvent.amounts[0];
+            this.token1.rawAmount += withdrawalTxOrEvent.amounts[1];
+            this.depositCount = withdrawalTxOrEvent.depositCount;
+        }
+        if(withdrawalTxOrEvent instanceof EVMSpvWithdrawalData) {
+            if(withdrawalTxOrEvent.getSpentVaultUtxo()!==this.utxo) return;
+            const amounts = withdrawalTxOrEvent.getTotalOutput();
+            this.token0.rawAmount -= amounts[0];
+            this.token1.rawAmount -= amounts[1];
+            this.withdrawCount++;
+            this.utxo = withdrawalTxOrEvent.btcTx.txid+":0";
+        }
+    }
+
+    getDepositCount(): number {
+        return this.depositCount;
+    }
+
+    getVaultParamsStruct(): SpvVaultParametersStruct {
+        return {
+            btcRelayContract: this.relayContract,
+            token0: this.token0.token,
+            token1: this.token1.token,
+            token0Multiplier: this.token0.multiplier,
+            token1Multiplier: this.token1.multiplier,
+            confirmations: this.confirmations
+        }
+    }
+
+    static randomVault(): EVMSpvVaultData {
+        const spvVaultParams = {
+            btcRelayContract: EVMAddresses.randomAddress(),
+            token0: EVMAddresses.randomAddress(),
+            token1: EVMAddresses.randomAddress(),
+            token0Multiplier: 1n,
+            token1Multiplier: 1n,
+            confirmations: 3n,
+        }
+        return new EVMSpvVaultData(EVMAddresses.randomAddress(), 0n, {
+            spvVaultParametersCommitment: getVaultParamsCommitment(spvVaultParams),
+            utxoTxHash: randomBytes(32),
+            utxoVout: 0n,
+            openBlockheight: 0n,
+            withdrawCount: 0n,
+            depositCount: 0n,
+            token0Amount: 0n,
+            token1Amount: 0n
+        }, spvVaultParams);
+    }
+
+}
+
+SpvVaultData.deserializers["EVM"] = EVMSpvVaultData;

package/src/evm/spv_swap/EVMSpvWithdrawalData.ts

@@ -1,70 +1,70 @@
-import {SpvWithdrawalTransactionData} from "@atomiqlabs/base";
-import {Buffer} from "buffer";
-import { EVMSpvVaultContract } from "./EVMSpvVaultContract";
-import {BitcoinVaultTransactionDataStruct} from "./SpvVaultContractTypechain";
-import {AbiCoder, keccak256, ZeroHash} from "ethers";
-
-
-export class EVMSpvWithdrawalData extends SpvWithdrawalTransactionData {
-
-    private getExecutionHashWith0x() {
-        return this.executionHash==null ? ZeroHash : (this.executionHash.startsWith("0x") ? this.executionHash : "0x"+this.executionHash)
-    }
-
-    protected fromOpReturnData(data: Buffer): { recipient: string; rawAmounts: bigint[]; executionHash: string } {
-        return EVMSpvVaultContract.fromOpReturnData(data);
-    }
-
-    isRecipient(address: string): boolean {
-        return this.getRecipient().toLowerCase()===address.toLowerCase();
-    }
-
-    getFrontingId(): string {
-        const callerFee = this.getCallerFee();
-        const frontingFee = this.getFrontingFee();
-        const txDataHash = keccak256(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 keccak256(AbiCoder.defaultAbiCoder().encode(
-            ["bytes32", "bytes32"],
-            [txDataHash, this.getTxHash()]
-        )).substring(2);
-    }
-
-    getTxHash(): string {
-        return "0x"+Buffer.from(this.btcTx.txid, "hex").reverse().toString("hex");
-    }
-
-    getFrontingAmount(): bigint[] {
-        return [this.rawAmounts[0] + this.getExecutionFee()[0], this.rawAmounts[1]];
-    }
-
-    serialize(): any {
-        return {
-            type: "EVM",
-            ...super.serialize()
-        };
-    }
-
-    serializeToStruct(): BitcoinVaultTransactionDataStruct {
-        const callerFee = this.getCallerFee();
-        const frontingFee = this.getFrontingFee();
-        const executionFee = this.getExecutionFee();
-        return {
-            recipient: this.recipient,
-            amount0: this.rawAmounts[0],
-            amount1: this.rawAmounts[1] ?? 0n,
-            callerFee0: callerFee[0],
-            callerFee1: callerFee[1] ?? 0n,
-            frontingFee0: frontingFee[0],
-            frontingFee1: frontingFee[1] ?? 0n,
-            executionHandlerFeeAmount0: executionFee[0],
-            executionHash: this.getExecutionHashWith0x(),
-            executionExpiry: BigInt(this.executionExpiry)
-        }
-    }
-
-}
-
-SpvWithdrawalTransactionData.deserializers["EVM"] = EVMSpvWithdrawalData;
+import {SpvWithdrawalTransactionData} from "@atomiqlabs/base";
+import {Buffer} from "buffer";
+import { EVMSpvVaultContract } from "./EVMSpvVaultContract";
+import {BitcoinVaultTransactionDataStruct} from "./SpvVaultContractTypechain";
+import {AbiCoder, keccak256, ZeroHash} from "ethers";
+
+
+export class EVMSpvWithdrawalData extends SpvWithdrawalTransactionData {
+
+    private getExecutionHashWith0x() {
+        return this.executionHash==null ? ZeroHash : (this.executionHash.startsWith("0x") ? this.executionHash : "0x"+this.executionHash)
+    }
+
+    protected fromOpReturnData(data: Buffer): { recipient: string; rawAmounts: bigint[]; executionHash: string } {
+        return EVMSpvVaultContract.fromOpReturnData(data);
+    }
+
+    isRecipient(address: string): boolean {
+        return this.getRecipient().toLowerCase()===address.toLowerCase();
+    }
+
+    getFrontingId(): string {
+        const callerFee = this.getCallerFee();
+        const frontingFee = this.getFrontingFee();
+        const txDataHash = keccak256(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 keccak256(AbiCoder.defaultAbiCoder().encode(
+            ["bytes32", "bytes32"],
+            [txDataHash, this.getTxHash()]
+        )).substring(2);
+    }
+
+    getTxHash(): string {
+        return "0x"+Buffer.from(this.btcTx.txid, "hex").reverse().toString("hex");
+    }
+
+    getFrontingAmount(): bigint[] {
+        return [this.rawAmounts[0] + this.getExecutionFee()[0], this.rawAmounts[1]];
+    }
+
+    serialize(): any {
+        return {
+            type: "EVM",
+            ...super.serialize()
+        };
+    }
+
+    serializeToStruct(): BitcoinVaultTransactionDataStruct {
+        const callerFee = this.getCallerFee();
+        const frontingFee = this.getFrontingFee();
+        const executionFee = this.getExecutionFee();
+        return {
+            recipient: this.recipient,
+            amount0: this.rawAmounts[0],
+            amount1: this.rawAmounts[1] ?? 0n,
+            callerFee0: callerFee[0],
+            callerFee1: callerFee[1] ?? 0n,
+            frontingFee0: frontingFee[0],
+            frontingFee1: frontingFee[1] ?? 0n,
+            executionHandlerFeeAmount0: executionFee[0],
+            executionHash: this.getExecutionHashWith0x(),
+            executionExpiry: BigInt(this.executionExpiry)
+        }
+    }
+
+}
+
+SpvWithdrawalTransactionData.deserializers["EVM"] = EVMSpvWithdrawalData;