0xweb/dequanto/src/explorer/BlockchainExplorerFactory.ts

Contract package manager and other web3 tools

import { IBlockchainExplorer } from './IBlockchainExplorer';
import { Constructor } from '@dequanto/utils/types';
import { BlockchainExplorer, IBlockchainExplorerConfig, IBlockchainExplorerFactoryParams } from './BlockchainExplorer';
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';



/**
 * @obsolete Use BlockchainExplorer class instead.
 */
export namespace BlockchainExplorerFactory {

    const registry = {} as Record<TPlatform, IBlockchainExplorer | Constructor<IBlockchainExplorer>>;

    export function register (platform: TPlatform, explorer: IBlockchainExplorer | Constructor<IBlockchainExplorer>) {
        registry[platform] = explorer;
    }

    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) {

        $require.notNull(mix, `ArgumentException: no platform in BlockchainExplorerFactory`);

        let platform = typeof mix === 'object' ? mix.platform : mix;


        let cfg =  $config.getExplorerOptions(platform);
        let params = {
            ...(opts ?? {}),
            ...(cfg ?? {}),
        } as any;

        let Ctor = registry[platform];
        if (Ctor != null) {
            if (typeof Ctor === 'function') {
                return new Ctor(params);
            }
            return Ctor;
        }

        return new BlockchainExplorer(params);
    }

    /** Same as sync variation, but ensures the config is being fetched */
    export async function getAsync (platform: TPlatform, opts?: IBlockchainExplorerFactoryParams) {
        await Config.get();
        return get(platform, opts);
    }

    /** @obsolete Create instance directly with the get/getAsync method */
    export function create (opts: IBlockchainExplorerFactoryParams): Constructor<IBlockchainExplorer> {

        return class extends BlockchainExplorer {
            constructor (config?: IBlockchainExplorerFactoryParams) {
                super(config ?? opts);
            }
        }
    }
}