dequanto 0.2.38 → 0.2.40

package/src/clients/WalletClient.ts

@@ -7,7 +7,7 @@ import { EIP6963ProviderDetail, EIP6963ProviderFactory } from '@dequanto/wallets
 import { WClient } from './ClientPool';
 import { $hex } from '@dequanto/utils/$hex';
 
-/** Wallet actions only. For all Node (Chain) related actions - Web3Client should be used */
+/** Wallet actions only. Use Web3Client for all node/chain-related actions */
 
 export class WalletClient {
     public factory: EIP6963ProviderFactory;
@@ -18,7 +18,7 @@ export class WalletClient {
 
     // Client abstract methods
 
-    //Set the provider by UUID as the default one for eth_** methods
+    // Set the provider by UUID as the default one for eth_** methods
     async useProvider (uuid: string) {
         this.factory.useProvider(uuid);
     }
@@ -37,7 +37,7 @@ export class WalletClient {
         return rpc.eth_accounts();
     }
 
-    /** Find the provider by UUID or use the first one to connect to and to requestAccounts */
+    /** Finds the provider by UUID, or uses the first one to connect and request accounts */
     async connect (uuid?: string): Promise<TEth.Address[]> {
         return this.factory.connect(uuid);
     }

package/src/clients/Web3BatchRequests.ts

@@ -58,12 +58,12 @@ export namespace Web3BatchRequests {
         //         if (RateLimitGuard.isBatchLimit(error)) {
         //             let num = RateLimitGuard.extractBatchLimitFromError(error);
         //             if (num && num < this.requests.length) {
-        //                 // if got the batch limit lower than current batch, throw to make the wClient to reread the batch limit, and the pool to retry
+        //                 // If the batch limit is lower than the current batch, throw so wClient rereads the batch limit and the pool retries
         //                 this.promise.reject(error);
         //                 return;
         //             }
         //         }
-        //         l`Web3BatchRequest failed for ${this.results.length} Batch with error "${ this.results[0]?.error?.message }". Fallback to single calls.`;
+        //         l`Web3BatchRequest failed for a batch of ${this.results.length} with error "${ this.results[0]?.error?.message }". Falling back to single calls.`;
         //         this.results = new Array(this.requests.length);
         //         this.awaitables = this.requests.length;
         //         this.callByOne();
@@ -98,7 +98,7 @@ export namespace Web3BatchRequests {
 
         //     } catch (error) {
         //         if (index > -1) {
-        //             l`BatchRequester when processing by one request errored after ${index + 1} requests`;
+        //             l`BatchRequester failed while processing requests one by one after ${index + 1} requests`;
         //         }
         //         this.promise.reject(error);
         //     }

package/src/clients/Web3Client.ts

@@ -43,7 +43,7 @@ export abstract class Web3Client implements IWeb3Client {
     abstract defaultGasLimit: number;
 
 
-    // Hardhat network could be launched in forking mode
+    // The Hardhat network can be launched in forking mode
     forked?: {
         platform: TPlatform;
         block?: number;
@@ -53,7 +53,7 @@ export abstract class Web3Client implements IWeb3Client {
     defaultGasPriceRatio = 1.4;
     minGasPriorityFee = 0.0012345;
 
-    // block time in ms
+    // Block time in ms
     blockTimeAvg = 12_000;
 
     get network (): TPlatform {
@@ -76,7 +76,7 @@ export abstract class Web3Client implements IWeb3Client {
 
         if (this.options.endpoints == null && this.options.web3 == null) {
             console.dir(this.options, { depth: null });
-            throw new Error(`Neither Node endpoints nor web3 instance provided`);
+            throw new Error(`Neither node endpoints nor a web3 instance were provided`);
         }
         this.pool = new ClientPool(this.options);
         this.debug = new ClientDebugMethods(this, this.options.debug);
@@ -109,7 +109,7 @@ export abstract class Web3Client implements IWeb3Client {
         let eventAbi = abi.find(x => x.type === 'event' && x.name === event);
         if (eventAbi == null) {
             let events = abi.filter(x => x.type === 'event').map(x => x.name).join(', ');
-            throw new Error(`Event "${event}" not present in ABI. Events: ${events}`);
+            throw new Error(`Event "${event}" is not present in the ABI. Events: ${events}`);
         }
         let stream = new ClientEventsStream(address, eventAbi);
         this
@@ -133,7 +133,7 @@ export abstract class Web3Client implements IWeb3Client {
     }
 
     async getWeb3(options?: IPoolWeb3Request) {
-        throw new Error(`To get the web3 initialize the Web3 compatibility class ('compatibility/Web3.ts') instead`)
+        throw new Error(`To get web3, initialize the Web3 compatibility class ('compatibility/Web3.ts') instead`)
     }
     async getRpc(options?: IPoolWeb3Request): Promise<Rpc> {
         return await this.pool.getRpc(options);
@@ -466,7 +466,7 @@ export abstract class Web3Client implements IWeb3Client {
             }
         }
         if (tx.input != null) {
-            /** eth_call expects 'data' property, not the 'input' as in Transaction */
+            /** eth_call expects the 'data' property, not 'input' as in Transaction */
             tx.data = tx.input;
             delete tx.input;
         }
@@ -484,18 +484,18 @@ export abstract class Web3Client implements IWeb3Client {
 
     async getPastLogs(filter: RpcTypes.Filter, options?: {
         /**
-         * For large block ranges and huge amounts of logs, streaming should be used, we pass the loaded logs in batches direct to onProgress
-         * and do not aggregate to a final logs array to prevent memory issues.
+         * For large block ranges and huge amounts of logs, streaming should be used. Loaded logs are passed directly to onProgress in batches
+         * and do not aggregate to a final logs array to prevent memory issues
          */
         streamed?: boolean
         /**
-         * Override the default block range limits for all underlying RPC clients, otherwise the config will be used or
-         * the RPC exception will be parsed.
+         * Overrides the default block range limits for all underlying RPC clients. Otherwise, the config will be used or
+         * the RPC exception will be parsed
          */
         blockRangeLimits?: WClient['blockRangeLimits']
 
         /**
-         * When loading in batches the cb will be called with fetched and parsed logs on each iteration
+         * When loading in batches, the callback will be called with fetched and parsed logs on each iteration
          */
         onProgress? (info: TLogsRangeProgress<TEth.Log>): void
     }): Promise<TEth.Log[]> {
@@ -504,7 +504,7 @@ export abstract class Web3Client implements IWeb3Client {
             this.pool.MINIMUM_BLOCK_RANGE = Math.min(this.pool.MINIMUM_BLOCK_RANGE, options.blockRangeLimits.blocks);
         }
 
-        // ensure numbers, bigints, bools are in HEX
+        // Ensure numbers, bigints, and bools are in HEX
         filter.topics = filter.topics?.map(mix => {
             if (mix != null && Array.isArray(mix) === false) {
                 return $hex.ensure(mix as any)
@@ -512,7 +512,7 @@ export abstract class Web3Client implements IWeb3Client {
             return mix;
         });
 
-        // ensure all topics are in 32-byte
+        // Ensure all topics are 32 bytes
         filter.topics = filter.topics?.map(topic => {
             if (typeof topic === 'string' && topic.startsWith('0x')) {
                 return $hex.padBytes(topic, 32);
@@ -540,7 +540,7 @@ export abstract class Web3Client implements IWeb3Client {
 
         let removedLogs = logs?.filter(x => x.removed === true);
         if (removedLogs?.length > 0) {
-            console.error(`Caution: There are ${removedLogs.length} removed Logs. But @dequanto didn't handle this as they are not expected to be present in past logs.`);
+            console.error(`Caution: there are ${removedLogs.length} removed logs. @dequanto does not handle them because they are not expected to be present in past logs.`);
         }
 
         return logs;
@@ -580,7 +580,7 @@ export abstract class Web3Client implements IWeb3Client {
 export type TLogsRangeProgress<TLogParsed> = {
     logs: TLogParsed[]
 
-    /** @deprecated Use logs for current logs buffer */
+    /** @deprecated Use logs for the current logs buffer */
     paged: TLogParsed[]
     latestBlock: number
     blocks: {
@@ -612,8 +612,8 @@ namespace RangeWorker {
     ) {
         let { fromBlock, toBlock } = ranges;
 
-        $require.Number(fromBlock, `FromBlock must be a number`);
-        $require.Number(toBlock, `ToBlock must be a number`);
+        $require.Number(fromBlock, `fromBlock must be a number`);
+        $require.Number(toBlock, `toBlock must be a number`);
         if (options?.streamed) {
             $require.Function(options.onProgress, `onProgress must be a function when streaming past logs`);
         }
@@ -738,7 +738,7 @@ namespace RangeWorker {
             }
 
             /**
-             * query returned more than 10000 results
+             * The query returned more than 10,000 results
              */
             $logger.log(`Range worker request: ${range.fromBlock}-${range.toBlock}. ${error.message.trim()}. Current range: ${ blockRange }`);
 
@@ -755,7 +755,7 @@ namespace RangeWorker {
 
             let maxRangeMatch = /\b(?<maxRange>\d{2,})\b/.exec(error.message)?.groups?.maxRange;
             if (maxRangeMatch && knownLimits.maxBlockRange == null) {
-                // handle unknown range, otherwise throw
+                // Handle an unknown range; otherwise, throw
                 let rangeLimit = Number(maxRangeMatch);
                 let currentRangeLimit = currentWClient.blockRangeLimits.blocks;
                 if (currentRangeLimit <= rangeLimit) {
@@ -766,7 +766,7 @@ namespace RangeWorker {
                 return fetchPaged(client, filter, range, knownLimits);
             }
             if (/\b(range|limit)\b/.test(error.message)) {
-                // Generic "block range is too wide", "limit exceeded",
+                // Generic "block range is too wide" or "limit exceeded" error
                 let newRange = Math.floor(blockRange * 0.8);
                 currentWClient.updateBlockRangeInfo({
                     blocks: newRange
@@ -798,7 +798,7 @@ namespace LogsFetcher {
 
                 let { result } = await fetch (client, lastBlock, toBlockExcluded, blockRange, filter);
 
-                // The sub-range query includes the last block, as some results might be skipped that are in the same block.
+                // The sub-range query includes the last block, as some results in the same block might otherwise be skipped
                 arr = arr.filter(x => x.blockNumber !== lastBlock);
                 arr = arr.concat(result.paged);
             }

package/src/clients/Web3ClientFactory.ts

@@ -26,7 +26,7 @@ export namespace Web3ClientFactory {
         });
     }
 
-    /** Same as sync variation, but ensures the config is being fetched */
+    /** Same as the sync variant, but ensures the config is fetched */
     export async function getAsync (platform: TPlatform | string | number, opts?: IWeb3EndpointOptions) {
         let cfg = await Config.get();
         return get(platform, opts);

package/src/clients/compatibility/Web3.ts

@@ -100,7 +100,7 @@ namespace $Web3Contract {
             get(target: Web3Contract, method, receiver) {
                 let abiItem = target.abi.find(item => item.name === method);
                 if (abiItem == null) {
-                    throw new Error(`Method ${method.toString()} not found. Available methods: ${target.abi.map(item => item.name).join(', ')}`);
+                    throw new Error(`Method ${method.toString()} was not found. Available methods: ${target.abi.map(item => item.name).join(', ')}`);
                 }
                 return (...args) => {
                     return new Web3ContractMethod(target.eth, abiItem, target.abi, target.address, args);
@@ -140,7 +140,7 @@ namespace $Web3Contract {
         }
         send (opts: { from, gas }) {
             let account = this.eth.accounts.wallet.get(opts.from);
-            $require.notNull(account, `Account ${opts.from} not found`);
+            $require.notNull(account, `Account ${opts.from} was not found`);
 
             let builder = new TxDataBuilder(this.eth.client, account, {
                 to: this.address,

package/src/clients/handlers/RateLimitGuard.ts

@@ -6,7 +6,7 @@ import memd from 'memd';
 
 let rateLimitRgx = {
     checks: [
-        // extracted from known and common rate-limit messages
+        // Extracted from known and common rate-limit messages
         /rate.+limit/i,
         /too.+many.+request/i,
         /exceed.+request/i,
@@ -99,9 +99,9 @@ export class RateLimitGuard {
 
                     val = Number(val);
                     if (val < 50_000) {
-                        // relative time
+                        // Relative time
                         if (val < 1000) {
-                            // in seconds
+                            // In seconds
                             val = val * 1000;
                         }
                         val = Date.now() + val;
@@ -190,7 +190,7 @@ export class RateLimitGuard {
             this.backoff = info.backoff;
         }
 
-        if (info.spanLimit && info.spanMs) {
+        if (info.spanLimit != null && info.spanMs != null) {
             l`Updating the yellow<rate limits> for ${this.id} using: bold<${info.spanLimit}> per bold<${info.spanMs}ms>`;
             let rate = this.rates.find(x => x.spanMs === info.spanMs);
             if (rate) {
@@ -243,9 +243,9 @@ export class RateLimitGuard {
     private onThrottle(ms: number) {
         let awaited = this.awaited;
         if (awaited.count > 0 && awaited.count % 20 === 0) {
-            l`The Node ${this.id} with (${this.rates[0].counter}req) was ${awaited.count}x throttled, in total for ${ $date.formatTimespan(awaited.total) }. Current wait-time: ${ $date.formatTimespan(ms) }`
+            l`The node ${this.id} with (${this.rates[0].counter} req) was throttled ${awaited.count}x for ${ $date.formatTimespan(awaited.total) } in total. Current wait time: ${ $date.formatTimespan(ms) }`
         } else if (ms > 30_000) {
-            l`The Node ${this.id} with (${this.rates[0].counter}req) waits now for ${ $date.formatTimespan(ms) } to continue.`
+            l`The node ${this.id} with (${this.rates[0].counter} req) is now waiting ${ $date.formatTimespan(ms) } to continue.`
         }
 
         //-this.rates[1].printStatus()
@@ -255,9 +255,9 @@ export class RateLimitGuard {
 }
 
 /**
- * In short epoch rate limiter (1s, 1m, 1h) we track each request
+ * In the short-epoch rate limiter (1s, 1m, 1h), we track each request
  *
- * sliding(rolling) window | fixed window
+ * sliding (rolling) window | fixed window
  */
 class ShortEpochRateLimitData {
     public started: number;
@@ -273,7 +273,7 @@ class ShortEpochRateLimitData {
         let rgx = /^(?<limit>\d+)[\\/](?<time>\w+)$/;
         let match = rgx.exec(rate);
         if (match == null) {
-            throw new Error(`Invalid value for rate limit: ${rate}. Expects to match the regex: ${rgx.toString()}`);
+            throw new Error(`Invalid value for rate limit: ${rate}. Expected to match the regex: ${rgx.toString()}`);
         }
         let spanMs = Number(match.groups.limit);
         let spanLimit = $date.parseTimespan(match.groups.time);
@@ -312,9 +312,9 @@ class ShortEpochRateLimitData {
     }
 
     /**
-     * The server has own request time, with `addTicks` we save the time BEFORE sending to the server
-     * Here we should update the times AFTER the response received,
-     * otherwise the Request could be removed locally from TimeWindow earlier, as it has been cleared on the backend.
+     * The server has its own request time. With `addTicks`, we save the time BEFORE sending to the server
+     * Here we should update the times AFTER the response is received,
+     * otherwise the request could be removed locally from TimeWindow earlier than it is cleared on the backend
      */
     public updateRequests (tick: number, newTick: number) {
         for (let i = 0; i < this.ticks.length; i++) {
@@ -329,20 +329,20 @@ class ShortEpochRateLimitData {
         let spanStart = now - this.spanMs;
         for (let i = 0; i < ticks.length; i++) {
             if (ticks[i] < spanStart) {
-                // older ticks, continue to slice later
+                // Older ticks; continue and slice later
                 continue;
             }
 
             if (i > 0) {
-                // remove older requests
+                // Remove older requests
                 ticks.splice(0, i);
             }
-            // in range tick found
+            // In-range tick found
             break;
         }
 
         if ((ticks.length + ticksCount) <= this.spanLimit) {
-            // We can add requests to current span
+            // We can add requests to the current span
             return 0;
         }
 

package/src/clients/interfaces/IWeb3Client.ts

@@ -15,7 +15,7 @@ export interface IWeb3ClientOptions {
     chainId?: number
     // Token symbol: e.g. ETH
     chainToken?: string
-    // alias to `provider`
+    // Alias to `provider`
     web3?: TTransport.Transport | Promise<TTransport.Transport>
     provider?: TTransport.Transport
 
@@ -23,7 +23,7 @@ export interface IWeb3ClientOptions {
     defaultGasPriceRatio?: number;
     minGasPriorityFee?: number; // in GWEI
 
-    // block time in ms
+    // Block time in ms
     blockTimeAvg?: number;
 
     debug?: {

package/src/clients/model/PromiEventWrap.ts

@@ -28,7 +28,7 @@ export class PromiseEventWrap extends class_Dfr {
         this._events.emit(event, ...args);
     }
 
-    /** Attach this wrapper to the promiseEvent */
+    /** Attaches this wrapper to the promiseEvent */
     bind (promiseEvent: PromiseEvent<any>) {
 
         this.$source = promiseEvent;

package/src/clients/utils/$web3Abi.ts

@@ -3,7 +3,7 @@ import type { TAbiItem } from '@dequanto/types/TAbi';
 
 export namespace $web3Abi {
 
-    /** Normalize user input by normalizing to the array of TAbiItems */
+    /** Normalizes user input into an array of TAbiItems */
     export function ensureAbis(abi: string | TAbiItem | TAbiItem[]): (TAbiItem & { signature? })[] {
         let arr: TAbiItem[];
         if (typeof abi === 'string') {
@@ -16,7 +16,7 @@ export namespace $web3Abi {
 
         let first = abi[0];
         if (first.outputs == null || first.outputs.length === 0) {
-            // Normalize outputs, to read at least bytes if nothing set
+            // Normalize outputs to read at least bytes if nothing is set
             first.outputs = [
                 {
                     type: 'bytes32',

package/src/clients/utils/ClientErrorUtil.ts

@@ -30,4 +30,8 @@ export namespace ClientErrorUtil {
     export function IsNonceTooHigh(error: Error) {
         return /nonce too high/i.test(error.message);
     }
+
+    export function IsUnderpriced(error: Error) {
+        return /underpriced/i.test(error.message);
+    }
 }

package/src/config/Config.ts

@@ -1,4 +1,5 @@
 import memd from 'memd';
+import type { Config as Appcfg } from 'appcfg/Config';
 import { class_Dfr, obj_extend } from 'atma-utils';
 import { TConfigParamsBrowser, TConfigParamsNode } from './AConfigBase';
 import { IConfigData } from './interface/IConfigData';
@@ -8,7 +9,7 @@ import { $logger } from '../utils/$logger';
 export class Config {
 
     @memd.deco.memoize()
-    static async fetch (parameters?: TConfigParamsNode | TConfigParamsBrowser) {
+    static async fetch (parameters?: TConfigParamsNode | TConfigParamsBrowser): Promise<Appcfg<IConfigData> & IConfigData> {
         singleton ??= new class_Dfr();
 
         let cfg = await provider.fetch(parameters);
@@ -27,7 +28,7 @@ export class Config {
     }
 
     /** Will return a config that was previously loaded by fetch with any parameters or will trigger fetch with default parameters  */
-    static async get (): Promise<IConfigData> {
+    static async get (): Promise<Appcfg<IConfigData> & IConfigData>  {
         if (singleton != null) {
             return singleton;
         }
@@ -47,4 +48,4 @@ export class Config {
 export const config = { } as IConfigData;
 
 let provider = new ConfigProvider();
-let singleton: class_Dfr<IConfigData> = null;
+let singleton: class_Dfr<Appcfg<IConfigData> & IConfigData> = null;

package/src/contracts/Contract.ts

@@ -107,7 +107,7 @@ export abstract class Contract {
         if (info == null) {
             let byName = $is.Address(mix) === false;
             if (byName) {
-                throw new Error(`Contract by name not found ${mix}`);
+                throw new Error(`Contract by name was not found: ${mix}`);
             }
             info = <any> { address: mix };
         }

package/src/contracts/ContractAbiProvider.ts

@@ -20,7 +20,7 @@ export class ContractAbiProvider {
 
     async getAbi(abi: TAddress | string, opts: { implementation?: string, location?: string, optional?: boolean } = null) {
 
-        $require.notNull(abi, `Abi not provided to get the Abi Json from`);
+        $require.notNull(abi, `ABI source is required`);
 
         let abiJson: TAbiItem[]
         let implementation: TAddress;
@@ -32,7 +32,7 @@ export class ContractAbiProvider {
             let path = abi;
             let location = opts?.location;
             if (location && $path.isAbsolute(path) === false) {
-                // if path not relative, check the file at ClassFile location
+                // If the path is not absolute, check the file relative to the class file location.
                 let relPath = class_Uri.combine(location, path);
                 if (await File.existsAsync(relPath)) {
                     path = relPath;
@@ -42,18 +42,18 @@ export class ContractAbiProvider {
             abiJson = Array.isArray(json) ? json : json.abi;
         }
 
-        opts?.optional !== true && $require.notNull(abiJson, `Abi not resolved from ${abi}`);
+        opts?.optional !== true && $require.notNull(abiJson, `ABI was not resolved from ${abi}`);
         return { abiJson, implementation };
     }
 
 
     private async getAbiByAddress (abi: TAddress, opts: { implementation?: string }) {
-        let address = $address.expectValid(abi, 'contract address is not valid');
+        let address = $address.expectValid(abi, 'Contract address is not valid');
         let platform = this.client.platform;
         let explorer = $require.notNull(this.explorer, `Explorer not resolved for network: ${platform}`);
 
         try {
-            $logger.log(`Loading contracts ABI for ${address}. `)
+            $logger.log(`Loading contract ABI for ${address}. `)
             let { abi, implementation } = await explorer.getContractAbi(address, opts);
 
             let hasProxy = $address.eq(address, implementation) === false;
@@ -63,7 +63,7 @@ export class ContractAbiProvider {
             return { abi: abiJson, implementation };
         } catch (error) {
             $logger.error(error);
-            throw new Error(`ABI is not resolved from ${platform}/${address}: ${error.message ?? error}`);
+            throw new Error(`ABI was not resolved from ${platform}/${address}: ${error.message ?? error}`);
         }
     }
 }

package/src/contracts/ContractBase.ts

@@ -39,7 +39,7 @@ export abstract class ContractBase {
     private blockDate?: Date;
     //private from?: TAddress;
 
-    /** 1.4 for medium*/
+    /** 1.4 for medium */
     private gasPriorityFee?: number;
     protected builderConfig?: ITxBuilderOptions;
     protected writerConfig?: ITxWriterOptions;
@@ -177,7 +177,7 @@ export abstract class ContractBase {
                     }
                     let data = writer.builder.data as any as TEth.Tx;
                     if (!params?.estimateGas) {
-                        // remove default values
+                        // Remove default values.
                         delete data.gasPrice;
                         delete data.maxPriorityFeePerGas;
                         delete data.maxFeePerGas;
@@ -404,7 +404,7 @@ export abstract class ContractBase {
             .filter(x => (x.inputs?.length ?? 0) === args.length);
 
         if ($abis.length === 0) {
-            throw new Error(`ABI not found in overloads \n${abis.join('\n')}\n by arguments count. Got ${args.length} arguments`);
+            throw new Error(`ABI was not found in overloads \n${abis.join('\n')}\n by argument count. Got ${args.length} arguments`);
         }
         if ($abis.length === 1) {
             return $abis[0];
@@ -422,7 +422,7 @@ export abstract class ContractBase {
             return $abis[0];
         }
 
-        throw new Error(`ABI not found. Got multiple overloads for the argument count ${args.length}. We should pick the ABI by parameters type.`)
+        throw new Error(`ABI was not found. Got multiple overloads for the argument count ${args.length}. The ABI should be selected by parameter types.`)
     }
 
     protected $extractLogs(tx: TEth.TxReceipt, abiItem: TAbiItem) {
@@ -458,9 +458,9 @@ export abstract class ContractBase {
         }
         onProgress?(info: TLogsRangeProgress<ITxLogItem>)
 
-        /** if TRUE the data will be only forwarded via onProgress callback.
-         * And the final array will be undefined.
-         * This will handle big queries to hold huge arrays in memory
+        /** If TRUE, data will only be forwarded via the onProgress callback.
+         * The final array will be undefined.
+         * This handles large queries without holding huge arrays in memory.
          * */
         streamed?: boolean
 
@@ -545,7 +545,7 @@ export abstract class ContractBase {
     @memd.deco.memoize({ perInstance: true })
     protected getContractWriter() {
         if (this.abi != null) {
-            // Updates the singleton instance
+            // Update the singleton instance.
             let logParser = di.resolve(TxTopicInMemoryProvider);
             logParser.register(this.abi);
         }
@@ -624,10 +624,10 @@ export type TEventLogOptions<TParams> = {
 type TEventParams<TEvents extends TEventsBase, TEventName extends keyof TEvents> = Partial<TEvents[TEventName]['outputParams']>;
 
 
-// Tuple check type detects how an argument satisfies the "tuple"
-// shallow: checks only that the argument is an object type
-// single: checks that all tuple components (keys) are present in the argument
-// both: checks that all tuple components are present in the argument AND all argument keys exist in the tuple components
+// Tuple check type detects how an argument satisfies the "tuple" type.
+// shallow: checks only that the argument is an object type.
+// single: checks that all tuple components (keys) are present in the argument.
+// both: checks that all tuple components are present in the argument AND all argument keys exist in the tuple components.
 function filterABIbyArguments(abis: TAbiItem[], args: any[], tupleCheck: 'shallow' | 'single' | 'both') {
     return abis.filter(abi => {
         for (let i = 0; i < args.length; i++) {
@@ -667,8 +667,8 @@ function filterABIbyArguments(abis: TAbiItem[], args: any[], tupleCheck: 'shallo
                     // E.g. Solidity structs:
                     // 1. struct FooV1 { uint256 a; uint256 b; }
                     // 2. struct FooV2 { uint256 a; uint256 b; uint256 c; }
-                    // If we call the 2. overloaded function the single check will match both structs
-                    // therefore we need later to call with tupleCheck === 'both' to detect correct overload
+                    // If we call the second overloaded function, the single check will match both structs.
+                    // Therefore, we need to call later with tupleCheck === 'both' to detect the correct overload.
                     const components = item.components ?? [];
                     const satisfies = components.every(x => x.name in arg) ?? false;
                     if (!satisfies) {

package/src/contracts/ContractProvider.ts

@@ -35,7 +35,7 @@ export class ContractProvider implements IContractProvider {
     async getByAddress (address: string): Promise<IContract> {
         let info = await this.getInfo(address);
         if (info == null) {
-            throw new Error(`Contract info not found for ${address}`)
+            throw new Error(`Contract info was not found for ${address}`)
         }
         let abi = await this.getAbi(info.address);
 

package/src/contracts/ContractReader.ts

@@ -149,7 +149,7 @@ export class ContractReader implements IContractReader {
         { -readonly [P in keyof T]: ContractReaderUtils.TIContractReadParamsInferred<T[P]>; }
     > {
 
-        // all inputs should be deferred requests
+        // All inputs should be deferred requests.
         let requests = await alot(requestArr as any[])
             .mapAsync(async x => await x)
             .toArrayAsync() as ContractReaderUtils.IContractReadParams[];
@@ -157,7 +157,7 @@ export class ContractReader implements IContractReader {
         let invalid = requests.find(x => $is.Address(x.address) === false);
         if (invalid != null) {
             $logger.error('Invalid object', invalid);
-            throw new Error(`Invalid Deferred Request at position ${ requests.indexOf(invalid) }`);
+            throw new Error(`Invalid deferred request at position ${ requests.indexOf(invalid) }`);
         }
 
         let inputs = await alot(requests).mapAsync(async req => {
@@ -190,10 +190,10 @@ export class ContractReader implements IContractReader {
     }
 
     async getLogsFilter(abi: TAbiItem | string | '*' | TAbiItem[], options: {
-        /** Can be UNDEFINED, then the logs will be searched globally */
+        /** Can be UNDEFINED; then the logs will be searched globally. */
         address?: TAddress | TAddress[]
         /**
-         * "deployment": get the contracts deployment date to skip lots of blocks (in case we use pagination to fetch logs)
+         * "deployment": get the contract deployment date to skip many blocks when paginating logs.
          */
         fromBlock?: number | Date | 'deployment'
         toBlock?: number | Date
@@ -214,14 +214,14 @@ export class ContractReader implements IContractReader {
                 if ($is.Array(options.address)) {
                     throw new Error('Cannot use "deployment" with multiple addresses');
                 }
-                $require.Address(options.address, `No contract address provided, but the "fromBlock" is "deployment"`)
+                $require.Address(options.address, `No contract address was provided, but "fromBlock" is "deployment"`)
                 try {
                     let explorer = BlockchainExplorerFactory.get(this.client.platform);
                     let dateResolver = new ContractCreationResolver(this.client, explorer);
                     let info = await dateResolver.getInfo(options.address);
                     filters.fromBlock = info.block - 1;
                 } catch (error) {
-                    // Skip any explorer errors and look from block 0
+                    // Skip any explorer errors and search from block 0.
                 }
             } else {
                 filters.fromBlock = await $block.ensureNumber(options.fromBlock, this.client);
@@ -259,7 +259,7 @@ export class ContractReader implements IContractReader {
                 }
                 filters.topics = topics;
             } else {
-                // is Array: query multiple events
+                // Array: query multiple events.
                 let topics = [
                     abi.map($abiUtils.getTopicSignature)
                 ];