@woof-software/contracts-tools-sdk-ethers 0.0.1

package/README.md

@@ -0,0 +1,8 @@
+# @woof-software/contracts-tools-sdk-ethers
+
+Provides logic for ethers interactions.
+
+---
+
+
+### See original [README](https://github.com/neuroborus/ethers-tools/blob/main/README.md)

package/lib/abis/index.d.ts

@@ -0,0 +1,2 @@
+import type { InterfaceAbi } from "ethers";
+export declare const MulticallAbi: InterfaceAbi;

package/lib/abis/index.js

@@ -0,0 +1,2 @@
+import MulticallABI from "./multicall.abi.json";
+export const MulticallAbi = MulticallABI;

package/lib/abis/multicall.abi.json

@@ -0,0 +1,440 @@
+[
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "target",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "callData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Call[]",
+                "name": "calls",
+                "type": "tuple[]"
+            }
+        ],
+        "name": "aggregate",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "blockNumber",
+                "type": "uint256"
+            },
+            {
+                "internalType": "bytes[]",
+                "name": "returnData",
+                "type": "bytes[]"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "target",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bool",
+                        "name": "allowFailure",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "callData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Call3[]",
+                "name": "calls",
+                "type": "tuple[]"
+            }
+        ],
+        "name": "aggregate3",
+        "outputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bool",
+                        "name": "success",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "returnData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Result[]",
+                "name": "returnData",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "target",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bool",
+                        "name": "allowFailure",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "uint256",
+                        "name": "value",
+                        "type": "uint256"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "callData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Call3Value[]",
+                "name": "calls",
+                "type": "tuple[]"
+            }
+        ],
+        "name": "aggregate3Value",
+        "outputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bool",
+                        "name": "success",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "returnData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Result[]",
+                "name": "returnData",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "target",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "callData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Call[]",
+                "name": "calls",
+                "type": "tuple[]"
+            }
+        ],
+        "name": "blockAndAggregate",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "blockNumber",
+                "type": "uint256"
+            },
+            {
+                "internalType": "bytes32",
+                "name": "blockHash",
+                "type": "bytes32"
+            },
+            {
+                "components": [
+                    {
+                        "internalType": "bool",
+                        "name": "success",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "returnData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Result[]",
+                "name": "returnData",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getBasefee",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "basefee",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint256",
+                "name": "blockNumber",
+                "type": "uint256"
+            }
+        ],
+        "name": "getBlockHash",
+        "outputs": [
+            {
+                "internalType": "bytes32",
+                "name": "blockHash",
+                "type": "bytes32"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getBlockNumber",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "blockNumber",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getChainId",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "chainid",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getCurrentBlockCoinbase",
+        "outputs": [
+            {
+                "internalType": "address",
+                "name": "coinbase",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getCurrentBlockDifficulty",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "difficulty",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getCurrentBlockGasLimit",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "gaslimit",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getCurrentBlockTimestamp",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "timestamp",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "addr",
+                "type": "address"
+            }
+        ],
+        "name": "getEthBalance",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "balance",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "getLastBlockHash",
+        "outputs": [
+            {
+                "internalType": "bytes32",
+                "name": "blockHash",
+                "type": "bytes32"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "bool",
+                "name": "requireSuccess",
+                "type": "bool"
+            },
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "target",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "callData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Call[]",
+                "name": "calls",
+                "type": "tuple[]"
+            }
+        ],
+        "name": "tryAggregate",
+        "outputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bool",
+                        "name": "success",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "returnData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Result[]",
+                "name": "returnData",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "bool",
+                "name": "requireSuccess",
+                "type": "bool"
+            },
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "target",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "callData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Call[]",
+                "name": "calls",
+                "type": "tuple[]"
+            }
+        ],
+        "name": "tryBlockAndAggregate",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "blockNumber",
+                "type": "uint256"
+            },
+            {
+                "internalType": "bytes32",
+                "name": "blockHash",
+                "type": "bytes32"
+            },
+            {
+                "components": [
+                    {
+                        "internalType": "bool",
+                        "name": "success",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "returnData",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Multicall3.Result[]",
+                "name": "returnData",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    }
+]

package/lib/config.d.ts

@@ -0,0 +1,37 @@
+export declare const config: {
+    multicallUnit: {
+        address: string;
+        allowFailure: boolean;
+        waitForTxs: boolean;
+        staticCalls: {
+            batchLimit: number;
+            timeoutMs: number;
+        };
+        mutableCalls: {
+            batchLimit: number;
+            timeoutMs: number;
+        };
+        waitCalls: {
+            timeoutMs: number;
+        };
+        priorityCalls: {
+            multiplier: number;
+        };
+        batchDelayMs: number;
+    };
+    contract: {
+        staticCalls: {
+            timeoutMs: number;
+        };
+        mutableCalls: {
+            timeoutMs: number;
+        };
+        logsGathering: {
+            blocksStep: number;
+            delayMs: number;
+        };
+    };
+    priorityCalls: {
+        multiplier: number;
+    };
+};

package/lib/config.js

@@ -0,0 +1,38 @@
+import { DEFAULT_LOGS_BLOCKS_STEP, DEFAULT_LOGS_DELAY_MS, DEFAULT_MULTICALL_ALLOW_FAILURE, DEFAULT_MULTICALL_BATCH_DELAY_MS, DEFAULT_MULTICALL_MUTABLE_CALLS_BATCH_LIMIT, DEFAULT_MULTICALL_STATIC_CALLS_BATCH_LIMIT, DEFAULT_MULTICALL_WAIT_FOR_TXS, DEFAULT_MUTABLE_CALLS_TIMEOUT_MS, DEFAULT_PRIORITY_CALL_MULTIPLIER, DEFAULT_STATIC_CALLS_TIMEOUT_MS, DEFAULT_WAIT_CALLS_TIMEOUT_MS, MULTICALL_ADDRESS, } from "./constant";
+export const config = {
+    multicallUnit: {
+        address: MULTICALL_ADDRESS,
+        allowFailure: DEFAULT_MULTICALL_ALLOW_FAILURE,
+        waitForTxs: DEFAULT_MULTICALL_WAIT_FOR_TXS,
+        staticCalls: {
+            batchLimit: DEFAULT_MULTICALL_STATIC_CALLS_BATCH_LIMIT,
+            timeoutMs: DEFAULT_STATIC_CALLS_TIMEOUT_MS,
+        },
+        mutableCalls: {
+            batchLimit: DEFAULT_MULTICALL_MUTABLE_CALLS_BATCH_LIMIT,
+            timeoutMs: DEFAULT_MUTABLE_CALLS_TIMEOUT_MS,
+        },
+        waitCalls: {
+            timeoutMs: DEFAULT_WAIT_CALLS_TIMEOUT_MS,
+        },
+        priorityCalls: {
+            multiplier: DEFAULT_PRIORITY_CALL_MULTIPLIER,
+        },
+        batchDelayMs: DEFAULT_MULTICALL_BATCH_DELAY_MS,
+    },
+    contract: {
+        staticCalls: {
+            timeoutMs: DEFAULT_STATIC_CALLS_TIMEOUT_MS,
+        },
+        mutableCalls: {
+            timeoutMs: DEFAULT_MUTABLE_CALLS_TIMEOUT_MS,
+        },
+        logsGathering: {
+            blocksStep: DEFAULT_LOGS_BLOCKS_STEP,
+            delayMs: DEFAULT_LOGS_DELAY_MS,
+        },
+    },
+    priorityCalls: {
+        multiplier: DEFAULT_PRIORITY_CALL_MULTIPLIER,
+    },
+};

package/lib/constant.d.ts

@@ -0,0 +1,12 @@
+export declare const MULTICALL_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
+export declare const DEFAULT_MULTICALL_WAIT_FOR_TXS = true;
+export declare const DEFAULT_MULTICALL_ALLOW_FAILURE = false;
+export declare const DEFAULT_MULTICALL_STATIC_CALLS_BATCH_LIMIT = 50;
+export declare const DEFAULT_MULTICALL_MUTABLE_CALLS_BATCH_LIMIT = 10;
+export declare const DEFAULT_MULTICALL_BATCH_DELAY_MS = 0;
+export declare const DEFAULT_PRIORITY_CALL_MULTIPLIER = 1.3;
+export declare const DEFAULT_LOGS_BLOCKS_STEP = 5000;
+export declare const DEFAULT_LOGS_DELAY_MS = 1000;
+export declare const DEFAULT_STATIC_CALLS_TIMEOUT_MS = 10000;
+export declare const DEFAULT_MUTABLE_CALLS_TIMEOUT_MS = 20000;
+export declare const DEFAULT_WAIT_CALLS_TIMEOUT_MS = 30000;

package/lib/constant.js

@@ -0,0 +1,12 @@
+export const MULTICALL_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
+export const DEFAULT_MULTICALL_WAIT_FOR_TXS = true; // The safest way to handle nonce in transactions
+export const DEFAULT_MULTICALL_ALLOW_FAILURE = false;
+export const DEFAULT_MULTICALL_STATIC_CALLS_BATCH_LIMIT = 50;
+export const DEFAULT_MULTICALL_MUTABLE_CALLS_BATCH_LIMIT = 10;
+export const DEFAULT_MULTICALL_BATCH_DELAY_MS = 0;
+export const DEFAULT_PRIORITY_CALL_MULTIPLIER = 1.3;
+export const DEFAULT_LOGS_BLOCKS_STEP = 5000;
+export const DEFAULT_LOGS_DELAY_MS = 1000;
+export const DEFAULT_STATIC_CALLS_TIMEOUT_MS = 10000;
+export const DEFAULT_MUTABLE_CALLS_TIMEOUT_MS = 20000;
+export const DEFAULT_WAIT_CALLS_TIMEOUT_MS = 30000;

package/lib/contract/base-contract.d.ts

@@ -0,0 +1,23 @@
+import { Contract as EthersContract, type Interface, type InterfaceAbi, type Listener, type LogDescription, type Provider, type Signer } from "ethers";
+import { type ContractCall, type ContractCallOptions, type ContractGetLogsOptions, type ContractOptions, type DynamicContractConstructor } from "../types";
+export declare class BaseContract {
+    readonly address: string;
+    readonly driver?: Signer | Provider;
+    readonly isCallable: boolean;
+    readonly isReadonly: boolean;
+    readonly contract: EthersContract;
+    readonly contractOptions: ContractOptions;
+    static createAutoClass(abi: Interface | InterfaceAbi, address?: string, driver?: Provider | Signer, options?: ContractOptions): DynamicContractConstructor;
+    static createAutoInstance(abi: Interface | InterfaceAbi, address?: string, driver?: Provider | Signer, options?: ContractOptions): import("../types").DynamicContract;
+    constructor(abi: Interface | InterfaceAbi, address: string | undefined, driver: Signer | Provider, options?: ContractOptions);
+    get provider(): Provider | null;
+    get signer(): Signer | null;
+    get interface(): Interface;
+    call<T>(method: string, args?: any[], options?: ContractCallOptions): Promise<Awaited<T>>;
+    getCall(methodName: string, args?: any[], callData?: {}): ContractCall;
+    listenEvent(eventName: string, listener: Listener): Promise<EthersContract>;
+    getLogs(fromBlock: number, eventsNames?: string[], toBlock?: number, options?: ContractGetLogsOptions): Promise<LogDescription[]>;
+    getLogsStream(fromBlock: number, eventsNames?: string[], toBlock?: number, // Latest by default
+    options?: ContractGetLogsOptions): AsyncGenerator<LogDescription, void>;
+    private getTimeoutSignal;
+}