Interface BroSDKOptions

interface BroSDKOptions {
    __experimental?: {
        backendAPI?: { runtimeEnv?: "prod" | "dev" };
        brc20?: { ignoreValidateResult?: boolean };
        btc?: { ignoreValidateResult?: boolean };
        evm?: { onChainConfigCachePrepared?: (cache: DumpableCache) => void };
        runes?: { ignoreValidateResult?: boolean };
    };
    debugLog?: boolean;
    evm?: {
        cacheOnChainConfig?: boolean;
        viemClients?: Record<
            | "evm-ethereum (BroSDK ChainId)"
            | "evm-sepolia (BroSDK ChainId)"
            | "evm-bsc (BroSDK ChainId)"
            | "evm-bsctestnet (BroSDK ChainId)"
            | "evm-coredao (BroSDK ChainId)"
            | "evm-coredao-testnet (BroSDK ChainId)"
            | "evm-bsquared (BroSDK ChainId)"
            | "evm-bob (BroSDK ChainId)"
            | "evm-bitlayer (BroSDK ChainId)"
            | "evm-lorenzo (BroSDK ChainId)"
            | "evm-merlin (BroSDK ChainId)"
            | "evm-ailayer (BroSDK ChainId)"
            | "evm-mode (BroSDK ChainId)"
            | "evm-xlayer (BroSDK ChainId)"
            | "evm-arbitrum (BroSDK ChainId)"
            | "evm-aurora (BroSDK ChainId)"
            | "evm-blife-testnet (BroSDK ChainId)"
            | "evm-bitboy-testnet (BroSDK ChainId)"
            | "evm-manta (BroSDK ChainId)"
            | "evm-linea (BroSDK ChainId)"
            | "evm-base (BroSDK ChainId)"
            | "evm-bera-testnet (BroSDK ChainId)",
            Client,
        >;
    };
}

Properties

__experimental? debugLog? evm?

Properties

Optional__experimental

__experimental?: {
    backendAPI?: { runtimeEnv?: "prod" | "dev" };
    brc20?: { ignoreValidateResult?: boolean };
    btc?: { ignoreValidateResult?: boolean };
    evm?: { onChainConfigCachePrepared?: (cache: DumpableCache) => void };
    runes?: { ignoreValidateResult?: boolean };
}

OptionaldebugLog

debugLog?: boolean

Optionalevm

evm?: {
    cacheOnChainConfig?: boolean;
    viemClients?: Record<
        | "evm-ethereum (BroSDK ChainId)"
        | "evm-sepolia (BroSDK ChainId)"
        | "evm-bsc (BroSDK ChainId)"
        | "evm-bsctestnet (BroSDK ChainId)"
        | "evm-coredao (BroSDK ChainId)"
        | "evm-coredao-testnet (BroSDK ChainId)"
        | "evm-bsquared (BroSDK ChainId)"
        | "evm-bob (BroSDK ChainId)"
        | "evm-bitlayer (BroSDK ChainId)"
        | "evm-lorenzo (BroSDK ChainId)"
        | "evm-merlin (BroSDK ChainId)"
        | "evm-ailayer (BroSDK ChainId)"
        | "evm-mode (BroSDK ChainId)"
        | "evm-xlayer (BroSDK ChainId)"
        | "evm-arbitrum (BroSDK ChainId)"
        | "evm-aurora (BroSDK ChainId)"
        | "evm-blife-testnet (BroSDK ChainId)"
        | "evm-bitboy-testnet (BroSDK ChainId)"
        | "evm-manta (BroSDK ChainId)"
        | "evm-linea (BroSDK ChainId)"
        | "evm-base (BroSDK ChainId)"
        | "evm-bera-testnet (BroSDK ChainId)",
        Client,
    >;
}

Type declaration

  • OptionalcacheOnChainConfig?: boolean

    Default

    true
  • OptionalviemClients?: Record<
        | "evm-ethereum (BroSDK ChainId)"
        | "evm-sepolia (BroSDK ChainId)"
        | "evm-bsc (BroSDK ChainId)"
        | "evm-bsctestnet (BroSDK ChainId)"
        | "evm-coredao (BroSDK ChainId)"
        | "evm-coredao-testnet (BroSDK ChainId)"
        | "evm-bsquared (BroSDK ChainId)"
        | "evm-bob (BroSDK ChainId)"
        | "evm-bitlayer (BroSDK ChainId)"
        | "evm-lorenzo (BroSDK ChainId)"
        | "evm-merlin (BroSDK ChainId)"
        | "evm-ailayer (BroSDK ChainId)"
        | "evm-mode (BroSDK ChainId)"
        | "evm-xlayer (BroSDK ChainId)"
        | "evm-arbitrum (BroSDK ChainId)"
        | "evm-aurora (BroSDK ChainId)"
        | "evm-blife-testnet (BroSDK ChainId)"
        | "evm-bitboy-testnet (BroSDK ChainId)"
        | "evm-manta (BroSDK ChainId)"
        | "evm-linea (BroSDK ChainId)"
        | "evm-base (BroSDK ChainId)"
        | "evm-bera-testnet (BroSDK ChainId)",
        Client,
    >

    You can assign your custom viem clients here

    Default

    undefined

Settings

Member Visibility

On This Page

Properties