web3.py: Don't include arbitrary addresses in documentation.
One example is https://web3py.readthedocs.io/en/stable/web3.eth.html#web3.eth.Eth.send_raw_transaction. 0xd3CdA913deB6f67967B99D67aCDFa1712C293601
should be replaced with public_address_of_receivers_account
.
This is live address that is actually used on mainnet: https://etherscan.io/address/0xd3CdA913deB6f67967B99D67aCDFa1712C293601 . Whether this is accident - I don’t know.
About this issue
- Original URL
- State: closed
- Created 3 years ago
- Comments: 21 (3 by maintainers)
Hey @divyanshugit. Thanks for the interest! I went ahead and assigned this to you. For this issue, we would want to replace the address
0xd3CdA913deB6f67967B99D67aCDFa1712C293601
, wherever it appears in the code base, with a variable name that is suited for the context in which it is used. ~For the particular example mentioned in the description of this issue,public_address_of_receivers_account
could be suitable.~ We may, however, need to tweak this variable name a bit depending on the different contexts that you see among the code base.Hope this helps.
edit: We should just use something simple like
account_address
, (account_address_2
, etc… if there are multiple) unless the context calls for the variable name being a bit more descriptive.@abdulqgg I also picked this up as my first issue. I am still working on it. I will update you if this would be free to pick up.
Hey thanks for getting this moving again 😅 … I’m still seeing a few addresses that are actual addresses in the docs:
edit: replied in the PR
@kclowes can’t we replace every live address with
address_of_account
oraddress
?@kclowes Thankyou! I will pick this up.