dequanto 0.1.23 → 0.1.24

package/readme.md

@@ -2,51 +2,56 @@
 
 [![Documentation Link](https://img.shields.io/badge/%E2%9D%93-documentation-green.svg)](https://docs.0xweb.org/dequanto)
 [![CircleCI](https://circleci.com/gh/0xweb-org/dequanto.svg?style=svg)](https://circleci.com/gh/0xweb-org/dequanto)
+[![NPM version](https://badge.fury.io/js/dequanto.svg)](http://badge.fury.io/js/dequanto)
 
 <p align='center'>
     <img src='assets/background.jpg'/>
 </p>
 
 
-A versatile library for EVM Blockchain Developers and Consumers. Based on your requirements and expertise, this library can either fully abstract the Blockchain Layer with autogenerated classes for contract communication or give you direct access to low-level methods.
+A flexible and all-in-one library for EVM Blockchain Developers and Consumers. Based on your requirements and expertise, this library can either fully abstract the Blockchain Layer with autogenerated classes for contract communication or give you direct access to low-level methods.
 
 This library includes numerous classes to cover all facets of blockchain development. Here’s a summary of some key features:
 
-### TypeScript and ES6 Class Generation
+### ✨ Generate ES6 classes with TypeScript support
 
-Generate contract clients based on ABI or source code, which can be automatically retrieved from blockchain explorers by address.
+Create contract clients based on ABI or source code, which can be automatically retrieved from blockchain explorers by address.
 
 > This can serve as an all-in-one tool for submitting transactions, querying contracts, or fetching events, as the contract clients handle the underlying steps.
 
 ---
 
-### RPC Clients
+### 🌐 RPC Clients
 
-A robust communication layer to connect to blockchain nodes. You can add multiple nodes (private or public) to the pool to manage **request balancing**, **throttling**, **rate limits**, and **automatic retries**.
+A robust communication layer to connect to blockchain nodes. You can add multiple nodes (private or public) to the pool to manage
 
-### Transaction Builder
+- **request balancing**
+- **throttling**
+- **rate limits**
+- **automatic retries**
 
-Provides fine-tuning for transaction submission. Supports Gnosis {Safe} and Account Abstraction Transactions.
+### 🏗️ Transaction Builder
 
-### Etherscan & Co Clients
+Provides fine-tuning for transaction submission. Supports Gnosis {Safe}, Account Abstraction Transactions and Flashbots.
+
+### 💠 Etherscan & Co Clients
 
 An integrated API for blockchain explorers.
 
-### Event Indexer
+### 🔎 Event Indexer
 
-An easy-to-use indexer for fetching contract events.
+An easy-to-use indexer for fetching contract events with file persistence layer and pause-resume progress.
 
-### Event and Transaction Watcher
+### 👀 Event and Transaction Watcher
 
 Listen to events and monitor transactions in real-time.
 
-### Native **`BigInt`** Types with **`BigFloat`** Support for Mantissa Math
+### 🔢 Native **`BigInt`** Types with **`BigFloat`** Support for Mantissa Math
 
-### Pre-generated OpenZeppelin Contracts
+### 📦 Pre-generated OpenZeppelin Contracts
 
-### Flashbots Support
 
-## Installation
+## ⬇️ Installation
 
 ### Using 0xweb CLI
 
@@ -62,26 +67,17 @@ npm i dequanto
 
 The package includes three types of source files:
 
-1. **TypeScript Sources**: Configure paths in your `tsconfig.json` like so:
+1. **Compiled CommonJS (CJS) Files**: Located at `node_modules/dequanto/lib/cjs/*/**.js`
+2. **Compiled ESM (Modules)**: Located at `node_modules/dequanto/lib/esm/*/**.mjs`
+3. **TypeScript Sources**: Located at `node_modules/dequanto/src/*/**.ts`
 
-   ```json
-   {
-       "compilerOptions": {
-           "paths": {
-               "@dequanto/*": [ "node_modules/dequanto/src/*" ],
-               "@dequanto-contract/*": [ "node_modules/dequanto/src/prebuilt/*" ]
-           }
-       }
-   }
-   ```
+Node and Build environments will automatically detect between 1 and 2 based on your project setup.
 
-2. **Compiled CommonJS (CJS) Files**: Located at `node_modules/dequanto/lib/cjs/*/**.js`
-3. **Compiled ESM (Modules)**: Located at `node_modules/dequanto/lib/esm/*/**.mjs`
 
-### Configuration
+### 🛠️ Configuration
 
 While the library includes configurations for various blockchains and {Safe} infrastructure, you may need to set custom RPC URLs, Blockchain Explorer API Keys, and other settings. This can be done in a **YAML** configuration file that loads when the application starts.
 
 ----
 
-(c) 2024 0xweb.org
+🏁 (c) 2024 0xweb.org

package/src/config/ConfigProvider.ts

@@ -45,7 +45,11 @@ export class ConfigProvider implements IConfigProvider {
 
         return [
             {
-                config: ConfigDefaults,
+                config: {
+                    ...ConfigDefaults,
+                    pin: unlockedAccountsKey ?? void 0,
+                    ...(parameters?.config ?? {}),
+                }
             },
             {
                 path: `./configs/dequanto.yml`,
@@ -82,8 +86,11 @@ export class ConfigProvider implements IConfigProvider {
     private async getSourcesBrowser (parameters: TConfigParamsNode) {
         return [
             {
-                config: ConfigDefaults
-            }
+                config: {
+                    ...ConfigDefaults,
+                    ...(parameters?.config ?? {}),
+                }
+            },
         ];
     }
 }

package/src/gen/templates/ContractTemplate.ts.tmpl

@@ -3,24 +3,24 @@
  *  Implementation: $EXPLORER_URL$
  */
 import di from 'a-di';
-import { TAddress } from '@dequanto/models/TAddress';
-import { TAccount } from '@dequanto/models/TAccount';
-import { TBufferLike } from '@dequanto/models/TBufferLike';
-import { ClientEventsStream, TClientEventsStreamData } from '@dequanto/clients/ClientEventsStream';
-import { ContractBase } from '@dequanto/contracts/ContractBase';
-import { ContractBaseUtils } from '@dequanto/contracts/utils/ContractBaseUtils';
-import { ContractStorageReaderBase } from '@dequanto/contracts/ContractStorageReaderBase';
-import { TxWriter } from '@dequanto/txs/TxWriter';
-import { ITxLogItem } from '@dequanto/txs/receipt/ITxLogItem';
-import { Web3Client } from '@dequanto/clients/Web3Client';
-import { IBlockChainExplorer } from '@dequanto/explorer/IBlockChainExplorer';
-import { SubjectStream } from '@dequanto/class/SubjectStream';
-
-
-import type { ContractWriter } from '@dequanto/contracts/ContractWriter';
-import type { TAbiItem } from '@dequanto/types/TAbi';
-import type { TEth } from '@dequanto/models/TEth';
-import type { TOverrideReturns } from '@dequanto/utils/types';
+import { TAddress } from 'dequanto/models/TAddress';
+import { TAccount } from 'dequanto/models/TAccount';
+import { TBufferLike } from 'dequanto/models/TBufferLike';
+import { ClientEventsStream, TClientEventsStreamData } from 'dequanto/clients/ClientEventsStream';
+import { ContractBase } from 'dequanto/contracts/ContractBase';
+import { ContractBaseUtils } from 'dequanto/contracts/utils/ContractBaseUtils';
+import { ContractStorageReaderBase } from 'dequanto/contracts/ContractStorageReaderBase';
+import { TxWriter } from 'dequanto/txs/TxWriter';
+import { ITxLogItem } from 'dequanto/txs/receipt/ITxLogItem';
+import { Web3Client } from 'dequanto/clients/Web3Client';
+import { IBlockChainExplorer } from 'dequanto/explorer/IBlockChainExplorer';
+import { SubjectStream } from 'dequanto/class/SubjectStream';
+
+
+import type { ContractWriter } from 'dequanto/contracts/ContractWriter';
+import type { TAbiItem } from 'dequanto/types/TAbi';
+import type { TEth } from 'dequanto/models/TEth';
+import type { TOverrideReturns } from 'dequanto/utils/types';
 
 
 /* IMPORTS */

package/src/hardhat/HardhatProvider.ts

@@ -297,7 +297,7 @@ export class HardhatProvider {
         const hhOptions = {
             ...paths,
             tsgen: options?.tsgen ?? false,
-            install: options?.install ?? null
+            install: options?.install ?? void 0
         };
         const hh = await this.getHardhat();
         await hh.run('compile', hhOptions);
@@ -346,7 +346,7 @@ export class HardhatProvider {
             ...paths,
 
             tsgen: options?.tsgen ?? false,
-            install: options?.install ?? null
+            install: options?.install ?? void 0
         };
         const hh = await this.getHardhat();
         await hh.run('compile', hhOptions);

package/lib/esm/ChainAccountService.d.ts

@@ -1,55 +0,0 @@
-import type { Config as Appcfg } from 'appcfg/Config';
-import { IAccount } from "./models/TAccount";
-import { TAddress } from './models/TAddress';
-import { TPlatform } from './models/TPlatform';
-import { TEth } from './models/TEth';
-export declare class ChainAccountService {
-    private storeConfig;
-    private storeFs;
-    private storeCustom;
-    private writable;
-    constructor(params?: {
-        store?: IAccountsStore;
-        writable?: 'config' | 'fs' | 'custom';
-        config?: InstanceType<typeof Appcfg>;
-    });
-    get<T extends IAccount = IAccount>(key: TEth.Hex | TAddress): Promise<T>;
-    get<T extends IAccount = IAccount>(mnemonic: string, params?: {
-        index?: number;
-        path?: string;
-    }): Promise<T>;
-    get<T extends IAccount = IAccount>(ns: string, params?: {
-        platform?: TPlatform;
-    }): Promise<T>;
-    get<T extends IAccount = IAccount>(name: string, params?: {
-        platform?: TPlatform;
-    }): Promise<T>;
-    get<T extends IAccount = IAccount>(address: TAddress, params?: {
-        platform?: TPlatform;
-    }): Promise<T>;
-    get<T extends IAccount = IAccount>(mix: string | TEth.Hex | TAddress, params?: {
-        platform?: TPlatform;
-        index?: number;
-        path?: string;
-    }): Promise<T>;
-    static get<T = IAccount>(name: string, params?: {
-        platform?: TPlatform;
-        store?: IAccountsStore;
-        writable?: 'config' | 'fs' | 'custom';
-        config?: Appcfg;
-    }): Promise<T>;
-    getAll(): Promise<IAccount[]>;
-    create(opts: {
-        name: string;
-        platform?: TPlatform;
-    }): Promise<IAccount>;
-    createMany(names: string[], platform: TPlatform): Promise<IAccount[]>;
-    private getWritableStore;
-}
-export interface IAccountsStore {
-    get(name: string): Promise<IAccount>;
-    get(address: TAddress): Promise<IAccount>;
-    getAll(): Promise<IAccount[]>;
-    save(account: IAccount): Promise<void>;
-    saveMany(accounts: IAccount[]): Promise<void>;
-}

package/lib/esm/abi/$abiCoder.d.ts

@@ -1,11 +0,0 @@
-import { TAbiInput } from '../types/TAbi';
-import { ParamType } from './fragments';
-import { TEth } from '../models/TEth';
-export declare namespace $abiCoder {
-    function encode(types: (string | ParamType | TAbiInput)[], values: any[]): TEth.Hex;
-    function encodePacked(types: string[], values: any[]): TEth.Hex;
-    function decode(types: (string | ParamType | TAbiInput)[], hex: string, opts?: {
-        loose?: boolean;
-        dynamic?: boolean;
-    }): any;
-}

package/lib/esm/abi/$rlp.d.ts

@@ -1,8 +0,0 @@
-import { TEth } from '../models/TEth';
-export declare namespace $rlp {
-    type RecursiveArray<T> = T | RecursiveArray<T>[];
-    function encode(arr: RecursiveArray<TEth.Hex | Uint8Array>): TEth.Hex;
-    function decode(value: Uint8Array | TEth.Hex, to?: 'hex'): RecursiveArray<Uint8Array>;
-    function decode(value: Uint8Array | TEth.Hex, to: 'bytes'): RecursiveArray<TEth.Hex>;
-    function bytesToRlp(bytes: RecursiveArray<Uint8Array>): Uint8Array;
-}

package/lib/esm/abi/Logger.d.ts

@@ -1,11 +0,0 @@
-export declare class Logger {
-    private v;
-    static errors: {
-        BUFFER_OVERRUN: string;
-        INVALID_ARGUMENT: string;
-    };
-    constructor(v?: string);
-    throwArgumentError(message: any, localVar: any, value: any): void;
-    throwError(message: any, name: any, params: any): void;
-    checkArgumentCount(length: number, count: number, message: string): void;
-}

package/lib/esm/abi/_version.d.ts

@@ -1 +0,0 @@
-export declare const version = "abi/5.7.0";

package/lib/esm/abi/abi-coder-packed.d.ts

@@ -1,10 +0,0 @@
-/**
- *   Computes the [[link-solc-packed]] representation of %%values%%
- *   respectively to their %%types%%.
- *
- *   @example:
- *       addr = "0x8ba1f109551bd432803012645ac136ddd64dba72"
- *       solidityPacked([ "address", "uint" ], [ addr, 45 ]);
- *       //_result:
- */
-export declare function solidityPacked(types: string[], values: ReadonlyArray<any>): string;

package/lib/esm/abi/abi-coder.d.ts

@@ -1,52 +0,0 @@
-/**
- *  When sending values to or receiving values from a [[Contract]], the
- *  data is generally encoded using the [ABI standard](link-solc-abi).
- *
- *  The AbiCoder provides a utility to encode values to ABI data and
- *  decode values from ABI data.
- *
- *  Most of the time, developers should favour the [[Contract]] class,
- *  which further abstracts a lot of the finer details of ABI data.
- *
- *  @_section api/abi/abi-coder:ABI Encoding
- */
-import { Result } from "./coders/abstract-coder";
-import { ParamType } from "./fragments";
-import { TAbiInput } from '../types/TAbi';
-/**
- *  The **AbiCoder** is a low-level class responsible for encoding JavaScript
- *  values into binary data and decoding binary data into JavaScript values.
- */
-export declare class AbiCoder {
-    #private;
-    /**
-     *  Get the default values for the given %%types%%.
-     *
-     *  For example, a ``uint`` is by default ``0`` and ``bool``
-     *  is by default ``false``.
-     */
-    getDefaultValue(types: ReadonlyArray<string | ParamType>): Result;
-    /**
-     *  Encode the %%values%% as the %%types%% into ABI data.
-     *
-     *  @returns DataHexstring
-     */
-    encode(types: ReadonlyArray<string | ParamType | TAbiInput>, values: ReadonlyArray<any>): string;
-    /**
-     *  Decode the ABI %%data%% as the %%types%% into values.
-     *
-     *  If %%loose%% decoding is enabled, then strict padding is
-     *  not enforced. Some older versions of Solidity incorrectly
-     *  padded event data emitted from ``external`` functions.
-     */
-    decode(types: ReadonlyArray<string | ParamType | TAbiInput>, hex: string, opts?: {
-        loose?: boolean;
-        dynamic?: boolean;
-    }): Result;
-    /**
-     *  Returns the shared singleton instance of a default [[AbiCoder]].
-     *
-     *  On the first call, the instance is created internally.
-     */
-    static defaultAbiCoder(): AbiCoder;
-}

package/lib/esm/abi/coders/abstract-coder.d.ts

@@ -1,119 +0,0 @@
-/**
- * @_ignore:
- */
-export declare const WordSize: number;
-/**
- *  A [[Result]] is a sub-class of Array, which allows accessing any
- *  of its values either positionally by its index or, if keys are
- *  provided by its name.
- *
- *  @_docloc: api/abi
- */
-export declare class Result extends Array<any> {
-    #private;
-    [K: string | number]: any;
-    /**
-     *  @private
-     */
-    constructor(...args: Array<any>);
-    /**
-     *  Returns the Result as a normal Array.
-     *
-     *  This will throw if there are any outstanding deferred
-     *  errors.
-     */
-    toArray(): Array<any>;
-    /**
-     *  Returns the Result as an Object with each name-value pair.
-     *
-     *  This will throw if any value is unnamed, or if there are
-     *  any outstanding deferred errors.
-     */
-    toObject(): Record<string, any>;
-    /**
-     *  @_ignore
-     */
-    slice(start?: number | undefined, end?: number | undefined): Result;
-    /**
-     *  @_ignore
-     */
-    filter(callback: (el: any, index: number, array: Result) => boolean, thisArg?: any): Result;
-    /**
-     *  @_ignore
-     */
-    map<T extends any = any>(callback: (el: any, index: number, array: Result) => T, thisArg?: any): Array<T>;
-    /**
-     *  Returns the value for %%name%%.
-     *
-     *  Since it is possible to have a key whose name conflicts with
-     *  a method on a [[Result]] or its superclass Array, or any
-     *  JavaScript keyword, this ensures all named values are still
-     *  accessible by name.
-     */
-    getValue(name: string): any;
-    /**
-     *  Creates a new [[Result]] for %%items%% with each entry
-     *  also accessible by its corresponding name in %%keys%%.
-     */
-    static fromItems(items: Array<any>, keys?: Array<null | string>): Result;
-}
-/**
- *  Returns all errors found in a [[Result]].
- *
- *  Since certain errors encountered when creating a [[Result]] do
- *  not impact the ability to continue parsing data, they are
- *  deferred until they are actually accessed. Hence a faulty string
- *  in an Event that is never used does not impact the program flow.
- *
- *  However, sometimes it may be useful to access, identify or
- *  validate correctness of a [[Result]].
- *
- *  @_docloc api/abi
- */
-export declare function checkResultErrors(result: Result): Array<{
-    path: Array<string | number>;
-    error: Error;
-}>;
-/**
- *  @_ignore
- */
-export declare abstract class Coder {
-    readonly name: string;
-    readonly type: string;
-    readonly localName: string;
-    readonly dynamic: boolean;
-    constructor(name: string, type: string, localName: string, dynamic: boolean);
-    _throwError(message: string, value: any): never;
-    abstract encode(writer: Writer, value: any): number;
-    abstract decode(reader: Reader): any;
-    abstract defaultValue(): any;
-}
-/**
- *  @_ignore
- */
-export declare class Writer {
-    #private;
-    constructor();
-    get data(): string;
-    get length(): number;
-    appendWriter(writer: Writer): number;
-    writeBytes(value: Uint8Array): number;
-    writeValue(value: bigint): number;
-    writeUpdatableValue(): (value: bigint) => void;
-}
-/**
- *  @_ignore
- */
-export declare class Reader {
-    #private;
-    readonly allowLoose: boolean;
-    constructor(data: string | Uint8Array, allowLoose?: boolean);
-    get data(): string;
-    get dataLength(): number;
-    get consumed(): number;
-    get bytes(): Uint8Array;
-    subReader(offset: number): Reader;
-    readBytes(length: number, loose?: boolean): Uint8Array;
-    readValue(): bigint;
-    readIndex(): number;
-}

package/lib/esm/abi/coders/address.d.ts

@@ -1,11 +0,0 @@
-import type { Reader, Writer } from "./abstract-coder";
-import { Coder } from "./abstract-coder";
-/**
- *  @_ignore
- */
-export declare class AddressCoder extends Coder {
-    constructor(localName: string);
-    defaultValue(): string;
-    encode(writer: Writer, _value: string): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/anonymous.d.ts

@@ -1,14 +0,0 @@
-import { Coder } from "./abstract-coder";
-import type { Reader, Writer } from "./abstract-coder";
-/**
- *  Clones the functionality of an existing Coder, but without a localName
- *
- *  @_ignore
- */
-export declare class AnonymousCoder extends Coder {
-    private coder;
-    constructor(coder: Coder);
-    defaultValue(): any;
-    encode(writer: Writer, value: any): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/array.d.ts

@@ -1,20 +0,0 @@
-import { Coder, Result, Writer } from "./abstract-coder";
-import type { Reader } from "./abstract-coder";
-export declare function pack(writer: Writer, coders: ReadonlyArray<Coder>, values: Array<any> | {
-    [name: string]: any;
-}): number;
-/**
- *  @_ignore
- */
-export declare function unpack(reader: Reader, coders: ReadonlyArray<Coder>): Result;
-/**
- *  @_ignore
- */
-export declare class ArrayCoder extends Coder {
-    readonly coder: Coder;
-    readonly length: number;
-    constructor(coder: Coder, length: number, localName: string);
-    defaultValue(): Array<any>;
-    encode(writer: Writer, _value: Array<any>): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/boolean.d.ts

@@ -1,11 +0,0 @@
-import { Coder } from "./abstract-coder";
-import type { Reader, Writer } from "./abstract-coder";
-/**
- *  @_ignore
- */
-export declare class BooleanCoder extends Coder {
-    constructor(localName: string);
-    defaultValue(): boolean;
-    encode(writer: Writer, value: boolean): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/bytes.d.ts

@@ -1,18 +0,0 @@
-import { Coder } from "./abstract-coder";
-import type { Reader, Writer } from "./abstract-coder";
-/**
- *  @_ignore
- */
-export declare class DynamicBytesCoder extends Coder {
-    constructor(type: string, localName: string);
-    defaultValue(): string;
-    encode(writer: Writer, value: any): number;
-    decode(reader: Reader): Uint8Array;
-}
-/**
- *  @_ignore
- */
-export declare class BytesCoder extends DynamicBytesCoder {
-    constructor(localName: string);
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/fixed-bytes.d.ts

@@ -1,12 +0,0 @@
-import type { Reader, Writer } from "./abstract-coder";
-import { Coder } from "./abstract-coder";
-/**
- *  @_ignore
- */
-export declare class FixedBytesCoder extends Coder {
-    readonly size: number;
-    constructor(size: number, localName: string);
-    defaultValue(): string;
-    encode(writer: Writer, value: Uint8Array | string): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/null.d.ts

@@ -1,11 +0,0 @@
-import { Coder } from "./abstract-coder";
-import type { Reader, Writer } from "./abstract-coder";
-/**
- *  @_ignore
- */
-export declare class NullCoder extends Coder {
-    constructor(localName: string);
-    defaultValue(): null;
-    encode(writer: Writer, value: any): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/number.d.ts

@@ -1,13 +0,0 @@
-import { Coder } from "./abstract-coder";
-import type { Reader, Writer } from "./abstract-coder";
-/**
- *  @_ignore
- */
-export declare class NumberCoder extends Coder {
-    readonly size: number;
-    readonly signed: boolean;
-    constructor(size: number, signed: boolean, localName: string);
-    defaultValue(): number;
-    encode(writer: Writer, _value: bigint | number | string): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/string.d.ts

@@ -1,8 +0,0 @@
-import type { Reader, Writer } from './abstract-coder';
-import { DynamicBytesCoder } from './bytes';
-export declare class StringCoder extends DynamicBytesCoder {
-    constructor(localName: string);
-    defaultValue(): string;
-    encode(writer: Writer, _value: string): number;
-    decode(reader: Reader): any;
-}

package/lib/esm/abi/coders/tuple.d.ts

@@ -1,11 +0,0 @@
-import { Coder } from './abstract-coder';
-import type { Reader, Writer } from './abstract-coder';
-export declare class TupleCoder extends Coder {
-    readonly coders: ReadonlyArray<Coder>;
-    constructor(coders: Array<Coder>, localName: string, dynamic?: boolean);
-    defaultValue(): any;
-    encode(writer: Writer, _value: Array<any> | {
-        [name: string]: any;
-    }): number;
-    decode(reader: Reader): any;
-}