Update docs #4185

luu-alex · 2021-07-21T18:11:10Z

Description

Updating documents with relevant changes

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Type of change

Checklist:

I have selected the correct base branch.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.
Any dependent changes have been merged and published in downstream modules.
I have updated the CHANGELOG.md file in the root folder.

whisper overview has been moved from https://github.com/ethereum/go-ethereum/wiki/Whisper to https://eth.wiki/concepts/whisper/whisper-overview

Original link gives out a 404, replaced by the closest thing I could find.

I think the author missed a "this" in the phrase

render · 2021-07-21T18:11:14Z

Your Render PR Server URL is https://web3-js-pr-4185.onrender.com.

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

spacesailor24 · 2021-07-21T18:36:46Z

CHANGELOG.md

@@ -400,4 +400,7 @@ Released with 1.0.0-beta.37 code base.

 - Removing the underscore package 

+### Changed
+ - Docs are being updated  


Suggested change

- Docs are being updated

- Grammar fix and updated Swarm and Whisper doc links

Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>

@frozeman

* Removing deprecation notice for HttpProvider From my view, it is just a provider with less capabilities than websockets, but still widely useful — and widely used as well. @frozeman @nivida @GregTheGreek any thoughts? * Update include_package-core.rst * Update CHANGELOG.md Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com> Co-authored-by: Alex <alex.luu@mail.utoronto.ca>

* [Docs] Updated solidity example to modern syntax Replaced the old constructor function syntax with the modern one, added 'emit' to event calls, added pragma, added a valid bytes32 value and updated the JSON ABI. * [Docs] Fixed a broken link (#1) Original link gives out a 404, replaced by the proper guide. Co-authored-by: Juan Alonso <Juan.Alonso@trimble.com> * Revert "[Docs] Fixed a broken link (#1)" This reverts commit 0de1272. Co-authored-by: Juan Alonso <Juan.Alonso@trimble.com>

…e-docs

coveralls · 2021-07-21T19:27:12Z

Pull Request Test Coverage Report for Build 1053718577

0 of 0 changed or added relevant lines in 0 files are covered.
223 unchanged lines in 7 files lost coverage.
Overall coverage remained the same at 76.196%

Files with Coverage Reduction	New Missed Lines	%
packages/web3-core-requestmanager/src/jsonrpc.js	1	70.0%
packages/web3-core-helpers/src/formatters.js	8	82.06%
packages/web3-utils/src/utils.js	27	9.92%
packages/web3-core-helpers/src/errors.js	29	1.56%
packages/web3-utils/src/soliditySha3.js	34	3.43%
packages/web3-utils/src/index.js	43	31.38%
packages/web3-eth-accounts/src/index.js	81	31.38%

Totals
Change from base Build 1015496704:	0.0%
Covered Lines:	3131
Relevant Lines:	3904

💛 - Coveralls

spacesailor24 · 2021-07-21T20:48:05Z

docs/web3-eth.rst

@@ -1419,17 +1421,21 @@ Parameters
    - ``value`` - ``Number|String|BN|BigNumber``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction.
    - ``gas``  - ``Number``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded).
    - ``gasPrice`` - ``Number|String|BN|BigNumber``: (optional) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to :ref:`web3.eth.gasPrice <eth-gasprice>`.
+    - ``type`` - ``Number|String|BN|BigNumber``: (optional) A positive unsigned 8-bit number between 0 and 0x7f that represents the type of the transaction. 
+    - ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total
+    - ``maxPriorityFeePerGas`` - ``Number|String|BN|BigNumber`` (optional) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee)


Suggested change

- ``maxPriorityFeePerGas`` - ``Number|String|BN|BigNumber`` (optional) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee)

- ``maxPriorityFeePerGas`` - ``Number|String|BN|BigNumber`` (optional, defaulted to ``1 Gwei``) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee)

spacesailor24 · 2021-07-21T20:50:20Z

docs/web3-eth.rst

@@ -1419,17 +1421,21 @@ Parameters
    - ``value`` - ``Number|String|BN|BigNumber``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction.
    - ``gas``  - ``Number``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded).
    - ``gasPrice`` - ``Number|String|BN|BigNumber``: (optional) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to :ref:`web3.eth.gasPrice <eth-gasprice>`.
+    - ``type`` - ``Number|String|BN|BigNumber``: (optional) A positive unsigned 8-bit number between 0 and 0x7f that represents the type of the transaction. 
+    - ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total


Suggested change

- ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total

- ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional, defaulted to ``(2 * block.baseFeePerGas) + maxPriorityFeePerGas``) The maximum fee per gas that the transaction is willing to pay in total

docs/web3-eth.rst

CHANGELOG.md

remove merge conflict indicator

The base branch was changed.

spacesailor24

Should not be merge in current state

alex/update-docs was branched off of release/1.5.0 and needs to be merged into 1.x, so that 1.x can be merged into release/1.5.0. All changes should be replicated in a branch that's based off of 1.x

This commit needs to be reverted

exx8 and others added 10 commits May 9, 2021 12:19

add nonce to send options.

c29b932

add nonce to send options.

fb726ab

Update CHANGELOG.md

70e4fda

linting

9139352

Merge remote-tracking branch 'origin/1.x' into 1.x

a277e69

merge

f23e07c

updating docs

8899f35

update web3-shh.rst : whisper-overview broken link (#4170)

ab58050

whisper overview has been moved from https://github.com/ethereum/go-ethereum/wiki/Whisper to https://eth.wiki/concepts/whisper/whisper-overview

[Docs] Fixed a broken link (#4151)

c61a335

Original link gives out a 404, replaced by the closest thing I could find.

Possible typo in docs (#4088)

9c31732

I think the author missed a "this" in the phrase

luu-alex added the 1.x 1.0 related issues label Jul 21, 2021

spacesailor24 reviewed Jul 21, 2021

View reviewed changes

fulldecent and others added 4 commits July 21, 2021 14:42

Typically you will have only one Web3 connection, use const (#3967)

46f9f6b

Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>

Merge branch '1.x' of https://github.com/exx8/web3.js into alex/updat…

068d986

…e-docs

spacesailor24 and others added 5 commits July 21, 2021 10:16

Update CHANGELOG with next anticipated version

cf32dcf

npm i and build for v1.5.0-rc.0

1c46aa7

v1.5.0-rc.0

fb3af4b

added EIP-2718 and EIP-1559 documentation

4779430

fixing typo

b0ea036

spacesailor24 reviewed Jul 21, 2021

View reviewed changes

addressing feedback

b650d1a

spacesailor24 reviewed Jul 21, 2021

View reviewed changes

docs/web3-eth.rst Outdated Show resolved Hide resolved

spacesailor24 reviewed Jul 21, 2021

View reviewed changes

docs/web3-eth.rst Outdated Show resolved Hide resolved

Alex added 2 commits July 21, 2021 17:05

changing possible types for maxPriorityFeePerGas

1ad5608

updating maxFeePerGas type

086ccd5

luu-alex changed the base branch from 1.x to release/1.5.0 July 21, 2021 21:42

Merge branch 'release/1.5.0' into alex/update-docs

a73c5e9

spacesailor24 reviewed Jul 21, 2021

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

a3e2e37

remove merge conflict indicator

spacesailor24 previously approved these changes Jul 21, 2021

View reviewed changes

spacesailor24 changed the base branch from release/1.5.0 to 1.x July 21, 2021 22:35

spacesailor24 suggested changes Jul 21, 2021

View reviewed changes

luu-alex closed this Jul 21, 2021

spacesailor24 deleted the alex/update-docs branch January 4, 2022 19:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs #4185

Update docs #4185

luu-alex commented Jul 21, 2021 •

edited

Loading

render bot commented Jul 21, 2021

spacesailor24 Jul 21, 2021

coveralls commented Jul 21, 2021

spacesailor24 Jul 21, 2021

spacesailor24 Jul 21, 2021

spacesailor24 left a comment •

edited

Loading

	- Docs are being updated
	- Grammar fix and updated Swarm and Whisper doc links

	- ``maxPriorityFeePerGas`` - ``Number\|String\|BN\|BigNumber`` (optional) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee)
	- ``maxPriorityFeePerGas`` - ``Number\|String\|BN\|BigNumber`` (optional, defaulted to ``1 Gwei``) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee)

	- ``maxFeePerGas`` - ``Number\|String\|BN\|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total
	- ``maxFeePerGas`` - ``Number\|String\|BN\|BigNumber``: (optional, defaulted to ``(2 * block.baseFeePerGas) + maxPriorityFeePerGas``) The maximum fee per gas that the transaction is willing to pay in total

Update docs #4185

Update docs #4185

Conversation

luu-alex commented Jul 21, 2021 • edited Loading

Description

Type of change

Checklist:

render bot commented Jul 21, 2021

spacesailor24 Jul 21, 2021

Choose a reason for hiding this comment

coveralls commented Jul 21, 2021

Pull Request Test Coverage Report for Build 1053718577

💛 - Coveralls

spacesailor24 Jul 21, 2021

Choose a reason for hiding this comment

spacesailor24 Jul 21, 2021

Choose a reason for hiding this comment

spacesailor24 left a comment • edited Loading

Choose a reason for hiding this comment

luu-alex commented Jul 21, 2021 •

edited

Loading

spacesailor24 left a comment •

edited

Loading