This repository was archived by the owner on Mar 5, 2025. It is now read-only.
Init web3_eth_migration_guide #5136
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
BatchRequest is not documented ( I'll copy it from web3 migration guide after it get ok from reviews) |
nazarhussain
suggested changes
Jun 23, 2022
Contributor
nazarhussain
left a comment
nazarhussain
left a comment
There was a problem hiding this comment.
I have following observations:
- Pleae make the change for the
biginteverywhere. All the numbers data type are consistenlty should return thebigint. If not then it's a bug and we should fix it. - It does not feel like productive to me to document those breaking changes in that way. Will be tedious to review and maintain. Instead we can just document the list of funcitons which now will return
bigintfor all number type attributes.
|
|
||
| - `givenProvider` default value is `undefined` instead of `null` | ||
| - `currentProvider` will never return `null`, provider required upon instantiation as opposed to being optional in 1.x //todo maybe this is not true after after the recent discussion/change | ||
| - `web3.eth.defaultAccount` default value is `undefined` instead of `null` |
Contributor
There was a problem hiding this comment.
That applies to everywhere. So insted of listing it for individual values, we should highlight it overall.
All the API level interfaces returning or accepting null are replaced with undefined
Contributor
There was a problem hiding this comment.
is extended implemented too?
Contributor
There was a problem hiding this comment.
Regarding point 2. Sound good to me.
Let's wait for input from the rest of the team for their opinion and to see how they have structured docs.
1 task
avkos
approved these changes
Jun 27, 2022
Contributor
avkos
left a comment
avkos
left a comment
There was a problem hiding this comment.
approved. except for Nazar comments
luu-alex
approved these changes
Jun 27, 2022
nazarhussain
approved these changes
Jul 8, 2022
jdevcs
approved these changes
Jul 11, 2022
spacesailor24
force-pushed
the
wyatt/4.x/5100-web3-eth-migration-guide
branch
from
4de5505 to
6b04afc
Compare
* fix decode function. migration guide. fix unit tests * 🏷️ Fix the contract types (#5213) * fix contract integration tests * add to changelog.md Co-authored-by: Nazar Hussain <[email protected]>
* Throw error for not found tx in getTransaction * Fix failing tests * Move mock values to fixtures * Throw error for not found tx in getTransactionReceipt * Create dedicated error * Create dedicated error code
* ⬆️ Update ethereum-cryptography package * Apply suggestions from code review Co-authored-by: Junaid <[email protected]> * 🎨 Update the code as per feedback Co-authored-by: Junaid <[email protected]>
* Init commit with defaultAccount * Add some more properties * Add more properties * Refactor docs * Apply some changes from reviews
* ⬆️ Update ethereum-cryptography package * Apply suggestions from code review Co-authored-by: Junaid <[email protected]> * 🎨 Update the code as per feedback Co-authored-by: Junaid <[email protected]>
* Init commit with defaultAccount * Add some more properties * Add more properties * Refactor docs * Apply some changes from reviews
spacesailor24
force-pushed
the
wyatt/4.x/5100-web3-eth-migration-guide
branch
from
68af2c4 to
e595585
Compare
Muhammad-Altabba
pushed a commit
that referenced
this pull request
Jul 19, 2022
* Init web3_eth_migration_guide * WIP migration guide * WIP migration guide * Add more methods * WIP migration guide * Add request accounts * Apply some changes from reviews * Add getHashrate as deprecated * Remove getAccounts, as it will be fixed * Fix hex string to bigint in docs * Migration guide refactors * fix decode function. migration guide. fix unit tests (#5210) * fix decode function. migration guide. fix unit tests * 🏷️ Fix the contract types (#5213) * fix contract integration tests * add to changelog.md Co-authored-by: Nazar Hussain <[email protected]> * Incompatible return types for 4.x implementations (#5205) * Throw error for not found tx in getTransaction * Fix failing tests * Move mock values to fixtures * Throw error for not found tx in getTransactionReceipt * Create dedicated error * Create dedicated error code * Upgrade ethereum-cryptography to 1.0 (#5211) * ⬆️ Update ethereum-cryptography package * Apply suggestions from code review Co-authored-by: Junaid <[email protected]> * 🎨 Update the code as per feedback Co-authored-by: Junaid <[email protected]> * add net to web3 eth interface (#5217) * web3-common/core defaults documentation (#5198) * Init commit with defaultAccount * Add some more properties * Add more properties * Refactor docs * Apply some changes from reviews * Upgrade ethereum-cryptography to 1.0 (#5211) * ⬆️ Update ethereum-cryptography package * Apply suggestions from code review Co-authored-by: Junaid <[email protected]> * 🎨 Update the code as per feedback Co-authored-by: Junaid <[email protected]> * web3-common/core defaults documentation (#5198) * Init commit with defaultAccount * Add some more properties * Add more properties * Refactor docs * Apply some changes from reviews Co-authored-by: Nikos Iliakis <[email protected]> Co-authored-by: Nikos Iliakis <[email protected]> Co-authored-by: Junaid <[email protected]> Co-authored-by: Oleksii Kosynskyi <[email protected]> Co-authored-by: Nazar Hussain <[email protected]> Signed-off-by: Muhammad-Altabba <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To preview migration guide:
cd web3.js/docsyarn startRemaining methods to check for breaking changes:
sendSignedTransactionsignsignTransactioncallestimateGasgetPastLogsgetWorksubmitWorkrequestAccountsgetChainIdgetNodeInfogetProof