https://github.com/paritytech/pallet-chaos
Substrate Pallet for chaotic experimentations
https://github.com/paritytech/pallet-chaos
Last synced: 9 months ago
JSON representation
Substrate Pallet for chaotic experimentations
- Host: GitHub
- URL: https://github.com/paritytech/pallet-chaos
- Owner: paritytech
- License: agpl-3.0
- Created: 2021-10-29T20:10:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-18T22:10:53.000Z (about 4 years ago)
- Last Synced: 2024-10-30T10:40:52.255Z (over 1 year ago)
- Language: Rust
- Size: 229 KB
- Stars: 5
- Watchers: 7
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chaos Pallet
The Chaos module is used to inject chaos into a Substrate Runtime and intentionally break things.
## Overview
The Chaos module provides functions for:
- Make Substrate Runtimes behave in ways that they're not supposed to.
- Explore Runtime edge cases.
- Explore Extrinsic weights and their economic implications.
- Expose Runtime Attack Vectors.
## Dispatchable Functions
### `overflow_adder`
Inspired by [overflow extrinsic implementation from Alexander Popiak's `how-not-to-build-a-pallet`](https://github.com/apopiak/how-not-to-build-a-pallet/blob/c737f27df5fed367c8e53adc20ed18e2846459e1/pallets/template/src/lib.rs#L165), performs an unchecked sum over the `Adder` storage object. If the result is above `4_294_967_296`, then `Adder` overflows.
This extrinsic illustrates the importance of using safe operations such as [`checked_add`](https://docs.rs/substrate-primitives/1.0.0/substrate_primitives/struct.U256.html#method.checked_add), [`checked_sub`](https://docs.rs/substrate-primitives/1.0.0/substrate_primitives/struct.U256.html#method.checked_sub) and their variants from [`substrate_primitives::U256`](https://docs.rs/substrate-primitives/1.0.0/substrate_primitives/struct.U256.html).
### `clear_adder`
Simply clears the `Adder` storage object so that `unwrap_add` can illustrate bad unwraps.
### `dragBlockUnitWeight(n)`
Injects a heavy computation payload into the runtime, effectively dragging block production by calculating hashes in a loop (n times), with constant unitary extrinsic weight.
This extrinsic illustrates the importance of proper weight design.
# Usage
[`chaoscope`](https://github.com/paritytech/chaoscope) provides a CLI utility to automate interaction with `pallet-chaos` on a local setup.
1. In case you want to interact with it manually, follow the steps below.
2. Include `pallet-chaos` to a `substrate-node-template`, build it, and start the chain:
```sh
$ ./target/release/node-template --dev --tmp
```
3. On PolkadotJS, connect to `DEVELOPMENT` Chain (`ws://127.0.0.1:9944`).
4. Open `Developer`->`Extrinsics`.
## Overflowing
On a browser new tab, open `Developer`->`Chain state`.
Then choose `chaos`-> `adder()`, and click the `+` sign. This is how you'll monitor the `Adder` storage object.
On the extrinsics tab you had previously open, choose `chaos`->`overflowAdder(n)`.
While monitoring `adder()` on the `Chain state` tab, keep adding numbers at will, until you reach `4_294_967_296`.
Observe what happens after you add above this value, and imagine what would be the implications if `Adder` actually represented something meaningful in your chain.
## Dragging Blocks
Choose `chaos`->`dragBlockUnitWeight(n)`.
Here's where the experimentation starts. Choose different values for `n`, call `Submit Transaction` and observe the effects on block production.
# License
AGPL-3.0