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

V5 upgrade guide #1284

Merged
merged 5 commits into from
Mar 18, 2019
Merged

V5 upgrade guide #1284

merged 5 commits into from
Mar 18, 2019

Conversation

kclowes
Copy link
Collaborator

@kclowes kclowes commented Mar 15, 2019

What was wrong?

As we are nearing the beta release of v5, a migration guide needed to be added so people know how to migrate.

Related to Issue #1260

How was it fixed?

Added one!

Cute Animal Picture

images

@@ -294,6 +294,53 @@ Cryptographic Hashing
>>> Web3.solidityKeccak(['address'], ["ethereumfoundation.eth"])
HexBytes("0x913c99ea930c78868f1535d34cd705ab85929b2eaaf70fcd09677ecd6e5d75e9")

.. py:classmethod:: Web3.sha3(primitive=None, hexstr=None, text=None)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added these back in because I noticed they haven't gone through a deprecation cycle. They were deprecated in v5a1.

docs/index.rst Outdated
@@ -15,7 +15,7 @@ Contents
quickstart
overview
node
v4_migration
Copy link
Member

Choose a reason for hiding this comment

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

hrm, since v4 is still supported should we keep the v4_migration docs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ohh right. Ya, good idea


In v4, JSON-RPC calls that looked up transactions or blocks and
didn't find them, returned ``None``. Now if a transaction or
block is not found, an error will be thrown. This applies to
Copy link
Member

Choose a reason for hiding this comment

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

Probably good to indicate the exception class that will be raised.

- ``contract.call`` was removed for ``contract.<functions/events>.<method name>.call``
- ``contract.transact`` was removed for ``contract.<functions/events>.<method name>.transact``
- ``contract.eventFilter`` was removed for ``contract.events.<event name>.createFilter``
- ``middleware_stack`` was removed for :meth:`~Web3.middleware_onion`
Copy link
Member

Choose a reason for hiding this comment

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

Maybe s/removed for/renamed to

Copy link
Collaborator

@carver carver left a comment

Choose a reason for hiding this comment

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

LGTM -- I didn't cross check this against the issue with the list of v5 changes, but we can incrementally add if something got missed.

- ``web3.providers.tester.EthereumTesterProvider`` and ``web3.providers.tester.TestRPCProvider`` have been removed for :meth:`~web3.providers.eth_tester.EthereumTesterProvider`

Deprecated Methods
~~~~~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe something like: "expect these to be removed in v6".

@kclowes kclowes merged commit 0af0e29 into ethereum:master Mar 18, 2019
@kclowes kclowes deleted the v5-upgrade-guide branch March 18, 2019 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants