Fix Greeter Contract Documentation to use local signing instead of transact #2414

lauwsj-alpha · 2022-04-05T16:16:42Z

What was wrong?

Fix #2386, Currently not all Ethereum nodes support signing transaction and it would be better to sign the transactions locally.

How was it fixed?

Replace all the transact() method with send_raw_transaction and also add example using construct_sign_and_send_raw_middleware for Greeter programme

Todo:

Add entry to the release notes

Cute Animal Picture

…leware

fselmo

I apologize for how long it took to review this... there are a lot of comments here but it's mostly about using snake_case over camelCase in a few places so don't worry 😅.

I also posed a question on the EthereumTesterProvider() examples that I'm curious to hear thoughts on.

Thanks for taking this on... this is a great addition to keep our docs up-to-date 👍

fselmo · 2022-06-29T19:32:03Z

docs/contracts.rst


+
+Using we can use ``send_raw_transaction`` to create the contract :


typo?

Suggested change

Using we can use ``send_raw_transaction`` to create the contract :

We can use ``send_raw_transaction`` to create the contract:

fselmo · 2022-06-29T19:32:27Z

docs/contracts.rst

    >>> tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
    >>> greeter.functions.greet().call()
    'Nihao'

+or we can set up ``construct_and_sign_middleware`` and let the middleware signs the transaction:


Suggested change

or we can set up ``construct_and_sign_middleware`` and let the middleware signs the transaction:

or we can set up ``construct_and_sign_middleware`` and let the middleware sign the transaction:

fselmo · 2022-06-29T19:33:06Z

docs/contracts.rst

@@ -35,7 +35,7 @@ After ``py-solc-x`` is installed, you will need to install a version of ``solc``
    >>> from solcx import install_solc
    >>> install_solc(version='latest')

-You should now be set up to run the contract deployment example below:
+You should now be set up to run the contract deployment example below :


nit, this space isn't necessary and keeps consistency across docs

Suggested change

You should now be set up to run the contract deployment example below :

You should now be set up to run the contract deployment example below:

fselmo · 2022-06-29T19:33:53Z

docs/contracts.rst

+    # Build the transaction parameters that deploys the contract
+    >>> tx_params = Greeter.constructor().buildTransaction()
+
+    # Send the transaction and let the middleware signs it


Suggested change

# Send the transaction and let the middleware signs it

# Send the transaction and let the middleware sign it

fselmo · 2022-06-29T19:36:20Z

docs/contracts.rst

+        >>> tx_params = token_contract.constructor(web3.eth.coinbase, 12345).buildTransaction({
+            'nonce': nonce
+        })
+        >>> signed_transaction = my_account.signTransaction(tx_params)


signTransaction (camelCase) has been deprecated over the snake_case

Suggested change

>>> signed_transaction = my_account.signTransaction(tx_params)

>>> signed_transaction = my_account.sign_transaction(tx_params)

fselmo · 2022-06-29T20:08:45Z

docs/contracts.rst

-    >>> tx_hash = contract.functions.transfer(alice, 10).transact({'gas': 899000, 'gasPrice': 674302241})
+    >>> private_key = provider.ethereum_tester.backend.account_keys[0]
+    >>> alice_nonce = w3.eth.get_transaction_count(alice_account.address)
+    >>> tx_params = contract.functions.transfer(alice, 10).buildTransaction({


Suggested change

>>> tx_params = contract.functions.transfer(alice, 10).buildTransaction({

>>> tx_params = contract.functions.transfer(alice, 10).build_transaction({

fselmo · 2022-06-29T20:08:53Z

docs/contracts.rst

+    ...     'gasPrice': 674302241,
+    ...     'nonce': alice_nonce,
+    ... })
+    >>> signed_transaction = alice_account.signTransaction(tx_params)


Suggested change

>>> signed_transaction = alice_account.signTransaction(tx_params)

>>> signed_transaction = alice_account.sign_transaction(tx_params)

fselmo · 2022-06-29T20:09:08Z

docs/contracts.rst

-
+   >>> my_account = w3.eth.account.from_key(PRIVATE_KEY)
+   >>> nonce = w3.eth.get_transaction_count(my_account.address)
+   >>> tx_params = deployed_contract.functions.update({'s1': ['0x0000000000000000000000000000000000000001', '0x0000000000000000000000000000000000000002'], 's2': [b'0'*32, b'1'*32], 'users': []}).buildTransaction({


Suggested change

>>> tx_params = deployed_contract.functions.update({'s1': ['0x0000000000000000000000000000000000000001', '0x0000000000000000000000000000000000000002'], 's2': [b'0'*32, b'1'*32], 'users': []}).buildTransaction({

>>> tx_params = deployed_contract.functions.update({'s1': ['0x0000000000000000000000000000000000000001', '0x0000000000000000000000000000000000000002'], 's2': [b'0'*32, b'1'*32], 'users': []}).build_transaction({

fselmo · 2022-06-29T20:09:17Z

docs/contracts.rst

+   >>> tx_params = deployed_contract.functions.update({'s1': ['0x0000000000000000000000000000000000000001', '0x0000000000000000000000000000000000000002'], 's2': [b'0'*32, b'1'*32], 'users': []}).buildTransaction({
+       'nonce': nonce
+   })
+   >>> signed_transaction = my_account.signTransaction(tx_params)


Suggested change

>>> signed_transaction = my_account.signTransaction(tx_params)

>>> signed_transaction = my_account.sign_transaction(tx_params)

fselmo · 2022-06-29T20:10:44Z

docs/contracts.rst

@@ -1072,75 +1179,106 @@ Event Log Object

    from web3 import Web3
    from hexbytes import HexBytes
-    w3 = Web3(Web3.EthereumTesterProvider())
+    provider = Web3.EthereumTesterProvider()


Same thought as above on the EthereumTesterProvider()... do we just keep this simpler? This isn't a node and we don't need to tiptoe around anything by signing before sending to eth-tester. So should we keep the api simpler here? I can go either way but I think I lean towards the simpler setup.

Update Greeter example to sign the transaction locally

9fe5570

lauwsj-alpha changed the title ~~Documentation fix/simon 05042022 contracts~~ Fix Greeter Contract Documentation to use local signing instead of transact Apr 5, 2022

Update all transact function and add construct,sign and send raw midd…

00c2042

…leware

lauwsj-alpha force-pushed the documentation_fix/simon_05042022_contracts branch from 1986cd0 to 00c2042 Compare April 5, 2022 16:19

Jonjay2626 approved these changes Apr 5, 2022

View reviewed changes

lauwsj-alpha added 2 commits April 6, 2022 01:37

Fix docs update to pass the CI

0483a24

Add 2386 news fragment

e92380e

fselmo requested changes Jun 29, 2022

View reviewed changes

kclowes assigned pacrob Apr 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Greeter Contract Documentation to use local signing instead of transact #2414

Fix Greeter Contract Documentation to use local signing instead of transact #2414

lauwsj-alpha commented Apr 5, 2022 •

edited

fselmo left a comment

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022

fselmo Jun 29, 2022



		Using we can use ``send_raw_transaction`` to create the contract :

	Using we can use ``send_raw_transaction`` to create the contract :
	We can use ``send_raw_transaction`` to create the contract:

	or we can set up ``construct_and_sign_middleware`` and let the middleware signs the transaction:
	or we can set up ``construct_and_sign_middleware`` and let the middleware sign the transaction:

	You should now be set up to run the contract deployment example below :
	You should now be set up to run the contract deployment example below:

	# Send the transaction and let the middleware signs it
	# Send the transaction and let the middleware sign it

	>>> signed_transaction = my_account.signTransaction(tx_params)
	>>> signed_transaction = my_account.sign_transaction(tx_params)

	>>> tx_params = contract.functions.transfer(alice, 10).buildTransaction({
	>>> tx_params = contract.functions.transfer(alice, 10).build_transaction({

	>>> signed_transaction = alice_account.signTransaction(tx_params)
	>>> signed_transaction = alice_account.sign_transaction(tx_params)

	>>> tx_params = deployed_contract.functions.update({'s1': ['0x0000000000000000000000000000000000000001', '0x0000000000000000000000000000000000000002'], 's2': [b'0'32, b'1'32], 'users': []}).buildTransaction({
	>>> tx_params = deployed_contract.functions.update({'s1': ['0x0000000000000000000000000000000000000001', '0x0000000000000000000000000000000000000002'], 's2': [b'0'32, b'1'32], 'users': []}).build_transaction({

Fix Greeter Contract Documentation to use local signing instead of transact #2414

Are you sure you want to change the base?

Fix Greeter Contract Documentation to use local signing instead of transact #2414

Conversation

lauwsj-alpha commented Apr 5, 2022 • edited

What was wrong?

How was it fixed?

Todo:

Cute Animal Picture

fselmo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lauwsj-alpha commented Apr 5, 2022 •

edited