DeltaChain Docs
Search…
🎯
Install

Requirements

Delta requires Go 1.12+ and C compiler to build.

#Getting the source

Clone the DeltaChain repo :
git clone https://github.com/deltachain/delta.git
cd delta

#Dependency management

Simply run:
make dep
If you keep getting network error, it is suggested to use Go Module Proxy.

#Building

To build the main app delta, just run
make
or build the full suite:
make all
If no error reported, all built executable binaries will appear in folder bin.

#Running Delta

Connect to DeltaChain's mainnet:
bin/delta --network main
Connect to DeltaChain's testnet:
bin/delta --network test
or startup a custom network
bin/delta --network <custom-net-genesis.json>
example genesis config file can be found at genesis/example.json
To find out usages of all command line options:
bin/delta -h
  • --network value the network to join (main|test) or path to genesis file
  • --data-dir value directory for block-chain databases
  • --cache value megabytes of ram allocated to internal caching (default: 2048)
  • --beneficiary value address for block rewards
  • --target-gas-limit value target block gas limit (adaptive if set to 0) (default: 0)
  • --api-addr value API service listening address (default: "localhost:8669")
  • --api-cors value comma separated list of domains from which to accept cross origin requests to API
  • --api-timeout value API request timeout value in milliseconds (default: 10000)
  • --api-call-gas-limit value limit contract call gas (default: 50000000)
  • --api-backtrace-limit value limit the distance between position and best block for subscriptions APIs (default: 1000)
  • --verbosity value log verbosity (0-9) (default: 3)
  • --max-peers value maximum number of P2P network peers (P2P network disabled if set to 0) (default: 25)
  • --p2p-port value P2P network listening port (default: 11235)
  • --nat value port mapping mechanism (any|none|upnp|pmp|extip:<IP>) (default: "none")
  • --bootnode value comma separated list of bootnode IDs
  • --skip-logs skip writing event|transfer logs (/logs API will be disabled)
  • --pprof turn on go-pprof
  • --disable-pruner disable state pruner to keep all history
  • --help, -h show help
  • --version, -v print the version

#Sub-commands

  • solo client runs in solo mode for test & dev
bin/delta solo --on-demand # create new block when there is pending transaction
bin/delta solo --persist # save blockchain data to disk(default to memory)
bin/delta solo --persist --on-demand # two options can work together
  • master-key master key management
# print the master address
bin/delta master-key
​
# export master key to keystore
bin/delta master-key --export > keystore.json
​
​
# import master key from keystore
cat keystore.json | bin/delta master-key --import

#Docker

This method needs running all commands by docker with the data directory mapped to the container.

#Pull image

docker pull deltachain/delta

#Export Master Key

First, start an interactive shell by docker:
docker run -it --rm\
-v {path-to-your-data-directory}:/root/.org.deltachain.delta\
--entrypoint /bin/sh deltachain/delta
Then export master key in the shell:
delta master-key --export > /root/.org.deltachain/keystore.json
Enter your password and check the generated file, then exit.

#Import Master Key

docker run -it --rm\
-v {path-to-your-data-directory}:/root/.org.deltachain\
deltachain/delta master-key --import
Follow the instruction by the program, input the KeyStore and also the password.

#Check Master Key

docker run -it --rm\
-v {path-to-your-data-directory}:/root/.org.deltachain\
deltachain/delta master-key
This command will print the Master Key.

#Start the Authority Masternode

docker run -d\
-v {path-to-your-data-directory}:/root/.org.deltachain\
-p 127.0.0.1:8669:8669 -p 11235:11235 -p 11235:11235/udp\
--name delta-node deltachain/delta --network main --skip-logs

#Public Nodes

Please visit Public Nodes for more information.