Web3Eth Docs

[Spacesai1or]

Adds documentation for web3_eth.ts and rpc_method_wrappers.ts RPC functions

Non-RPC functions such as:

• detectTransactionType
• formatTransaction
• isAccessList
• isAccessListEntry
• isBaseTransaction
• isTransaction1559Unsigned
• isTransaction2930Unsigned
• isTransactionCall
• isTransactionlegacyUnsigned
• isTransactionWithSender
• prepareTransactionForSigning
• transactionBuilder
• validateChainInfo
• validateCustomChainInfo
• validateFeeMarketGas
• validateGas
• validateLegacyGas
• validateTransacitonCall
• validateTransactionForSigning
• validateTransactionWithSender

are exported, but not currently manually documented

closes #4973

[Muhammad-Altabba]

Looks good!
However, I suggest using await in the sample coding snippits.

[jdevcs]

its desc :

Suggested change

	* @param block The {@link BlockNumberOrTag} (defaults to {@link Web3Eth.defaultBlock}) or block hash of the desired block.
	* Returns a block matching the block number, block hash or block tag.
	*
	* @param block The {@link BlockNumberOrTag} (defaults to {@link Web3Eth.defaultBlock}) or block hash of the desired block.

[Spacesai1or]

block is the name of the first parameter of this method, referring to the block identifier that's being requested

[jdevcs]

thats correct. I suggested to add description before block param.

[Spacesai1or]

Implemented via this commit

[jdevcs]

I think we should add some note in documentation like:
All these functions are available in web3Eth class and normal users should use from there. These RPC wrapper functions are used internally in web3Eth class and are also available for advance users of lib if they want.

[Spacesai1or]

There's no single place to add that disclaimer, but we did talk about linking to the Web3Eth methods for each rpc_method_wrapper method

[jdevcs]

there are multiple places / rpc functions, you are right, but we can add this note at top (may be before first wrapper function only or at top section?) like one of:

https://docusaurus.io/docs/next/markdown-features/admonitions

[Spacesai1or]

Made an issue to track this

[jdevcs]

Mostly functions in Web3Eth class are only returning results of wrappers by passing context, so Could you check if possible, can we use inherit doc feature https://typedoc.org/tags/inheritDoc/ for copying doc from Web3Eth class functions into these wrappers in rendered doc? and add additional @ param web3Context in these functions.

This will help us for avoiding duplicate effort for maintaining doc.

[Spacesai1or]

This would definitely be an improvement over the duplicated docs, however, I cannot get @inheritdoc to work. Additionally, I don't think the code example would be inherited based off what's listed here:

[Spacesai1or]

Made an issue to track this

[Spacesai1or]

Looks like @remarks should maybe solve the code example being copied

[jdevcs]

Good work Wyatt for lifting Eth package

[render]

Your Render PR Server URL is https://web3js-docs-pr-5251.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-cbhcuhb97ej1nnb5lceg.