@shazow/whatsabi
    Preparing search index...

    Type Alias AutoloadConfig

    AutoloadConfig specifies the configuration inputs for the autoload function.

    type AutoloadConfig = {
        abiLoader?: ABILoader | false;
        addressResolver?: (name: string) => Promise<string>;
        enableExperimentalMetadata?: boolean;
        followProxies?: boolean;
        loadContractResult?: boolean;
        onError?: (phase: string, error: Error) => boolean | void;
        onProgress?: (phase: string, ...args: any[]) => void;
        provider: AnyProvider;
        signatureLookup?: SignatureLookup | false;
    }
    Index
    provider
    addressResolver? onError? onProgress?
    abiLoader? signatureLookup?
    loadContractResult?
    enableExperimentalMetadata? followProxies?
    provider: AnyProvider
    addressResolver?: (name: string) => Promise<string>

    Called to resolve invalid addresses, uses provider's built-in resolver otherwise

    onError?: (phase: string, error: Error) => boolean | void

    Called during any encountered errors during a given phase

    onProgress?: (phase: string, ...args: any[]) => void

    Called during various phases: resolveName, getCode, abiLoader, signatureLookup, followProxies

    abiLoader?: ABILoader | false
    signatureLookup?: SignatureLookup | false
    loadContractResult?: boolean

    Load full contract metadata result, include it in AutoloadResult.contractResult if successful.

    This changes the behaviour of autoload to use ABILoader.getContract instead of ABILoader.loadABI, which returns a larger superset result including all of the available verified contract metadata.

    enableExperimentalMetadata?: boolean

    Enable pulling additional metadata from WhatsABI's static analysis which may be unreliable. For now, this is primarily for event topics.

    followProxies?: boolean

    Enable following proxies automagically if reasonable. Return the final result.

    Some caveats:

    • Proxies that are relative to a specific selector (such as DiamondProxies) will not be followed.
    • Contracts that are not primarily proxies will not be followed. Current heuristic is containing at most 5 SSTORE instructions. (See Issue #173)

    Settings
    Member Visibility

    On This Page
    Required
    Hooks
    Loaders
    Properties
    Settings