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

package/dist/starknet/chain/modules/StarknetFees.js

@@ -1,100 +1,100 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StarknetFees = void 0;
-const Utils_1 = require("../../../utils/Utils");
-const StarknetTokens_1 = require("./StarknetTokens");
-const MAX_FEE_AGE = 5000;
-class StarknetFees {
-    constructor(provider, gasToken = "STRK", maxFeeRate = gasToken === "ETH" ? 100000000000 /*100 GWei*/ : 1000000000000000 /*100 * 10000 GWei*/, feeMultiplier = 1.25, da) {
-        this.logger = (0, Utils_1.getLogger)("StarknetFees: ");
-        this.blockFeeCache = null;
-        this.provider = provider;
-        this.gasToken = gasToken;
-        this.maxFeeRate = BigInt(maxFeeRate);
-        this.feeDA = da?.fee ?? "L1";
-        this.nonceDA = da?.nonce ?? "L1";
-        this.feeMultiplierPPM = BigInt(Math.floor(feeMultiplier * 1000000));
-    }
-    /**
-     * Gets starknet fee rate
-     *
-     * @private
-     * @returns {Promise<BN>} L1 gas price denominated in Wei
-     */
-    async _getFeeRate() {
-        const block = await this.provider.getBlockWithTxHashes("latest");
-        let l1GasCost = (0, Utils_1.toBigInt)(this.gasToken === "ETH" ? block.l1_gas_price.price_in_wei : block.l1_gas_price.price_in_fri);
-        l1GasCost = l1GasCost * this.feeMultiplierPPM / 1000000n;
-        this.logger.debug("_getFeeRate(): L1 fee rate: " + l1GasCost.toString(10));
-        return l1GasCost;
-    }
-    /**
-     * Gets the gas price with caching, format: <gas price in Wei>;<transaction version: v1/v3>
-     *
-     * @private
-     */
-    async getFeeRate() {
-        if (this.blockFeeCache == null || Date.now() - this.blockFeeCache.timestamp > MAX_FEE_AGE) {
-            let obj = {
-                timestamp: Date.now(),
-                feeRate: null
-            };
-            obj.feeRate = this._getFeeRate().catch(e => {
-                if (this.blockFeeCache === obj)
-                    this.blockFeeCache = null;
-                throw e;
-            });
-            this.blockFeeCache = obj;
-        }
-        let feeRate = await this.blockFeeCache.feeRate;
-        if (feeRate > this.maxFeeRate)
-            feeRate = this.maxFeeRate;
-        const fee = feeRate.toString(10) + ";" + (this.gasToken === "ETH" ? "v1" : "v3");
-        this.logger.debug("getFeeRate(): calculated fee: " + fee);
-        return fee;
-    }
-    getDefaultGasToken() {
-        return this.gasToken === "ETH" ? StarknetTokens_1.StarknetTokens.ERC20_ETH : StarknetTokens_1.StarknetTokens.ERC20_STRK;
-    }
-    /**
-     * Calculates the total gas fee fee paid for a given gas limit at a given fee rate
-     *
-     * @param gas
-     * @param feeRate
-     */
-    static getGasFee(gas, feeRate) {
-        if (feeRate == null)
-            return 0n;
-        const arr = feeRate.split(";");
-        const gasPrice = BigInt(arr[0]);
-        return gasPrice * BigInt(gas);
-    }
-    static getGasToken(feeRate) {
-        if (feeRate == null)
-            return null;
-        const arr = feeRate.split(";");
-        const txVersion = arr[1];
-        return txVersion === "v1" ? StarknetTokens_1.StarknetTokens.ERC20_ETH : StarknetTokens_1.StarknetTokens.ERC20_STRK;
-    }
-    getFeeDetails(L1GasLimit, L2GasLimit, feeRate) {
-        if (feeRate == null)
-            return null;
-        const arr = feeRate.split(";");
-        const gasPrice = BigInt(arr[0]);
-        const version = arr[1];
-        const maxFee = (0, Utils_1.toHex)(BigInt(L1GasLimit) * gasPrice, 16);
-        return {
-            maxFee: maxFee,
-            version: version === "v1" ? "0x1" : "0x3",
-            resourceBounds: {
-                l1_gas: { max_amount: (0, Utils_1.toHex)(L1GasLimit, 16), max_price_per_unit: (0, Utils_1.toHex)(gasPrice, 16) },
-                l2_gas: { max_amount: "0x0", max_price_per_unit: "0x0" }
-            },
-            tip: "0x0",
-            paymasterData: [],
-            nonceDataAvailabilityMode: this.nonceDA,
-            feeDataAvailabilityMode: this.feeDA
-        };
-    }
-}
-exports.StarknetFees = StarknetFees;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StarknetFees = void 0;
+const Utils_1 = require("../../../utils/Utils");
+const StarknetTokens_1 = require("./StarknetTokens");
+const MAX_FEE_AGE = 5000;
+class StarknetFees {
+    constructor(provider, gasToken = "STRK", maxFeeRate = gasToken === "ETH" ? 100000000000 /*100 GWei*/ : 1000000000000000 /*100 * 10000 GWei*/, feeMultiplier = 1.25, da) {
+        this.logger = (0, Utils_1.getLogger)("StarknetFees: ");
+        this.blockFeeCache = null;
+        this.provider = provider;
+        this.gasToken = gasToken;
+        this.maxFeeRate = BigInt(maxFeeRate);
+        this.feeDA = da?.fee ?? "L1";
+        this.nonceDA = da?.nonce ?? "L1";
+        this.feeMultiplierPPM = BigInt(Math.floor(feeMultiplier * 1000000));
+    }
+    /**
+     * Gets starknet fee rate
+     *
+     * @private
+     * @returns {Promise<BN>} L1 gas price denominated in Wei
+     */
+    async _getFeeRate() {
+        const block = await this.provider.getBlockWithTxHashes("latest");
+        let l1GasCost = (0, Utils_1.toBigInt)(this.gasToken === "ETH" ? block.l1_gas_price.price_in_wei : block.l1_gas_price.price_in_fri);
+        l1GasCost = l1GasCost * this.feeMultiplierPPM / 1000000n;
+        this.logger.debug("_getFeeRate(): L1 fee rate: " + l1GasCost.toString(10));
+        return l1GasCost;
+    }
+    /**
+     * Gets the gas price with caching, format: <gas price in Wei>;<transaction version: v1/v3>
+     *
+     * @private
+     */
+    async getFeeRate() {
+        if (this.blockFeeCache == null || Date.now() - this.blockFeeCache.timestamp > MAX_FEE_AGE) {
+            let obj = {
+                timestamp: Date.now(),
+                feeRate: null
+            };
+            obj.feeRate = this._getFeeRate().catch(e => {
+                if (this.blockFeeCache === obj)
+                    this.blockFeeCache = null;
+                throw e;
+            });
+            this.blockFeeCache = obj;
+        }
+        let feeRate = await this.blockFeeCache.feeRate;
+        if (feeRate > this.maxFeeRate)
+            feeRate = this.maxFeeRate;
+        const fee = feeRate.toString(10) + ";" + (this.gasToken === "ETH" ? "v1" : "v3");
+        this.logger.debug("getFeeRate(): calculated fee: " + fee);
+        return fee;
+    }
+    getDefaultGasToken() {
+        return this.gasToken === "ETH" ? StarknetTokens_1.StarknetTokens.ERC20_ETH : StarknetTokens_1.StarknetTokens.ERC20_STRK;
+    }
+    /**
+     * Calculates the total gas fee fee paid for a given gas limit at a given fee rate
+     *
+     * @param gas
+     * @param feeRate
+     */
+    static getGasFee(gas, feeRate) {
+        if (feeRate == null)
+            return 0n;
+        const arr = feeRate.split(";");
+        const gasPrice = BigInt(arr[0]);
+        return gasPrice * BigInt(gas);
+    }
+    static getGasToken(feeRate) {
+        if (feeRate == null)
+            return null;
+        const arr = feeRate.split(";");
+        const txVersion = arr[1];
+        return txVersion === "v1" ? StarknetTokens_1.StarknetTokens.ERC20_ETH : StarknetTokens_1.StarknetTokens.ERC20_STRK;
+    }
+    getFeeDetails(L1GasLimit, L2GasLimit, feeRate) {
+        if (feeRate == null)
+            return null;
+        const arr = feeRate.split(";");
+        const gasPrice = BigInt(arr[0]);
+        const version = arr[1];
+        const maxFee = (0, Utils_1.toHex)(BigInt(L1GasLimit) * gasPrice, 16);
+        return {
+            maxFee: maxFee,
+            version: version === "v1" ? "0x1" : "0x3",
+            resourceBounds: {
+                l1_gas: { max_amount: (0, Utils_1.toHex)(L1GasLimit, 16), max_price_per_unit: (0, Utils_1.toHex)(gasPrice, 16) },
+                l2_gas: { max_amount: "0x0", max_price_per_unit: "0x0" }
+            },
+            tip: "0x0",
+            paymasterData: [],
+            nonceDataAvailabilityMode: this.nonceDA,
+            feeDataAvailabilityMode: this.feeDA
+        };
+    }
+}
+exports.StarknetFees = StarknetFees;

package/dist/starknet/chain/modules/StarknetSignatures.d.ts

@@ -1,29 +1,29 @@
-import { Buffer } from "buffer";
-import { StarknetModule } from "../StarknetModule";
-import { StarknetSigner } from "../../wallet/StarknetSigner";
-import { StarknetType, TypedData } from "starknet";
-import { StarknetChainInterface } from "../StarknetChainInterface";
-export declare class StarknetSignatures extends StarknetModule {
-    private readonly domain;
-    constructor(root: StarknetChainInterface, domainName?: string);
-    getTypedMessage(type: StarknetType[], typeName: string, message: object): TypedData;
-    signTypedMessage(signer: StarknetSigner, type: StarknetType[], typeName: string, message: object): Promise<string>;
-    isValidSignature(signature: string, address: string, type: StarknetType[], typeName: string, message: object): Promise<boolean>;
-    /**
-     * Produces a signature over the sha256 of a specified data Buffer, only works with providers which
-     *  expose their private key (i.e. backend based, not browser wallet based)
-     *
-     * @param signer
-     * @param data data to sign
-     */
-    getDataSignature(signer: StarknetSigner, data: Buffer): Promise<string>;
-    /**
-     * Checks whether a signature is a valid signature produced by the account over a data message (computes
-     *  sha256 hash of the message)
-     *
-     * @param data signed data
-     * @param signature data signature
-     * @param address public key of the signer
-     */
-    isValidDataSignature(data: Buffer, signature: string, address: string): Promise<boolean>;
-}
+import { Buffer } from "buffer";
+import { StarknetModule } from "../StarknetModule";
+import { StarknetSigner } from "../../wallet/StarknetSigner";
+import { StarknetType, TypedData } from "starknet";
+import { StarknetChainInterface } from "../StarknetChainInterface";
+export declare class StarknetSignatures extends StarknetModule {
+    private readonly domain;
+    constructor(root: StarknetChainInterface, domainName?: string);
+    getTypedMessage(type: StarknetType[], typeName: string, message: object): TypedData;
+    signTypedMessage(signer: StarknetSigner, type: StarknetType[], typeName: string, message: object): Promise<string>;
+    isValidSignature(signature: string, address: string, type: StarknetType[], typeName: string, message: object): Promise<boolean>;
+    /**
+     * Produces a signature over the sha256 of a specified data Buffer, only works with providers which
+     *  expose their private key (i.e. backend based, not browser wallet based)
+     *
+     * @param signer
+     * @param data data to sign
+     */
+    getDataSignature(signer: StarknetSigner, data: Buffer): Promise<string>;
+    /**
+     * Checks whether a signature is a valid signature produced by the account over a data message (computes
+     *  sha256 hash of the message)
+     *
+     * @param data signed data
+     * @param signature data signature
+     * @param address public key of the signer
+     */
+    isValidDataSignature(data: Buffer, signature: string, address: string): Promise<boolean>;
+}

package/dist/starknet/chain/modules/StarknetSignatures.js

@@ -1,72 +1,72 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StarknetSignatures = void 0;
-const buffer_1 = require("buffer");
-const StarknetModule_1 = require("../StarknetModule");
-const starknet_1 = require("starknet");
-const Utils_1 = require("../../../utils/Utils");
-const sha2_1 = require("@noble/hashes/sha2");
-const StarknetDomain = [
-    { name: 'name', type: 'shortstring' },
-    { name: 'version', type: 'shortstring' },
-    { name: 'chainId', type: 'shortstring' },
-    { name: 'revision', type: 'shortstring' },
-];
-const DataHash = [
-    { name: 'Data hash', type: 'u256' }
-];
-class StarknetSignatures extends StarknetModule_1.StarknetModule {
-    constructor(root, domainName = "atomiq.exchange") {
-        super(root);
-        this.domain = {
-            name: domainName,
-            version: '1',
-            chainId: starknet_1.shortString.decodeShortString(root.starknetChainId),
-            revision: '1'
-        };
-    }
-    getTypedMessage(type, typeName, message) {
-        return {
-            types: {
-                StarknetDomain,
-                [typeName]: type,
-            },
-            primaryType: typeName,
-            domain: this.domain,
-            message
-        };
-    }
-    async signTypedMessage(signer, type, typeName, message) {
-        const signature = await signer.account.signMessage(this.getTypedMessage(type, typeName, message));
-        return JSON.stringify(starknet_1.stark.formatSignature(signature));
-    }
-    async isValidSignature(signature, address, type, typeName, message) {
-        return new starknet_1.Account(this.provider, address, null).verifyMessage(this.getTypedMessage(type, typeName, message), JSON.parse(signature));
-    }
-    ///////////////////
-    //// Data signatures
-    /**
-     * Produces a signature over the sha256 of a specified data Buffer, only works with providers which
-     *  expose their private key (i.e. backend based, not browser wallet based)
-     *
-     * @param signer
-     * @param data data to sign
-     */
-    getDataSignature(signer, data) {
-        const buff = buffer_1.Buffer.from((0, sha2_1.sha256)(data));
-        return this.signTypedMessage(signer, DataHash, 'DataHash', { "Data hash": starknet_1.cairo.uint256((0, Utils_1.toHex)(buff)) });
-    }
-    /**
-     * Checks whether a signature is a valid signature produced by the account over a data message (computes
-     *  sha256 hash of the message)
-     *
-     * @param data signed data
-     * @param signature data signature
-     * @param address public key of the signer
-     */
-    isValidDataSignature(data, signature, address) {
-        const buff = buffer_1.Buffer.from((0, sha2_1.sha256)(data));
-        return this.isValidSignature(signature, address, DataHash, 'DataHash', { "Data hash": starknet_1.cairo.uint256((0, Utils_1.toHex)(buff)) });
-    }
-}
-exports.StarknetSignatures = StarknetSignatures;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StarknetSignatures = void 0;
+const buffer_1 = require("buffer");
+const StarknetModule_1 = require("../StarknetModule");
+const starknet_1 = require("starknet");
+const Utils_1 = require("../../../utils/Utils");
+const sha2_1 = require("@noble/hashes/sha2");
+const StarknetDomain = [
+    { name: 'name', type: 'shortstring' },
+    { name: 'version', type: 'shortstring' },
+    { name: 'chainId', type: 'shortstring' },
+    { name: 'revision', type: 'shortstring' },
+];
+const DataHash = [
+    { name: 'Data hash', type: 'u256' }
+];
+class StarknetSignatures extends StarknetModule_1.StarknetModule {
+    constructor(root, domainName = "atomiq.exchange") {
+        super(root);
+        this.domain = {
+            name: domainName,
+            version: '1',
+            chainId: starknet_1.shortString.decodeShortString(root.starknetChainId),
+            revision: '1'
+        };
+    }
+    getTypedMessage(type, typeName, message) {
+        return {
+            types: {
+                StarknetDomain,
+                [typeName]: type,
+            },
+            primaryType: typeName,
+            domain: this.domain,
+            message
+        };
+    }
+    async signTypedMessage(signer, type, typeName, message) {
+        const signature = await signer.account.signMessage(this.getTypedMessage(type, typeName, message));
+        return JSON.stringify(starknet_1.stark.formatSignature(signature));
+    }
+    async isValidSignature(signature, address, type, typeName, message) {
+        return new starknet_1.Account(this.provider, address, null).verifyMessage(this.getTypedMessage(type, typeName, message), JSON.parse(signature));
+    }
+    ///////////////////
+    //// Data signatures
+    /**
+     * Produces a signature over the sha256 of a specified data Buffer, only works with providers which
+     *  expose their private key (i.e. backend based, not browser wallet based)
+     *
+     * @param signer
+     * @param data data to sign
+     */
+    getDataSignature(signer, data) {
+        const buff = buffer_1.Buffer.from((0, sha2_1.sha256)(data));
+        return this.signTypedMessage(signer, DataHash, 'DataHash', { "Data hash": starknet_1.cairo.uint256((0, Utils_1.toHex)(buff)) });
+    }
+    /**
+     * Checks whether a signature is a valid signature produced by the account over a data message (computes
+     *  sha256 hash of the message)
+     *
+     * @param data signed data
+     * @param signature data signature
+     * @param address public key of the signer
+     */
+    isValidDataSignature(data, signature, address) {
+        const buff = buffer_1.Buffer.from((0, sha2_1.sha256)(data));
+        return this.isValidSignature(signature, address, DataHash, 'DataHash', { "Data hash": starknet_1.cairo.uint256((0, Utils_1.toHex)(buff)) });
+    }
+}
+exports.StarknetSignatures = StarknetSignatures;

package/dist/starknet/chain/modules/StarknetTokens.d.ts

@@ -1,67 +1,67 @@
-import { StarknetModule } from "../StarknetModule";
-import { StarknetAction } from "../StarknetAction";
-export declare class StarknetTokens extends StarknetModule {
-    static readonly ERC20_ETH = "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
-    static readonly ERC20_STRK = "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d";
-    static readonly GasCosts: {
-        TRANSFER: {
-            l1: number;
-            l2: number;
-        };
-        APPROVE: {
-            l1: number;
-            l2: number;
-        };
-    };
-    private getContract;
-    /**
-     * Action for transferring the erc20 token
-     *
-     * @param signer
-     * @param recipient
-     * @param token
-     * @param amount
-     * @constructor
-     * @private
-     */
-    private Transfer;
-    /**
-     * Approves spend of tokens for a specific spender
-     *
-     * @param signer
-     * @param spender
-     * @param token
-     * @param amount
-     * @constructor
-     * @private
-     */
-    Approve(signer: string, spender: string, token: string, amount: bigint): StarknetAction;
-    /**
-     * Checks if the provided string is a valid starknet token
-     *
-     * @param token
-     */
-    isValidToken(token: string): boolean;
-    /**
-     * Returns the token balance of the address
-     *
-     * @param address
-     * @param token
-     */
-    getTokenBalance(address: string, token: string): Promise<bigint>;
-    /**
-     * Returns the native currency address, return the default used by the fee module
-     */
-    getNativeCurrencyAddress(): string;
-    /**
-     * Creates transactions for sending the over the tokens
-     *
-     * @param signer
-     * @param token token to send
-     * @param amount amount of the token to send
-     * @param recipient recipient's address
-     * @param feeRate fee rate to use for the transactions
-     * @private
-     */
-    txsTransfer(signer: string, token: string, amount: bigint, recipient: string, feeRate?: string): Promise<import("./StarknetTransactions").StarknetTx[]>;
-}
+import { StarknetModule } from "../StarknetModule";
+import { StarknetAction } from "../StarknetAction";
+export declare class StarknetTokens extends StarknetModule {
+    static readonly ERC20_ETH = "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
+    static readonly ERC20_STRK = "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d";
+    static readonly GasCosts: {
+        TRANSFER: {
+            l1: number;
+            l2: number;
+        };
+        APPROVE: {
+            l1: number;
+            l2: number;
+        };
+    };
+    private getContract;
+    /**
+     * Action for transferring the erc20 token
+     *
+     * @param signer
+     * @param recipient
+     * @param token
+     * @param amount
+     * @constructor
+     * @private
+     */
+    private Transfer;
+    /**
+     * Approves spend of tokens for a specific spender
+     *
+     * @param signer
+     * @param spender
+     * @param token
+     * @param amount
+     * @constructor
+     * @private
+     */
+    Approve(signer: string, spender: string, token: string, amount: bigint): StarknetAction;
+    /**
+     * Checks if the provided string is a valid starknet token
+     *
+     * @param token
+     */
+    isValidToken(token: string): boolean;
+    /**
+     * Returns the token balance of the address
+     *
+     * @param address
+     * @param token
+     */
+    getTokenBalance(address: string, token: string): Promise<bigint>;
+    /**
+     * Returns the native currency address, return the default used by the fee module
+     */
+    getNativeCurrencyAddress(): string;
+    /**
+     * Creates transactions for sending the over the tokens
+     *
+     * @param signer
+     * @param token token to send
+     * @param amount amount of the token to send
+     * @param recipient recipient's address
+     * @param feeRate fee rate to use for the transactions
+     * @private
+     */
+    txsTransfer(signer: string, token: string, amount: bigint, recipient: string, feeRate?: string): Promise<import("./StarknetTransactions").StarknetTx[]>;
+}