This is a convenient way to run a private Neo blockchain. This image is meant to skip the overhead of having to wait to get enough gas for smart contract testing on testnet and to bypass the steps of creating your own private chain. See the section below on extracting Neo and Gas as the private chain in this Docker image starts at block height 0.
Note: There is also a turnkey Docker image with the initial 100M NEO and 16.6k GAS already claimed in a ready-to-use wallet available here: https://hub.docker.com/r/cityofzion/neo-privatenet
Note: If you are running Ubuntu on Windows (WSL), refer to this article to install and operate docker from Ubuntu: https://medium.com/@sebagomez/installing-the-docker-client-on-ubuntus-windows-subsystem-for-linux-612b392a44c4
- If copying and pasting the commands from the article ensure you delete and re-enter any quotation marks that you paste.
These instruction reference the official instructions from Docker found here: https://docs.docker.com/install/linux/docker-ce/ubuntu/. But, the steps following installation (after step 6) are required in order to run docker from Ubuntu.
Instructions to use the private network image
Use these commands to pull the image from Docker hub and run it:
$ docker pull cityofzion/neo-privatenet $ docker run --rm -d --name neo-privatenet -p 20333-20336:20333-20336/tcp -p 30333-30336:30333-30336/tcp cityofzion/neo-privatenet
Take a look at the documentation at Docker Hub for more information about how to use the wallet and the supplied WIF key: https://hub.docker.com/r/cityofzion/neo-privatenet
Instructions to build the image yourself
Clone the repository and build the Docker image:
git clone https://github.com/CityOfZion/neo-privatenet-docker.git cd neo-privatenet-docker ./docker_build.sh
docker_build.sh has a few possible arguments:
- Disable Docker image caching with
- Use a custom neo-cli zip file
docker_build.sh --neo-cli <zip-fn>
- Show the help with
After the image is built, you can start the private network like this:
Start the private network, create a wallet and automatically claim the initial NEO and 48 GAS (takes about 5 minutes):
or, if you prefer
docker-compose, you can start the nodes with:
docker-compose up -d
You can now claim the initial NEO and GAS:
./create_wallet will display several internal error messages, which is expected as long as at the end you still get a success message.
If you call
./docker_run_and_create_wallet.sh, it will create 2 files in your current directory:
neo-privnet.wallet: a wallet you can use with neo-python
neo-privnet.wif: a wif private key you can import into other clients (neo-gui for example).
Those files will get you access to the wallet containing all the NEO and GAS for your private network.
Install neo-gui or neo-gui-developer
Install one of the following:
Edit the protocol.json in your respective neo-gui installation to point to the IP of the system running your docker. Please note the ports listed match the private chain ports in the current docker build.
If you copy the protocol.json file from the configs directory of this repo and replace your neo-gui protocol.json you will only need to find and edit the section that looks like the following:
"SeedList": [ "127.0.0.1:20333", "127.0.0.1:20334", "127.0.0.1:20335", "127.0.0.1:20336" ],
Change each occurrence of 127.0.0.1 to the IP of the system or vm running your docker image.
If you don't copy the protocol.json from the docker configs directory of this repo, in addition to the "SeedList" modifications mentioned above, you will also need to edit the following:
- Change value "Magic" to 56753
- Copy the public keys of each of your node wallets into the "StandbyValidators" section
For users who use docker machine (i.e Windows Home Edition users without Hyper-V)
You'll need your docker machine IP. First, get the name of your machine:
And get the ip with:
docker-machine ip "Nameofyourmachine"
(By default, the machine name is "default"). Use this ip to replace each occurence of 127.0.0.1 in the SeedList array.
Copy wallets from docker image to neo-gui
Note: You won't need this step if you used
./docker_run_and_create_wallet.sh in the previous step (The multiparty signature and neo/gas extraction should already be done).
Once your docker image is running, use the following commands to copy each node's wallet to your neo-gui home directory in preparation for multiparty signature and neo/gas extraction. Note: all four must be copied.
The following will copy each wallet from the docker image to the current working directory.
docker cp neo-privnet:/opt/node1/neo-cli/wallet1.json . docker cp neo-privnet:/opt/node2/neo-cli/wallet2.json . docker cp neo-privnet:/opt/node3/neo-cli/wallet3.json . docker cp neo-privnet:/opt/node4/neo-cli/wallet4.json .
Extracting Neo and Gas
Check out the docs at http://docs.neo.org/en-us/node/private-chain.html for instructions on how to claim Neo and Gas for testing.