suno ·

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.

Why use `suno`

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.

Features

[✓] 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.

Future / Ideas / Work in Progress

[] Config custom commands
[] 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, /nominate extrinsics

Implementation constraints / goals

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 with only three proxy types supported:
- Staking, StakingOperator (Asset Hub)
- NonTransfer (Relay Chain)
Proxy account must be an account with password exported from PJS/PDS.

Installation

Note: Binary release available for Linux and macOS

Option 1

Download and extract the latest binary from GitHub Releases.

Option 2

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 | bash

The 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.0

Configuration

Validator stashes and RPCs

Most 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:
        - "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
  - 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}"

Signer Account (Proxy-Only)

To operate and execute extrinsics onchain, a proxy account with at least one of the following types Staking, StakingOperator, NonTransfer 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, and NonTransfer [NT] on the Relay chain.

Commands supported per Proxy Type

NOTE: Each suno command is intrinsically dependant on its availability within the runtime

[S] Staking (Asset Hub)
- /bond
- /bond_extra
- /unbond
- /rebond
- /withdraw_unbonded
- /set_payee
- /validate
- /chill
[SO] StakingOperator (Asset Hub)
- /validate
- /chill
- /set_keys_async
- /purge_keys_async
[NT] NonTransfer (Relay Chain)
- /set_keys
- /purge_keys

Proxy Account configuration

Step 1

Currently, to setup the proxy account on suno, the ONLY supported, recommended and easiest way, is to create a new account on the PJS/PDS 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
  }
}

Step 2

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

Step 3

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.

Usage

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

List of keybindings

'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 area

Change or Build your own theme

The 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 :)

Development / Build from Source

If you'd like to build from source, first install Rust.

curl https://sh.rustup.rs -sSf | sh

If Rust is already installed run

rustup update

Verify Rust installation by running

rustc --version

Once done, finish installing the support software

sudo apt install build-essential git clang libclang-dev pkg-config libssl-dev

Build suno by cloning this repository

#!/bin/bash
git clone http://github.com/turboflakes/suno

Compile suno package with Cargo

#!/bin/bash
cargo build

And then run it

#!/bin/bash
./target/debug/suno

Otherwise, recompile the code on changes and run the binary

#!/bin/bash
cargo watch -x 'run --bin suno'

Collaboration

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.

License

suno - The entire code within this repository is licensed under the Apache License 2.0.

__

Enjoy suno

Name		Name	Last commit message	Last commit date
Latest commit History 272 Commits
.github		.github
assets		assets
packages		packages
scripts		scripts
themes		themes
.config.example.yaml		.config.example.yaml
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
LICENSE-APACHE		LICENSE-APACHE
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

suno ·

Why use `suno`

Features

Future / Ideas / Work in Progress

Implementation constraints / goals

Installation

Option 1

Option 2

Configuration

Validator stashes and RPCs

Signer Account (Proxy-Only)

Commands supported per Proxy Type

Proxy Account configuration

Step 1

Step 2

Step 3

Usage

List of keybindings

Change or Build your own theme

Development / Build from Source

Collaboration

License

About

Uh oh!

Releases 3

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

suno ·

Why use suno

Features

Future / Ideas / Work in Progress

Implementation constraints / goals

Installation

Option 1

Option 2

Configuration

Validator stashes and RPCs

Signer Account (Proxy-Only)

Commands supported per Proxy Type

Proxy Account configuration

Step 1

Step 2

Step 3

Usage

List of keybindings

Change or Build your own theme

Development / Build from Source

Collaboration

License

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 3

Uh oh!

Contributors

Uh oh!

Languages

Why use `suno`