From e1754483809b45dcf948b1d91c91517bd5387e42 Mon Sep 17 00:00:00 2001 From: Richard Moore Date: Thu, 3 Feb 2022 16:31:40 -0500 Subject: [PATCH] docs: added BaseProvider (#2625). --- docs.wrm/api/providers/api-providers.wrm | 2 +- docs.wrm/api/providers/jsonrpc-provider.wrm | 2 +- docs.wrm/api/providers/other.wrm | 2 +- docs.wrm/api/providers/provider.wrm | 14 ++++++++++++++ 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/docs.wrm/api/providers/api-providers.wrm b/docs.wrm/api/providers/api-providers.wrm index 7165431da..6aa8aa320 100644 --- a/docs.wrm/api/providers/api-providers.wrm +++ b/docs.wrm/api/providers/api-providers.wrm @@ -11,7 +11,7 @@ To mitigate these issues, it is recommended you use a [Default Provider](providers-getDefaultProvider). -_subsection: EtherscanProvider @ @inherit<[[Provider]]> @src +_subsection: EtherscanProvider @ @inherit<[[BaseProvider]]> @src The **EtherscanProvider** is backed by a combination of the various [Etherscan APIs](link-etherscan-api). diff --git a/docs.wrm/api/providers/jsonrpc-provider.wrm b/docs.wrm/api/providers/jsonrpc-provider.wrm index b378ccb4d..1cfbd4190 100644 --- a/docs.wrm/api/providers/jsonrpc-provider.wrm +++ b/docs.wrm/api/providers/jsonrpc-provider.wrm @@ -1,4 +1,4 @@ -_section: JsonRpcProvider @ @INHERIT<[[Provider]]> @SRC +_section: JsonRpcProvider @ @INHERIT<[[BaseProvider]]> @SRC The [JSON-RPC API](link-jsonrpc) is a popular method for interacting with Ethereum and is available in all major Ethereum node implementations diff --git a/docs.wrm/api/providers/other.wrm b/docs.wrm/api/providers/other.wrm index b331ff7a6..91348c084 100644 --- a/docs.wrm/api/providers/other.wrm +++ b/docs.wrm/api/providers/other.wrm @@ -1,6 +1,6 @@ _section: Other Providers -_subsection: FallbackProvider @ @INHERIT<[[Provider]]> @SRC +_subsection: FallbackProvider @ @INHERIT<[[BaseProvider]]> @SRC The **FallbackProvider** is the most advanced [[Provider]] available in ethers. diff --git a/docs.wrm/api/providers/provider.wrm b/docs.wrm/api/providers/provider.wrm index b9c9621b1..dff213193 100644 --- a/docs.wrm/api/providers/provider.wrm +++ b/docs.wrm/api/providers/provider.wrm @@ -550,3 +550,17 @@ _subsection: Inspection Methods @ _property: Provider.isProvider(object) => boolean @ @SRC Returns true if and only if //object// is a Provider. + +_subsection: BaseProvider @ @INHERIT<[[Provider]]> @SRC + +Most Providers available in ethers are sub-classes of BaseProvider, which +simplifies sub-classes, as it handles much of the event operations, such as +polling and formatting. + +_property: provider.polling => boolean +Indicates if the Provider is currently polling. If there are no events to +poll for or polling has been explicitly disabled, this will be false. + +_property: provider.pollingInterval => number +The frequency at which the provider polls. +