From a068543dd0c21b723876bc05a58272240ecbac01 Mon Sep 17 00:00:00 2001 From: Keyrxng <106303466+Keyrxng@users.noreply.github.com> Date: Sun, 9 Jun 2024 07:43:50 +0100 Subject: [PATCH] fix: readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4c5b30d..4e9d507 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ import { RPCHandler, HandlerConstructorConfig } from "@ubiquity-dao/rpc-handler/ export function useHandler(networkId: number) { const config: HandlerConstructorConfig = { - networkId: 1; + networkId: 100; // your chosen networkId networkName: null; // will default using the networkRpcs networkRpcs: null; // e.g "https://mainnet.infura.io/..." runtimeRpcs: null; // e.g "__https://mainnet.infura.io/..." > "1__https://mainnet.infura.io/..." @@ -39,11 +39,11 @@ export function useHandler(networkId: number) { proxySettings: { retryCount: 3; // how many times we'll loop the list of RPCs retrying the request before failing retryDelay: 100; // (ms) how long we'll wait before moving to the next RPC, best to keep this low - logTier: "ok"|"info"|"error"|"debug"|"fatal"|"verbose"; // set to "none" for no logs, null will default to "error", "verbose" will log all - logger: PrettyLogs | LogInterface | null; // null will default to PrettyLogs - strictLogs: boolean; // true, only the specified logTier will be logged and false all wll be logged. - moduleName?: ModuleName | string; // this is the prefix for the logs - disabled?: boolean; // this will disable the proxy, requiring you to handle retry logic etc yourself + logTier: "ok"; // |"info"|"error"|"debug"|"fatal"|"verbose"; set to "none" for no logs, null will default to "error", "verbose" will log all + logger: null; // null will default to PrettyLogs + strictLogs: true; // true, only the specified logTier will be logged and false all wll be logged. + moduleName?: "[UBQ RPC Handler];" // Can be omitted. this is the prefix for the logs. + disabled?: false; // Can be omitted. this will disable the proxy, requiring you to handle retry logic etc yourself. } }; // No RPCs are tested at this point