Skip to content

Latest commit

 

History

History
150 lines (109 loc) · 6.33 KB

README.md

File metadata and controls

150 lines (109 loc) · 6.33 KB
Raw

Go Alaya

Alaya-Go is the implementation of Alaya network which is pioneering demonstration network of PlatON.

API Reference Go Report Card Build Status) codecov version GitHub All Releases

Building the source

The requirements to build Alaya-Go are:

  • OS:Windows10/Ubuntu18.04
  • Golang :version 1.16+
  • cmake :version 3.0+
  • g++&gcc :version 7.4.0+

The 'cmake' and 'gcc&g++' are usually built-in with Ubuntu

In addition, the following libraries needs to be installed manually

sudo apt install libgmp-dev libssl-dev

Then, clone the repository and download dependency

git clone https://github.com/AlayaNetwork/Alaya-Go.git --recursive
cd Alaya-Go && go mod download

Ubuntu:

make all

Windows:

go run build\ci.go install

The resulting binary will be placed in '$Alaya-Go/build/bin' .

Getting Started

The project comes with several executables found in the build/bin directory.

Command Description
alaya Our main Alaya CLI client. It is the entry point into the Alaya network
alayakey a key related tool.

Generate the keys

Each node requires two pairs of public&private keys, the one is called node's keypair, it's generated based on the secp256k1 curve for marking the node identity and signning the block, and the other is called node's blskeypair, it's based on the BLS_12_381 curve and is used for consensus verifing. These two pairs of public-private key need to be generated by the alayakey tool.

Switch to the directory where contains 'alayakey.exe'(Windows) or 'alayakey'(Ubuntu). Node's keypair(Ubuntu for example):

alayakey genkeypair
PrivateKey:  1abd1200759d4693f4510fbcf7d5caad743b11b5886dc229da6c0747061fca36
PublicKey :  8917c748513c23db46d23f531cc083d2f6001b4cc2396eb8412d73a3e4450ffc5f5235757abf9873de469498d8cf45f5bb42c215da79d59940e17fcb22dfc127

Node's blskeypair:：

alayakey genblskeypair
PrivateKey:  7747ec6876bbf8ca0934f05e45917b4213afc5814639355868bbf06d0b3e0f19
PublicKey :  e5eb9915ed2b5fd52cf5ff760873a75a8562956e176968f3cbe5ea2b22e03a7b5efc07fdd5ad66d433b404cb880b560bed6295fa79f8fa649588be02231de2e70a782751dc28dbf516b7bb5d52053b5cdf985d8961a5baafa467e8dda55fe981

Note: The PublicKey generated by the 'genkeypair' command is the NodeID we needed, the PrivateKey is the corresponding node private key, and the PublicKey generated by the 'genblskeypair' command is the node BLS PublicKey, used in the staking and consensus process, PrivateKey is the Node BLS PrivateKey, these two keypairs are common in different operating systems, that is, the public and private keys generated in Windows above, can be used in Ubuntu.

store the two private keys in files:

mkdir -p ./data
touch ./data/nodekey 
echo "{your-nodekey}" > ./data/nodekey
touch ./data/blskey
echo "{your-blskey}" > ./data/blskey

Generate a wallet

alaya --datadir ./data account new
Your new account is locked with a password. Please give a password. Do not forget this password.
Passphrase:
Repeat passphrase:
Address: {apt1anp4tzmdggdrcf39qvshfq3glacjxcd5mayaa8}

Do remember the password

Connect to the Alaya network

Options description
--identity Custom node name
--datadir Data directory for the databases and keystore
--rpcaddr HTTP-RPC server listening interface (default: "localhost")
--rpcport HTTP-RPC server listening port (default: 6789)
--rpcapi API's offered over the HTTP-RPC interface
--rpc Enable the HTTP-RPC server
--nodiscover Disables the peer discovery mechanism (manual peer addition)
--nodekey P2P node key file
--cbft.blskey BLS key file

Run the following command to launch a Alaya node connecting to the Alaya's mainnet:

alaya --identity "alaya" --datadir ./data --port {your-p2p-port} --rpcaddr 127.0.0.1 --rpcport {your-rpc-port} --rpcapi "platon,net,web3,admin,personal" --rpc --nodiscover --nodekey ./data/nodekey --cbft.blskey ./data/blskey

OK, it seems that the chain is running correctly, we can check it as follow:

alaya attach http://127.0.0.1:6789
Welcome to the Alaya JavaScript console!

instance: AlayaNetwork/v0.16.1-unstable-747d8011-20210908/linux-amd64/go1.17
at block: 0 (Sat, 19 Mar 52766 18:00:00 HKT)
 datadir: /home/develop/alaya/data
 modules: admin:1.0 debug:1.0 miner:1.0 net:1.0 personal:1.0 platon:1.0 rpc:1.0 txgen:1.0 txpool:1.0 web3:1.0

> platon.blockNumber
29

For more information, please visit our Docs.

Contributing to Alaya-Go

All of codes for Alaya-Go are open source and contributing are very welcome! Before beginning, please take a look at our contributing guidelines. You can also open an issue by clicking here.

Support

If you have any questions or suggestions please contact us at [email protected].

License

The Alaya-Go library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The Alaya-Go binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.