genesis

command module

Version: v1.6.3 Latest Latest Go to latest Published: Apr 25, 2019 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more

Repository

github.com/whiteblock/genesis

Links

Report a Vulnerability

README ¶

#Genesis

##Installation

clone repository
cd router
go get
go build

##Configuration Configuration options are located in config.json in the same directory as the binary

ssh-user: The default username for ssh
ssh-password: The default password for ssh
listen: The socket to listen on
rsa-key: The location of the ssh private key
rsa-user: The corresponding username for that private key
verbose: Enable or disable verbose mode
server-bits: The bits given to each server's number
cluster-bits: The bits given to each clusters's number
node-bits: The bits given to each nodes's number
thread-limit: The maximum number of threads that can be used for building
ip-prefix: Used for the IP Scheme
docker-output-file: The location instead the docker containers where the clients stdout and stderr will be captured
influx: The influxdb endpoint
influx-user: The influx auth username
influx-password: The influx auth password
service-network: CIDR of the network for the services
service-network-name: The name for the service network
node-prefix: The prefix for each node name
node-network-prefix: The prefix for each cluster network
service-prefix: The prefix for each service
nodes-public-key: Location of the public key for the nodes
nodes-private-key: Location of the private key for the nodes
handle-node-ssh-keys: Should genesis handle the nodes ssh keys?
max-nodes: Set a maximum number of nodes that a client can build
max-node-memory: Set the max memory per node that a client can use
max-node-cpu: Set the max cpus per node that a client can use

###Config Environment Overrides These will override what is set in the config.json file, and allow configuration via only ENV variables

SSH_USER
SSH_PASSWORD
LISTEN
RSA_KEY
RSA_USER
VERBOSE (only need to set it)
SERVER_BITS
CLUSTER_BITS
NODE_BITS
THREAD_LIMIT
IP_PREFIX
DOCKER_OUTPUT_FILE
INFLUX
INFLUX_USER
INFLUX_PASSWORD
SERVICE_NETWORK
SERVICE_NETWORK_NAME
NODE_PREFIX
NODE_NETWORK_PREFIX
SERVICE_PREFIX
NODES_PUBLIC_KEY
NODES_PRIVATE_KEY
HANDLE_NODE_SSH_KEYS (only need to set it)
MAX_NODES
MAX_NODE_MEMORY
MAX_NODE_CPU

###Additional Information

Config order of priority ENV -> config file -> defaults
ssh-user,ssh-password and rsa-user, rsa-key are both used, starting with pass auth then falling back to key auth

##IP Scheme We are using ipv4 so each address will have 32 bits.

The following assumptions will be made

Each server will have a relatively unique serverId
This uniqueness need only apply to servers which will contain nodes which communicate with each other
There are going to be 3 ip addresses reserved from each subnet
Nodes in the same docker network are able to route between each other by default

For simplicity, the following variables will be used

A = ip-prefix
B = server-bits
C = cluster-bits
D = node-bits

Note the following rules

A,B,C, and D must be greater than 0
ceil(log2(A)) + B + C + D <= 32
D must be atleast 2
(2^B) = The maximum number of servers
(2^C) = The number of cluster in a given server
(2^D - 3) = How many nodes are groups together in each cluster
(2^D - 3) * (2^C) = The max number of nodes on a server
(2^D - 3) * (2^C) * (2^B) = The maximum number of nodes that could be on the platform

###What is a cluster?

Each cluster corresponds to a subnet,docker network,and vlan. Containers in the same cluster will have minimal latency applied to them. In the majority of cases it is best to just have one node per cluster, allowing for latency control between all of the nodes.

###How is it all calculated?

Given a node number X and a serverId of Y, Let Z be the cluster number, I be the generated IP in big-endian, and the earlier mentioned variables applied

Z = floor(X / (2^D - 3))) I = (A * 2^(B+C+D) ) + ( Y * 2^(B+C) ) + (Z * 2^C) + (X % (2^D - 3) + 2)

if Z == (2^C - 1) then I = I - 2

####Explaination First get the cluster the node is in Then construct the IP one segment at a time through addition Due to the restrictions, each piece will fit neatly into place without overlap Finally, check if it is not the last cluster on the server, add 1 to the ip address if it is not the last cluster.

####Example Given a node number(X) of 2 and a serverId(Y) of 3 Given the IP Scheme of A = 10, B = 8, C = 14, D = 2 Z = floor(2/(2^2 - 3)) Z = 2 It is going to be in cluster 2 Now, for the construction of the IP Visually, it can be represented as IP = AAAAAAAA BBBBBBBB CCCCCCCC CCCCCCDD The values are simply placed inside the bit space of the IP address as represented, with the exception of the D bits, which needs to be calculated calculate this number as (2 % (2^2 - 3) + 2) or 2 Then since (Z != (2^C - 1)) 2 != 16383, the value remains 2 Finally, construct IP Part A = 00001010 Part B = 00000011 Part C = 00000000000010 Part D = 10 IP = 00001010 00000011 00000000000010 10 = 00001010 00000011 00000000 00001010 = 10 3 0 10

The gateway is calculated in a similar way, except take Part D to always equal 1

Gateway IP = 00001010 00000011 00000000000010 01 = 00001010 00000011 00000000 00001001 = 10 3 0 9

Finally the subnet is 32 - D

Resulting in IP = 10.3.0.10 Gateway IP = 10.3.0.9 Subnet = 10.3.0.8/30

##REST API

###GET /servers/ Get the current registered servers #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
{
    "server_name":{
        "addr":(string),
        "iaddr":{
            "ip":(string),
            "gateway":(string),
            "subnet":(int)
        },
        "nodes":(int),
        "max":(int),
        "id":(int),
        "serverID":(int),
        "iface":(string),
        "switches":[
            {
                "addr":(string),
                "iface":(string),
                "brand":(int),
                "id":(int)
            }
        ]
    },
    "server2_name":{...}...
}

#####EXAMPLE

curl -XGET http://localhost:8000/servers/

###PUT /servers/{name} ####PRIVATE Register and add a new server to be controlled by the instance #####BODY

{
    "addr":(string),
    "iaddr":{
        "ip":(string),
        "gateway":(string),
        "subnet":(int)
    },
    "nodes":(int),
    "max":(int),
    "id":-1,
    "serverID":(int),
    "iface":(string),
    "switches":[
        {
            "addr":(string),
            "iface":(string),
            "brand":(int),
            "id":(int)
        }
    ]
}

#####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
<server id>

#####EXAMPLE

curl -X PUT http://localhost:8000/servers/foxtrot -d \
'{"addr":"172.16.6.5","iaddr":{"ip":"10.254.6.100","gateway":"10.254.6.1","subnet":24},
"nodes":0,"max":10,"serverID":6,"id":-1,"iface":"eth0","switches":[{"addr":"172.16.1.1","iface":"eno3","brand":1,"id":5}],"ips":null}}'

###GET /servers/{id} Get a server by id #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
{
    "addr":(string),
    "iaddr":{
        "ip":(string),
        "gateway":(string),
        "subnet":(int)
    },
    "nodes":(int),
    "max":(int),
    "id":(int),
    "serverID":(int),
    "iface":(string),
    "switches":[
        {
            "addr":(string),
            "iface":(string),
            "brand":(int),
            "id":(int)
        }
    ]
}

###DELETE /servers/{id} ####PRIVATE Delete a server #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
Success

#####EXAMPLE

curl -X DELETE http://localhost:8000/servers/5

###UPDATE /servers/{id} ####PRIVATE Update server information #####BODY

{
    "addr":(string),
    "iaddr":{
        "ip":(string),
        "gateway":(string),
        "subnet":(int)
    },
    "nodes":(int),
    "max":(int),
    "id":(int),
    "serverID":(int),
    "iface":(string),
    "switches":[
        {
            "addr":(string),
            "iface":(string),
            "brand":(int),
            "id":(int)
        }
    ]
}

#####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
Success

#####EXAMPLE

curl -X UPDATE http://localhost:8000/servers/5 -d \
 '{"addr":"172.16.4.5","iaddr":{"ip":"10.254.4.100","gateway":"10.254.4.1","subnet":24}, 
 "nodes":0,"max":30,"id":5,"serverID":4,"iface":"eno3","switches":[{"addr":"172.16.1.1","iface":"eth4","brand":1,"id":3}],"ips":null}'

###GET /testnets/ Get all testnets which are currently running #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
[
    {
        "id":(int),
        "blockchain":(string),
        "nodes":(int),
        "image":(string)
    },...

]

###POST /testnets/ Add and deploy a new testnet #####BODY

{
    "servers":[(int),(int)...],
    "blockchain":(string),
    "nodes":(int),
    "image":(string),
    "resources":{
        "cpus":(string),
        "memory":(string)
    },
    "params":(Object containing params specific to the chain/client being built)
}

#####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
Success

#####EXAMPLE

curl -X POST http://localhost:8000/testnets/ -d '{"servers":[3],"blockchain":"ethereum","nodes":3,"image":"ethereum:latest",
"resources":[{"cpus":"2.0","memory":"10gb"}],"environments"{"BLAH":"blah"},"files":{"config.json":"base64 of file"},"params":null}'

###GET /testnets/{id} Get data on a single testnet #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
{
    "id":(int),
    "blockchain":(string),
    "nodes":(int),
    "image":(string)
}

###GET /testnets/{id}/nodes/ ####PRIVATE Get the nodes in a testnet #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
[
    {
        "id":(string),
        "testNetId":(int),
        "server":(int),
        "localId":(int),
        "ip":(string)
    },...
]

###GET /status/nodes/{testnetid} Get the nodes that are running in the given testnet #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
[
    {
        "name":"whiteblock-node0",
        "server":4,
        "cpu":1.4,
        "up":true
    },...
]

#####EXAMPLE

curl -XGET http://localhost:8000/status/nodes/

###GET /params/{blockchain}/ Get the build params for a blockchain #####RESPONSE

[
    {"chainId":"int"},
    {"networkId":"int"},
    {"difficulty":"int"},
    {"initBalance":"string"},
    {"maxPeers":"int"},
    {"gasLimit":"int"},
    {"homesteadBlock":"int"},
    {"eip155Block":"int"},
    {"eip158Block":"int"}
]

#####EXAMPLE

curl -X GET http://localhost:8000/params/ethereum

###GET /defaults/{blockchain} Get the default parameters for a blockchain #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
{
    "chainId":15468,
    "networkId":15468,
    "difficulty":100000,
    "initBalance":100000000000000000000,
    "maxPeers":1000,
    "gasLimit":4000000,
    "homesteadBlock":0,
    "eip155Block":0,
    "eip158Block":0
}

#####EXAMPLE

curl -X GET http://localhost:8000/defaults/ethereum

###GET /log/{server}/{node} Get both stdout and stderr from the blockchain process

#####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
<The contents>

#####EXAMPLE

curl -X POST http://localhost:8000/exec/4/0 -d 'ls'

###GET /nodes/{testnetid} Get the nodes for the latest testnet #####RESPONSE

[
    {
        "id": 1647,
        "testNetId": 134,
        "server": 3,
        "localId": 0,
        "ip": "10.6.0.2",
        "label": ""
    },
    {
        "id": 1648,
        "testNetId": 134,
        "server": 3,
        "localId": 1,
        "ip": "10.6.0.6",
        "label": ""
    }
]

#####EXAMPLE

curl -X GET http://localhost:8000/nodes

###DELETE /build/{buildid} Stop the given build #####RESPONSE Stop signal has been sent... #####EXAMPLE

curl -X DELETE http://localhost:8000/build

###POST /nodes/{num} Add {num} nodes to the current test net (Body is optional) #####BODY

{
    "servers":[(int),(int)...],
    "blockchain":(string),
    "nodes":(int),
    "image":(string),
    "resources":{
        "cpus":(string),
        "memory":(string)
    },
    "params":(Object containing params specific to the chain/client being built)
}

#####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
Success

#####EXAMPLE

curl -X POST http://localhost:8000/nodes/3 -d '{"servers":[3],"blockchain":"ethereum","nodes":3,"image":"ethereum:latest",
"resources":{"cpus":"2.0","memory":"10gb"},"params":null}'

###DELETE /nodes/{num} Delete {num} nodes from the testnet #####BODY #####RESPONSE

HTTP/1.1 200 OK
Date: Mon, 22 Oct 2018 15:31:18 GMT
Success

#####EXAMPLE

curl -X DELETE http://localhost:8000/nodes/5

###DELETE /emulate/{testnetId} Turn off emulate for a whole testnet ####BODY

####EXAMPLE

curl -X DELETE http://localhost:8000/emulate/9e09efe8_d7a3_4429_832c_447d876194c8

###POST /emulate/{testnetId} Set emulation for a node or nodes ####BODY TODO ####EXAMPLE

curl -X POST http://localhost:8000/emulate/9e09efe8_d7a3_4429_832c_447d876194c8

###POST /emulate/all/{testnetId} Set emulation for a whole testnet ####BODY TODO ####EXAMPLE

curl -X POST http://localhost:8000/emulate/all/9e09efe8_d7a3_4429_832c_447d876194c8

###GET /resources/{blockchain}

####BODY TODO ####EXAMPLE

curl -X POST http://localhost:8000/resources/geth

###GET /resources/{blockchain}/{file}

####BODY TODO ####EXAMPLE

curl -X GET http://localhost:8000/resources/geth/genesis.json

###POST /resources/{blockchain}/{file}

####BODY TODO ####EXAMPLE

curl -X POST http://localhost:8000/resources/geth/genesis.json

##Blockchain Specific Parameters

###Geth (Go-Ethereum) Note: Any configuration option can be left out, and this entire section can even be null, the example contains all of the defaults

####Options

chainId: The chain id set in the genesis.conf
networkId: The network id
difficulty: The initial difficulty set in the genesis.conf file
initBalance: The initial balance for the accounts
maxPeers: The maximum number of peers for each node
gasLimit: The initial gas limit
homesteadBlock: Set in genesis.conf
eip155Block: Set in genesis.conf
eip158Block: Set in genesis.conf

####Example (using defaults)

{
    "chainId":15468,
    "networkId":15468,
    "difficulty":100000,
    "initBalance":100000000000000000000,
    "maxPeers":1000,
    "gasLimit":4000000,
    "homesteadBlock":0,
    "eip155Block":0,
    "eip158Block":0
}

###Syscoin (RegTest)

####Options

rpcUser: The username credential
rpcPass: The password credential
masterNodeConns: The number of connections to set up for the master nodes
nodeConns: The number of connections to set up for the normal nodes
percentMasternodes: The percentage of the network consisting of master nodes
options: Options to set enabled for all nodes
senderOptions: Options to set enabled for senders
receiverOptions: Options to set enabled for receivers
mnOptions: Options to set enabled for master nodes
extras: Extra options to add to the config file for all nodes
senderExtras: Extra options to add to the config file for senders
receiverExtras: Extra options to add to the config file for receivers
mnExtras: Extra options to add to the config file for master nodes

####Example (using defaults)

{
    "rpcUser":"username",
    "rpcPass":"password",
    "masterNodeConns":25,
    "nodeConns":8,
    "percentMasternodes":90,
    "options":[
        "server",
        "regtest",
        "listen",
        "rest"
    ],
    "senderOptions":[
        "tpstest",
        "addressindex"
    ],
    "mnOptions":[],
    "receiverOptions":[
        "tpstest"
    ],
    "extras":[],
    "senderExtras":[],
    "receiverExtras":[],
    "mnExtras":[]
}

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all

Directories ¶

Path	Synopsis
blockchains
artemis
beam
cosmos
eos
geth
helpers
pantheon
parity
rchain
syscoin
tendermint
db Package db manages persistent state and keeps track of previous and current builds.	Package db manages persistent state and keeps track of previous and current builds.
deploy
manager Contains functions for managing the testnets.	Contains functions for managing the testnets.
net Allows the ability for the simulation of network conditions accross nodes.	Allows the ability for the simulation of network conditions accross nodes.
rest Implements the REST interface which is used to communicate with this module	Implements the REST interface which is used to communicate with this module
ssh
state Handles global state that can be changed	Handles global state that can be changed
status Handles functions related to the current state of the network	Handles functions related to the current state of the network
testnet
util Provides a multitude of support functions to help make development easier.	Provides a multitude of support functions to help make development easier.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL