Operating system support

Cypherium is a derivative blockchain system compatible with Ethereum. With the integration of blockchains connected to various consensus chains, it will run mixed signature accounts such as ed22519 and ecdsa. This version only supports transaction signatures for ECDSA and consensus signatures for ED25519. To participate in consensus, it is necessary to create a new account through the client-side personan.newAccountEd25519 in order to participate and receive a coin reward. It will be used as a weighted coin to participate in the subsequent consensus and enter the committee. After supporting transactions with ed25519, it can participate in the transfer of this account.

Public iP for VPS is needed

Your ip of your machine or VPS which used to deploy cypher node must be public IP.such AWS ec2 which has public IP to deploy your cypher node! Open Consensus port 7100 (UDP), P2P block synchronous port 6000 and 30301 (TCP and UDP) , RPC port 8000 (TCP). The P2P port and RPC port can be any port that is not occupied by the system. If no POST, CURL, GET or other RPC requests are sent to this node, the RPC port should be closed to prevent possible network attacks.

Install the openssl

for linux

sudo apt-get install openssl
sudo apt-get install libssl-dev

for mac:

git clone https://github.com/openssl/openssl
cd openssl
sudo ./config --prefix=/usr/local/openssl
make
make install
openssl version

Download repository

1. Install Git:

for linux,run follow command: sudo apt-get install git

for mac,visit follow URL to install: http://sourceforge.net/projects/git-osx-installer/

2. Open the terminal and clone repository:

 git clone https://github.com/cypherium/cypher-bin.git
 cd cypher-bin
 ls

3.List the mainly use files

resetStart.sh:can delete chaindb automic,and restart chaind directly,the txBlock and keyBlock will syn from 0. start.sh:continue the txBlock and keyBlock Height,and going on.

Below are all start mode commands:
./start.sh --silentor ./start.sh 0 :start cypher application and output the log to the cypherlog.txt
./start.sh --detailor ./start.sh 1:start cypher application and print the log online
./resetStart.sh --silentor ./start.sh 0:reset start cypher application and output the log to the cypherlog.txt
./resetStart.sh --detailor ./start.sh 1:reset start cypher application and print the log online

Two method to run the cypher

run from genesis block 0 by script

for console detail print mode you should run this:

 ./resetStart.sh --detail

or for silent mode ,you should run this

 ./resetStart.sh

If you want to run testNet,please append test to the command,such as /resetStart.sh 1 test After doing this,now the log is output to the cypherlog.txt file or console immediately,you can check the dynamic log. Congratulations! You have successfully started the Cypherium Node!

run from genesis block 0 step by step

• init genesis block

  ./linux/cypher --datadir ./linux/chaindb init ./genesis.json
  

  ./mac/cypher --datadir ./mac/chaindb init ./genesis.json
  

• start

  ./linux/cypher --nat "none" --ws  txpool --rnetport 7100 -wsaddr="0.0.0.0" --wsorigins "*" --rpc --rpccorsdomain "*" --rpcaddr 0.0.0.0 --rpcapi eth,web3,personal,miner --port 6000 --rpcport 18004 --verbosity 4 --datadir ./linux/chaindb --networkid 16162 --gcmode archive --bootnodes "cnode://098c1149a1476cf44ad9d480baa67d956715b8671a4915bed17d06a1cafd7b154bc1841d451d80d391427ebc48aaa3216d4e8a2b46544dffdc61b76be6475418@13.72.80.40:9090"  console 2>"cypherlog.txt"
  

  ./mac/cypher --nat "none" txpool --rnetport 7100 --ws   -wsaddr="0.0.0.0" --wsorigins "*" --rpc --rpccorsdomain "*" --rpcaddr 0.0.0.0 --rpcapi eth,web3,personal,miner --port 6000 --rpcport 18004 --verbosity 4 --datadir ./mac/chaindb --networkid 16162 --gcmode archive --bootnodes "cnode://098c1149a1476cf44ad9d480baa67d956715b8671a4915bed17d06a1cafd7b154bc1841d451d80d391427ebc48aaa3216d4e8a2b46544dffdc61b76be6475418@13.72.80.40:9090"  console 2>"cypherlog.txt"
  

start up parameters help

The IPC interface is enabled by default and exposes all the APIs supported by cypher, whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect.

HTTP based JSON-RPC API options:

• --addr HTTP-RPC server listening interface (default: localhost)
• --rpcport HTTP-RPC server listening port (default: 8000)
• --port P2P listening port (default: 6000)
• --api API's offered over the HTTP-RPC interface (default: eth,net,web3)
• --corsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
• --ws Enable the WS-RPC server
• --wsaddr WS-RPC server listening interface (default: localhost)
• --wsport WS-RPC server listening port (default: 8000)
• --wsorigins Origins from which to accept websockets requests
• --rpcapi API's offered over the IPC-RPC interface (default: admin,debug,eth,miner,net,personal,shh,txpool,web3)
• --ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)
• --nat value NAT port mapping mechanism (any|none|upnp|pmp|extip:) (default: "any")
• --rnetport Committee consensus port(default: 7100)
• --verbosity Output log level,max value is 6(default: 4)
• --datadir Data directory for the databases and keystore
• --networkid Network identifier (16162=mainNet)
• --datadir Blockchain garbage collection mode ("full", "archive") (default: "full")
• --bootnodes The first time a node connects to the network it uses one of the predefined bootnodes. Through these bootnodes a node can join the network and find other nodes.
• --mine Enable mining
• --console Start an interactive JavaScript environment

You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect via HTTP, WS or IPC to a cypher node configured with the above flags. You can reuse the same connection for multiple requests!

**Note: Please understand the security implications of opening up an S based transport before doing so! Hackers on the internet are actively trying to subvert Cypherium nodes with exposed APIs! Further, all browser tabs can access locally running web servers, so malicious web pages could try to subvert locally available API

Troubleshooting

If you get panic: not exists jdk class! crash

• Execute sudo passwd to create root password if you have not created.
• Please give the jdk folder read/write permission by typing sudo chmod -R 777 ./jdk.

If you cannot execute the bin, try the following tips:

• Make sure you are operating on the root account of your computer. (You can do this with the command “sudo” and entering your password. If you have not created a root password yet, sudo passwd will help you set a password to your root account.)
• Execute command sudo chmod -R 777 . when your current directory path is at ../cypherBFTBin/
• Execute sudo rm -rf chaindb to delete the database. Then, regenerate the database by executing ./cypher -–datadir chaindb init ../genesis.json
• Execute shell ./resetStart.sh can delete database automic,and restart directly.As soon as you finding the chainId is different from previous chaindId which is checked through executing
• Make sure you are operating on the root account of your computer. (You can do this with the command “su” and entering your password. If you have not created a root password yet, sudo passwd will help you set a password to your root account.)
• Execute command sudo chmod -R 777 . when your current directory path is at ../cypherBFTBin/
• Execute sudo rm -rf chaindb to delete the database. Then, regenerate the database by executing ./cypher -–datadir chaindb init ../genesis.json
• Execute shell ./resetStart.sh can delete database automic,and restart directly.As soon as you finding the chainId is different from previous chaindId which is checked through executing

With the database up and running, try out these commands

1. eth.blockNumber

Check the transaction block height.

2. personal.newAccount("cypher2019xxddlllaaxxx") or personal.newAccountEd25519("cypher2019xxddlllaaxxx")

New one account,Among " " your should assign one password. newAccount will create eth compatible account;newAccountEd25519 will create miner work account.

3. net

List the peer nodes's detail from P2P network.

4. admin.peers

List the number of peer nodes from P2P network.

5. eth.accounts

List all the accounts

6. eth.getBalance(...)

Get the balance by specify one account. eth.getBalance("0x2dbde7263aaaf1286b9c41b1138191e178cb2fd4") The string of “ 0x2dbde7263aaaf1286b9c41b1138191e178cb2fd4” is your wallet account. This wallet account string you shoud copy and store it when you executiong comand “ personal.newAccount(...) “; also your can using command “ eth.accounts ” to find if from serveal acccounts.

Txpool

1. txpool.status

List count of pending and queued transactions.

2. txpool.content

List all transactions int txpool.

Manual send transaction demonstration

1. Guarantee you have two account

Check this through “cph.accounts”.If you do not have,please new two accouts by using comand “ personal.newAccount() “

2. check your account balance

 eth.getBalance("0x461f9d24b10edca41c1d9296f971c5c028e6c64c")
 eth.getBalance("0x01482d12a73186e9e0ac1421eb96381bbdcd4557")

3. unlock your account

personal.unlockAccount("0x461f9d24b10edca41c1d9296f971c5c028e6c64c")

4. sendTransaction

eth.sendTransaction({from:'0x461f9d24b10edca41c1d9296f971c5c028e6c64c',to: '0x01482d12a73186e9e0ac1421eb96381bbdcd4557', value: 1000000000000000000})

5. wait several seconds to checkout balance

 eth.getBalance("0x461f9d24b10edca41c1d9296f971c5c028e6c64c")
 eth.getBalance("0x01482d12a73186e9e0ac1421eb96381bbdcd4557")

RUN:Operator miner functions

1. miner.start(1, "0x2dbde7263aaaf1286b9c41b1138191e178cb2fd4")

First param 1 is for threads accord to you computer power;Second param is "0x2dbde7263aaaf1286b9c41b1138191e178cb2fd4" is your account.You must be enter your password.

2. miner.status()

After miner.start(),your can check your current status or your current node role by using function for miner.status():

You will wait minimum 1 hour to check with command function for miner.status() to confirm whether your node have been promoted successfully. If you are node accounts status is "I'm committee member, Doing consensus." or "I'm leader, Doing consensus."your account have been chosen into committee successfully:

Finally,after waiting about 1 hour you can check you account’s balance through function for eth.getBalance()

3. miner.content()

You can check miner’s candidate from yourself and other nodes.

4. miner.stop()

Stop the to find candidate to take part in consensus.

More APIs

ref eth apis