Dec 13, 2019 - The code base is changing daily so check the telegram group for updates. References to other guides are below. Check out Chris Graffagnino's notes too. https://github.com/Chris-Graffagnino/Jormungandr-for-Newbs/blob/master/docs/jormungandr_node_setup_guide.md
https://github.com/input-output-hk/shelley-testnet/blob/master/docs/stake_pool_operator_how_to.md
THIS REPO WILL BE DEPRECIATED - A NEW FOLDER WILL BE DEDICATED TO THE 0.8.0 BETA https://github.com/cliffc2/jormungandr-setup
https://github.com/input-output-hk/jormungandr/releases/
After you load the binaries, you will need to make a 2 folders (jormungandr folder and a tmp/jormungandr "storage" folder) then create the config.yaml (or node-config.yaml then save the file to the jormungandr folder).
Overview
- To do list (load from source - not for newbies though mostly harmless)
- load Rust (using rustup command)
- load jormungandr program (the ring of computers around the globe)
- load jcli (Jormungandr Command Line Interface - JCLI)
- load sqlite (if not loaded - for temporary blockchain database)
- edit port and check ip addresses
- make folders (for temporary blockchain database)
- edit node-config.yaml (your computer's IP info)
- make public keys from secret keys (to receive funds)
- check node is in 'sync'
- get tokens from faucet
- send tokens to another account
- delegate stake to pool
- make stake pool keys (4)
- make stake pool certificate
- get node id
Open a command line Terminal (Open the Finder ▸ look under Applications ▸ and click Utilities)
| Steps (mostly in order) | Type these commands into the OSX computer Terminal (computer_name:~ account$) | Output example |
|---|---|---|
| Download Rust (command linked to website) | curl https://sh.rustup.rs -sSf / sh |
|
| Create Rust path | source $HOME/.cargo/env |
loads rustup path to bash_profile |
| Load Rust | rustup install stable |
info: checking for self-updates |
| Load Default | rustup default stable |
info: default toolchain set to 'stable-x86_64-apple-darwin' |
| Check the Rust version | rustc --version |
rustc 1.38.0 (625451e37 2019-09-23) |
| Update if old | rustup update |
|
| Check folder path if Rust fails | echo $PATH |
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin |
| Download Jormungandr | git clone --recurse-submodules https://github.com/input-output-hk/jormungandr |
Cloning into 'jormungandr'remote: Enumerating objects: 110, done --- Submodule path 'chain-deps': checked out |
| Go to the Jormungandr folder | cd jormungandr |
returns command prompt - macbook-pro:jormungandr cliff$ |
| Load Jormungandr | cargo install --path jormungandr |
Installing jormungandr v0.5.5 (/Users/cliff/jormungandr/jormungandr |
| if build fails | load xcode-select --install |
note: xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun |
| Load jcli | cargo install --path jcli |
Installing jcli v0.5.2 (/Users/cliff/jormungandr/jcli) |
| Check the jcli version | jcli -V |
jcli 0.5.X to present |
Now we will create a new account. revised IOHK Documentation here There are some New scripts if you want to skip the manual account and key making.
| Make an Account by hand | Type these commands into the OSX computer Terminal (computer_name:~ account$) | Output example |
|---|---|---|
| Start (run) Jormungandr Node 0.8.0 RC10 | jormungandr --genesis-block-hash 65a9b15f82619fffd5a7571fdbf973a18480e9acf1d2fddeb606ebb53ecca839 --config config.yaml |
|
| Start (old) Jormungandr Passive Node 0.7.0 | jormungandr --genesis-block-hash 27668e95121566df0bb2e2c11c5fd95dfe59efd570f8f592235ecff167ca3f29 --config config.yaml (note: you need to use this hash to connect to the testnet chain. Do not use --genesis-block block-0.bin to start the node. That is a self-node.) |
Sep 28 04:32:15.874 INFO Starting jormungandr 0.5.2 (master-0b40827e, release, macos [x86_64]) - [rustc 1.38.0 (625451e37 2019-09-23)], task: init |
| Check the directory | ls |
list of folders |
| Go to the Jormungandr folder | cd jormungandr |
returns command prompt - macbook-pro:~ cliff$ |
| Now we can make keys | note - new key making script here so you can skip to the faucet step. https://github.com/input-output-hk/jormungandr-qa/tree/master/scripts | createAddress.sh account |
| skip | Check permissions | ls -l |
| skip | Change permissions | chmod +x createAddress.sh |
| skip | run script createAddress.sh account |
createAddress.sh account |
| Make a secret key | jcli key generate --type=Ed25519Extended > receiver_secret.key |
ed25519e_sk1vqsf2dh3rlg2.... |
| Make a public key from the secret key | cat receiver_secret.key / jcli key to-public > receiver_public.key |
change / to vert line ed25519_pk1nv4f5.... |
| Make an account address from the public key | jcli address account --prefix addr --testing $(cat receiver_public.key) / tee receiver_account.txt |
This is your receiver account (account address) ca1s56lu955y... change / to vert line |
| List files and folders in jormungandr | ls (You should see receiver_account.txt, receiver_secret.key, receiver_public.key...) |
list of all your files and folders |
| FAUCET STEP Go to the IOHK website to get ADA testnet tokens from the faucet | Now we can go get testnet tokens https://testnet.iohkdev.io/en/cardano/shelley/tools/faucet/ | it will give you a transaction number |
| Check your account address to see your tokens | jcli rest v0 account get $(cat receiver_account.txt) -h http://127.0.0.1:3100/api (note: you need to check your node-config.yaml (config.yaml) to see what port (i.e. 3101 or 3100) you are using) |
counter: 0 -delegation:pools:[] value: 250000000000 |
| Send tokens to account | Now we can send tokens (money) using a script. https://github.com/input-output-hk/jormungandr-qa/tree/master/scripts send-lovelaces.sh <ADDRESS> <AMOUNT> <REST-LISTEN-PORT> <SOURCE-SK> |
|
| Check the message log to see tx | jcli rest v0 message logs --host "http://127.0.0.1:3100/api |
OUTPUT ================Send Money================= DESTINATION_ADDRESS: ca1sdj6vsyq4qdfrm0t5h4cgftld238lvxc7dp3h5ph5ld89ydlylh659d0q5g DESTINATION_AMOUNT: 10000 REST_PORT: 3101...
| Delegate script | |
|---|---|
| Delegate tokens to a Stake pool. | Now we can delegate using a script. https://github.com/input-output-hk/jormungandr-qa/tree/master/scripts delegate-account.sh <STAKE_POOL_ID> <REST-LISTEN-PORT> <ACCOUNT-SK>Here is the IOHK Zendesk reference https://iohk.zendesk.com/hc/en-us/categories/360002383814-Shelley-Networked-Testnet |
| OSX Terminal | |
|---|---|
| Make a secret vrf key | jcli key generate --type=Curve25519_2HashDH > stake_pool_vrf.prv |
| Make a public vrf key from secret vrf key | cat stake_pool_vrf.prv jcli key to-public > stake_pool_vrf.pub |
| Make a secret stakepool key from scratch | jcli key generate --type=SumEd25519_12 > stake_pool_kes.prv |
| Make a public stakepool key from secret | cat stake_pool_kes.prv jcli key to-public > stake_pool_kes.pub |
jcli certificate new stake-pool-registration --kes-key kes25519-12-pk1q06kvadqp040wzc5acnnv06rjqphnavyf9xfgpf6awjnnptqef9jkk --vrf-key vrf_pk1sesgrk2k6e6rxypkcj855fnnwcs9k5zg62yhqklrzshmlj02qysdhxeqy --owner ed25519_pk14pe9kt0kcxqlj7h8g3ye2lt5mjlph0y08l2jg8u6hgwsag830qd708gl --start-validity 0 --management-threshold 1 --serial 1010101010 > stake_pool.cert
jcli certificate new stake-pool-registration \
--kes-key $(cat stake_pool_kes.pub) \
--vrf-key $(cat stake_pool_vrf.pub) \
--start-validity 0 \
--management-threshold 1 \
--tax-fixed 1000000 \
--tax-limit 1000000000 \
--tax-ratio "1/10" \
--owner $(cat owner_key.pub) > stake_pool.cert
| Git something | OSX Terminal Command |
|---|---|
| Load new version | git checkout v0.x.x |
| Copy from Github | git pull |
| Check submodules | git submodule update --init --recursive |
| Clean (Optional) | cargo clean |
| Update | cargo update |
| Reload Jormungandr old to new | cargo install --path jormungandr --force |
| Reload jcli old to new | cargo install --path jcli --force |
How to drop all your local changes and commits, fetch the latest history from the server and point your local master branch at it like this
| Git something | OSX Terminal Command |
|---|---|
| Load new version | git fetch origin |
| Reset | git reset --hard origin/master |
| Other commands | OSX Terminal Command |
|---|---|
| Edit your folder paths for bash commands | touch ~/.bash_profile; open ~/.bash_profile |
| Find your jormungadr folder location | which jormungandr |
| Check submodule updates | git submodule update --init --recursive |
| Find your sudo folder | which sudo |
| Create new folder (directory) | mkdir tmp/jormungandr |
| Find your mac version | uname -a |
| Check the file permissions (execute?) | ls -l |
| Check the hidden files | ls -a |
| Check for ssh keys | ls -al ~/.ssh |
| Edit permission to execute command | chmod +x createAddress.sh |
| Edit file permission to execute command | chmod +x faucet-send-money.sh |
| Check if you are connecting to nodes | netstat -a | grep ESTABLISHED netstat reference here |
| Check your public key from your account address | jcli address info <insert account address here> |
| Check the blockchain statistics | jcli rest v0 node stats get -h http://127.0.0.1:3100/api |
| Shutdown a Node (FYI) | jcli rest v0 shutdown get -h http://127.0.0.1:3100/api |
| How to stop the command line if | (ctrl)+c |
| ulimit error (tbd) | launchctl limit maxfiles https://forum.aeternity.com/t/solved-problems-setting-up-a-node-on-osx-mojave/1678 |
| run debug | jormungandr --genesis-block-hash check4thelatestgenesisblock3 --config config.yaml --log-level=debug |
| find your public ip address | dig +short myip.opendns.com @resolver1.opendns.com |
How to download the UTXO list from the blockchain
jcli rest v0 utxo get --host "http://127.0.0.1:3100/api"
output example
- address: ca1svdr67ywnmnu2cqgzsqjsfc2px7rw4zkwagxh067ufjwp7999slt2j9yjgt associated_fund: 10006 index_in_transaction: 1 transaction_id: 7e5d7f0afea88aa54cb221f6e6b24377ce9ed95bdd1defe926a02e28a15e2bcd
- address: ca1svkrff0urjvla0c7wjxyt4963epk9lpxqrhy24pnfvju7ulngudwj3vuwe0 associated_fund: 105427 index_in_transaction: 0 transaction_id: ff50694b70a3369e1235bf6919f33477d30587584ea46f0280b2b25e46f29ecf
or you can use curl http://127.0.0.1:3100/api/v0/node/stats
genesis:
sig_key: kes25519-12-sk1qqqqqqxrnh4zjh828faxytve8d...really-long-string
vrf_key: vrf_sk1wtgsdfaluirbcurebpieurvjbrlerjblbrezj
node_id: 8ca471252c536d55fiuheroiseriuaeaircapeiuhfwe
Format of the genesis.yaml file
genesis:
sig_key: Content of stake_pool_kes.prv file
vrf_key: Content of stake_pool_vrf.prv file
node_id: Content of stake_pool.id file
The Official reference IOHK Quickstart reference
Also check out the Cardano StakePool Community on telegram and the Github support triage for the Shelley testnet if you have any questions.