Skip to content
This repository was archived by the owner on Aug 22, 2022. It is now read-only.
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
7f7d2eb
lukso installer modification started
Jan 20, 2022
bb0f292
restore name to lukso
Jan 20, 2022
b96b33f
generate keys mmodified according to kintsugi
Jan 20, 2022
73cb980
added tag inside download url
Jan 20, 2022
36c54a3
updated installer with new tag
Jan 20, 2022
9f7000b
beacon chain download url is fixed
Jan 20, 2022
e77814d
installer updated
Jan 20, 2022
0799ce0
geth beacon validator clients command is updated
Jan 21, 2022
a305442
lukso script updated to accept geth inforamtion
Jan 21, 2022
c9a19fb
removed lukso status
Jan 21, 2022
ab8254f
changed names from pandora to geth and vanguard to beacon-cheain
Jan 24, 2022
729ec5c
beacon flags are changed from vanguard to beacon
Jan 24, 2022
46d2d44
changed the url for configs
Jan 25, 2022
14799f4
eth2 stat url changed
Jan 25, 2022
c30a012
renamed some flags
Jan 25, 2022
1fa3ce3
network config location changed
Jan 26, 2022
9efceef
removed network-config from the downloader
Jan 26, 2022
0d1c216
download url has changed
Jan 26, 2022
4cf4a5d
change network name
Jan 26, 2022
d546277
modified bootnodes
Jan 26, 2022
ffbc4db
geth commands are changed
Jan 26, 2022
49736cc
slide modifications in lukso script
Jan 27, 2022
ac01504
README Updated
Jan 28, 2022
1678528
vanguard and pandora renamed in README.md
Jan 28, 2022
5fb7000
vanguard and pandora renamed in README.md
Jan 28, 2022
5a1c984
kintsugi installer introduced
Feb 22, 2022
44a7a46
remove sudo from kintsugi script
Feb 22, 2022
0018960
make file is added for kintsugi
Feb 22, 2022
c8bd32d
added makefile in the installer script
Feb 22, 2022
b831383
replace node name and also change docker message
Feb 22, 2022
72ba401
change node name
Feb 22, 2022
3d69fc5
change node name
Feb 22, 2022
ad87e4c
more comments are added with the installer
Feb 22, 2022
2426f6d
fix mac os sed related issue
Feb 22, 2022
b5a6ed9
eth2 name bug resolved
Feb 22, 2022
5bdc737
add some comments in downloader
Feb 22, 2022
cbd19e0
chore(l16): fix ethstats + eth2stats naming script
rryter Feb 23, 2022
7450b12
added support for ip change and unix support
Feb 23, 2022
9dac440
Merge branch 'feature/lukso-cli-with-kintsugi' of https://github.com/…
Feb 23, 2022
3afafc2
make file added with new features and installer bug fixed
Feb 23, 2022
7a0fd04
major bug fix in dockerlog and message change in the installer
Feb 23, 2022
da91967
colon was missing after extip.
Feb 23, 2022
d876600
add some more comments
Feb 23, 2022
a93500d
make file modified
Feb 23, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.env
data
configs
bin
keystore
deposit_data.json
docker-compose.yml
Makefile
132 changes: 59 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In `./shell_scripts` are currently used scripts that will be replaced by proper

### Minimum specifications

These specifications must be met in order to successfully run the Vanguard, Pandora, and Orchestrator clients.
These specifications must be met in order to successfully run the Beacon-chain and Geth clients.

- Operating System: 64-bit Linux, Mac OS X 10.14+
- Processor: Intel Core i5–760 or AMD FX-8100 or better
Expand All @@ -24,7 +24,7 @@ These specifications must be met in order to successfully run the Vanguard, Pand

### Recommended specifications

These hardware specifications are recommended, but not required to run the Vanguard, Pandora, and Orchestrator clients.
These hardware specifications are recommended, but not required to run the Beacon-chain and Geth.

- Processor: Intel Core i7–4770 or AMD FX-8310 or better
- Memory: 16GB RAM
Expand Down Expand Up @@ -60,9 +60,9 @@ Enter `lukso config` in your shell to generate config file.
Example:
~~~yaml
COINBASE: "0x616e6f6e796d6f75730000000000000000000000"
WALLET_DIR: "/home/user/.lukso/l15-prod/vanguard-wallet"
DATADIR: "/home/user/.lukso/l15-prod/datadirs"
LOGSDIR: "/home/user/.lukso/l15-prod/logs"
WALLET_DIR: "/home/user/.lukso/l16-prod/beacon-wallet"
DATADIR: "/home/user/.lukso/l16-prod/datadirs"
LOGSDIR: "/home/user/.lukso/l16-prod/logs"
NODE_NAME: "l15-johnsmith123"
~~~
After that, you can use `--config /path/to/config.yaml` insted of other flags:
Expand All @@ -74,13 +74,13 @@ After that, you can use `--config /path/to/config.yaml` insted of other flags:

| command | description | argument |
|-----------|------------------------|----------------------|
| start | Starts up all or specific client(s) | [orchestrator, pandora, vanguard, validator, eth2stats-client, lukso-status, **all**] |
| stop | Stops all or specific client(s) | [orchestrator, pandora, vanguard, validator, eth2stats-client, lukso-status, **all**] |
| reset | Clears client(s) datadirs (this also removes chain-data) | [orchestrator, pandora, vanguard, validator, all, **none**]
| start | Starts up all or specific client(s) | [geth, beacon, validator, eth2stats-client, **all**] |
| stop | Stops all or specific client(s) | [geth, beacon, validator, eth2stats-client, **all**] |
| reset | Clears client(s) datadirs (this also removes chain-data) | [geth, beacon, validator, all, **none**]
| config | Interactive tool for creating config file | |
| keygen | Runs `lukso-deposit-cli` | |
| wallet | Imports `lukso-deposit-cli` keys into `lukso-validator` wallet| |
| logs | Show logs | [orchestrator, pandora, vanguard, validator, eth2stats-client, lukso-status] |
| keygen | Runs `network-validator-tools` to generate keystore and wallet | |
| gen-deposit-data | Uses `network-validator-tools` to `deposit-keys.json`| |
| logs | Show logs | [orchestrator, geth, beacon, validator, eth2stats-client, lukso-status] |
| bind-binaries | sets client(s) to desired version |
| version | Shows the LUKSO script version |
> In **bold** is a behaviour when argument is skipped (default)
Expand All @@ -89,68 +89,61 @@ After that, you can use `--config /path/to/config.yaml` insted of other flags:

| name | description | Argument |
|-----------|------------------------|---|
| --network | Picks which setup to use | Name of network from list: `mainnet, l15-prod, l15-staging, l15-dev`
| --l15-prod | Shorthand alias for `--network l15-prod` | <none\>
| --l15-staging | Shorthand alias for `--network l15-staging` | <none\>
| --l15-dev | Shorthand alias for `--network l15-dev` | <none\>
| --network | Picks which setup to use | Name of network from list: `mainnet, l16-prod, l16-staging, l16-dev`
| --l16-prod | Shorthand alias for `--network l16-prod` | <none\>
| --l16-staging | Shorthand alias for `--network l16-staging` | <none\>
| --l16-dev | Shorthand alias for `--network l16-dev` | <none\>
| --config | Path to config file | Path ex. `config.yaml` |
| --validate | Starts validator | <none\>
| --coinbase | Sets pandora coinbase. This is public address for block mining rewards (default = first account created) (default: "0") | ETH1 addres ex. `0x144a9533B3d759d647597762d33a1cD6f9Bf118c`
| --node-name | Name of node that's shown on pandora stats and vanguard stats | String ex. `johnsmith123`
| --coinbase | Sets geth coinbase. This is public address for block mining rewards (default = first account created) (default: "0") | ETH1 addres ex. `0x144a9533B3d759d647597762d33a1cD6f9Bf118c`
| --node-name | Name of node that's shown on geth stats and beacon stats | String ex. `johnsmith123`
| --logsdir | Sets the logs path | String ex. `/mnt/external/lukso-logs`
| --datadir | Sets datadir path | String ex. `/mnt/external/lukso-datadir`
| --home | Sets path for datadir and logs in a single location (--datadir and --logs take priority) | String ex. `/var/lukso`
| --orchestrator-verbosity | Sets orchestrator logging depth | String ex. `silent, error, warn, info, debug, trace`
| --pandora-verbosity | Sets pandora logging depth (note: pandora uses integers for that flag, script will convert those to proper values) | String ex. `silent, error, warn, info, debug, trace`
| --pandora-bootnodes | Sets pandora bootnodes | Strings of bootnodes separated by commas: `enode://72caa...,enode://b4a11a...`
| --pandora-http-port | Sets pandora RPC (over http) port | Number between 1023-65535
| --pandora-metrics | Enables pandora metrics server | <none\>
| --pandora-nodekey | P2P node key file | Path to file (relative or absolute)
| --pandora-rpcvhosts | Sets pandora rpc virtual hosts (use quotes if you want to set \* `'*'` otherwise shell will resolve it) | Comma-separated list of virtual hosts Ex. `localhost` or `*`
| --pandora-external-ip | Sets external IP for pandora (overrides --external-ip if present) | String ex. `72.122.32.234`
| --pandora-universal-profile-expose | Exposes "net,eth,txpool,web3" API's on Pandora RPC | <none\>
| --pandora-unsafe-expose | Exposes ALL API's ("admin,net,eth,debug,miner,personal,txpool,web3") API's on Pandora RPC | <none\>
| --vanguard-verbosity | Sets vanguard logging depth | String ex. `silent, error, warn, info, debug, trace`
| --vanguard-bootnodes | Sets vanguard bootnodes | Strings of bootnodes separated by commas: `enr:-Ku4QAmY...,enr:-M23QLmY...`
| --vanguard-p2p-priv-key | The file containing the private key to use in communications with other peers. | Path to file (relative or absolute)
| --vanguard-external-ip | Sets external IP for vanguard (overrides --external-ip if present) | IP ex. `72.122.32.234`
| --vanguard-p2p-host-dns | Sets host DNS vanguard (overrides --external-ip AND --vanguard-external-ip if present) | DNS name ex. `l15-nodes-1.nodes.l15.lukso.network`
| --vanguard-rpc-host | Sets vanguard RPC listening interface | IP ex. `127.0.0.1`
| --vanguard-monitoring-host | Sets vanguard monitoring listening interface | IP ex. `127.0.0.1`
| --network-version | Picup the network version for which configs will be downloaded
| --geth-verbosity | Sets geth logging depth (note: geth uses integers for that flag, script will convert those to proper values) | String ex. `silent, error, warn, info, debug, trace`
| --geth-bootnodes | Sets geth bootnodes | Strings of bootnodes separated by commas: `enode://72caa...,enode://b4a11a...`
| --geth-http-port | Sets geth RPC (over http) port | Number between 1023-65535
| --geth-metrics | Enables geth metrics server | <none\>
| --geth-nodekey | P2P node key file | Path to file (relative or absolute)
| --geth-rpcvhosts | Sets geth rpc virtual hosts (use quotes if you want to set \* `'*'` otherwise shell will resolve it) | Comma-separated list of virtual hosts Ex. `localhost` or `*`
| --geth-external-ip | Sets external IP for geth (overrides --external-ip if present) | String ex. `72.122.32.234`
| --geth-universal-profile-expose | Exposes "net,eth,txpool,web3" API's on geth RPC | <none\>
| --geth-unsafe-expose | Exposes ALL API's ("admin,net,eth,debug,miner,personal,txpool,web3") API's on geth RPC | <none\>
| --beacon-verbosity | Sets beacon-client logging depth | String ex. `silent, error, warn, info, debug, trace`
| --beacon-bootnodes | Sets beacon-client bootnodes | Strings of bootnodes separated by commas: `enr:-Ku4QAmY...,enr:-M23QLmY...`
| --beacon-p2p-priv-key | The file containing the private key to use in communications with other peers. | Path to file (relative or absolute)
| --beacon-external-ip | Sets external IP for beacon-client (overrides --external-ip if present) | IP ex. `72.122.32.234`
| --beacon-p2p-host-dns | Sets host DNS beacon-client (overrides --external-ip AND --beacon-external-ip if present) | DNS name ex. `l16-nodes-1.nodes.l16.lukso.network`
| --beacon-rpc-host | Sets beacon-client RPC listening interface | IP ex. `127.0.0.1`
| --beacon-monitoring-host | Sets beacon-client monitoring listening interface | IP ex. `127.0.0.1`
| --validator-verbosity | Sets validator logging depth | String ex. `silent, error, warn, info, debug, trace`
| --wallet-dir | Sets directory of `lukso-validator` wallet | Path to directory, relative or absolute
| --wallet-password-file | Sets location of password file for validator (without it, it will always prompt for password) | Path to a file, relative or absolute
| --cors-domain | Sets CORS domain (note: if you want to set every origin you must type asterisk wrapped in quotes `'*'` otherwise shell may try to resolve it | CORS Domain ex. `localhost`, `*`
| --external-ip | Sets external IP for pandora and vanguard | String ex. `72.122.32.234`
| --external-ip | Sets external IP for geth and beacon-chain | String ex. `72.122.32.234`
| --allow-respin | Deletes all datadirs IF network config changed (based on genesis time) | <none\>
| --vanguard-http-web3provider | An eth1 web3 provider string http endpoint or IPC socket path. (default: http://127.0.0.1:8545) | URL address, e.g. `http://127.0.0.1:8545`
| --vanguard-rpc-host | Host on which the RPC server should listen. (default: 127.0.0.1) | IPv4 address, e.g. `127.0.0.1`
| --van-rpc-port | Port on which the RPC server should listen. (default: 4000) | Port, e.g. `4000`
| --van-udp-port | Vanguard beacon chain client UDP port. The port used by discv5. (default: 12000) | Port number, e.g. `12000`
| --van-tcp-port | Vanguard beacon chain client TCP port. The port used by libp2p. (default: 13000) | Port number, e.g. `13000`
| --van-grpc-gateway-port | Vanguard gRPC gateway port. The port on which the gateway server runs on (default: 3500) | Gateway port, e.g. `3500`
| --vanguard-orc-rpc-provider | A orchestrator rpc endpoint. This is our orchestrator client http endpoint or socket path. (default: http://127.0.0.1:7877) | URL or IPC socket path, e.g. `http://127.0.0.1:7877`
| --validator-beacon-rpc-provider | Beacon node (vanguard) RPC provider endpoint. (default is: 127.0.0.1:4000) | IPv4 with port, e.g. `127.0.0.1:4000`
| --validator-pandora-http-provider | A pandora rpc endpoint. This is our pandora client http endpoint. (default is: http://127.0.0.1:8545) | URL or IPC socket path, e.g. `http://127.0.0.1:8545`
| --orchestrator-vanguard-rpc-endpoint | Enables Vanguard node RPC provider endpoint. (default is: 127.0.0.1:4000) | IPv4 with port, e.g. `127.0.0.1:4000`
| --orchestrator-pandora-rpc-endpoint | Pandora node RP provider endpoint. (default: ws://127.0.0.1:8546) | Websocket address with port, e.g. `ws://127.0.0.1:8546`
| --beacon-http-web3provider | An eth1 web3 provider string http endpoint or IPC socket path. (default: http://127.0.0.1:8545) | URL address, e.g. `http://127.0.0.1:8545`
| --beacon-rpc-host | Host on which the RPC server should listen. (default: 127.0.0.1) | IPv4 address, e.g. `127.0.0.1`
| --beacon-rpc-port | Port on which the RPC server should listen. (default: 4000) | Port, e.g. `4000`
| --beacon-udp-port | beacon chain client UDP port. The port used by discv5. (default: 12000) | Port number, e.g. `12000`
| --beacon-tcp-port | beacon chain client TCP port. The port used by libp2p. (default: 13000) | Port number, e.g. `13000`
| --beacon-grpc-gateway-port | beacon-chain gRPC gateway port. The port on which the gateway server runs on (default: 3500) | Gateway port, e.g. `3500`
| --validator-beacon-rpc-provider | Beacon node RPC provider endpoint. (default is: 127.0.0.1:4000) | IPv4 with port, e.g. `127.0.0.1:4000`
| --validator-geth-http-provider | A geth rpc endpoint. This is our geth client http endpoint. (default is: http://127.0.0.1:8545) | URL or IPC socket path, e.g. `http://127.0.0.1:8545`
| --eth2stats-beacon-addr | Beacon node endpoint address for eth2stats-client. (default: 127.0.0.1:4000) | IPv4 with port, e.g. `127.0.0.1:4000`
| --orc-http-port | Orchestrator HTTP port exposed. Default is: 7877 | Port number, e.g. `7877`
| --orc-http-addr | Orchestrator HTTP address exposed. Default is: 127.0.0.1 | IPv4 address, e.g. `127.0.0.1`
| --orc-ws-port | Orchestrator websocket port exposed. Default is: 7878 | Port number, e.g. `7878`
| --orc-ws-addr | Orchestrator websocket address exposed. Default is: 127.0.0.1 | IPv4 address, e.g. `127.0.0.1`
| --pan-port | Pandora client TCP/UDP port exposed. Default is: 30405 | Port number, e.g. `30405`
| --pan-http-addr | Pandora client http address exposed. Default is: 127.0.0.1 | IPv4 address, e.g. `127.0.0.1`
| --pan-http-port | Pandora client http port exposed. Default is: 8545 | Port number, e.g. `8545`
| --pan-ws-addr | Pandora client websocket address exposed. Default is: 127.0.0.1 | IPv4 address, e.g. `127.0.0.1`
| --pan-ws-port | Pandora client websocket port exposed. Default is: 8546 | Port number, e.g. `8546`
| --pan-http-miner-addr | Pandora HTTP URL to notify of new work packages. Default is: http://127.0.0.1:7877 | HTTP address, e.g. `http://127.0.0.1:7877`
| --pan-ws-miner-addr | Pandora Websocket URL to notify of new work packages. Default is: ws://127.0.0.1:7878 | WS address, e.g. `ws://127.0.0.1:7878`
| --pan-ethstats | Pandora flag to activate ethstats listing on remote dashboard. If enabled you should see your node by your node name provided via --node-name flag or lukso config. (default: disabled) | Token and address like `token123@stats.example.com`
| --van-ethstats | Vanguard flag fo activate eth2stats listing on remote dashboard. If enabled you should see your node by your node name provided via --node-name flag or lukso config. (default: disabled) | Address with port, e.g. `192.168.0.1:9090`
| --van-min-sync-peers | The required number of valid Vanguard peers to connect with before syncing. (default: 2) | Number of required peers, e.g. `1`
| --van-max-p2p-peers | The max number of Vanguard p2p peers to maintain. (default: 50) | Peers count, e.g. `70`
| --van-ethstats-metrics | The metrics address for Vanguard eth2stats-client service (default: http://127.0.0.1:8080/metrics) | HTTP address with port and `metrics` endpoint, e.g. `http://127.0.0.1:8080/metrics`
| --geth-port | Geth client TCP/UDP port exposed. Default is: 30405 | Port number, e.g. `30405`
| --geth-http-addr | Geth client http address exposed. Default is: 127.0.0.1 | IPv4 address, e.g. `127.0.0.1`
| --geth-http-port | Geth client http port exposed. Default is: 8545 | Port number, e.g. `8545`
| --geth-ws-addr | Geth client websocket address exposed. Default is: 127.0.0.1 | IPv4 address, e.g. `127.0.0.1`
| --geth-ws-port | Geth client websocket port exposed. Default is: 8546 | Port number, e.g. `8546`
| --geth-http-miner-addr | Geth HTTP URL to notify of new work packages. Default is: http://127.0.0.1:7877 | HTTP address, e.g. `http://127.0.0.1:7877`
| --geth-ws-miner-addr | Geth Websocket URL to notify of new work packages. Default is: ws://127.0.0.1:7878 | WS address, e.g. `ws://127.0.0.1:7878`
| --geth-ethstats | Geth flag to activate ethstats listing on remote dashboard. If enabled you should see your node by your node name provided via --node-name flag or lukso config. (default: disabled) | Token and address like `token123@stats.example.com`
| --beacon-ethstats | Beacon-chain flag fo activate eth2stats listing on remote dashboard. If enabled you should see your node by your node name provided via --node-name flag or lukso config. (default: disabled) | Address with port, e.g. `192.168.0.1:9090`
| --beacon-min-sync-peers | The required number of valid beacon-chain peers to connect with before syncing. (default: 2) | Number of required peers, e.g. `1`
| --beacon-max-p2p-peers | The max number of beacon-chain p2p peers to maintain. (default: 50) | Peers count, e.g. `70`
| --beacon-ethstats-metrics | The metrics address for beacon-chain eth2stats-client service (default: http://127.0.0.1:8080/metrics) | HTTP address with port and `metrics` endpoint, e.g. `http://127.0.0.1:8080/metrics`
| --status-page | This flag is for lukso-status activation. With this service you can check your node status over web browser (default: disabled). Default web address is: http://127.0.0.1:8111 | <none\>

How to use flags with values? Provide a flag and value like: `lukso start --datadir /data/network-node`
Expand All @@ -160,30 +153,23 @@ How to use flags with values? Provide a flag and value like: `lukso start --data
|-----------|------------------------|---|
| --force | Adds force option to kill commands (may result in corruption of node data) | <none\> |

### keygen
### gen-deposit-data
| name | description | Argument |
|-----------|------------------------|---|
| --keys-dir | Sets directory of `lukso-deposit-cli` keys | Path to directory, relative or absolute
| --keys-password-file | Sets directory of `lukso-deposit-cli` keys | Path to directory, relative or absolute

### wallet
### keygen
| name | description | Argument |
|-----------|------------------------|---|
| --keys-dir | Sets directory of `lukso-deposit-cli` keys | Path to directory, relative or absolute
| --keys-password-file | Sets directory of `lukso-deposit-cli` keys | Path to directory, relative or absolute
| --wallet-dir | Sets directory of `lukso-validator` wallet | Path to directory, relative or absolute
| --wallet-password-file | Sets directory of `lukso-validator` wallet | Path to directory, relative or absolute


### bind-binaries
| name | description | Argument |
|-----------|------------------------|---|
| --orchestrator | download and set `orchestrator` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --pandora | download and set `pandora` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --vanguard | download and set `vanguard` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --geth | download and set `geth` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --beacon | download and set `beacon-chain` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --validator | download and set `validator` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --deposit | download and set `lukso-deposit-cli` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --eth2stats | download and set `eth2stats` to given tag | Tag, ex. `v0.1.0-rc.1` |
| --lukso-status | download and set `lukso-status` to given tag | Tag, ex. `v0.1.0-rc.1` |


Loading