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

package/dist/starknet/swaps/modules/StarknetSwapInit.d.ts

@@ -1,84 +1,84 @@
-import { StarknetSwapData } from "../StarknetSwapData";
-import { StarknetSwapModule } from "../StarknetSwapModule";
-import { StarknetSigner } from "../../wallet/StarknetSigner";
-import { StarknetTx } from "../../chain/modules/StarknetTransactions";
-export type StarknetPreFetchVerification = {
-    pendingBlockTime?: number;
-};
-export declare class StarknetSwapInit extends StarknetSwapModule {
-    private static readonly GasCosts;
-    /**
-     * bare Init action based on the data passed in swapData
-     *
-     * @param swapData
-     * @param timeout
-     * @param signature
-     * @private
-     */
-    private Init;
-    /**
-     * Returns auth prefix to be used with a specific swap, payIn=true & payIn=false use different prefixes (these
-     *  actually have no meaning for the smart contract/solana program in the Solana case)
-     *
-     * @param swapData
-     * @private
-     */
-    private getAuthPrefix;
-    preFetchForInitSignatureVerification(): Promise<StarknetPreFetchVerification>;
-    /**
-     * Signs swap initialization authorization, using data from preFetchedBlockData if provided & still valid (subject
-     *  to SIGNATURE_PREFETCH_DATA_VALIDITY)
-     *
-     * @param signer
-     * @param swapData
-     * @param authorizationTimeout
-     * @public
-     */
-    signSwapInitialization(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number): Promise<{
-        prefix: string;
-        timeout: string;
-        signature: string;
-    }>;
-    /**
-     * Checks whether the provided signature data is valid, using preFetchedData if provided and still valid
-     *
-     * @param swapData
-     * @param timeout
-     * @param prefix
-     * @param signature
-     * @param preFetchData
-     * @public
-     */
-    isSignatureValid(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string, preFetchData?: StarknetPreFetchVerification): Promise<null>;
-    /**
-     * Gets expiry of the provided signature data, this is a minimum of slot expiry & swap signature expiry
-     *
-     * @param timeout
-     * @public
-     */
-    getSignatureExpiry(timeout: string): Promise<number>;
-    /**
-     * Checks whether signature is expired for good, compares the timestamp to the current "pending" block timestamp
-     *
-     * @param timeout
-     * @param preFetchData
-     * @public
-     */
-    isSignatureExpired(timeout: string, preFetchData?: StarknetPreFetchVerification): Promise<boolean>;
-    /**
-     * Creates init transaction with a valid signature from an LP
-     *
-     * @param swapData swap to initialize
-     * @param timeout init signature timeout
-     * @param prefix init signature prefix
-     * @param signature init signature
-     * @param skipChecks whether to skip signature validity checks
-     * @param feeRate fee rate to use for the transaction
-     */
-    txsInit(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string, skipChecks?: boolean, feeRate?: string): Promise<StarknetTx[]>;
-    /**
-     * Get the estimated solana fee of the init transaction, this includes the required deposit for creating swap PDA
-     *  and also deposit for ATAs
-     */
-    getInitFee(swapData?: StarknetSwapData, feeRate?: string): Promise<bigint>;
-}
+import { StarknetSwapData } from "../StarknetSwapData";
+import { StarknetSwapModule } from "../StarknetSwapModule";
+import { StarknetSigner } from "../../wallet/StarknetSigner";
+import { StarknetTx } from "../../chain/modules/StarknetTransactions";
+export type StarknetPreFetchVerification = {
+    pendingBlockTime?: number;
+};
+export declare class StarknetSwapInit extends StarknetSwapModule {
+    private static readonly GasCosts;
+    /**
+     * bare Init action based on the data passed in swapData
+     *
+     * @param swapData
+     * @param timeout
+     * @param signature
+     * @private
+     */
+    private Init;
+    /**
+     * Returns auth prefix to be used with a specific swap, payIn=true & payIn=false use different prefixes (these
+     *  actually have no meaning for the smart contract/solana program in the Solana case)
+     *
+     * @param swapData
+     * @private
+     */
+    private getAuthPrefix;
+    preFetchForInitSignatureVerification(): Promise<StarknetPreFetchVerification>;
+    /**
+     * Signs swap initialization authorization, using data from preFetchedBlockData if provided & still valid (subject
+     *  to SIGNATURE_PREFETCH_DATA_VALIDITY)
+     *
+     * @param signer
+     * @param swapData
+     * @param authorizationTimeout
+     * @public
+     */
+    signSwapInitialization(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number): Promise<{
+        prefix: string;
+        timeout: string;
+        signature: string;
+    }>;
+    /**
+     * Checks whether the provided signature data is valid, using preFetchedData if provided and still valid
+     *
+     * @param swapData
+     * @param timeout
+     * @param prefix
+     * @param signature
+     * @param preFetchData
+     * @public
+     */
+    isSignatureValid(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string, preFetchData?: StarknetPreFetchVerification): Promise<null>;
+    /**
+     * Gets expiry of the provided signature data, this is a minimum of slot expiry & swap signature expiry
+     *
+     * @param timeout
+     * @public
+     */
+    getSignatureExpiry(timeout: string): Promise<number>;
+    /**
+     * Checks whether signature is expired for good, compares the timestamp to the current "pending" block timestamp
+     *
+     * @param timeout
+     * @param preFetchData
+     * @public
+     */
+    isSignatureExpired(timeout: string, preFetchData?: StarknetPreFetchVerification): Promise<boolean>;
+    /**
+     * Creates init transaction with a valid signature from an LP
+     *
+     * @param swapData swap to initialize
+     * @param timeout init signature timeout
+     * @param prefix init signature prefix
+     * @param signature init signature
+     * @param skipChecks whether to skip signature validity checks
+     * @param feeRate fee rate to use for the transaction
+     */
+    txsInit(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string, skipChecks?: boolean, feeRate?: string): Promise<StarknetTx[]>;
+    /**
+     * Get the estimated solana fee of the init transaction, this includes the required deposit for creating swap PDA
+     *  and also deposit for ATAs
+     */
+    getInitFee(swapData?: StarknetSwapData, feeRate?: string): Promise<bigint>;
+}

package/dist/starknet/swaps/modules/StarknetSwapInit.js

@@ -1,164 +1,200 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StarknetSwapInit = void 0;
-const base_1 = require("@atomiqlabs/base");
-const Utils_1 = require("../../../utils/Utils");
-const buffer_1 = require("buffer");
-const StarknetAction_1 = require("../../chain/StarknetAction");
-const StarknetSwapModule_1 = require("../StarknetSwapModule");
-const StarknetFees_1 = require("../../chain/modules/StarknetFees");
-const Initialize = [
-    { name: 'Swap hash', type: 'felt' },
-    { name: 'Timeout', type: 'timestamp' }
-];
-class StarknetSwapInit extends StarknetSwapModule_1.StarknetSwapModule {
-    /**
-     * bare Init action based on the data passed in swapData
-     *
-     * @param swapData
-     * @param timeout
-     * @param signature
-     * @private
-     */
-    Init(swapData, timeout, signature) {
-        return new StarknetAction_1.StarknetAction(swapData.payIn ? swapData.offerer : swapData.claimer, this.root, this.swapContract.populateTransaction.initialize(swapData.toEscrowStruct(), signature, timeout, swapData.extraData == null || swapData.extraData === "" ? [] : (0, Utils_1.bufferToBytes31Span)(buffer_1.Buffer.from(swapData.extraData, "hex")).map(Utils_1.toHex)), swapData.payIn ? StarknetSwapInit.GasCosts.INIT_PAY_IN : StarknetSwapInit.GasCosts.INIT);
-    }
-    /**
-     * Returns auth prefix to be used with a specific swap, payIn=true & payIn=false use different prefixes (these
-     *  actually have no meaning for the smart contract/solana program in the Solana case)
-     *
-     * @param swapData
-     * @private
-     */
-    getAuthPrefix(swapData) {
-        return swapData.isPayIn() ? "claim_initialize" : "initialize";
-    }
-    async preFetchForInitSignatureVerification() {
-        return {
-            pendingBlockTime: await this.root.Blocks.getBlockTime("pending")
-        };
-    }
-    /**
-     * Signs swap initialization authorization, using data from preFetchedBlockData if provided & still valid (subject
-     *  to SIGNATURE_PREFETCH_DATA_VALIDITY)
-     *
-     * @param signer
-     * @param swapData
-     * @param authorizationTimeout
-     * @public
-     */
-    async signSwapInitialization(signer, swapData, authorizationTimeout) {
-        const authTimeout = Math.floor(Date.now() / 1000) + authorizationTimeout;
-        const signature = await this.root.Signatures.signTypedMessage(signer, Initialize, "Initialize", {
-            "Swap hash": "0x" + swapData.getEscrowHash(),
-            "Timeout": (0, Utils_1.toHex)(authTimeout)
-        });
-        return {
-            prefix: this.getAuthPrefix(swapData),
-            timeout: authTimeout.toString(10),
-            signature
-        };
-    }
-    /**
-     * Checks whether the provided signature data is valid, using preFetchedData if provided and still valid
-     *
-     * @param swapData
-     * @param timeout
-     * @param prefix
-     * @param signature
-     * @param preFetchData
-     * @public
-     */
-    async isSignatureValid(swapData, timeout, prefix, signature, preFetchData) {
-        const sender = swapData.isPayIn() ? swapData.offerer : swapData.claimer;
-        const signer = swapData.isPayIn() ? swapData.claimer : swapData.offerer;
-        if (!swapData.isPayIn() && await this.contract.isExpired(sender.toString(), swapData)) {
-            throw new base_1.SignatureVerificationError("Swap will expire too soon!");
-        }
-        if (prefix !== this.getAuthPrefix(swapData))
-            throw new base_1.SignatureVerificationError("Invalid prefix");
-        const currentTimestamp = BigInt(Math.floor(Date.now() / 1000));
-        const timeoutBN = BigInt(timeout);
-        const isExpired = (timeoutBN - currentTimestamp) < BigInt(this.contract.authGracePeriod);
-        if (isExpired)
-            throw new base_1.SignatureVerificationError("Authorization expired!");
-        if (await this.isSignatureExpired(timeout, preFetchData))
-            throw new base_1.SignatureVerificationError("Authorization expired!");
-        const valid = await this.root.Signatures.isValidSignature(signature, signer, Initialize, "Initialize", {
-            "Swap hash": "0x" + swapData.getEscrowHash(),
-            "Timeout": (0, Utils_1.toHex)(timeoutBN)
-        });
-        if (!valid)
-            throw new base_1.SignatureVerificationError("Invalid signature!");
-        return null;
-    }
-    /**
-     * Gets expiry of the provided signature data, this is a minimum of slot expiry & swap signature expiry
-     *
-     * @param timeout
-     * @public
-     */
-    async getSignatureExpiry(timeout) {
-        const now = Date.now();
-        const timeoutExpiryTime = (parseInt(timeout) - this.contract.authGracePeriod) * 1000;
-        if (timeoutExpiryTime < now)
-            return 0;
-        return timeoutExpiryTime;
-    }
-    /**
-     * Checks whether signature is expired for good, compares the timestamp to the current "pending" block timestamp
-     *
-     * @param timeout
-     * @param preFetchData
-     * @public
-     */
-    async isSignatureExpired(timeout, preFetchData) {
-        if (preFetchData == null || preFetchData.pendingBlockTime == null) {
-            preFetchData = await this.preFetchForInitSignatureVerification();
-        }
-        return preFetchData.pendingBlockTime > parseInt(timeout);
-    }
-    /**
-     * Creates init transaction with a valid signature from an LP
-     *
-     * @param swapData swap to initialize
-     * @param timeout init signature timeout
-     * @param prefix init signature prefix
-     * @param signature init signature
-     * @param skipChecks whether to skip signature validity checks
-     * @param feeRate fee rate to use for the transaction
-     */
-    async txsInit(swapData, timeout, prefix, signature, skipChecks, feeRate) {
-        const sender = swapData.isPayIn() ? swapData.offerer : swapData.claimer;
-        if (!skipChecks) {
-            const [_, payStatus] = await Promise.all([
-                (0, Utils_1.tryWithRetries)(() => this.isSignatureValid(swapData, timeout, prefix, signature), this.retryPolicy, (e) => e instanceof base_1.SignatureVerificationError),
-                (0, Utils_1.tryWithRetries)(() => this.contract.getCommitStatus(sender, swapData), this.retryPolicy)
-            ]);
-            if (payStatus !== base_1.SwapCommitStatus.NOT_COMMITED)
-                throw new base_1.SwapDataVerificationError("Invoice already being paid for or paid");
-        }
-        feeRate ?? (feeRate = await this.root.Fees.getFeeRate());
-        const initAction = this.Init(swapData, BigInt(timeout), JSON.parse(signature));
-        if (swapData.payIn)
-            initAction.addAction(this.root.Tokens.Approve(sender, this.swapContract.address, swapData.token, swapData.amount), 0); //Add erc20 approve
-        if (swapData.getTotalDeposit() !== 0n)
-            initAction.addAction(this.root.Tokens.Approve(sender, this.swapContract.address, swapData.feeToken, swapData.getTotalDeposit()), 0); //Add deposit erc20 approve
-        this.logger.debug("txsInitPayIn(): create swap init TX, swap: " + swapData.getClaimHash() +
-            " feerate: " + feeRate);
-        return [await initAction.tx(feeRate)];
-    }
-    /**
-     * Get the estimated solana fee of the init transaction, this includes the required deposit for creating swap PDA
-     *  and also deposit for ATAs
-     */
-    async getInitFee(swapData, feeRate) {
-        feeRate ?? (feeRate = await this.root.Fees.getFeeRate());
-        return StarknetFees_1.StarknetFees.getGasFee(swapData.payIn ? StarknetSwapInit.GasCosts.INIT_PAY_IN.l1 : StarknetSwapInit.GasCosts.INIT.l1, feeRate);
-    }
-}
-exports.StarknetSwapInit = StarknetSwapInit;
-StarknetSwapInit.GasCosts = {
-    INIT: { l1: 500, l2: 0 },
-    INIT_PAY_IN: { l1: 1000, l2: 0 },
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StarknetSwapInit = void 0;
+const base_1 = require("@atomiqlabs/base");
+const Utils_1 = require("../../../utils/Utils");
+const buffer_1 = require("buffer");
+const StarknetAction_1 = require("../../chain/StarknetAction");
+const StarknetSwapModule_1 = require("../StarknetSwapModule");
+const starknet_1 = require("starknet");
+const StarknetFees_1 = require("../../chain/modules/StarknetFees");
+const Initialize = [
+    { name: 'Swap hash', type: 'felt' },
+    { name: 'Offerer', type: 'ContractAddress' },
+    { name: 'Claimer', type: 'ContractAddress' },
+    { name: 'Token amount', type: 'TokenAmount' },
+    { name: 'Pay in', type: 'bool' },
+    { name: 'Pay out', type: 'bool' },
+    { name: 'Tracking reputation', type: 'bool' },
+    { name: 'Claim handler', type: 'ContractAddress' },
+    { name: 'Claim data', type: 'felt' },
+    { name: 'Refund handler', type: 'ContractAddress' },
+    { name: 'Refund data', type: 'felt' },
+    { name: 'Security deposit', type: 'TokenAmount' },
+    { name: 'Claimer bounty', type: 'TokenAmount' },
+    { name: 'Claim action hash', type: 'felt' },
+    { name: 'Deadline', type: 'timestamp' }
+];
+class StarknetSwapInit extends StarknetSwapModule_1.StarknetSwapModule {
+    /**
+     * bare Init action based on the data passed in swapData
+     *
+     * @param swapData
+     * @param timeout
+     * @param signature
+     * @private
+     */
+    Init(swapData, timeout, signature) {
+        return new StarknetAction_1.StarknetAction(swapData.payIn ? swapData.offerer : swapData.claimer, this.root, this.swapContract.populateTransaction.initialize(swapData.toEscrowStruct(), signature, timeout, swapData.extraData == null || swapData.extraData === "" ? [] : (0, Utils_1.bufferToBytes31Span)(buffer_1.Buffer.from(swapData.extraData, "hex")).map(Utils_1.toHex)), swapData.payIn ? StarknetSwapInit.GasCosts.INIT_PAY_IN : StarknetSwapInit.GasCosts.INIT);
+    }
+    /**
+     * Returns auth prefix to be used with a specific swap, payIn=true & payIn=false use different prefixes (these
+     *  actually have no meaning for the smart contract/solana program in the Solana case)
+     *
+     * @param swapData
+     * @private
+     */
+    getAuthPrefix(swapData) {
+        return swapData.isPayIn() ? "claim_initialize" : "initialize";
+    }
+    async preFetchForInitSignatureVerification() {
+        return {
+            pendingBlockTime: await this.root.Blocks.getBlockTime("pending")
+        };
+    }
+    /**
+     * Signs swap initialization authorization, using data from preFetchedBlockData if provided & still valid (subject
+     *  to SIGNATURE_PREFETCH_DATA_VALIDITY)
+     *
+     * @param signer
+     * @param swapData
+     * @param authorizationTimeout
+     * @public
+     */
+    async signSwapInitialization(signer, swapData, authorizationTimeout) {
+        const authTimeout = Math.floor(Date.now() / 1000) + authorizationTimeout;
+        const signature = await this.root.Signatures.signTypedMessage(signer, Initialize, "Initialize", {
+            "Swap hash": "0x" + swapData.getEscrowHash(),
+            "Offerer": swapData.offerer,
+            "Claimer": swapData.claimer,
+            "Token amount": {
+                token_address: swapData.token,
+                amount: starknet_1.cairo.uint256(swapData.amount)
+            },
+            "Pay in": swapData.isPayIn(),
+            "Pay out": swapData.isPayOut(),
+            "Tracking reputation": swapData.reputation,
+            "Refund handler": swapData.refundHandler,
+            "Claim handler": swapData.claimHandler,
+            "Claim data": "0x" + swapData.getClaimHash(),
+            "Refund data": swapData.refundData.startsWith("0x") ? swapData.refundData : "0x" + swapData.refundData,
+            "Security deposit": {
+                token_address: swapData.feeToken,
+                amount: starknet_1.cairo.uint256(swapData.securityDeposit)
+            },
+            "Claimer bounty": {
+                token_address: swapData.feeToken,
+                amount: starknet_1.cairo.uint256(swapData.claimerBounty)
+            },
+            "Claim action hash": 0n,
+            "Deadline": (0, Utils_1.toHex)(authTimeout)
+        });
+        return {
+            prefix: this.getAuthPrefix(swapData),
+            timeout: authTimeout.toString(10),
+            signature
+        };
+    }
+    /**
+     * Checks whether the provided signature data is valid, using preFetchedData if provided and still valid
+     *
+     * @param swapData
+     * @param timeout
+     * @param prefix
+     * @param signature
+     * @param preFetchData
+     * @public
+     */
+    async isSignatureValid(swapData, timeout, prefix, signature, preFetchData) {
+        const sender = swapData.isPayIn() ? swapData.offerer : swapData.claimer;
+        const signer = swapData.isPayIn() ? swapData.claimer : swapData.offerer;
+        if (!swapData.isPayIn() && await this.contract.isExpired(sender.toString(), swapData)) {
+            throw new base_1.SignatureVerificationError("Swap will expire too soon!");
+        }
+        if (prefix !== this.getAuthPrefix(swapData))
+            throw new base_1.SignatureVerificationError("Invalid prefix");
+        const currentTimestamp = BigInt(Math.floor(Date.now() / 1000));
+        const timeoutBN = BigInt(timeout);
+        const isExpired = (timeoutBN - currentTimestamp) < BigInt(this.contract.authGracePeriod);
+        if (isExpired)
+            throw new base_1.SignatureVerificationError("Authorization expired!");
+        if (await this.isSignatureExpired(timeout, preFetchData))
+            throw new base_1.SignatureVerificationError("Authorization expired!");
+        const valid = await this.root.Signatures.isValidSignature(signature, signer, Initialize, "Initialize", {
+            "Swap hash": "0x" + swapData.getEscrowHash(),
+            "Timeout": (0, Utils_1.toHex)(timeoutBN)
+        });
+        if (!valid)
+            throw new base_1.SignatureVerificationError("Invalid signature!");
+        return null;
+    }
+    /**
+     * Gets expiry of the provided signature data, this is a minimum of slot expiry & swap signature expiry
+     *
+     * @param timeout
+     * @public
+     */
+    async getSignatureExpiry(timeout) {
+        const now = Date.now();
+        const timeoutExpiryTime = (parseInt(timeout) - this.contract.authGracePeriod) * 1000;
+        if (timeoutExpiryTime < now)
+            return 0;
+        return timeoutExpiryTime;
+    }
+    /**
+     * Checks whether signature is expired for good, compares the timestamp to the current "pending" block timestamp
+     *
+     * @param timeout
+     * @param preFetchData
+     * @public
+     */
+    async isSignatureExpired(timeout, preFetchData) {
+        if (preFetchData == null || preFetchData.pendingBlockTime == null) {
+            preFetchData = await this.preFetchForInitSignatureVerification();
+        }
+        return preFetchData.pendingBlockTime > parseInt(timeout);
+    }
+    /**
+     * Creates init transaction with a valid signature from an LP
+     *
+     * @param swapData swap to initialize
+     * @param timeout init signature timeout
+     * @param prefix init signature prefix
+     * @param signature init signature
+     * @param skipChecks whether to skip signature validity checks
+     * @param feeRate fee rate to use for the transaction
+     */
+    async txsInit(swapData, timeout, prefix, signature, skipChecks, feeRate) {
+        const sender = swapData.isPayIn() ? swapData.offerer : swapData.claimer;
+        if (!skipChecks) {
+            const [_, payStatus] = await Promise.all([
+                (0, Utils_1.tryWithRetries)(() => this.isSignatureValid(swapData, timeout, prefix, signature), this.retryPolicy, (e) => e instanceof base_1.SignatureVerificationError),
+                (0, Utils_1.tryWithRetries)(() => this.contract.getCommitStatus(sender, swapData), this.retryPolicy)
+            ]);
+            if (payStatus !== base_1.SwapCommitStatus.NOT_COMMITED)
+                throw new base_1.SwapDataVerificationError("Invoice already being paid for or paid");
+        }
+        feeRate ?? (feeRate = await this.root.Fees.getFeeRate());
+        const initAction = this.Init(swapData, BigInt(timeout), JSON.parse(signature));
+        if (swapData.payIn)
+            initAction.addAction(this.root.Tokens.Approve(sender, this.swapContract.address, swapData.token, swapData.amount), 0); //Add erc20 approve
+        if (swapData.getTotalDeposit() !== 0n)
+            initAction.addAction(this.root.Tokens.Approve(sender, this.swapContract.address, swapData.feeToken, swapData.getTotalDeposit()), 0); //Add deposit erc20 approve
+        this.logger.debug("txsInitPayIn(): create swap init TX, swap: " + swapData.getClaimHash() +
+            " feerate: " + feeRate);
+        return [await initAction.tx(feeRate)];
+    }
+    /**
+     * Get the estimated solana fee of the init transaction, this includes the required deposit for creating swap PDA
+     *  and also deposit for ATAs
+     */
+    async getInitFee(swapData, feeRate) {
+        feeRate ?? (feeRate = await this.root.Fees.getFeeRate());
+        return StarknetFees_1.StarknetFees.getGasFee(swapData.payIn ? StarknetSwapInit.GasCosts.INIT_PAY_IN : StarknetSwapInit.GasCosts.INIT, feeRate);
+    }
+}
+exports.StarknetSwapInit = StarknetSwapInit;
+StarknetSwapInit.GasCosts = {
+    INIT: { l1DataGas: 750, l2Gas: 8000000, l1Gas: 0 },
+    INIT_PAY_IN: { l1DataGas: 500, l2Gas: 4800000, l1Gas: 0 },
+};