@atomiqlabs/chain-starknet 1.0.9 → 2.0.0-beta.0

package/dist/starknet/spv_swap/StarknetSpvVaultContract.d.ts

@@ -0,0 +1,65 @@
+import { BitcoinRpc, BtcTx, RelaySynchronizer, SpvVaultContract, SpvVaultTokenData, SpvWithdrawalState, SpvWithdrawalTransactionData, TransactionConfirmationOptions } from "@atomiqlabs/base";
+import { Buffer } from "buffer";
+import { StarknetTx } from "../chain/modules/StarknetTransactions";
+import { StarknetContractBase } from "../contract/StarknetContractBase";
+import { StarknetChainInterface } from "../chain/StarknetChainInterface";
+import { StarknetBtcRelay } from "../btcrelay/StarknetBtcRelay";
+import { StarknetAction } from "../chain/StarknetAction";
+import { SpvVaultContractAbi } from "./SpvVaultContractAbi";
+import { StarknetSigner } from "../wallet/StarknetSigner";
+import { StarknetSpvVaultData } from "./StarknetSpvVaultData";
+import { StarknetSpvWithdrawalData } from "./StarknetSpvWithdrawalData";
+import { StarknetBtcStoredHeader } from "../btcrelay/headers/StarknetBtcStoredHeader";
+export declare class StarknetSpvVaultContract extends StarknetContractBase<typeof SpvVaultContractAbi> implements SpvVaultContract<StarknetTx, StarknetSigner, "STARKNET", StarknetSpvVaultData, StarknetSpvWithdrawalData> {
+    private static readonly GasCosts;
+    readonly chainId = "STARKNET";
+    readonly btcRelay: StarknetBtcRelay<any>;
+    readonly bitcoinRpc: BitcoinRpc<any>;
+    readonly claimTimeout: number;
+    readonly maxClaimsPerTx: number;
+    readonly logger: {
+        debug: (msg: any, ...args: any[]) => void;
+        info: (msg: any, ...args: any[]) => void;
+        warn: (msg: any, ...args: any[]) => void;
+        error: (msg: any, ...args: any[]) => void;
+    };
+    constructor(chainInterface: StarknetChainInterface, btcRelay: StarknetBtcRelay<any>, bitcoinRpc: BitcoinRpc<any>, contractAddress?: string);
+    protected Open(signer: string, vault: StarknetSpvVaultData): StarknetAction;
+    protected Deposit(signer: string, vault: StarknetSpvVaultData, rawAmounts: bigint[]): StarknetAction;
+    protected Front(signer: string, vault: StarknetSpvVaultData, data: StarknetSpvWithdrawalData, withdrawalSequence: number): StarknetAction;
+    protected Claim(signer: string, vault: StarknetSpvVaultData, data: StarknetSpvWithdrawalData, blockheader: StarknetBtcStoredHeader, merkle: Buffer[], position: number): StarknetAction;
+    checkWithdrawalTx(tx: SpvWithdrawalTransactionData): Promise<void>;
+    createVaultData(owner: string, vaultId: bigint, utxo: string, confirmations: number, tokenData: SpvVaultTokenData[]): Promise<StarknetSpvVaultData>;
+    getVaultData(owner: string, vaultId: bigint): Promise<StarknetSpvVaultData>;
+    getAllVaults(owner?: string): Promise<StarknetSpvVaultData[]>;
+    getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
+    getWithdrawalData(btcTx: BtcTx): Promise<StarknetSpvWithdrawalData>;
+    fromOpReturnData(data: Buffer): {
+        recipient: string;
+        rawAmounts: bigint[];
+        executionHash: string;
+    };
+    static fromOpReturnData(data: Buffer): {
+        recipient: string;
+        rawAmounts: bigint[];
+        executionHash: string;
+    };
+    toOpReturnData(recipient: string, rawAmounts: bigint[], executionHash?: string): Buffer;
+    static toOpReturnData(recipient: string, rawAmounts: bigint[], executionHash?: string): Buffer;
+    claim(signer: StarknetSigner, vault: StarknetSpvVaultData, txs: {
+        tx: StarknetSpvWithdrawalData;
+        storedHeader?: StarknetBtcStoredHeader;
+    }[], synchronizer?: RelaySynchronizer<any, any, any>, initAta?: boolean, txOptions?: TransactionConfirmationOptions): Promise<string>;
+    deposit(signer: StarknetSigner, vault: StarknetSpvVaultData, rawAmounts: bigint[], txOptions?: TransactionConfirmationOptions): Promise<string>;
+    frontLiquidity(signer: StarknetSigner, vault: StarknetSpvVaultData, realWithdrawalTx: StarknetSpvWithdrawalData, withdrawSequence: number, txOptions?: TransactionConfirmationOptions): Promise<string>;
+    open(signer: StarknetSigner, vault: StarknetSpvVaultData, txOptions?: TransactionConfirmationOptions): Promise<string>;
+    txsClaim(signer: string, vault: StarknetSpvVaultData, txs: {
+        tx: StarknetSpvWithdrawalData;
+        storedHeader?: StarknetBtcStoredHeader;
+    }[], synchronizer?: RelaySynchronizer<any, any, any>, initAta?: boolean, feeRate?: string): Promise<StarknetTx[]>;
+    txsDeposit(signer: string, vault: StarknetSpvVaultData, rawAmounts: bigint[], feeRate?: string): Promise<StarknetTx[]>;
+    txsFrontLiquidity(signer: string, vault: StarknetSpvVaultData, realWithdrawalTx: StarknetSpvWithdrawalData, withdrawSequence: number, feeRate?: string): Promise<StarknetTx[]>;
+    txsOpen(signer: string, vault: StarknetSpvVaultData, feeRate?: string): Promise<StarknetTx[]>;
+    getClaimFee(signer: string, withdrawalData: StarknetSpvWithdrawalData, feeRate?: string): Promise<bigint>;
+    getFrontFee(signer: string, withdrawalData: StarknetSpvWithdrawalData, feeRate?: string): Promise<bigint>;
+}

package/dist/starknet/spv_swap/StarknetSpvVaultContract.js

@@ -0,0 +1,372 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StarknetSpvVaultContract = void 0;
+const base_1 = require("@atomiqlabs/base");
+const buffer_1 = require("buffer");
+const StarknetContractBase_1 = require("../contract/StarknetContractBase");
+const StarknetBtcRelay_1 = require("../btcrelay/StarknetBtcRelay");
+const starknet_1 = require("starknet");
+const StarknetAction_1 = require("../chain/StarknetAction");
+const SpvVaultContractAbi_1 = require("./SpvVaultContractAbi");
+const StarknetSpvVaultData_1 = require("./StarknetSpvVaultData");
+const StarknetSpvWithdrawalData_1 = require("./StarknetSpvWithdrawalData");
+const Utils_1 = require("../../utils/Utils");
+const StarknetAddresses_1 = require("../chain/modules/StarknetAddresses");
+const StarknetFees_1 = require("../chain/modules/StarknetFees");
+const spvVaultContractAddreses = {
+    [starknet_1.constants.StarknetChainId.SN_SEPOLIA]: "0x047961ea0687a2e3207478d386779bd5ec22aa8abc234319ccd723e2d7191a0c",
+    [starknet_1.constants.StarknetChainId.SN_MAIN]: "0x06ee5228af01baa443657ccda27b80637a609d43a97ed2f8fd478313e10abf4e"
+};
+const STARK_PRIME_MOD = 2n ** 251n + 17n * 2n ** 192n + 1n;
+function decodeUtxo(utxo) {
+    const [txId, vout] = utxo.split(":");
+    return {
+        txHash: BigInt("0x" + buffer_1.Buffer.from(txId, "hex").reverse().toString("hex")),
+        vout: BigInt(vout)
+    };
+}
+class StarknetSpvVaultContract extends StarknetContractBase_1.StarknetContractBase {
+    constructor(chainInterface, btcRelay, bitcoinRpc, contractAddress = spvVaultContractAddreses[chainInterface.starknetChainId]) {
+        super(chainInterface, contractAddress, SpvVaultContractAbi_1.SpvVaultContractAbi);
+        this.chainId = "STARKNET";
+        this.claimTimeout = 180;
+        this.maxClaimsPerTx = 10;
+        this.logger = (0, Utils_1.getLogger)("StarknetSpvVaultContract: ");
+        this.btcRelay = btcRelay;
+        this.bitcoinRpc = bitcoinRpc;
+    }
+    //StarknetActions
+    Open(signer, vault) {
+        const { txHash, vout } = decodeUtxo(vault.getUtxo());
+        const tokens = vault.getTokenData();
+        if (tokens.length !== 2)
+            throw new Error("Must specify exactly 2 tokens for vault!");
+        return new StarknetAction_1.StarknetAction(signer, this.Chain, this.contract.populateTransaction.open(vault.getVaultId(), this.btcRelay.contract.address, starknet_1.cairo.tuple(starknet_1.cairo.uint256(txHash), vout), vault.getConfirmations(), tokens[0].token, tokens[1].token, tokens[0].multiplier, tokens[1].multiplier), StarknetSpvVaultContract.GasCosts.OPEN);
+    }
+    Deposit(signer, vault, rawAmounts) {
+        return new StarknetAction_1.StarknetAction(signer, this.Chain, this.contract.populateTransaction.deposit(vault.getOwner(), vault.getVaultId(), rawAmounts[0], rawAmounts[1] ?? 0n), StarknetSpvVaultContract.GasCosts.DEPOSIT);
+    }
+    Front(signer, vault, data, withdrawalSequence) {
+        return new StarknetAction_1.StarknetAction(signer, this.Chain, this.contract.populateTransaction.front(vault.getOwner(), vault.getVaultId(), BigInt(withdrawalSequence), data.getTxHash(), data.serializeToStruct()), StarknetSpvVaultContract.GasCosts.FRONT);
+    }
+    Claim(signer, vault, data, blockheader, merkle, position) {
+        return new StarknetAction_1.StarknetAction(signer, this.Chain, {
+            contractAddress: this.contract.address,
+            entrypoint: "claim",
+            calldata: [
+                vault.getOwner(),
+                vault.getVaultId(),
+                ...(0, Utils_1.bufferToByteArray)(buffer_1.Buffer.from(data.btcTx.hex, "hex")),
+                ...blockheader.serialize(),
+                merkle.length,
+                ...merkle.map(Utils_1.bufferToU32Array).flat(),
+                position,
+            ].map(val => (0, Utils_1.toHex)(val, 0))
+        }, StarknetSpvVaultContract.GasCosts.CLAIM);
+    }
+    async checkWithdrawalTx(tx) {
+        const result = await this.Chain.provider.callContract({
+            contractAddress: this.contract.address,
+            entrypoint: "parse_bitcoin_tx",
+            calldata: (0, Utils_1.bufferToByteArray)(buffer_1.Buffer.from(tx.btcTx.hex, "hex"))
+        });
+        if (result == null)
+            throw new Error("Failed to parse transaction!");
+    }
+    createVaultData(owner, vaultId, utxo, confirmations, tokenData) {
+        if (tokenData.length !== 2)
+            throw new Error("Must specify 2 tokens in tokenData!");
+        return Promise.resolve(new StarknetSpvVaultData_1.StarknetSpvVaultData(owner, vaultId, {
+            relay_contract: this.btcRelay.contract.address,
+            token_0: tokenData[0].token,
+            token_1: tokenData[1].token,
+            token_0_multiplier: tokenData[0].multiplier,
+            token_1_multiplier: tokenData[1].multiplier,
+            utxo: starknet_1.cairo.tuple(starknet_1.cairo.uint256(0), 0),
+            confirmations: confirmations,
+            withdraw_count: 0,
+            deposit_count: 0,
+            token_0_amount: 0n,
+            token_1_amount: 0n
+        }, utxo));
+    }
+    //Getters
+    async getVaultData(owner, vaultId) {
+        const struct = await this.contract.get_vault(owner, vaultId);
+        return new StarknetSpvVaultData_1.StarknetSpvVaultData(owner, vaultId, struct);
+    }
+    async getAllVaults(owner) {
+        const openedVaults = new Set();
+        await this.Events.findInContractEventsForward(["spv_swap_vault::events::Opened", "spv_swap_vault::events::Closed"], owner == null ? null : [null, owner], (event) => {
+            const owner = (0, Utils_1.toHex)(event.keys[2]);
+            const vaultId = (0, Utils_1.toBigInt)(event.keys[3]);
+            const vaultIdentifier = owner + ":" + vaultId.toString(10);
+            if (event.name === "spv_swap_vault::events::Opened") {
+                openedVaults.add(vaultIdentifier);
+            }
+            else {
+                openedVaults.delete(vaultIdentifier);
+            }
+            return null;
+        });
+        const vaults = [];
+        for (let identifier of openedVaults.keys()) {
+            const [owner, vaultIdStr] = identifier.split(":");
+            vaults.push(await this.getVaultData(owner, BigInt(vaultIdStr)));
+        }
+        return vaults;
+    }
+    async getWithdrawalState(btcTxId) {
+        const txHash = buffer_1.Buffer.from(btcTxId, "hex").reverse();
+        const txHashU256 = starknet_1.cairo.uint256("0x" + txHash.toString("hex"));
+        let result = {
+            type: base_1.SpvWithdrawalStateType.NOT_FOUND
+        };
+        await this.Events.findInContractEventsForward(["spv_swap_vault::events::Fronted", "spv_swap_vault::events::Claimed", "spv_swap_vault::events::Closed"], [
+            (0, Utils_1.toHex)(txHashU256.low),
+            (0, Utils_1.toHex)(txHashU256.high)
+        ], async (event) => {
+            switch (event.name) {
+                case "spv_swap_vault::events::Fronted":
+                    result = {
+                        type: base_1.SpvWithdrawalStateType.FRONTED,
+                        txId: event.txHash,
+                        owner: (0, Utils_1.toHex)(event.keys[2]),
+                        vaultId: (0, Utils_1.toBigInt)(event.keys[3]),
+                        recipient: (0, Utils_1.toHex)(event.keys[4]),
+                        fronter: (0, Utils_1.toHex)(event.keys[6])
+                    };
+                    break;
+                case "spv_swap_vault::events::Claimed":
+                    result = {
+                        type: base_1.SpvWithdrawalStateType.CLAIMED,
+                        txId: event.txHash,
+                        owner: (0, Utils_1.toHex)(event.keys[2]),
+                        vaultId: (0, Utils_1.toBigInt)(event.keys[3]),
+                        recipient: (0, Utils_1.toHex)(event.keys[4]),
+                        claimer: (0, Utils_1.toHex)(event.keys[6]),
+                        fronter: (0, Utils_1.toHex)(event.data[2])
+                    };
+                    break;
+                case "spv_swap_vault::events::Closed":
+                    result = {
+                        type: base_1.SpvWithdrawalStateType.CLOSED,
+                        txId: event.txHash,
+                        owner: (0, Utils_1.toHex)(event.keys[2]),
+                        vaultId: (0, Utils_1.toBigInt)(event.keys[3]),
+                        error: (0, Utils_1.bigNumberishToBuffer)(event.data[0]).toString()
+                    };
+                    break;
+            }
+        });
+        return result;
+    }
+    getWithdrawalData(btcTx) {
+        return Promise.resolve(new StarknetSpvWithdrawalData_1.StarknetSpvWithdrawalData(btcTx));
+    }
+    //OP_RETURN data encoding/decoding
+    fromOpReturnData(data) {
+        return StarknetSpvVaultContract.fromOpReturnData(data);
+    }
+    static fromOpReturnData(data) {
+        let rawAmount0 = 0n;
+        let rawAmount1 = 0n;
+        let executionHash = null;
+        if (data.length === 40) {
+            rawAmount0 = data.readBigInt64LE(32).valueOf();
+        }
+        else if (data.length === 48) {
+            rawAmount0 = data.readBigInt64LE(32).valueOf();
+            rawAmount1 = data.readBigInt64LE(40).valueOf();
+        }
+        else if (data.length === 72) {
+            rawAmount0 = data.readBigInt64LE(32).valueOf();
+            executionHash = data.slice(40, 72).toString("hex");
+        }
+        else if (data.length === 80) {
+            rawAmount0 = data.readBigInt64LE(32).valueOf();
+            rawAmount1 = data.readBigInt64LE(40).valueOf();
+            executionHash = data.slice(48, 80).toString("hex");
+        }
+        else {
+            throw new Error("Invalid OP_RETURN data length!");
+        }
+        if (executionHash != null) {
+            const executionHashValue = BigInt("0x" + executionHash);
+            if (executionHashValue >= STARK_PRIME_MOD)
+                throw new Error("Execution hash not in range of starknet prime");
+        }
+        const recipient = "0x" + data.slice(0, 32).toString("hex");
+        if (!StarknetAddresses_1.StarknetAddresses.isValidAddress(recipient))
+            throw new Error("Invalid recipient specified");
+        return { executionHash, rawAmounts: [rawAmount0, rawAmount1], recipient };
+    }
+    toOpReturnData(recipient, rawAmounts, executionHash) {
+        return StarknetSpvVaultContract.toOpReturnData(recipient, rawAmounts, executionHash);
+    }
+    static toOpReturnData(recipient, rawAmounts, executionHash) {
+        if (!StarknetAddresses_1.StarknetAddresses.isValidAddress(recipient))
+            throw new Error("Invalid recipient specified");
+        if (rawAmounts.length < 1)
+            throw new Error("At least 1 amount needs to be specified");
+        if (rawAmounts.length > 2)
+            throw new Error("At most 2 amounts need to be specified");
+        rawAmounts.forEach(val => {
+            if (val < 0n)
+                throw new Error("Negative raw amount specified");
+            if (val >= 2n ** 64n)
+                throw new Error("Raw amount overflow");
+        });
+        if (executionHash != null) {
+            const executionHashValue = (0, Utils_1.toBigInt)(executionHash);
+            if (executionHashValue < 0n)
+                throw new Error("Execution hash negative");
+            if (executionHashValue >= STARK_PRIME_MOD)
+                throw new Error("Execution hash not in range of starknet prime");
+        }
+        const recipientBuffer = buffer_1.Buffer.from(recipient.substring(2).padStart(64, "0"), "hex");
+        const amount0Buffer = buffer_1.Buffer.from(rawAmounts[0].toString(16).padStart(16, "0"), "hex");
+        const amount1Buffer = rawAmounts[1] == null || rawAmounts[1] === 0n ? buffer_1.Buffer.alloc(0) : buffer_1.Buffer.from(rawAmounts[1].toString(16).padStart(16, "0"), "hex");
+        const executionHashBuffer = executionHash == null ? buffer_1.Buffer.alloc(0) : buffer_1.Buffer.from(executionHash.substring(2).padStart(64, "0"), "hex");
+        return buffer_1.Buffer.concat([
+            recipientBuffer,
+            amount0Buffer.reverse(),
+            amount1Buffer.reverse(),
+            executionHashBuffer
+        ]);
+    }
+    //Actions
+    async claim(signer, vault, txs, synchronizer, initAta, txOptions) {
+        const result = await this.txsClaim(signer.getAddress(), vault, txs, synchronizer, initAta, txOptions?.feeRate);
+        const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
+        return signature;
+    }
+    async deposit(signer, vault, rawAmounts, txOptions) {
+        const result = await this.txsDeposit(signer.getAddress(), vault, rawAmounts, txOptions?.feeRate);
+        const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
+        return signature;
+    }
+    async frontLiquidity(signer, vault, realWithdrawalTx, withdrawSequence, txOptions) {
+        const result = await this.txsFrontLiquidity(signer.getAddress(), vault, realWithdrawalTx, withdrawSequence, txOptions?.feeRate);
+        const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
+        return signature;
+    }
+    async open(signer, vault, txOptions) {
+        const result = await this.txsOpen(signer.getAddress(), vault, txOptions?.feeRate);
+        const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
+        return signature;
+    }
+    //Transactions
+    async txsClaim(signer, vault, txs, synchronizer, initAta, feeRate) {
+        if (!vault.isOpened())
+            throw new Error("Cannot claim from a closed vault!");
+        feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
+        const txsWithMerkleProofs = [];
+        for (let tx of txs) {
+            const merkleProof = await this.bitcoinRpc.getMerkleProof(tx.tx.btcTx.txid, tx.tx.btcTx.blockhash);
+            this.logger.debug("txsClaim(): merkle proof computed: ", merkleProof);
+            txsWithMerkleProofs.push({
+                ...merkleProof,
+                ...tx
+            });
+        }
+        const starknetTxs = [];
+        const storedHeaders = await StarknetBtcRelay_1.StarknetBtcRelay.getCommitedHeadersAndSynchronize(signer, this.btcRelay, txsWithMerkleProofs.filter(tx => tx.storedHeader == null).map(tx => {
+            return {
+                blockhash: tx.tx.btcTx.blockhash,
+                blockheight: tx.blockheight,
+                requiredConfirmations: vault.getConfirmations()
+            };
+        }), starknetTxs, synchronizer, feeRate);
+        if (storedHeaders == null)
+            throw new Error("Cannot fetch committed header!");
+        const actions = txsWithMerkleProofs.map(tx => {
+            return this.Claim(signer, vault, tx.tx, tx.storedHeader ?? storedHeaders[tx.tx.btcTx.blockhash], tx.merkle, tx.pos);
+        });
+        let starknetAction = new StarknetAction_1.StarknetAction(signer, this.Chain);
+        for (let action of actions) {
+            starknetAction.add(action);
+            if (starknetAction.ixsLength() >= this.maxClaimsPerTx) {
+                await starknetAction.addToTxs(starknetTxs, feeRate);
+                starknetAction = new StarknetAction_1.StarknetAction(signer, this.Chain);
+            }
+        }
+        if (starknetAction.ixsLength() > 0) {
+            await starknetAction.addToTxs(starknetTxs, feeRate);
+        }
+        this.logger.debug("txsClaim(): " + starknetTxs.length + " claim TXs created claiming " + txs.length + " txs, owner: " + vault.getOwner() +
+            " vaultId: " + vault.getVaultId().toString(10));
+        return starknetTxs;
+    }
+    async txsDeposit(signer, vault, rawAmounts, feeRate) {
+        if (!vault.isOpened())
+            throw new Error("Cannot deposit to a closed vault!");
+        //Approve first
+        const vaultTokens = vault.getTokenData();
+        const action = new StarknetAction_1.StarknetAction(signer, this.Chain);
+        let realAmount0 = 0n;
+        let realAmount1 = 0n;
+        if (rawAmounts[0] != null && rawAmounts[0] !== 0n) {
+            realAmount0 = rawAmounts[0] * vaultTokens[0].multiplier;
+            action.add(this.Chain.Tokens.Approve(signer, this.contract.address, vaultTokens[0].token, realAmount0));
+        }
+        if (rawAmounts[1] != null && rawAmounts[1] !== 0n) {
+            realAmount1 = rawAmounts[1] * vaultTokens[1].multiplier;
+            action.add(this.Chain.Tokens.Approve(signer, this.contract.address, vaultTokens[1].token, realAmount1));
+        }
+        action.add(this.Deposit(signer, vault, rawAmounts));
+        feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
+        this.logger.debug("txsDeposit(): deposit TX created," +
+            " token0: " + vaultTokens[0].token + " rawAmount0: " + rawAmounts[0].toString(10) + " amount0: " + realAmount0.toString(10) +
+            " token1: " + vaultTokens[1].token + " rawAmount1: " + (rawAmounts[1] ?? 0n).toString(10) + " amount1: " + realAmount1.toString(10));
+        return [await action.tx(feeRate)];
+    }
+    async txsFrontLiquidity(signer, vault, realWithdrawalTx, withdrawSequence, feeRate) {
+        if (!vault.isOpened())
+            throw new Error("Cannot front on a closed vault!");
+        //Approve first
+        const vaultTokens = vault.getTokenData();
+        const action = new StarknetAction_1.StarknetAction(signer, this.Chain);
+        const rawAmounts = realWithdrawalTx.getFrontingAmount();
+        let realAmount0 = 0n;
+        let realAmount1 = 0n;
+        if (rawAmounts[0] != null && rawAmounts[0] !== 0n) {
+            realAmount0 = rawAmounts[0] * vaultTokens[0].multiplier;
+            action.add(this.Chain.Tokens.Approve(signer, this.contract.address, vaultTokens[0].token, realAmount0));
+        }
+        if (rawAmounts[1] != null && rawAmounts[1] !== 0n) {
+            realAmount1 = rawAmounts[1] * vaultTokens[1].multiplier;
+            action.add(this.Chain.Tokens.Approve(signer, this.contract.address, vaultTokens[1].token, realAmount1));
+        }
+        action.add(this.Front(signer, vault, realWithdrawalTx, withdrawSequence));
+        feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
+        this.logger.debug("txsFrontLiquidity(): front TX created," +
+            " token0: " + vaultTokens[0].token + " rawAmount0: " + rawAmounts[0].toString(10) + " amount0: " + realAmount0.toString(10) +
+            " token1: " + vaultTokens[1].token + " rawAmount1: " + (rawAmounts[1] ?? 0n).toString(10) + " amount1: " + realAmount1.toString(10));
+        return [await action.tx(feeRate)];
+    }
+    async txsOpen(signer, vault, feeRate) {
+        if (vault.isOpened())
+            throw new Error("Cannot open an already opened vault!");
+        const action = this.Open(signer, vault);
+        feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
+        this.logger.debug("txsOpen(): open TX created, owner: " + vault.getOwner() +
+            " vaultId: " + vault.getVaultId().toString(10));
+        return [await action.tx(feeRate)];
+    }
+    async getClaimFee(signer, withdrawalData, feeRate) {
+        feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
+        return StarknetFees_1.StarknetFees.getGasFee(StarknetSpvVaultContract.GasCosts.CLAIM.l1, feeRate);
+    }
+    async getFrontFee(signer, withdrawalData, feeRate) {
+        feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
+        return StarknetFees_1.StarknetFees.getGasFee(StarknetSpvVaultContract.GasCosts.FRONT.l1, feeRate);
+    }
+}
+exports.StarknetSpvVaultContract = StarknetSpvVaultContract;
+StarknetSpvVaultContract.GasCosts = {
+    DEPOSIT: { l1: 750, l2: 0 },
+    OPEN: { l1: 1500, l2: 0 },
+    FRONT: { l1: 750, l2: 0 },
+    CLAIM: { l1: 10000, l2: 0 }
+};

package/dist/starknet/spv_swap/StarknetSpvVaultData.d.ts

@@ -0,0 +1,49 @@
+import { SpvVaultClaimEvent, SpvVaultCloseEvent, SpvVaultData, SpvVaultDepositEvent, SpvVaultOpenEvent, SpvVaultTokenBalance, SpvVaultTokenData } from "@atomiqlabs/base";
+import { BigNumberish } from "starknet";
+import { StarknetSpvWithdrawalData } from "./StarknetSpvWithdrawalData";
+export type StarknetSpvVaultDataType = {
+    relay_contract: BigNumberish;
+    token_0: BigNumberish;
+    token_1: BigNumberish;
+    token_0_multiplier: BigNumberish;
+    token_1_multiplier: BigNumberish;
+    utxo: Record<number, boolean | object | BigNumberish>;
+    confirmations: BigNumberish;
+    withdraw_count: BigNumberish;
+    deposit_count: BigNumberish;
+    token_0_amount: BigNumberish;
+    token_1_amount: BigNumberish;
+};
+export declare class StarknetSpvVaultData extends SpvVaultData<StarknetSpvWithdrawalData> {
+    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, struct: StarknetSpvVaultDataType, initialUtxo?: string);
+    constructor(serializedObj: any);
+    getBalances(): SpvVaultTokenBalance[];
+    getConfirmations(): number;
+    getOwner(): string;
+    getTokenData(): SpvVaultTokenData[];
+    getUtxo(): string;
+    getVaultId(): bigint;
+    getWithdrawalCount(): number;
+    isOpened(): boolean;
+    serialize(): any;
+    updateState(withdrawalTxOrEvent: SpvVaultClaimEvent | SpvVaultCloseEvent | SpvVaultOpenEvent | SpvVaultDepositEvent | StarknetSpvWithdrawalData): void;
+    getDepositCount(): number;
+}

package/dist/starknet/spv_swap/StarknetSpvVaultData.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StarknetSpvVaultData = void 0;
+const base_1 = require("@atomiqlabs/base");
+const Utils_1 = require("../../utils/Utils");
+const buffer_1 = require("buffer");
+const StarknetSpvWithdrawalData_1 = require("./StarknetSpvWithdrawalData");
+class StarknetSpvVaultData extends base_1.SpvVaultData {
+    constructor(ownerOrObj, vaultId, struct, initialUtxo) {
+        super();
+        if (typeof (ownerOrObj) === "string") {
+            this.owner = ownerOrObj;
+            this.vaultId = vaultId;
+            this.relayContract = (0, Utils_1.toHex)(struct.relay_contract);
+            this.token0 = {
+                token: (0, Utils_1.toHex)(struct.token_0),
+                multiplier: (0, Utils_1.toBigInt)(struct.token_0_multiplier),
+                rawAmount: (0, Utils_1.toBigInt)(struct.token_0_amount)
+            };
+            this.token1 = {
+                token: (0, Utils_1.toHex)(struct.token_1),
+                multiplier: (0, Utils_1.toBigInt)(struct.token_1_multiplier),
+                rawAmount: (0, Utils_1.toBigInt)(struct.token_1_amount)
+            };
+            const txHash = buffer_1.Buffer.from((0, Utils_1.toBigInt)(struct.utxo["0"]).toString(16).padStart(64, "0"), "hex");
+            const vout = (0, Utils_1.toBigInt)(struct.utxo["1"]);
+            this.utxo = txHash.reverse().toString("hex") + ":" + vout.toString(10);
+            this.confirmations = Number((0, Utils_1.toBigInt)(struct.confirmations));
+            this.withdrawCount = Number((0, Utils_1.toBigInt)(struct.withdraw_count));
+            this.depositCount = Number((0, Utils_1.toBigInt)(struct.deposit_count));
+            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() {
+        return [
+            { ...this.token0, scaledAmount: this.token0.rawAmount * this.token0.multiplier },
+            { ...this.token1, scaledAmount: this.token1.rawAmount * this.token1.multiplier }
+        ];
+    }
+    getConfirmations() {
+        return this.confirmations;
+    }
+    getOwner() {
+        return this.owner;
+    }
+    getTokenData() {
+        return [this.token0, this.token1];
+    }
+    getUtxo() {
+        return this.isOpened() ? this.utxo : this.initialUtxo;
+    }
+    getVaultId() {
+        return this.vaultId;
+    }
+    getWithdrawalCount() {
+        return this.withdrawCount;
+    }
+    isOpened() {
+        return this.utxo !== "0000000000000000000000000000000000000000000000000000000000000000:0";
+    }
+    serialize() {
+        return {
+            type: "STARKNET",
+            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,
+            initialUtxo: this.initialUtxo
+        };
+    }
+    updateState(withdrawalTxOrEvent) {
+        if (withdrawalTxOrEvent instanceof base_1.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 base_1.SpvVaultCloseEvent) {
+            this.token0.rawAmount = 0n;
+            this.token1.rawAmount = 0n;
+            this.utxo = "0000000000000000000000000000000000000000000000000000000000000000:0";
+        }
+        if (withdrawalTxOrEvent instanceof base_1.SpvVaultOpenEvent) {
+            if (this.isOpened())
+                return;
+            this.utxo = withdrawalTxOrEvent.btcTxId + ":" + withdrawalTxOrEvent.vout;
+        }
+        if (withdrawalTxOrEvent instanceof base_1.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 StarknetSpvWithdrawalData_1.StarknetSpvWithdrawalData) {
+            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() {
+        return this.depositCount;
+    }
+}
+exports.StarknetSpvVaultData = StarknetSpvVaultData;
+base_1.SpvVaultData.deserializers["STARKNET"] = StarknetSpvVaultData;

package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.d.ts

@@ -0,0 +1,24 @@
+import { SpvWithdrawalTransactionData } from "@atomiqlabs/base";
+import { Buffer } from "buffer";
+import { BigNumberish } from "starknet";
+export declare class StarknetSpvWithdrawalData extends SpvWithdrawalTransactionData {
+    protected fromOpReturnData(data: Buffer): {
+        recipient: string;
+        rawAmounts: bigint[];
+        executionHash: string;
+    };
+    isRecipient(address: string): boolean;
+    getTxHash(): bigint;
+    getFrontingAmount(): bigint[];
+    serialize(): any;
+    serializeToStruct(): {
+        recipient: string;
+        amount: Record<number, boolean | object | BigNumberish>;
+        caller_fee: Record<number, boolean | object | BigNumberish>;
+        fronting_fee: Record<number, boolean | object | BigNumberish>;
+        execution_handler_fee_amount_0: bigint;
+        execution_hash: bigint;
+        execution_expiry: bigint;
+    };
+    serializeToFelts(): BigNumberish[];
+}