suno -- Yet another way to manage Substrate Node Operations from your terminal. suno is a terminal user interface to monitor live data and manage your own or third-party nodes. It supports Polkadot, Kusama, Paseo, and Westend networks.
As a node operator, to manage your own or third-party nodes from the terminal.
As a nominator you can just as easily check the validators you nominate.
- [✓] Support Polkadot, Kusama, Paseo and Westend networks all at once on the same view;
- [✓] General network stats. Block height, era and epoch progress.
- [✓] Total validators and total nominators (active vs waiting).
- [✓] Network total staked percentage.
- [✓] Validator status, identity and Live Points
- [✓] Total nominators, Total stake, Self stake, Bonded, Unbonding, Unlocked. Display payee.
- [✓] Active vs Next commission. Current and Queued session keys;
- [✓] Validate and display only supported proxy type for each stash.
- [✓] Autocomplete, select or filter commands (extrinsics) based on proxy type context.
- [✓] Support commands for most of Staking Operations as well as Rotate session keys.
- [✓] Verify and sign call_data. Display and log transaction progress.
- [✓] Add builtin themes [
Suno Dark,Suno Light] and load user specific custom themes. - [✓] Define and run user-specific commands linked to each configured validator.
- [✓] Explicitly use advanced builtin commands:
calls/rotate_and_set_keys,calls/has_keys,calls/has_queued_keys. - [✓] Execute custom commands locally or remotely.
- [] Pro / Advanced mode to show validators key insight metrics
- [] Collator metrics and extrinsics
- [] RPC manual restarts and health check metrics
- [] Light client mode
- [] Multi-proxy setup
- [] Support for
/kick,/nominateextrinsics
- Runs on the terminal.
- No backend APIs. No indexers.
- Users are free to swap between any RPC node provider of their choice. Connect to Local, Private or Public nodes.
- Restricted Proxy-Only operations on Asset Hub, with only two proxy types supported:
- Staking or StakingOperator
- Proxy account must be an account with password exported from PJS.
Note: Binary release available for Linux and macOS
Download and extract the latest binary from GitHub Releases.
Alternatively, run the bash script in /scripts/install.sh with the command below:
curl -fsSL https://raw.githubusercontent.com/turboflakes/suno/main/scripts/install.sh | bashThe script downloads the latest release, extracts it, and installs the binary into the $HOME/suno directory by default. It prompts you to change the directory as well as asking if a default configuration file is required.
An example of the instructions presented:
> Enter SUNO installation path [default: /home/paulo/suno]:
✔︎ Output directory /home/paulo/suno
✔︎ Downloading suno v0.2.0
suno-x86_64-unknown-linux-gnu.tar.gz 100%[==================================================================>] 18.01M 25.7MB/s in 0.7s
suno-x86_64-unknown-linux-gnu.tar.gz.sha256 100%[==================================================================>] 103 --.-KB/s in 0s
✔︎ Checksum verified
✔︎ Existing binary backed up to /home/paulo/suno/suno.backup
✔︎ Checking if suno exists: total 89896
-rwxr-xr-x 1 paulo paulo 73157832 Mar 19 14:52 suno
-rw-rw-r-- 1 paulo paulo 18887761 Mar 19 15:42 suno-x86_64-unknown-linux-gnu.tar.gz
-rw-rw-r-- 1 paulo paulo 103 Mar 19 15:42 suno-x86_64-unknown-linux-gnu.tar.gz.sha256
✔︎ Successfully installed suno v0.2.0 at /home/paulo/suno/suno
> Would you like to install the DEFAULT configuration file? [y/N]: y
> Enter the configuration path [default: /home/paulo/suno/.config.yaml]:
✔︎ Writing /home/paulo/suno/.config.yaml template
✔︎ Config file saved at /home/paulo/suno/.config.yaml.
==> Next edit the config file and replace STASHES and RPC endpoints as you wish.
✔︎ Installation complete
— Enjoy suno v0.2.0Most configuration is done via a config file. Here is a full example .config.example.yaml, showing all available options:
chains:
- polkadot:
rpc_url: "__WSS_POLKADOT_RPC_PROVIDER__"
validators:
- "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
- "1LfAfKweyPjXs4JkKW4AxHPTe7pu4w4HjcZbEtB6a8vMqkd"
- asset_hub_polkadot:
rpc_url: "__WSS_POLKADOT_HUB_RPC_PROVIDER__"
- people_polkadot:
rpc_url: "__WSS_POLKADOT_PEOPLE_RPC_PROVIDER__"
- kusama:
rpc_url: "__WSS_KUSAMA_RPC_PROVIDER__"
validators:
- stash: "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
ssh: # optional, if configured all commands are executed via ssh, otherwise local
host: 192.0.2.100
user: suno_user
# port: 22 # optional, default 22
# identity: "~/.ssh/id_ed25519" # optional, falls back to SSH agent
commands:
- name: Rotate and Set keys
uses: "calls/rotate_and_set_keys"
- name: Has session keys
uses: "calls/has_keys"
- name: Has queued session keys
uses: "calls/has_queued_keys"
- name: Restart service
cmd: /restart
run: systemctl restart the-node-01.service
- name: Upgrade node binary
cmd: /upgrade {version}
run: ~/update_stable_node.sh {version}
- asset_hub_kusama:
rpc_url: "__WSS_KUSAMA_HUB_RPC_PROVIDER__"
- paseo:
rpc_url: "__WSS_PASEO_RPC_PROVIDER__"
validators:
[
"1LfAfKweyPjXs4JkKW4AxHPTe7pu4w4HjcZbEtB6a8vMqkd",
"13iiwNL7mzjuS4KxXEHQ2Csx8fETishXWKzeeCfHCig6j2dd",
]
- asset_hub_paseo:
rpc_url: "__WSS_PASEO_HUB_RPC_PROVIDER__"
- people_paseo:
rpc_url: "__WSS_PASEO_PEOPLE_RPC_PROVIDER__"
features:
enable_validators: true
themes:
active: "Suno Dark"
path: "./themes"
signer:
proxy_path: ".proxy_account.json"
explorer:
url: "https://polkadot.js.org/apps/?rpc=wss://{chain}.rpc.turboflakes.io#/explorer/query/{block_hash}"
# A few other explorers commented out below
# url: "https://dev.papi.how/explorer/{block_hash}#networkId=localhost&endpoint=wss://{chain}.rpc.turboflakes.io"
# url: "https://polkadot.chainconsole.com/apps/?rpc=wss://{chain}.rpc.turboflakes.io#/explorer/query/{block_hash}"To operate and execute extrinsics onchain, a proxy account with at least one of the following types Staking, StakingOperator must be set-up for the stashes listed in the configuration file. For example, Staking (short form as visualized in the tool [S]) or StakingOperator [SO] must be setup on the Asset-Hub chain.
NOTE: Each suno command is intrinsically dependant on its availability within the runtime
-
[S] Staking
/bond/bond_extra/unbond/rebond/withdraw_unbonded/set_payee/validate/chill/set_keys/purge_keys/rotate_and_set_keys¹
-
[SO] StakingOperator
/validate/chill/set_keys/purge_keys/rotate_and_set_keys¹
¹ Requires explicit configuration for each validator in the config file.
Currently, to setup the proxy account on suno, the ONLY supported, recommended and easiest way, is to create a new account on the PJS and than click Export Account. You should get a json file with the content similar to the one below:
{
"encoded": "J2FFcPHAY11Pmq/38eqbwfUv9OPitYJs+oYgahBvlagAAAIAAQAAAAgAAAB5o0DwXCWDblsH+9pc++RaBO4fpHBHzUirHFHFE9yS3sDzgAIQjhgvPqJ3ODrMR2gy7vk0VZg1fyirIvmsrfjGbWnOI8YU0joX0tYytroyWaykFKtZJMmE0pNKcJ5dJmDxscbK53Ac+7ld2UdH07yKPXxmPuYNNw3vKx8cg9CdQgifKfzQxHnC+EUpOoHPLwGlHsFEYtIlQtngqd9n",
"encoding": {
"content": ["pkcs8", "sr25519"],
"type": ["scrypt", "xsalsa20-poly1305"],
"version": "3"
},
"address": "5CfWTDh7XxJ2yrayqQ2aJnnZAH5v5XaF1oJFfH5QCpbfP9v8",
"meta": {
"genesisHash": "",
"name": "Bob",
"whenCreated": 1768916488918
}
}You can rename the file to .proxy_account.json, since it is the one built-in by default and is expected to live alongside the binary. Alternatively, you can rename it and move the file to a directory of your choice. If you choose a different name and path, you have 2 options:
Option 1 specify the new proxy_path under the signer section in the configuration file. For example:
signer:
proxy_path: ".proxy_account.json"Option 2 via the --proxy-path flag when calling suno from the terminal, eg. suno --proxy-path /home/suno/suno-proxy-account.json
If you end up creating a brand new account, don't forget to transfer some funds to it and set up the proxy types described above for your target stashes you would like to operate via suno. This can be done in many other tools already available in the Polkadot ecosystem.
Custom commands are user defined commands or a composition of builtin commands. These are defined in the config.yaml file and tied to each configured stash.
There are two types of custom commands:
User defined commands that are executed on the terminal, can call simple shell commands or bash script files, basically any program that can run in the terminal. As long as the configured commands e.g. /service_restart, /upgrade, /reboot do not clash with existing ones, they can be named anything.
Custom calls that are builtin, but is up to the user to enable them. These can be a composition of extrinsics and RPC calls, e.g. a unique command to rotate session keys and automatically set those keys, or a simple command to check if the X host has the current session keys. Currently these special commands are:
- Use
calls/rotate_and_set_keysto rotate and set session keys as a single operation (requires a proxy to be already set up). - Use
calls/has_keysto check whether the host has the next session keys. - Use
calls/has_queued_keysto check whether the host has the queued session keys.
NOTE: curl must be available on the host machine for RPC calls to execute successfully.
Below is how you can define custom commands in the config.yaml:
validators:
- stash: "5GTD7ZeD823BjpmZBCSzBQp7cvHR1Gunq7oDkurZr9zUev2n"
host_rpc: 127.0.0.1:9944 # optional, used in curl RPC calls and falls back to 127.0.0.1:9944
ssh: # optional, if configured all commands are executed via SSH, otherwise local
host: 192.0.2.100
user: suno_user
# port: 22 # optional, default 22
# identity: "~/.ssh/id_ed25519" # optional, falls back to SSH agent
commands:
- name: "Test custom commands"
cmd: /echo
run: "echo 'hello world' > hello.txt"
- name: "Restart service"
cmd: /restart
run: "systemctl restart the-node-01.service"
- name: "Rotate and set keys"
uses: "calls/rotate_and_set_keys"
From your favourite terminal, simply call suno. If you use a custom configuration file, located in a different directory than the suno binary, provide the path with the --config-path flag, eg. suno --config-path ~/suno/suno-custom-config.json
Check all flags available:
suno --help
Yet another way to manage Substrate Node Operations from your terminal.
Usage: suno [OPTIONS]
Options:
-c, --config-path <FILE> Sets a custom config file path. [default: .config.yaml]
-p, --proxy-path <FILE> Sets a custom proxy account file path.
-h, --help Print help
-V, --version Print version'ctrl+e' to show list of enabled commands for the selected vaidator
'ctrl+w' to switch window
'ctrl+c' to quit suno
'esc' to close popup or unfocus from input field
'ctrl+h / ctrl+l / left / right' to navigate between pane sections
'tab' to input focus, to command autocomplete or just to navigate between pane sections
'ctrl+j / ctrl+k / up / down' to select a chain, validator, or extrinsic depending on the highlighted areaThe Suno Dark and Suno Light themes are built-in, you can swap between them by updating the configuration file.
To create your own theme, pick one of the ones available in the /themes directory, copy and rename it, adjust the colors as you please. The filename will serve as the theme name. Under the themes section in the configuration file (see below), specify the new theme name and adjust the directory path as needed; It should point to the custom themes folder.
themes:
active: "Blue Sky"
path: "./themes"When you are done, make a PR with your art, I'll thank you :)
If you'd like to build from source, first install Rust.
curl https://sh.rustup.rs -sSf | shIf Rust is already installed run
rustup updateVerify Rust installation by running
rustc --versionOnce done, finish installing the support software
sudo apt install build-essential git clang libclang-dev pkg-config libssl-devBuild suno by cloning this repository
#!/bin/bash
git clone http://github.com/turboflakes/sunoCompile suno package with Cargo
#!/bin/bash
cargo buildAnd then run it
#!/bin/bash
./target/debug/sunoOtherwise, recompile the code on changes and run the binary
#!/bin/bash
cargo watch -x 'run --bin suno'Have an idea for a new feature, a fix or you found a bug, please open an issue or submit a pull request.
Any feedback is welcome.
suno - The entire code within this repository is licensed under the Apache License 2.0.
__
Enjoy suno