@atomiqlabs/chain-evm 1.0.0-dev.22

package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMBtcStoredHeader = void 0;
+const base_1 = require("@atomiqlabs/base");
+const EVMBtcHeader_1 = require("./EVMBtcHeader");
+const buffer_1 = require("buffer");
+const ethers_1 = require("ethers");
+class EVMBtcStoredHeader {
+    constructor(obj) {
+        this.blockheader = obj.blockheader instanceof EVMBtcHeader_1.EVMBtcHeader ? obj.blockheader : new EVMBtcHeader_1.EVMBtcHeader(obj.blockheader);
+        this.blockHash = obj.blockHash;
+        this.chainWork = obj.chainWork;
+        this.blockHeight = obj.blockHeight;
+        this.lastDiffAdjustment = obj.lastDiffAdjustment;
+        this.prevBlockTimestamps = obj.prevBlockTimestamps;
+    }
+    getBlockheight() {
+        return this.blockHeight;
+    }
+    getChainWork() {
+        return buffer_1.Buffer.from(this.chainWork.toString(16).padStart(64, "0"), "hex");
+    }
+    getHeader() {
+        return this.blockheader;
+    }
+    getLastDiffAdjustment() {
+        return this.lastDiffAdjustment;
+    }
+    getPrevBlockTimestamps() {
+        return this.prevBlockTimestamps;
+    }
+    getBlockHash() {
+        return buffer_1.Buffer.from([...this.blockHash]).reverse();
+    }
+    /**
+     * Computes prevBlockTimestamps for a next block, shifting the old block timestamps to the left & appending
+     *  this block's timestamp to the end
+     *
+     * @private
+     */
+    computeNextBlockTimestamps() {
+        const prevBlockTimestamps = [...this.prevBlockTimestamps];
+        for (let i = 1; i < 10; i++) {
+            prevBlockTimestamps[i - 1] = prevBlockTimestamps[i];
+        }
+        prevBlockTimestamps[9] = this.blockheader.getTimestamp();
+        return prevBlockTimestamps;
+    }
+    /**
+     * Computes total chain work after a new header with "nbits" is added to the chain
+     *
+     * @param nbits
+     * @private
+     */
+    computeNextChainWork(nbits) {
+        return this.chainWork + base_1.BigIntBufferUtils.fromBuffer(base_1.StatePredictorUtils.getChainwork(nbits));
+    }
+    /**
+     * Computes lastDiffAdjustment, this changes only once every DIFF_ADJUSTMENT_PERIOD blocks
+     *
+     * @param headerTimestamp
+     * @private
+     */
+    computeNextLastDiffAdjustment(headerTimestamp) {
+        const blockheight = this.blockHeight + 1;
+        let lastDiffAdjustment = this.lastDiffAdjustment;
+        if (blockheight % base_1.StatePredictorUtils.DIFF_ADJUSTMENT_PERIOD === 0) {
+            lastDiffAdjustment = headerTimestamp;
+        }
+        return lastDiffAdjustment;
+    }
+    computeNext(header) {
+        header.previousBlockhash = this.blockHash;
+        return new EVMBtcStoredHeader({
+            chainWork: this.computeNextChainWork(header.getNbits()),
+            prevBlockTimestamps: this.computeNextBlockTimestamps(),
+            blockHeight: this.blockHeight + 1,
+            lastDiffAdjustment: this.computeNextLastDiffAdjustment(header.getTimestamp()),
+            blockHash: header.getHash(),
+            blockheader: header
+        });
+    }
+    getCommitHash() {
+        return (0, ethers_1.keccak256)(this.serialize());
+    }
+    serialize() {
+        const buffer = buffer_1.Buffer.alloc(160);
+        this.blockheader.serialize().copy(buffer, 0, 0, 80);
+        base_1.BigIntBufferUtils.toBuffer(this.chainWork, "be", 32).copy(buffer, 80, 0, 32);
+        buffer.writeUint32BE(this.blockHeight, 112);
+        buffer.writeUint32BE(this.lastDiffAdjustment, 116);
+        for (let i = 0; i < 10; i++) {
+            buffer.writeUint32BE(this.prevBlockTimestamps[i], 120 + (i * 4));
+        }
+        return buffer;
+    }
+    serializeToStruct() {
+        const buffer = this.serialize();
+        const result = [];
+        for (let i = 0; i < 5; i++) {
+            result[i] = "0x" + buffer.subarray(i * 32, (i + 1) * 32).toString("hex");
+        }
+        return { data: result };
+    }
+    static deserialize(data) {
+        if (data.length !== 160)
+            throw new Error(`Invalid size Expected 160, got: ${data.length}!`);
+        const blockheader = EVMBtcHeader_1.EVMBtcHeader.deserialize(data.subarray(0, 80));
+        const prevBlockTimestamps = [];
+        for (let i = 0; i < 10; i++) {
+            prevBlockTimestamps[i] = data.readUint32BE(120 + (i * 4));
+        }
+        return new EVMBtcStoredHeader({
+            blockheader,
+            blockHash: blockheader.getHash(),
+            chainWork: base_1.BigIntBufferUtils.fromBuffer(data.subarray(80, 112)),
+            blockHeight: data.readUint32BE(112),
+            lastDiffAdjustment: data.readUint32BE(116),
+            prevBlockTimestamps
+        });
+    }
+}
+exports.EVMBtcStoredHeader = EVMBtcStoredHeader;

package/dist/evm/chain/EVMChainInterface.d.ts

@@ -0,0 +1,51 @@
+import { ChainInterface, TransactionConfirmationOptions } from "@atomiqlabs/base";
+import { LoggerType } from "../../utils/Utils";
+import { JsonRpcApiProvider, Transaction, TransactionRequest } from "ethers";
+import { EVMBlocks, EVMBlockTag } from "./modules/EVMBlocks";
+import { EVMEvents } from "./modules/EVMEvents";
+import { EVMFees } from "./modules/EVMFees";
+import { EVMTokens } from "./modules/EVMTokens";
+import { EVMTransactions } from "./modules/EVMTransactions";
+import { EVMSignatures } from "./modules/EVMSignatures";
+import { EVMSigner } from "../wallet/EVMSigner";
+export type EVMRetryPolicy = {
+    maxRetries?: number;
+    delay?: number;
+    exponential?: boolean;
+};
+export type EVMConfiguration = {
+    safeBlockTag: EVMBlockTag;
+    maxLogsBlockRange: number;
+};
+export declare class EVMChainInterface<ChainId extends string = string, EVMChainId extends number = number> implements ChainInterface {
+    readonly chainId: ChainId;
+    readonly provider: JsonRpcApiProvider;
+    readonly retryPolicy: EVMRetryPolicy;
+    readonly evmChainId: EVMChainId;
+    readonly config: EVMConfiguration;
+    Fees: EVMFees;
+    readonly Tokens: EVMTokens;
+    readonly Transactions: EVMTransactions;
+    readonly Signatures: EVMSignatures;
+    readonly Events: EVMEvents;
+    readonly Blocks: EVMBlocks;
+    protected readonly logger: LoggerType;
+    constructor(chainId: ChainId, evmChainId: EVMChainId, provider: JsonRpcApiProvider, config: EVMConfiguration, retryPolicy?: EVMRetryPolicy, evmFeeEstimator?: EVMFees);
+    getBalance(signer: string, tokenAddress: string): Promise<bigint>;
+    getNativeCurrencyAddress(): string;
+    isValidToken(tokenIdentifier: string): boolean;
+    isValidAddress(address: string): boolean;
+    offBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): boolean;
+    onBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): void;
+    onBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): void;
+    offBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): boolean;
+    randomAddress(): string;
+    randomSigner(): EVMSigner;
+    sendAndConfirm(signer: EVMSigner, txs: TransactionRequest[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]>;
+    serializeTx(tx: Transaction): Promise<string>;
+    deserializeTx(txData: string): Promise<Transaction>;
+    getTxIdStatus(txId: string): Promise<"not_found" | "pending" | "success" | "reverted">;
+    getTxStatus(tx: string): Promise<"not_found" | "pending" | "success" | "reverted">;
+    txsTransfer(signer: string, token: string, amount: bigint, dstAddress: string, feeRate?: string): Promise<TransactionRequest[]>;
+    transfer(signer: EVMSigner, token: string, amount: bigint, dstAddress: string, txOptions?: TransactionConfirmationOptions): Promise<string>;
+}

package/dist/evm/chain/EVMChainInterface.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMChainInterface = void 0;
+const Utils_1 = require("../../utils/Utils");
+const ethers_1 = require("ethers");
+const EVMBlocks_1 = require("./modules/EVMBlocks");
+const EVMEvents_1 = require("./modules/EVMEvents");
+const EVMFees_1 = require("./modules/EVMFees");
+const EVMTokens_1 = require("./modules/EVMTokens");
+const EVMTransactions_1 = require("./modules/EVMTransactions");
+const EVMSignatures_1 = require("./modules/EVMSignatures");
+const EVMAddresses_1 = require("./modules/EVMAddresses");
+const EVMSigner_1 = require("../wallet/EVMSigner");
+class EVMChainInterface {
+    constructor(chainId, evmChainId, provider, config, retryPolicy, evmFeeEstimator = new EVMFees_1.EVMFees(provider)) {
+        var _a;
+        this.chainId = chainId;
+        this.evmChainId = evmChainId;
+        this.provider = provider;
+        this.retryPolicy = retryPolicy;
+        this.config = config;
+        (_a = this.config).safeBlockTag ?? (_a.safeBlockTag = "safe");
+        this.logger = (0, Utils_1.getLogger)("EVMChainInterface(" + this.evmChainId + "): ");
+        this.Fees = evmFeeEstimator;
+        this.Tokens = new EVMTokens_1.EVMTokens(this);
+        this.Transactions = new EVMTransactions_1.EVMTransactions(this);
+        this.Signatures = new EVMSignatures_1.EVMSignatures(this);
+        this.Events = new EVMEvents_1.EVMEvents(this);
+        this.Blocks = new EVMBlocks_1.EVMBlocks(this);
+    }
+    async getBalance(signer, tokenAddress) {
+        //TODO: For native token we should discount the cost of transactions
+        return await this.Tokens.getTokenBalance(signer, tokenAddress);
+    }
+    getNativeCurrencyAddress() {
+        return this.Tokens.getNativeCurrencyAddress();
+    }
+    isValidToken(tokenIdentifier) {
+        return this.Tokens.isValidToken(tokenIdentifier);
+    }
+    isValidAddress(address) {
+        return EVMAddresses_1.EVMAddresses.isValidAddress(address);
+    }
+    ///////////////////////////////////
+    //// Callbacks & handlers
+    offBeforeTxReplace(callback) {
+        return true;
+    }
+    onBeforeTxReplace(callback) { }
+    onBeforeTxSigned(callback) {
+        this.Transactions.onBeforeTxSigned(callback);
+    }
+    offBeforeTxSigned(callback) {
+        return this.Transactions.offBeforeTxSigned(callback);
+    }
+    randomAddress() {
+        const wallet = ethers_1.Wallet.createRandom();
+        return wallet.address;
+    }
+    randomSigner() {
+        const wallet = ethers_1.Wallet.createRandom();
+        return new EVMSigner_1.EVMSigner(wallet, wallet.address);
+    }
+    ////////////////////////////////////////////
+    //// Transactions
+    sendAndConfirm(signer, txs, waitForConfirmation, abortSignal, parallel, onBeforePublish) {
+        return this.Transactions.sendAndConfirm(signer, txs, waitForConfirmation, abortSignal, parallel, onBeforePublish);
+    }
+    serializeTx(tx) {
+        return this.Transactions.serializeTx(tx);
+    }
+    deserializeTx(txData) {
+        return this.Transactions.deserializeTx(txData);
+    }
+    getTxIdStatus(txId) {
+        return this.Transactions.getTxIdStatus(txId);
+    }
+    getTxStatus(tx) {
+        return this.Transactions.getTxStatus(tx);
+    }
+    async txsTransfer(signer, token, amount, dstAddress, feeRate) {
+        return [await this.Tokens.Transfer(signer, token, amount, dstAddress, feeRate)];
+    }
+    async transfer(signer, token, amount, dstAddress, txOptions) {
+        const tx = await this.Tokens.Transfer(signer.getAddress(), token, amount, dstAddress, txOptions?.feeRate);
+        const [txId] = await this.Transactions.sendAndConfirm(signer, [tx], txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
+        return txId;
+    }
+}
+exports.EVMChainInterface = EVMChainInterface;

package/dist/evm/chain/EVMModule.d.ts

@@ -0,0 +1,9 @@
+import { JsonRpcApiProvider } from "ethers";
+import { EVMChainInterface, EVMRetryPolicy } from "./EVMChainInterface";
+export declare class EVMModule<ChainId extends string = string, EVMChainId extends number = number> {
+    protected readonly provider: JsonRpcApiProvider;
+    protected readonly retryPolicy: EVMRetryPolicy;
+    protected readonly root: EVMChainInterface<ChainId, EVMChainId>;
+    protected readonly logger: import("../../utils/Utils").LoggerType;
+    constructor(root: EVMChainInterface<ChainId, EVMChainId>);
+}

package/dist/evm/chain/EVMModule.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMModule = void 0;
+const Utils_1 = require("../../utils/Utils");
+class EVMModule {
+    constructor(root) {
+        this.logger = (0, Utils_1.getLogger)(this.constructor.name + ": ");
+        this.provider = root.provider;
+        this.retryPolicy = root.retryPolicy;
+        this.root = root;
+    }
+}
+exports.EVMModule = EVMModule;

package/dist/evm/chain/modules/ERC20Abi.d.ts

@@ -0,0 +1,168 @@
+export declare const ERC20Abi: readonly [{
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "name";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: false;
+    readonly inputs: readonly [{
+        readonly name: "_spender";
+        readonly type: "address";
+    }, {
+        readonly name: "_value";
+        readonly type: "uint256";
+    }];
+    readonly name: "approve";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "totalSupply";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: false;
+    readonly inputs: readonly [{
+        readonly name: "_from";
+        readonly type: "address";
+    }, {
+        readonly name: "_to";
+        readonly type: "address";
+    }, {
+        readonly name: "_value";
+        readonly type: "uint256";
+    }];
+    readonly name: "transferFrom";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "decimals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [{
+        readonly name: "_owner";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "balance";
+        readonly type: "uint256";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "symbol";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: false;
+    readonly inputs: readonly [{
+        readonly name: "_to";
+        readonly type: "address";
+    }, {
+        readonly name: "_value";
+        readonly type: "uint256";
+    }];
+    readonly name: "transfer";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [{
+        readonly name: "_owner";
+        readonly type: "address";
+    }, {
+        readonly name: "_spender";
+        readonly type: "address";
+    }];
+    readonly name: "allowance";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly payable: true;
+    readonly stateMutability: "payable";
+    readonly type: "fallback";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly name: "Approval";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly name: "Transfer";
+    readonly type: "event";
+}];

package/dist/evm/chain/modules/ERC20Abi.js

@@ -0,0 +1,225 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERC20Abi = void 0;
+exports.ERC20Abi = [
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "name",
+        "outputs": [
+            {
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "_spender",
+                "type": "address"
+            },
+            {
+                "name": "_value",
+                "type": "uint256"
+            }
+        ],
+        "name": "approve",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "totalSupply",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "_from",
+                "type": "address"
+            },
+            {
+                "name": "_to",
+                "type": "address"
+            },
+            {
+                "name": "_value",
+                "type": "uint256"
+            }
+        ],
+        "name": "transferFrom",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "decimals",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint8"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [
+            {
+                "name": "_owner",
+                "type": "address"
+            }
+        ],
+        "name": "balanceOf",
+        "outputs": [
+            {
+                "name": "balance",
+                "type": "uint256"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "symbol",
+        "outputs": [
+            {
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "_to",
+                "type": "address"
+            },
+            {
+                "name": "_value",
+                "type": "uint256"
+            }
+        ],
+        "name": "transfer",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [
+            {
+                "name": "_owner",
+                "type": "address"
+            },
+            {
+                "name": "_spender",
+                "type": "address"
+            }
+        ],
+        "name": "allowance",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "payable": true,
+        "stateMutability": "payable",
+        "type": "fallback"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "name": "owner",
+                "type": "address"
+            },
+            {
+                "indexed": true,
+                "name": "spender",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "name": "value",
+                "type": "uint256"
+            }
+        ],
+        "name": "Approval",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "name": "from",
+                "type": "address"
+            },
+            {
+                "indexed": true,
+                "name": "to",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "name": "value",
+                "type": "uint256"
+            }
+        ],
+        "name": "Transfer",
+        "type": "event"
+    }
+];

package/dist/evm/chain/modules/EVMAddresses.d.ts

@@ -0,0 +1,9 @@
+import { EVMModule } from "../EVMModule";
+export declare class EVMAddresses extends EVMModule<any> {
+    /**
+     * Checks whether an address is a valid EVM address
+     *
+     * @param value
+     */
+    static isValidAddress(value: string): boolean;
+}