Add documentation/example with deployment on private geth chain

trufflesuite / truffle

:warning: The Truffle Suite is being sunset. For information on ongoing support, migration options and FAQs, visit the Consensys blog. Thank you for all the support over the years.

https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat?utm_source=github&utm_medium=referral&utm_campaign=2023_Sep_truffle-sunset-2023_announcement_

MIT License

14.03k stars 2.32k forks source link

Add documentation/example with deployment on private geth chain #2795

Open wbt opened 4 years ago

wbt commented 4 years ago

Issue

Available examples for truffle migrate focus on using a development blockchain like ganache or testrpc. An example should be given of deployment to a private geth node.

Specifically, this documentation addition should demonstrate how to connect to geth (examples show use of the HTTP RPC endpoint Geth can provide) while allowing an account to be unlocked sufficiently for truffle to do migrations. This should be with Geth >1.9.0, following Geth PR 17037 which prevents unlocking accounts when RPC/HTTP access to the node is enabled. The example should show instructions demonstrating a truffle migrate without the error authentication needed: password or unlock using Geth >1.9.0 as the blockchain node.

wbt commented 4 years ago

For anyone hoping to do a PR or find a solution on this, the instructions are roughly:

Use a Hierarchical Deterministic (HD) wallet provider such as MyEtherWallet to generate an HD wallet mnemonic. It may not be best for security to use one's primary MetaMask wallet mnemonic here.
Get the address of at least one account from that wallet, e.g. the first one.
Run geth with RPC enabled and without unlocking any accounts; make sure the RPC address is reflected in truffle-config.js
Make sure that address is funded (and sufficiently privileged to run any transaction in the migration, if applicable) before attempting to run a migration, whether from the genesis block or from subsequent transactions, on the chain you intend to deploy on.
Install HDWalletProvider and specify its use in truffle-config.js per documentation in that repo, with access to the same mnemonic and account index.

gnidan commented 4 years ago

Thanks for submitting this, @wbt! Good to see you again 😄

miguelmtzinf commented 3 years ago

Hey, working on this for EthDenver, any insight about how the docs should be formatted? using markdown?

wbt commented 3 years ago

@miguelmartinezinf Thanks! Probably a format and location similar to the source of https://www.trufflesuite.com/docs/truffle/getting-started/running-migrations would be easiest to find.

miguelmtzinf commented 3 years ago

Work submitted for EthDenver! https://devfolio.co/submissions/custom-contract-deployment-with-truffle-docs-b738