@atomiqlabs/chain-starknet 4.0.0-dev.4 → 4.0.0-dev.40

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

@@ -1,69 +1,69 @@
-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: {
-            l1DataGas: number;
-            l2Gas: number;
-            l1Gas: number;
-        };
-        APPROVE: {
-            l1DataGas: number;
-            l2Gas: number;
-            l1Gas: 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: {
+            l1DataGas: number;
+            l2Gas: number;
+            l1Gas: number;
+        };
+        APPROVE: {
+            l1DataGas: number;
+            l2Gas: number;
+            l1Gas: 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[]>;
+}

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

@@ -1,98 +1,102 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StarknetTokens = void 0;
-const StarknetModule_1 = require("../StarknetModule");
-const StarknetAction_1 = require("../StarknetAction");
-const ERC20Abi_1 = require("./ERC20Abi");
-const starknet_1 = require("starknet");
-const Utils_1 = require("../../../utils/Utils");
-const StarknetAddresses_1 = require("./StarknetAddresses");
-class StarknetTokens extends StarknetModule_1.StarknetModule {
-    getContract(address) {
-        return new starknet_1.Contract(ERC20Abi_1.ERC20Abi, address, this.root.provider).typedv2(ERC20Abi_1.ERC20Abi);
-    }
-    /**
-     * Action for transferring the erc20 token
-     *
-     * @param signer
-     * @param recipient
-     * @param token
-     * @param amount
-     * @constructor
-     * @private
-     */
-    Transfer(signer, recipient, token, amount) {
-        const erc20 = this.getContract(token);
-        return new StarknetAction_1.StarknetAction(signer, this.root, erc20.populateTransaction.transfer(recipient, amount), StarknetTokens.GasCosts.TRANSFER);
-    }
-    /**
-     * Approves spend of tokens for a specific spender
-     *
-     * @param signer
-     * @param spender
-     * @param token
-     * @param amount
-     * @constructor
-     * @private
-     */
-    Approve(signer, spender, token, amount) {
-        const erc20 = this.getContract(token);
-        return new StarknetAction_1.StarknetAction(signer, this.root, erc20.populateTransaction.approve(spender, amount), StarknetTokens.GasCosts.APPROVE);
-    }
-    ///////////////////
-    //// Tokens
-    /**
-     * Checks if the provided string is a valid starknet token
-     *
-     * @param token
-     */
-    isValidToken(token) {
-        return StarknetAddresses_1.StarknetAddresses.isValidAddress(token);
-    }
-    /**
-     * Returns the token balance of the address
-     *
-     * @param address
-     * @param token
-     */
-    async getTokenBalance(address, token) {
-        const erc20 = this.getContract(token);
-        const balance = await erc20.balance_of(address);
-        const balanceBN = (0, Utils_1.toBigInt)(balance);
-        this.logger.debug("getTokenBalance(): token balance fetched, token: " + token +
-            " address: " + address + " amount: " + balanceBN.toString());
-        return balanceBN;
-    }
-    /**
-     * Returns the native currency address, return the default used by the fee module
-     */
-    getNativeCurrencyAddress() {
-        return this.root.Fees.getDefaultGasToken();
-    }
-    ///////////////////
-    //// Transfers
-    /**
-     * 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
-     */
-    async txsTransfer(signer, token, amount, recipient, feeRate) {
-        const action = this.Transfer(signer, recipient, token, amount);
-        feeRate = feeRate ?? await this.root.Fees.getFeeRate();
-        this.logger.debug("txsTransfer(): transfer TX created, recipient: " + recipient.toString() +
-            " token: " + token.toString() + " amount: " + amount.toString(10));
-        return [await action.tx(feeRate)];
-    }
-}
-exports.StarknetTokens = StarknetTokens;
-StarknetTokens.ERC20_ETH = "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
-StarknetTokens.ERC20_STRK = "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d";
-StarknetTokens.GasCosts = {
-    TRANSFER: { l1DataGas: 400, l2Gas: 4000000, l1Gas: 0 },
-    APPROVE: { l1DataGas: 400, l2Gas: 4000000, l1Gas: 0 }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StarknetTokens = void 0;
+const StarknetModule_1 = require("../StarknetModule");
+const StarknetAction_1 = require("../StarknetAction");
+const ERC20Abi_1 = require("./ERC20Abi");
+const starknet_1 = require("starknet");
+const Utils_1 = require("../../../utils/Utils");
+const StarknetAddresses_1 = require("./StarknetAddresses");
+class StarknetTokens extends StarknetModule_1.StarknetModule {
+    getContract(address) {
+        return new starknet_1.Contract({
+            abi: ERC20Abi_1.ERC20Abi,
+            address: address,
+            providerOrAccount: this.root.provider
+        }).typedv2(ERC20Abi_1.ERC20Abi);
+    }
+    /**
+     * Action for transferring the erc20 token
+     *
+     * @param signer
+     * @param recipient
+     * @param token
+     * @param amount
+     * @constructor
+     * @private
+     */
+    Transfer(signer, recipient, token, amount) {
+        const erc20 = this.getContract(token);
+        return new StarknetAction_1.StarknetAction(signer, this.root, erc20.populateTransaction.transfer(recipient, amount), StarknetTokens.GasCosts.TRANSFER);
+    }
+    /**
+     * Approves spend of tokens for a specific spender
+     *
+     * @param signer
+     * @param spender
+     * @param token
+     * @param amount
+     * @constructor
+     * @private
+     */
+    Approve(signer, spender, token, amount) {
+        const erc20 = this.getContract(token);
+        return new StarknetAction_1.StarknetAction(signer, this.root, erc20.populateTransaction.approve(spender, amount), StarknetTokens.GasCosts.APPROVE);
+    }
+    ///////////////////
+    //// Tokens
+    /**
+     * Checks if the provided string is a valid starknet token
+     *
+     * @param token
+     */
+    isValidToken(token) {
+        return StarknetAddresses_1.StarknetAddresses.isValidAddress(token);
+    }
+    /**
+     * Returns the token balance of the address
+     *
+     * @param address
+     * @param token
+     */
+    async getTokenBalance(address, token) {
+        const erc20 = this.getContract(token);
+        const balance = await erc20.balance_of(address);
+        const balanceBN = (0, Utils_1.toBigInt)(balance);
+        this.logger.debug("getTokenBalance(): token balance fetched, token: " + token +
+            " address: " + address + " amount: " + balanceBN.toString());
+        return balanceBN;
+    }
+    /**
+     * Returns the native currency address, return the default used by the fee module
+     */
+    getNativeCurrencyAddress() {
+        return this.root.Fees.getDefaultGasToken();
+    }
+    ///////////////////
+    //// Transfers
+    /**
+     * 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
+     */
+    async txsTransfer(signer, token, amount, recipient, feeRate) {
+        const action = this.Transfer(signer, recipient, token, amount);
+        feeRate = feeRate ?? await this.root.Fees.getFeeRate();
+        this.logger.debug("txsTransfer(): transfer TX created, recipient: " + recipient.toString() +
+            " token: " + token.toString() + " amount: " + amount.toString(10));
+        return [await action.tx(feeRate)];
+    }
+}
+exports.StarknetTokens = StarknetTokens;
+StarknetTokens.ERC20_ETH = "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
+StarknetTokens.ERC20_STRK = "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d";
+StarknetTokens.GasCosts = {
+    TRANSFER: { l1DataGas: 400, l2Gas: 4000000, l1Gas: 0 },
+    APPROVE: { l1DataGas: 400, l2Gas: 4000000, l1Gas: 0 }
+};

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

@@ -1,93 +1,111 @@
-import { StarknetModule } from "../StarknetModule";
-import { Call, DeployAccountContractPayload, DeployAccountContractTransaction, Invocation, InvocationsSignerDetails, BigNumberish } from "starknet";
-import { StarknetSigner } from "../../wallet/StarknetSigner";
-export type StarknetTx = ({
-    type: "DEPLOY_ACCOUNT";
-    tx: DeployAccountContractPayload;
-    signed?: DeployAccountContractTransaction;
-} | {
-    type: "INVOKE";
-    tx: Array<Call>;
-    signed?: Invocation;
-}) & {
-    details: InvocationsSignerDetails & {
-        maxFee?: BigNumberish;
-    };
-    txId?: string;
-};
-export declare class StarknetTransactions extends StarknetModule {
-    private readonly latestConfirmedNonces;
-    private cbkBeforeTxSigned;
-    /**
-     * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
-     *  the transaction at regular interval
-     *
-     * @param tx starknet transaction to wait for confirmation for & keep re-sending until it confirms
-     * @param abortSignal signal to abort waiting for tx confirmation
-     * @private
-     */
-    private confirmTransaction;
-    /**
-     * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
-     *
-     * @param signer
-     * @param txs
-     * @private
-     */
-    private prepareTransactions;
-    /**
-     * Sends out a signed transaction to the RPC
-     *
-     * @param tx Starknet tx to send
-     * @param onBeforePublish a callback called before every transaction is published
-     * @param signer
-     * @private
-     */
-    private sendSignedTransaction;
-    /**
-     * Prepares, signs , sends (in parallel or sequentially) & optionally waits for confirmation
-     *  of a batch of starknet transactions
-     *
-     * @param signer
-     * @param txs transactions to send
-     * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
-     *  are re-sent at regular intervals)
-     * @param abortSignal abort signal to abort waiting for transaction confirmations
-     * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
-     *  are executed in order)
-     * @param onBeforePublish a callback called before every transaction is published
-     */
-    sendAndConfirm(signer: StarknetSigner, txs: StarknetTx[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]>;
-    /**
-     * Serializes the solana transaction, saves the transaction, signers & last valid blockheight
-     *
-     * @param tx
-     */
-    serializeTx(tx: StarknetTx): Promise<string>;
-    /**
-     * Deserializes saved solana transaction, extracting the transaction, signers & last valid blockheight
-     *
-     * @param txData
-     */
-    deserializeTx(txData: string): Promise<StarknetTx>;
-    /**
-     * Gets the status of the raw starknet transaction
-     *
-     * @param tx
-     */
-    getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted">;
-    /**
-     * Gets the status of the starknet transaction with a specific txId
-     *
-     * @param txId
-     */
-    _getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted" | "rejected">;
-    /**
-     * Gets the status of the starknet transaction with a specific txId
-     *
-     * @param txId
-     */
-    getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted">;
-    onBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): void;
-    offBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): boolean;
-}
+import { StarknetModule } from "../StarknetModule";
+import { Call, DeployAccountContractPayload, DeployAccountContractTransaction, Invocation, InvocationsSignerDetails, BigNumberish, BlockTag } from "starknet";
+import { StarknetSigner } from "../../wallet/StarknetSigner";
+export type StarknetTxBase = {
+    details: InvocationsSignerDetails & {
+        maxFee?: BigNumberish;
+    };
+    txId?: string;
+};
+export type StarknetTxInvoke = StarknetTxBase & {
+    type: "INVOKE";
+    tx: Array<Call>;
+    signed?: Invocation;
+};
+export declare function isStarknetTxInvoke(obj: any): obj is StarknetTxInvoke;
+export type StarknetTxDeployAccount = StarknetTxBase & {
+    type: "DEPLOY_ACCOUNT";
+    tx: DeployAccountContractPayload;
+    signed?: DeployAccountContractTransaction;
+};
+export declare function isStarknetTxDeployAccount(obj: any): obj is StarknetTxDeployAccount;
+export type StarknetTx = StarknetTxInvoke | StarknetTxDeployAccount;
+export declare class StarknetTransactions extends StarknetModule {
+    private readonly latestConfirmedNonces;
+    private readonly latestPendingNonces;
+    private readonly latestSignedNonces;
+    readonly _cbksBeforeTxReplace: ((oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>)[];
+    private readonly cbksBeforeTxSigned;
+    readonly _knownTxSet: Set<string>;
+    sendTransaction(tx: StarknetTx): Promise<string>;
+    /**
+     * Returns the nonce of the account or 0, if the account is not deployed yet
+     *
+     * @param address
+     * @param blockTag
+     */
+    getNonce(address: string, blockTag?: BlockTag): Promise<bigint>;
+    /**
+     * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
+     *  the transaction at regular interval
+     *
+     * @param tx starknet transaction to wait for confirmation for & keep re-sending until it confirms
+     * @param abortSignal signal to abort waiting for tx confirmation
+     * @private
+     */
+    private confirmTransaction;
+    /**
+     * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
+     *
+     * @param signer
+     * @param txs
+     * @private
+     */
+    private prepareTransactions;
+    /**
+     * Sends out a signed transaction to the RPC
+     *
+     * @param tx Starknet tx to send
+     * @param onBeforePublish a callback called before every transaction is published
+     * @private
+     */
+    private sendSignedTransaction;
+    /**
+     * Prepares, signs , sends (in parallel or sequentially) & optionally waits for confirmation
+     *  of a batch of starknet transactions
+     *
+     * @param signer
+     * @param _txs transactions to send
+     * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
+     *  are re-sent at regular intervals)
+     * @param abortSignal abort signal to abort waiting for transaction confirmations
+     * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
+     *  are executed in order)
+     * @param onBeforePublish a callback called before every transaction is published
+     */
+    sendAndConfirm(signer: StarknetSigner, _txs: StarknetTx[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]>;
+    /**
+     * Serializes the starknet transaction, saves the transaction, signers & last valid blockheight
+     *
+     * @param tx
+     */
+    static serializeTx(tx: StarknetTx): string;
+    /**
+     * Deserializes saved starknet transaction, extracting the transaction, signers & last valid blockheight
+     *
+     * @param txData
+     */
+    static deserializeTx(txData: string): StarknetTx;
+    /**
+     * Gets the status of the raw starknet transaction
+     *
+     * @param tx
+     */
+    getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted">;
+    /**
+     * Gets the status of the starknet transaction with a specific txId
+     *
+     * @param txId
+     */
+    _getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted" | "rejected">;
+    /**
+     * Gets the status of the starknet transaction with a specific txId
+     *
+     * @param txId
+     */
+    getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted">;
+    onBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): void;
+    offBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): boolean;
+    onBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): void;
+    offBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): boolean;
+}