README
¶
aknode
Overview
This is the node server for Aidos Kuneen for step2, including:
- Messaging between nodes (Testing)
- Consensus / Validator (Testing)
- Aidos Explorer (Testing)
- RPC APIs with Wallet Service (Testing)
- One time address (Testing)
- One time ring signature / Confidential transaction (Not planned for Step2)
UNDER CONSTRUCTION. DON'T TOUCH ME.
Requirements
- git
- go 1.9+
are required to compile.
Installation
$ go get github.com/AidosKuneen/aknode
How to Run
- Setup aknode.json
- $ cd github.com/AidosKuneen/aknode/cmd/aknode
- $ go run main.go -config aknode.json
aknode.json
| key | default | description |
|---|---|---|
| debug | false | setup for debug info (memory usage etc) |
| testnet | 0 | 0:mainnet 1:testnet 2:debugnet |
| blacklists | [] | node IPs which should be banned |
| root_dir | $HOME/.aknode | root directory data will be stored |
| my_host_port | remote address:port in TCP/IP packet | hostname and port repoted when connected from (connects to) remote node. required if your node is behind firewall. |
| default_nodes | [] | nodes which are connected from start |
| bind | "0.0.0.0" | bind address for listening node |
| port | mainnet:14270, testnet:14370 | port number for listening node |
| max_connections | 5 | umber of max connections for node |
| proxy | "" | proxy ussed when connecting nodes |
| use_public_rpc | false | use open public RPCs |
| use_wallet_rpc | false | use wallet RPCs |
| rpc_bind | "localhost" | bind address for listening RPC |
| rpc_port | mainnet:14271, testnet: 14371 | port number for listening RPC |
| rpc_user | "" | rpc user name, required if you use wallet |
| rpc_password | "" | rpc password, required if you use wallet |
| rpc_max_connections | 0 | number of max connections for RPC, 0:no limit |
| rpc_tx_tag | "" | Tag of transactions sent from aknode |
| rpc_allow_public_pow | false | if allow PoW from remote |
| wallet_notify | "" | the comand when a tx comes into wallet |
| run_validator | false | run validator node |
| validator_secret | "" | secret key for validator, required if run_validator:true |
| run_explorer | false | run explorer |
| explorer_bind | "localhost" | bind address for listening explorer |
| explorer_port | mainnet:8081, testnet:8082 | port number for listening explorer |
| explorer_max_connections | 1 | number of max connections for explorer |
| run_fee_miner | false | run miner node for fee |
| run_ticket_miner | false | run miner node for ticket |
| run_ticket_issuer | false | run miner node for issuing miner |
| miner_address | "" | address of miner, required if run_*_miner :true |
example:
{
"debug": true,
"testnet": 2,
"use_public_rpc": true,
"rpc_user":"tester",
"rpc_password":"test",
"wallet_notify":"echo %s",
"run_explorer": true,
"run_fee_miner":true,
"run_ticket_miner":true,
"run_ticket_issuer":true,
"miner_address":"AKADRSD4HSext48uT6cibWYoQQj6pvtVgLkQo61wbiToSKfeSi2inrMUU"
}
Contribution
Improvements to the codebase and pull requests are encouraged.
Dependencies and Licenses
This software includes the work that is distributed in the Apache License 2.0.
github.com/AidosKuneen/aklib MIT License
github.com/AidosKuneen/aknode MIT License
github.com/AidosKuneen/bliss/bit MIT License
github.com/AidosKuneen/consensus MIT License
github.com/AidosKuneen/cuckoo MIT License
github.com/AidosKuneen/numcpu MIT License
github.com/AndreasBriese/bbloom MIT License, Public Domain
github.com/blang/semver MIT License
github.com/cloudflare/sidh BSD 3-clause "New" or "Revised" License / MIT License
github.com/dgraph-io/badger Apache License 2.0
github.com/dgryski/go-farm MIT License
github.com/gobuffalo/envy MIT License
github.com/gobuffalo/packd MIT License
github.com/gobuffalo/packr MIT License
github.com/golang/protobuf/proto BSD 3-clause "New" or "Revised" License
github.com/google/go-github/github BSD 3-clause "New" or "Revised" License
github.com/google/go-querystring/query BSD 3-clause "New" or "Revised" License
github.com/henrydcase/nobs/hash/sha3 BSD 3-clause "New" or "Revised" License
github.com/inconshreveable/go-update Apache License, Version 2
github.com/inconshreveable/go-update/internal/binarydist MIT License
github.com/inconshreveable/go-update/internal/osext BSD 3-clause "New" or "Revised" License
github.com/joho/godotenv MIT License
github.com/markbates/oncer MIT License
github.com/mattn/go-shellwords MIT License
github.com/natefinch/lumberjack MIT License
github.com/pkg/errors BSD 2-clause "Simplified" License
github.com/rhysd/go-github-selfupdate/selfupdate MIT License
github.com/skip2/go-qrcode MIT License
github.com/tcnksm/go-gitconfig MIT License
github.com/ulikunitz/xz BSD 3-clause "New" or "Revised" License
github.com/vmihailenco/msgpack/codes BSD 2-clause "Simplified" License
golang.org/x/crypto BSD 3-clause "New" or "Revised" License
golang.org/x/net BSD 3-clause "New" or "Revised" License
golang.org/x/oauth2/internal BSD 3-clause "New" or "Revised" License
golang.org/x/sys BSD 3-clause "New" or "Revised" License
golang.org/x/text BSD 3-clause "New" or "Revised" License
Golang Standard Library BSD 3-clause License
Directories
Click to show internal directories.
Click to hide internal directories.