Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs 2 #4188

Merged
merged 21 commits into from
Jul 22, 2021
Merged

Update docs 2 #4188

merged 21 commits into from
Jul 22, 2021

Conversation

luu-alex
Copy link
Contributor

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.

exx8 and others added 19 commits May 9, 2021 12:19
Original link gives out a 404, replaced by the closest thing I could find.
I think the author missed a "this" in the phrase
Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>
* 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>
@luu-alex luu-alex added the 1.x 1.0 related issues label Jul 21, 2021
@render
Copy link

render bot commented Jul 21, 2021

@coveralls
Copy link

coveralls commented Jul 22, 2021

Pull Request Test Coverage Report for Build 1056452555

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 423 unchanged lines in 7 files lost coverage.
  • Overall coverage decreased (-2.6%) to 72.819%

Files with Coverage Reduction New Missed Lines %
packages/web3-core-requestmanager/src/jsonrpc.js 1 88.0%
packages/web3-core-helpers/src/formatters.js 24 80.33%
packages/web3-core-helpers/src/errors.js 31 4.41%
packages/web3-utils/src/soliditySha3.js 55 5.13%
packages/web3-utils/src/index.js 62 29.31%
packages/web3-utils/src/utils.js 84 12.87%
packages/web3-eth-accounts/src/index.js 166 25.31%
Totals Coverage Status
Change from base Build 1053770148: -2.6%
Covered Lines: 3301
Relevant Lines: 4282

💛 - Coveralls

@luu-alex luu-alex merged commit 7d03412 into 1.x Jul 22, 2021
@luu-alex luu-alex deleted the alex/update-docs3 branch July 22, 2021 14:40
@luu-alex luu-alex linked an issue Jul 22, 2021 that may be closed by this pull request
@spacesailor24 spacesailor24 mentioned this pull request Jul 24, 2021
spacesailor24 pushed a commit that referenced this pull request Aug 26, 2021
* add nonce to send options.

* add nonce to send options.

* Update CHANGELOG.md

* linting

* updating docs

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

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)

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

* Possible typo in docs (#4088)

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

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

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

* Removing deprecation notice for HttpProvider (#4008)

* 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 (#4147)

* [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>

* added EIP-2718 and EIP-1559 documentation

* fixing typo

* addressing feedback

* changing possible types for maxPriorityFeePerGas

* updating maxFeePerGas type

* update changelog

Co-authored-by: exx8 <exx8eran@gmail.com>
Co-authored-by: starwalker00 <68958932+starwalker00@users.noreply.github.com>
Co-authored-by: mongolsteppe <75075420+mongolsteppe@users.noreply.github.com>
Co-authored-by: João Monteiro <joao.monteiro95@hotmail.com>
Co-authored-by: William Entriken <github.com@phor.net>
Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>
Co-authored-by: Ev <evertonfrag@gmail.com>
Co-authored-by: Juan Alonso <Juan.Alonso@trimble.com>
spacesailor24 added a commit that referenced this pull request Aug 26, 2021
* Merge conflitcs

* Add unsubscribeByID (#4061)

* adding function unsubscribe by id

* adding an unsubscribe testcase

* adding testcase

* seperated unsubscribebyid to its own method

* adding testcases

* adding await

* fixing testcases

Co-authored-by: Alex <alex.luu@mail.utoronto.ca>
Co-authored-by: Alex <alex@chainsafe.io>

* ignore .md and docs (#4077)

* Merge conflicts

* Merge conflicts

* Release v1.4.0 (#4118)

* npm run build for 1.4.0-rc.0

* v1.4.0-rc.0

* 1.4.0 Geth version downgrade (#4149)

* Update pull Geth docker version from stable to pre-london (1.10.3)

* Update CHANGELOG

* v1.4.0

* remove underscore (#4069)

* removed some of the underscore methods in web3-core-method

* removed underscore from bzz

* adding subscriptions

* fixing up test cases

* changing variable names

* removed underscore from formatters.js

* removed underscore from request manager and abi

* removing underscore in the rest of the web3 packages

* fixing exports

* fixing failing testcases

* removing underscore from tests

* addressing feedback

* removing unwanted code from transaction

* removing underscore from remaining packages

* updating change log

* addressing feedback

* adding strict equality

* efficient short circuiting

* fixing test case

* Merge conflicts

* Update docs 2 (#4188)

* add nonce to send options.

* add nonce to send options.

* Update CHANGELOG.md

* linting

* updating docs

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

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)

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

* Possible typo in docs (#4088)

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

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

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

* Removing deprecation notice for HttpProvider (#4008)

* 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 (#4147)

* [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>

* added EIP-2718 and EIP-1559 documentation

* fixing typo

* addressing feedback

* changing possible types for maxPriorityFeePerGas

* updating maxFeePerGas type

* update changelog

Co-authored-by: exx8 <exx8eran@gmail.com>
Co-authored-by: starwalker00 <68958932+starwalker00@users.noreply.github.com>
Co-authored-by: mongolsteppe <75075420+mongolsteppe@users.noreply.github.com>
Co-authored-by: João Monteiro <joao.monteiro95@hotmail.com>
Co-authored-by: William Entriken <github.com@phor.net>
Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>
Co-authored-by: Ev <evertonfrag@gmail.com>
Co-authored-by: Juan Alonso <Juan.Alonso@trimble.com>

* eth_feeHistory (EIP 1559) (#4191)

* WIP

* Add missing fields for test runner

* Correct function arguments for getFeeHistory

* getFeeHistory tests with correct arguments

* Init utils.toNumber function

* Rename toNumber test to hexToNumber

* Add inputFormatters to getFeeHistory

* Rename newestBlock to lastBlock. Update types for blockCount and lastBlock

* Add additional tests with different input types

* Add missing function export

* eth-feehistory docs (#4190)

* updating docs

* updating example

* updating types and adding example of list

* Update docs/web3-eth.rst

* Update docs/web3-eth.rst

* Update docs/web3-eth.rst

Co-authored-by: alex <luu.alex@outlook.com>
Co-authored-by: Wyatt Barnes <wyatt@writerof.software>

Co-authored-by: Alex <alex.luu@mail.utoronto.ca>
Co-authored-by: alex <luu.alex@outlook.com>

* Update CHANGELOG (#4193)

Test don't run when only changes to `CHANGELOG.md` have been made

* Merge conflicts

* Merge conflicts

* Merge conflicts

* Merge conflicts

* Merge conflicts

* Merge conflicts

* Merge conflicts

* Merge conflicts

Co-authored-by: Alex <alex.luu@mail.utoronto.ca>
Co-authored-by: Alex <alex@chainsafe.io>
Co-authored-by: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>
Co-authored-by: exx8 <exx8eran@gmail.com>
Co-authored-by: starwalker00 <68958932+starwalker00@users.noreply.github.com>
Co-authored-by: mongolsteppe <75075420+mongolsteppe@users.noreply.github.com>
Co-authored-by: João Monteiro <joao.monteiro95@hotmail.com>
Co-authored-by: William Entriken <github.com@phor.net>
Co-authored-by: Ev <evertonfrag@gmail.com>
Co-authored-by: Juan Alonso <Juan.Alonso@trimble.com>
Co-authored-by: alex <luu.alex@outlook.com>
Co-authored-by: jdevcs <86780488+jdevcs@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs for EIP-2718 and EIP-1559
9 participants