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

eth-feehistory docs #4190

Merged
merged 6 commits into from
Jul 23, 2021
Merged

eth-feehistory docs #4190

merged 6 commits into from
Jul 23, 2021

Conversation

luu-alex
Copy link
Contributor

Description

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

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

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 ran npm run dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.

@luu-alex luu-alex added the 1.x 1.0 related issues label Jul 22, 2021
@render
Copy link

render bot commented Jul 22, 2021

@luu-alex luu-alex requested a review from spacesailor24 July 22, 2021 18:20
docs/web3-eth.rst Outdated Show resolved Hide resolved
docs/web3-eth.rst Outdated Show resolved Hide resolved

1. ``String`` - Number of blocks in the requested range. Between 1 and 1024 blocks can be requested in a single query. Less than requested may be returned if not all blocks are available.
2. ``String`` - Highest number block of the requested range.
3. ``Array of numbers`` - (optional) A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we maybe include an example of a monotonically list

docs/web3-eth.rst Outdated Show resolved Hide resolved
docs/web3-eth.rst Outdated Show resolved Hide resolved
docs/web3-eth.rst Outdated Show resolved Hide resolved
@spacesailor24 spacesailor24 changed the base branch from 1.x to wyatt/feehistory July 23, 2021 23:49
@spacesailor24 spacesailor24 merged commit 509fccd into wyatt/feehistory Jul 23, 2021
@spacesailor24 spacesailor24 deleted the alex/ethfeehistory branch July 23, 2021 23:53
spacesailor24 added a commit that referenced this pull request Jul 24, 2021
* 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>
spacesailor24 added a commit that referenced this pull request Aug 26, 2021
* 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>
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.

4 participants