JsonRpcProvider.connection not documented

[aspiers]

Unless I'm going crazy, JsonRpcProvider.connection is the only public API for obtaining the URL which the provider is connected to ... but it's not documented:

• https://docs.ethers.io/v5/api/providers/jsonrpc-provider/#JsonRpcProvider
• https://docs.ethers.io/v5/search/?search=.connection

IIUC, it returns either an object like { url: "https://..." }, or the ConnectionInfo object which was passed into the constructor.

And while I'm here, I note that the ConnectionInfo type is documented under API > Utilities > Web Utilities, which seems like an very odd and counter-intuitive place to put it:

https://docs.ethers.io/v5/api/utils/web/#ConnectionInfo

I doubt anyone would be able to easily find that via the navbar alone.

[aspiers]

See #1954 for an example of fallout from this missing documentation.

[aspiers]

BTW when using hardhat-ethers, it gets harder: NomicFoundation/hardhat#2309

[ricmoo]

I can't do anything about Hardhat, you would have to discuss that with them.

But I'll update the ethers docs. :)

[ricmoo]

Added: https://docs.ethers.io/v5/api/providers/jsonrpc-provider/#JsonRpcProvider

Thanks! :)

[aspiers]

Great thanks!