A collection of debug tools and libraries around substrate chains.
This project has evolved from the historical name
offline-phragmen
. I first created this repo prior to Kusama's NPoS enabling as a tool to predict the outcome. Henceforth, it has evolved into this repo. This functionality is still provided in theoffline-elections
crate.
Almost all of the tools in this repository are no longer maintained. Some are moved to substrate (e.g. remote-externalities
. Some are being re-worked in Typescript, and some are scheduled to be re-done with Frame's new Metadata.
sub-storage
: This is the backbone of all of the crates in this repo. It provides a minimal wrapper around substrate's storage rpc call for easier use. It provides all you need to read any module's storage items, constants, and metadata. All of this is independent of any chain or pallet and should work in any substrate chain. Additionally, it provide some pallet-dependent helpers as well under thehelpers
feature (such as reading identity of an account).sub-du
: a disk-usage-like tool that prints the storage usage of a chain. It reads all the info it needs from metadata, so independent chain or runtime. Arguably not super useful, but I find it cool.offline-elections
: The historical main purpose of this repo. It can scrape the staking module's info and run election algorithms ofsp-npos-elections
offline. Given the correct parameters, it can be used to predict the next validator set. It also provide other election related functionalities. See the sub-commands for more info.remote-externalities
: It provides the ability to write simple rust unit tests over a specific state of a chain. It can be very useful to debug breaking changes and storage migrations.tokens
: Quite a dumb and small crate that provides wrappers for easy pretty-printing tokens likeDOT
. Somewhat similar to thetoHuman()
interface of the javascript API.laboratory
: This is where I try new stuff.
git clone https://github.com/paritytech/substrate-debug-kit/
cd substrate-debug-kit
cargo build --release
- The sub-du command to read all of the chain storage usage
./target/release/sub-du
- The offline-election tool for staking
./target/release/offline-election staking -i 10 -r
- The offline-election tool to review a validator
./target/release/offline-election validator-check --who CpYNXnYC1mPPRSXMHvm9EUuhEqHjvj6kCN4kshqMdEpPYSF
- Substrate module sidecar: A wrapper around remote-externalities that allows you to run a
substrate module in a TextExternalities environment and constantly feed the new block data into
it. Would need to listen to new blocks, upon each block:
- call
Module::on_initialize()
. - scan for any transaction in that block that might be targeted to this module (how? call matching), call them directly
- call
Module::on_finalize()
. - Wipe the state and update it to the new state of the newly imported block.
- call
Notes: will probably be a pain to do because of rust dependency clashes. Using wasm would make this easier, but then debugging will become harder.