dequanto 0.1.39 → 0.1.45

package/src/contracts/ContractWriter.ts

@@ -120,6 +120,7 @@ export class ContractWriter implements IContractWriter {
         }
 
         let writerConfig = configs?.writerConfig ?? this.writerConfig;
+
         let writer = TxWriter.write(
             this.client,
             txBuilder,

package/src/contracts/deploy/storage/DeploymentsStorage.ts

@@ -233,14 +233,13 @@ export class  DeploymentsStorage {
             path = class_Uri.combine(directory, `${filenamePrefix}${platformPathNormalized}-${upstreamPlatformNormalized}.json`);
 
             let upstreamDeploymentExists = await File.existsAsync(upstreamDeploymentsPath);
-
+            let upstreamDeployments: IDeployment[];
             let shouldCopy = true;
             if (await File.existsAsync(path)) {
                 // forked deployments path already exists, check if stale
                 let blockNumber = await this.client.getBlockNumber();
                 if (upstreamDeploymentExists) {
-                    let upstreamDeployments = await File.readAsync<IDeployment[]>(upstreamDeploymentsPath);
-
+                    upstreamDeployments = await File.readAsync<IDeployment[]>(upstreamDeploymentsPath);
                     // 1. Check if the original(upstream) network has more recent deployments
                     let hasNewDeployments = upstreamDeployments.some(x => x.block > blockNumber);
                     shouldCopy = hasNewDeployments;
@@ -248,6 +247,8 @@ export class  DeploymentsStorage {
                     shouldCopy = false;
                 }
 
+
+
                 if (shouldCopy === false) {
                     let deployments = await File.readAsync<IDeployment[]>(path);
                     // 2. Always copy if forked deployments are empty
@@ -271,6 +272,15 @@ export class  DeploymentsStorage {
                             }
                         }
                     }
+                    if (shouldCopy === false && upstreamDeployments?.length > 0) {
+                        // 5. Just-in-case, if there are upstream deployments with lower block number, as the current HEAD, but not in the current forked network
+                        let deploymentIds = alot(deployments).toDictionary(x => x.id);
+                        let hasNewDeployments = upstreamDeployments
+                            .filter(x => x.block <= blockNumber)
+                            .some(x => x.id in deploymentIds === false)
+
+                        shouldCopy = hasNewDeployments;
+                    }
                 }
             }
             if (shouldCopy) {

package/src/explorer/BlockchainExplorer.ts

@@ -10,7 +10,6 @@ import { TPlatform } from '@dequanto/models/TPlatform';
 import { $address } from '@dequanto/utils/$address';
 import { $require } from '@dequanto/utils/$require';
 import { Web3ClientFactory } from '@dequanto/clients/Web3ClientFactory';
-import { $config } from '@dequanto/utils/$config';
 import { $str } from '@dequanto/solidity/utils/$str';
 import { $platform } from '@dequanto/utils/$platform';
 import type { TAbiItem } from '@dequanto/types/TAbi';
@@ -19,8 +18,10 @@ import { $is } from '@dequanto/utils/$is';
 import { $http } from '@dequanto/utils/$http';
 import { IVerifier } from './verifiers/IVerifier';
 import { FsHtmlVerifier } from './verifiers/FsHtmlVerifier';
+import { TExplorer, TExplorerDefinition } from '@dequanto/models/TExplorer';
 
 
+/** @deprecated use TExplorerDefinition instead */
 export interface IBlockchainExplorerConfig {
     key?: string
     api?: string
@@ -34,6 +35,7 @@ export interface IBlockchainExplorerConfig {
     }[]
 }
 
+/** @deprecated use TExplorerDefinition instead */
 export interface IBlockchainExplorerFactoryParams extends IBlockchainExplorerConfig {
 
     platform?: string
@@ -56,35 +58,65 @@ export class BlockchainExplorer implements IBlockchainExplorer {
 
 
     inMemoryDb: IContractDetails[]
-    config: IBlockchainExplorerConfig;
     fsVerification: IVerifier
-    opts: IBlockchainExplorerFactoryParams;
-    platform: TPlatform;
 
-    constructor(opts?: IBlockchainExplorerFactoryParams)
-    constructor(platform?: TPlatform)
-    constructor(mix?: TPlatform | IBlockchainExplorerFactoryParams) {
+    config: TExplorer
+    platform: TPlatform
+    // opts: IBlockchainExplorerFactoryParams;
 
-        let opts = typeof mix === 'string'
-            ? { platform: mix }
-            : mix;
+    getWeb3: (platform) => Web3Client
 
-        this.opts = ensureDefaults(opts);
-        this.config = opts.getConfig(this.platform)
-        this.inMemoryDb = this.opts.CONTRACTS ?? [];
-        this.platform =this.opts.platform;
 
-        if ($str.isNullOrWhiteSpace(opts.ABI_CACHE) === false) {
+    constructor(config: TExplorerDefinition)
+    constructor(opts: IBlockchainExplorerFactoryParams)
+    constructor(mix: TExplorerDefinition | IBlockchainExplorerFactoryParams) {
+
+        $require.notNull(mix.platform, `BlockchainExplorer: Platform is required`);
+
+        let ABI_CACHE = mix.ABI_CACHE ?? `./cache/${$platform.toPath(mix.platform)}/abis.json`;
+        let CONTRACTS = mix.CONTRACTS ?? [];
+
+        let source = mix as TExplorerDefinition & IBlockchainExplorerFactoryParams;
+        let config = {
+            platform: mix.platform,
+            url: source.url ?? source.www ?? source.host,
+            api: (() => {
+                if (source.api == null) {
+                    let host = source.url ?? source.host ?? source.www;
+                    return {
+                        url: `${host}/api`,
+                        key: source.key
+                    }
+                }
+                if (typeof source.api === 'string') {
+                    return {
+                        url: source.api,
+                        key: source.key
+                    }
+                }
+                return source.api;
+            })(),
+            name: source.name ,
+            verification: source.verification ?? true,
+            standard: source.standard,
+        } satisfies TExplorer;
+
+        this.inMemoryDb = CONTRACTS ?? [];
+        this.config = config;
+        this.platform = config.platform;
+        this.getWeb3 = mix.getWeb3 ?? ((platform) => Web3ClientFactory.get(platform));
+
+        if ($str.isNullOrWhiteSpace(ABI_CACHE) === false) {
             this.getContractAbi = memd.fn.memoize(this.getContractAbi, {
                 trackRef: true,
                 persistence: new memd.FsTransport({
-                    path: opts.ABI_CACHE
+                    path: ABI_CACHE
                 })
             });
             this.getContractSource = memd.fn.memoize(this.getContractSource, {
                 trackRef: true,
                 persistence: new memd.FsTransport({
-                    path: opts.ABI_CACHE.replace('.json', '-source.json')
+                    path: ABI_CACHE.replace('.json', '-source.json')
                 })
             });
         }
@@ -101,8 +133,8 @@ export class BlockchainExplorer implements IBlockchainExplorer {
     }
 
     async getContractCreation(address: TAddress): Promise<{ creator: TAddress, txHash: TEth.Hex }> {
-        let apiUrl = this.config.api ?? `${this.config.host}/api`;
-        let url = `${apiUrl}?module=contract&action=getcontractcreation&contractaddresses=${address}&apikey=${this.config.key}`;
+        let apiUrl = this.config.api.url;
+        let url = `${apiUrl}?module=contract&action=getcontractcreation&contractaddresses=${address}&apikey=${this.config.api.key}`;
         let result = await this.client.get(url);
         let json = Array.isArray(result) ? result[0] : result;
         if (json == null) {
@@ -131,8 +163,8 @@ export class BlockchainExplorer implements IBlockchainExplorer {
             return { abi: info.abi, implementation: address }
         }
 
-        let apiUrl = this.config.api ?? `${this.config.host}/api`;
-        let url = `${apiUrl}?module=contract&action=getabi&address=${address}&apikey=${this.config.key}`;
+        let apiUrl = this.config.api.url;
+        let url = `${apiUrl}?module=contract&action=getabi&address=${address}&apikey=${this.config.api.key}`;
         let abi: string;
 
         try {
@@ -149,7 +181,7 @@ export class BlockchainExplorer implements IBlockchainExplorer {
         let abiJson = JSON.parse(abi);
         if (params?.implementation) {
             if ($is.HexBytes32(params.implementation)) {
-                let web3 = this.opts.getWeb3(this.platform);
+                let web3 = this.getWeb3(this.platform);
                 let uin256Hex = await web3.getStorageAt(
                     address,
                     params.implementation
@@ -160,7 +192,7 @@ export class BlockchainExplorer implements IBlockchainExplorer {
             throw new Error(`Implement ${params.implementation} support`);
         }
         if (isOpenZeppelinProxy(abiJson) || mightBeProxy(abiJson)) {
-            let web3 = this.opts.getWeb3(this.platform);
+            let web3 = this.getWeb3(this.platform);
             // (BigInt($contract.keccak256("eip1967.proxy.implementation")) - 1n).toString(16);
             let uint256Hex = await web3.getStorageAt(address, `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc`);
             if ($address.isEmpty(uint256Hex)) {
@@ -179,7 +211,7 @@ export class BlockchainExplorer implements IBlockchainExplorer {
         }
 
         if (hasImplementationSlot(abiJson)) {
-            let web3 = this.opts.getWeb3(this.platform);
+            let web3 = this.getWeb3(this.platform);
             let implAddress = await web3.readContract({
                 address: address,
                 abi: abiJson,
@@ -189,7 +221,7 @@ export class BlockchainExplorer implements IBlockchainExplorer {
             return this.getContractAbi(implAddress);
         }
         if (hasTargetSlot(abiJson)) {
-            let web3 = this.opts.getWeb3(this.platform);
+            let web3 = this.getWeb3(this.platform);
             let implAddress = await web3.readContract({
                 address: address,
                 abi: abiJson,
@@ -214,9 +246,9 @@ export class BlockchainExplorer implements IBlockchainExplorer {
     }) {
         await this.fsVerification.submitContractVerification(contractData);
 
-        let url = this.config.api ?? `${this.config.host}/api`;
+        let url = this.config.api.url;
         let body = {
-            apikey: this.config.key,
+            apikey: this.config.api.key,
             module: 'contract',
             action: 'verifysourcecode',
             contractaddress: contractData.address,
@@ -240,9 +272,9 @@ export class BlockchainExplorer implements IBlockchainExplorer {
     }
 
     async checkContractVerificationSubmission(submission: { guid }) {
-        let url = this.config.api ?? `${this.config.host}/api`;
+        let url = this.config.api.url;
         let result = await this.client.get<string>(url, {
-            apikey: this.config.key,
+            apikey: this.config.api.key,
             module: "contract",
             action: "checkverifystatus",
             guid: submission.guid
@@ -256,10 +288,10 @@ export class BlockchainExplorer implements IBlockchainExplorer {
     }): Promise<string> {
         await this.fsVerification.submitContractProxyVerification(contractData);
 
-        let url = this.config.api ?? `${this.config.host}/api`;
+        let url = this.config.api.url;
         let guid = await this.client.post(url, {
             body: {
-                apikey: this.config.key,
+                apikey: this.config.api.key,
                 module: "contract",
                 action: "verifyproxycontract",
                 address: contractData.address,
@@ -269,9 +301,9 @@ export class BlockchainExplorer implements IBlockchainExplorer {
         return guid;
     }
     async checkContractProxyVerificationSubmission(submission: { guid: any; }): Promise<string> {
-        let url = this.config.api ?? `${this.config.host}/api`;
+        let url = this.config.api.url;
         let result = await this.client.get<string>(url, {
-            apikey: this.config.key,
+            apikey: this.config.api.key,
             module: "contract",
             action: "checkproxyverification",
             guid: submission.guid
@@ -292,8 +324,8 @@ export class BlockchainExplorer implements IBlockchainExplorer {
         ContractName: string
         ABI: string
     }> {
-        let apiUrl = this.config.api ?? `${this.config.host}/api`;
-        let url = `${apiUrl}?module=contract&action=getsourcecode&address=${address}&apikey=${this.config.key}`;
+        let apiUrl = this.config.api.url;
+        let url = `${apiUrl}?module=contract&action=getsourcecode&address=${address}&apikey=${this.config.api.key}`;
         let result = await this.client.get(url);
         let json = Array.isArray(result) ? result[0] : result;
 
@@ -400,7 +432,7 @@ export class BlockchainExplorer implements IBlockchainExplorer {
     }
 
     async getSimilarContract(address: TAddress) {
-        let url = `${this.config.www}/address/${address}#code`;
+        let url = `${this.config.url}/address/${address}#code`;
         let html = await this.client.getHtml(url);
         let rgx = /This contract matches/ig;
         let match = rgx.exec(html);
@@ -426,8 +458,8 @@ export class BlockchainExplorer implements IBlockchainExplorer {
         size?: number,
         sort?: 'asc' | 'desc'
     }) {
-        let apiUrl = this.config.api ?? `${this.config.host}/api`;
-        let url = `${apiUrl}?module=account&action=${type}&address=${address}&sort=${params.sort ?? 'desc'}&apikey=${this.config.key}`;
+        let apiUrl = this.config.api.url;
+        let url = `${apiUrl}?module=account&action=${type}&address=${address}&sort=${params.sort ?? 'desc'}&apikey=${this.config.api.key}`;
         if (params.fromBlockNumber != null) {
             url += `&startblock=${params.fromBlockNumber}`
         }
@@ -515,25 +547,24 @@ function hasMethod(abi: TAbiItem[], name: string) {
     return abi.some(item => item.type === 'function' && item.name === name);
 }
 
-function ensureDefaults(opts: IBlockchainExplorerFactoryParams) {
-    opts ??= {};
+function ensureDefaults(opts: TExplorerDefinition) {
 
     let platform = opts.platform;
     $require.notNull(platform, `Generic Blockchain Explorer Config should contain platform name`);
 
     opts.ABI_CACHE ??= `./cache/${$platform.toPath(platform)}/abis.json`
     opts.CONTRACTS ??= [];
-    opts.getWeb3 ??= (_) => {
-        return Web3ClientFactory.get(platform);
-    };
-    opts.getConfig ??= () => {
-        let config = $config.get(`blockchainExplorer.${platform}`);
-
-        return {
-            ...(config ?? {}),
-            ...opts,
-        };
-    };
+    // opts.getWeb3 ??= (_) => {
+    //     return Web3ClientFactory.get(platform);
+    // };
+    // opts.getConfig ??= () => {
+    //     let config = $config.get(`blockchainExplorer.${platform}`);
+
+    //     return {
+    //         ...(config ?? {}),
+    //         ...opts,
+    //     };
+    // };
     return opts;
 }
 

package/src/explorer/BlockchainExplorerFactory.ts

@@ -4,6 +4,10 @@ import { BlockchainExplorer, IBlockchainExplorerConfig, IBlockchainExplorerFacto
 import { TPlatform } from '@dequanto/models/TPlatform';
 import { $config } from '@dequanto/utils/$config';
 import { Config } from '@dequanto/config/Config';
+import { TExplorer, TExplorerDefinition } from '@dequanto/models/TExplorer';
+import { IConfigData } from '@dequanto/config/interface/IConfigData';
+import { TChain } from '@dequanto/models/TChain';
+import { $require } from '@dequanto/utils/$require';
 
 
 
@@ -18,14 +22,23 @@ export namespace BlockchainExplorerFactory {
         registry[platform] = explorer;
     }
 
-    export function get (platform: TPlatform | string, opts?: IBlockchainExplorerFactoryParams) {
+    export function get (platform: TPlatform | number)
+    export function get (config: TExplorerDefinition)
+    /** @obsolete */
+    export function get (platform: TPlatform | number, opts: IBlockchainExplorerFactoryParams)
+    export function get (mix: TPlatform | number | TExplorerDefinition, opts?: IBlockchainExplorerFactoryParams) {
 
-        let cfg = $config.get(`blockchainExplorer.${platform}`);
+        $require.notNull(mix, `ArgumentException: no platform in BlockchainExplorerFactory`);
+
+        let platform = typeof mix === 'object' ? mix.platform : mix;
+
+
+        let cfg =  $config.getExplorerOptions(platform);
         let params = {
-            platform ,
             ...(opts ?? {}),
-            ...(cfg?? {})
-        };
+            ...(cfg ?? {}),
+        } as any;
+
         let Ctor = registry[platform];
         if (Ctor != null) {
             if (typeof Ctor === 'function') {
@@ -38,7 +51,7 @@ export namespace BlockchainExplorerFactory {
     }
 
     /** Same as sync variation, but ensures the config is being fetched */
-    export async function getAsync (platform: TPlatform | string, opts?: IBlockchainExplorerFactoryParams) {
+    export async function getAsync (platform: TPlatform, opts?: IBlockchainExplorerFactoryParams) {
         await Config.get();
         return get(platform, opts);
     }

package/src/explorer/verifiers/FsHtmlVerifier.ts

@@ -5,7 +5,7 @@ import { IVerifier } from './IVerifier';
 import { IBlockchainTransferEvent } from '../IBlockchainExplorer';
 import { $platform } from '@dequanto/utils/$platform';
 import { TPlatform } from '@dequanto/models/TPlatform';
-import { IBlockchainExplorerConfig } from '../BlockchainExplorer';
+import { TExplorer, TExplorerDefinition } from '@dequanto/models/TExplorer';
 
 const PATH_ROOT = `./data/0xc/verification`;
 const PATH_TEMPLATE = `${PATH_ROOT}/template.html`;
@@ -66,7 +66,7 @@ export class FsHtmlVerifier implements IVerifier {
     private key: string;
     private enabled: boolean;
 
-    constructor (public platform: TPlatform, public config: IBlockchainExplorerConfig) {
+    constructor (public platform: TPlatform, public config: TExplorer) {
         $require.notEmpty(platform, `Argument platform is required`);
         $require.notNull(config, `Config is required for ${platform}`);
         this.enabled = Boolean(config.api);
@@ -105,12 +105,12 @@ export class FsHtmlVerifier implements IVerifier {
 
 
         let html = template
-            .replace('__host__', this.config.api)
+            .replace('__host__', this.config.api.url)
             .replace('__name__', contractData.contractName)
             .replace('__JSON__', contractData.sourceCode)
             .replace('__contractaddress__', contractData.address)
             .replace('__contractname__', contractData.contractName)
-            .replace('__apikey__', this.config.key ?? '')
+            .replace('__apikey__', this.config.api.key ?? '')
             .replace('__constructorArguements__', contractData.arguments?.replace(/^0x/, '') || '');
 
 
@@ -162,9 +162,9 @@ export class FsHtmlVerifier implements IVerifier {
 
 
         let html = template
-            .replace('__host__', this.config.api)
+            .replace('__host__', this.config.api.url)
             .replace('__contractaddress__', contractData.address)
-            .replace('__apikey__', this.config.key ?? '')
+            .replace('__apikey__', this.config.api.key ?? '')
             .replace('__expectedImplementation__', contractData.expectedImplementation ?? '')
             ;
 
@@ -197,8 +197,8 @@ export class FsHtmlVerifier implements IVerifier {
         throw new Error('Method not implemented.');
     }
 
-    private extractHostKey (config: IBlockchainExplorerConfig) {
-        let hostKey = /\.(?<hostkey>[\w\-]+)\.\w+($|\/)/.exec(config.api ?? config.host).groups.hostkey;
+    private extractHostKey (config: TExplorer) {
+        let hostKey = /\.(?<hostKey>[\w\-]+)\.\w+($|\/)/.exec(config.api.url).groups.hostKey;
         return hostKey;
     }
     private extractContractName (contractData: { address: `0x${string}`; contractName?: string; }, defaultPfx?: string) {

package/src/json/JsonArrayMultiStore.ts

@@ -2,14 +2,14 @@
  * Store data across multiple files for cases, that could contain thousands of entries
  */
 
-import { IStoreOptions, JsonArrayStore } from './JsonArrayStore';
+import { IArrayStoreOptions, JsonArrayStore } from './JsonArrayStore';
 import { Directory } from 'atma-io';
 import memd from 'memd';
 import alot from 'alot';
 import type { Alot } from 'alot/alot';
 import { $require } from '@dequanto/utils/$require';
 
-export interface  IMultiStoreOptions<T> extends IStoreOptions<T> {
+export interface  IMultiStoreOptions<T> extends IArrayStoreOptions<T> {
     groupKey: (x: T) => number
     groupSize: number
 }

package/src/json/JsonArrayStore.ts

@@ -4,7 +4,7 @@ import { Alot } from 'alot/alot'
 import { JsonStoreFs } from './JsonStoreFs'
 import { Constructor } from '@dequanto/utils/types'
 
-export interface IStoreOptions<T, TStorage = T> {
+export interface IArrayStoreOptions<T, TStorage = T> {
     path: string
     watchFs?: boolean
     onFsChanged?: () => any
@@ -14,6 +14,8 @@ export interface IStoreOptions<T, TStorage = T> {
     serialize? (x: T): TStorage
     Type?: Constructor
     format?: boolean
+
+    transport?: 'file' | 'localStorage'
 }
 
 export class JsonArrayStore<T> {
@@ -22,7 +24,7 @@ export class JsonArrayStore<T> {
 
     private fs: JsonStoreFs<T[]>;
 
-    constructor (public options: IStoreOptions<T>) {
+    constructor (public options: IArrayStoreOptions<T>) {
         let keyFn = this.options.key;
         if (keyFn == null) {
             throw new Error('Key getter must be defined');
@@ -34,6 +36,7 @@ export class JsonArrayStore<T> {
             , this.options.format
             , []
             , this.options.serialize as any
+            , this.options.transport
         );
         if (this.options?.watchFs) {
             this.fs.watch(() => this.onStoreChanged());

package/src/json/JsonObjectStore.ts

@@ -2,7 +2,7 @@ import type { Constructor } from 'atma-utils'
 import { JsonConvert } from 'class-json'
 import { JsonStoreFs } from './JsonStoreFs';
 
-export interface IStoreOptions<T, TOut = T> {
+export interface IObjectStoreOptions<T, TOut = T> {
     path: string
     map? (x: T): TOut
     serialize? (x: T): any
@@ -10,6 +10,9 @@ export interface IStoreOptions<T, TOut = T> {
     format?: boolean
     default?: TOut
     watchFs?: boolean
+    onFsChanged?: () => any
+
+    transport?: 'file' | 'localStorage'
 }
 
 export class JsonObjectStore<T> {
@@ -20,7 +23,7 @@ export class JsonObjectStore<T> {
     private fs: JsonStoreFs<T>;
 
 
-    constructor (public options: IStoreOptions<T>) {
+    constructor (public options: IObjectStoreOptions<T>) {
         this.fs = new JsonStoreFs<T>(
             this.options.path
             , this.options.Type
@@ -28,6 +31,7 @@ export class JsonObjectStore<T> {
             , this.options.format
             , this.options.default ?? {} as any
             , this.options.serialize as any
+            , this.options.transport
         );
 
         if (this.options?.watchFs) {
@@ -35,8 +39,6 @@ export class JsonObjectStore<T> {
         }
     }
 
-
-
     async get(opts?: { cloned?: boolean }): Promise<this['options']['default']> {
         if (this.fs.errored != null) {
             throw this.fs.errored;
@@ -64,6 +66,7 @@ export class JsonObjectStore<T> {
     private onStoreChanged () {
         this.data = null;
         this.fs.cleanCache();
+        this.options.onFsChanged?.();
     }
 
     private async restore () {