diff --git a/docs.wrm/getting-started.wrm b/docs.wrm/getting-started.wrm index 2f9ea8d8e..63ac5a113 100644 --- a/docs.wrm/getting-started.wrm +++ b/docs.wrm/getting-started.wrm @@ -1,3 +1,3 @@ _section: Getting Started @ @priority<100> -The v6 getting started is ocming soon... +The v6 getting started is coming soon... diff --git a/docs.wrm/index.wrm b/docs.wrm/index.wrm index 2c8c158fb..3190c7583 100644 --- a/docs.wrm/index.wrm +++ b/docs.wrm/index.wrm @@ -1,4 +1,18 @@ -_section: Documentation +_section: Documentation (BETA) @ + +**NOTE:** This documentation is for the **beta branch** (i.e. ``v6-beta-exports``), which +is still undergoing minor changes. + +To try it out: + +_code: +/home/ricmoo> npm install ethers@beta-eports + +_null: + +Please [report any v6 issues](link-issue) and I will get to them right away. + +If you are looking v5 docs, please see the [v5 documentation here](link-v5). _subsection: What is Ethers? diff --git a/docs.wrm/links.txt b/docs.wrm/links.txt index 8d7ea18f0..14038d4b1 100644 --- a/docs.wrm/links.txt +++ b/docs.wrm/links.txt @@ -1,5 +1,7 @@ link-mail [link-mail](mailto:me@ricmoo.com) +link-issue [Open GitHub Issue](https://github.com/ethers-io/ethers.js/issues/new/choose) +link-v5 [V5 Documentation](https://docs.ethers.io/v5/) # Projects link-alchemy [Alchemy](https://alchemy.com/?a=ethers) diff --git a/src.ts/providers/provider-fallback.ts b/src.ts/providers/provider-fallback.ts index 0cd93409f..1800a1e1d 100644 --- a/src.ts/providers/provider-fallback.ts +++ b/src.ts/providers/provider-fallback.ts @@ -1,4 +1,8 @@ - +/** + * Explain all the nitty-gritty about the **FallbackProvider**. + * + * @_section: api/providers/fallback-provider:Fallback Provider [about-fallback-provider] + */ import { getBigInt, getNumber, assert, assertArgument } from "../utils/index.js"; @@ -36,6 +40,9 @@ function stringify(value: any): string { }); } +/** + * A configuration entry for how to use a [[Provider]]. + */ export interface FallbackProviderConfig { // The provider @@ -56,6 +63,9 @@ const defaultConfig = { stallTimeout: 400, priority: 1, weight: 1 }; // We track a bunch of extra stuff that might help debug problems or // optimize infrastructure later on. +/** + * The statistics and state maintained for a [[Provider]]. + */ export interface FallbackProviderState extends Required { // The most recent blockNumber this provider has reported (-2 if none) @@ -112,6 +122,9 @@ async function waitForSync(config: Config, blockNumber: number): Promise { } } +/** + * Additional options to configure a [[FallbackProvider]]. + */ export type FallbackProviderOptions = { // How many providers must agree on a value before reporting // back the response @@ -293,6 +306,10 @@ function getFuzzyMode(quorum: number, results: Array): undefined | return bestResult; } +/** + * A Fallback Provider. + * + */ export class FallbackProvider extends AbstractProvider { readonly quorum: number; diff --git a/src.ts/utils/geturl.ts b/src.ts/utils/geturl.ts index eb42b453d..4858333fc 100644 --- a/src.ts/utils/geturl.ts +++ b/src.ts/utils/geturl.ts @@ -7,7 +7,9 @@ import { getBytes } from "./data.js"; import type { FetchRequest, FetchCancelSignal, GetUrlResponse } from "./fetch.js"; - +/** + * @_ignore: + */ export async function getUrl(req: FetchRequest, signal?: FetchCancelSignal): Promise { const protocol = req.url.split(":")[0].toLowerCase();