poanetwork
/
istanbul-tools
mirror of https://github.com/poanetwork/istanbul-tools.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
127 Commits 2 Branches 3 Tags 94 MiB
Go 97.1%
Smarty 1.1%
Python 0.7%
HCL 0.7%
Makefile 0.3%
Go to file
Alan Chen c6dac0d378 tests: test block refactoring and use wait methods 2017-08-24 15:37:45 +08:00
benchmark/kubernetes benchmark/kubernetes: update genesis.json 2017-08-22 15:32:47 +08:00
cmd Revert "Use send batch txs" 2017-08-11 16:46:12 +08:00
container Merge pull request #33 from getamis/feature/TFU-02-03-remove-validators 2017-08-24 14:42:52 +08:00
genesis container, genesis: support docker network and refactoring 2017-08-18 15:24:35 +08:00
istclient istclient: add StopMining 2017-08-23 15:04:42 +08:00
tests tests: test block refactoring and use wait methods 2017-08-24 15:37:45 +08:00
vendor vendor: add freeport package 2017-08-14 15:09:02 +08:00
.gitignore add gitignore file 2017-06-19 15:37:13 +08:00
.travis.yml travis: run tests in parallel 2017-08-23 14:30:51 +08:00
Makefile add istanbul encoder/decoder tools 2017-06-23 17:21:00 +08:00
README.md rename Istanbul-tools to istanbul-tools 2017-06-26 15:24:54 +08:00
glide.lock vendor: add freeport package 2017-08-14 15:09:02 +08:00
glide.yaml vendor: add freeport package 2017-08-14 15:09:02 +08:00

README.md

istanbul-tools

Genesis extra-data encoder and decoder library for Istanbul consensus.

istanbul-tools is used to generate extra-data field of genesis due to extra-data is combined signer vanity with RLP encoded Istanbul extra data. The Istanbul extra data struct is defined as follows:

type IstanbulExtra struct {
    Validators    []common.Address  // Validator addresses
    Seal          []byte            // Proposer seal 65 bytes
    CommittedSeal [][]byte          // Committed seal, 65 * len(Validators) bytes
}

Please note: The Seal, and CommittedSeal is not considered in genesis block.

Getting started

$ make istanbul
$ build/bin/istanbul

NAME:
   istanbul - the istanbul-tools command line interface

USAGE:
   istanbul [global options] command [command options] [arguments...]

COMMANDS:
     decode   To decode an Istanbul extraData
     encode   To encode an Istanbul extraData
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help

COPYRIGHT:
   Copyright 2017 The Amis Authors

Example

Encode command

Encode the given file to Encoded Istanbul extra-data

$ build/bin/istanbul encode --config ./cmd/istanbul/example/config.toml

OUTPUT:
Encoded Istanbul extra-data: 0x0000000000000000000000000000000000000000000000000000000000000000f89af85494475cc98b5521ab2a1335683e7567c8048bfe79ed9407d8299de61faed3686ba4c4e6c3b9083d7e2371944fe035ce99af680d89e2c4d73aca01dbfc1bd2fd94dc421209441a754f79c4a4ecd2b49c935aad0312b8410000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c0

Decode command

Decode extraData for the given input

$ build/bin/istanbul decode --extradata 0x0000000000000000000000000000000000000000000000000000000000000000f89af85494475cc98b5521ab2a1335683e7567c8048bfe79ed9407d8299de61faed3686ba4c4e6c3b9083d7e2371944fe035ce99af680d89e2c4d73aca01dbfc1bd2fd94dc421209441a754f79c4a4ecd2b49c935aad0312b8410000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c0

OUTPUT:
vanity:  0x0000000000000000000000000000000000000000000000000000000000000000
validator:  0x475cc98b5521ab2a1335683e7567c8048bfe79ed
validator:  0x07d8299de61faed3686ba4c4e6c3b9083d7e2371
validator:  0x4fe035ce99af680d89e2c4d73aca01dbfc1bd2fd
validator:  0xdc421209441a754f79c4a4ecd2b49c935aad0312
seal: 0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000