Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multisig-labs/GoGoTools
🎈A collection of utilities for Avalanche developers🗻
https://github.com/multisig-labs/GoGoTools
avalanche avalanche-avax avalanche-subnet blockchain golang
Last synced: 2 days ago
JSON representation
🎈A collection of utilities for Avalanche developers🗻
- Host: GitHub
- URL: https://github.com/multisig-labs/GoGoTools
- Owner: multisig-labs
- License: cc0-1.0
- Created: 2023-01-17T06:08:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T21:49:50.000Z (6 months ago)
- Last Synced: 2024-05-09T22:48:17.513Z (6 months ago)
- Topics: avalanche, avalanche-avax, avalanche-subnet, blockchain, golang
- Language: Go
- Homepage: https://multisiglabs.notion.site/GoGoTools-Local-Avalanche-Subnet-Development-Made-Easy-0d034c380ef54931851ceaef56bd153e
- Size: 279 KB
- Stars: 16
- Watchers: 6
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GoGoTools 🎈
A (growing) collection of useful tools for Avalanche subnet developers.
GGT currently lets you quickly spin up a subnet dev environment that has avalanchego + subnet-evm + precompiles, allowing you to:
- Make your “Time to RPC" 10x faster
- Easily find/tweak/experiment with configs and precompiles
- Easily create many isolated environments to test different versions of binaries
- ... and comes with default user accounts / keys for easy startup
## Installation
Requires [Go](https://golang.org/doc/install) version >= 1.20
Clone Repository
```sh
git clone https://github.com/multisig-labs/gogotools.git
cd gogotools
```
Install [Just](https://github.com/casey/just) for your system, something like:
```sh
brew install just
or
cargo install just
or
apk add just
etc
```
Then build with
```sh
just build
```
which will create the binary `bin/ggt` (Make sure you add it to your $PATH)
## Usage
We are still trying to find the optimal workflows for doing this kind of dev work, but this is what we have as of now. Help wanted!
**Assumptions:**
- You have [Foundry](https://book.getfoundry.sh/getting-started/installation) installed and `cast` in your path
- You have a version of the `avalanchego` binary
- You have cloned the [subnet-evm](https://github.com/ava-labs/subnet-evm) repo and have a compiled evm binary
- You have this tool `ggt` compiled and in your $PATH
### Workflow
The idea is that we make a new, empty project directory, then use `ggt prepare` to create one or many `nodes`, which are basically a directory with `avalancego`, a vm binary, and a bunch of configs all setup in the right place. By default, `avalanchego` puts its files in `$HOME/.avalanchego`. **WE CHANGE THIS** behavior via command line flags to instead put all logs, db files, configs etc into the specified node directory, and organized a bit differently. The `start.sh` script starts up avalanchego with the correct command-line args.
You can easily blow away a node and start over with `rm -rf `. If you want to save off your progress just `cp` the dir to a new name.
Once you have your node directory prepared, you can run it with `ggt node run `. This will start up avalanchego in that directory. In this way its easy to have many directories, with say different binary versions of `avalanchego` and your vms, and switch between them. A caveat is that we expect only **ONE** node to be running at any one time.
If you have problems with the `ggt node run` command (it's currently under heavy development) you can always run the `start.sh` script inside each node directory to get things going.
### Example
```sh
# Mac
mkdir MySubnetProject
cd MySubnetProject
ggt utils init v1.10.19 v0.5.11 # Downloads binaries from GitHub
ggt node prepare NodeV1 --ava-bin=avalanchego-v1.10.19 --vm-name=subnetevm --vm-bin=subnet-evm-v0.5.11
```
If you then `prepared` another node NodeV2 with some different binary versions, you might have a directory structure that looks like this:
```
MySubnetProject
├── NodeV1
│ ├── bin
│ │ ├── avalanchego -> /path/to/avalanchego-v1.9.6
│ │ └── plugins
│ │ └── srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy -> /path/to/subnetevm-v0.4.7
│ ├── configs
│ │ ├── chains
│ │ │ ├── C
│ │ │ │ └── config.json
│ │ │ ├── X
│ │ │ │ └── config.json
│ │ │ └── aliases.json
│ │ ├── node-config.json
│ │ └── vms
│ │ └── aliases.json
│ ├── data
│ └── start.sh
├── NodeV2
│ ├── bin
│ │ ├── avalanchego -> /path/to/avalanchego-v1.9.7
│ │ └── plugins
│ │ └── srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy -> /path/to/subnetevm-v0.4.8
│ ├── configs
│ │ ├── chains
│ │ │ ├── C
│ │ │ │ └── config.json
│ │ │ ├── X
│ │ │ │ └── config.json
│ │ │ └── aliases.json
│ │ ├── node-config.json
│ │ └── vms
│ │ └── aliases.json
│ ├── data
│ └── start.sh
├── README.md
├── accounts.json
├── contracts.json
├── evmconfig.json
├── node-config.json
├── subnetevm-config.json
└── subnetevm-genesis.json
```
(Note that the `--vm-name=subnetevm` name you supplied for your VM (which can be any name) has been converted into an Avalanche `ids.ID` `srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy` and symlinked to the vm binary you specified)
Now we can start our node:
```sh
ggt node run NodeV1 (--clear-logs to delete logs before starting node)
```
This will start `avalanchego` from the `NodeV1` directory and you should see the `NodeV1/data` directory fill up with logs and data.
In another terminal, lets create our subnet (the `ggt utils init` cmd we ran earlier creates a sample genesis with all precompiles enabled):
```sh
ggt wallet create-chain NodeV1 MyChain subnetevm --genesis-file subnetevm-genesis.json
```
This command assumes NodeV1 is running, and will create a new Subnet, and then inside that subnet it will create a blockchain with the name `MyChain`, using the `subnetevm` virtual machine binary we registered earlier, and using the specified genesis file.
You should see an RPC URL printed to the terminal:
`http://localhost:9650/ext/bc/6SPgMtm5xfZrGGLJztaByMwKGJhrw4WzhKk6nGC5yfXqiJGuT/rpc`
You can now use this to issue commands to your EVM.
## Info
```sh
ggt node info | jq
```
(Assuming you have [jq](https://stedolan.github.io/jq/manual/) installed, and why wouldn't you!)
This collects node info from several different Avalanche API endpoints and gives you a single blob with all the data, including an `rpcs` key with the rpc url for each blockchain.
```json
{
"nodeID": "NodeID-5VvkgcSJoUnRruSEMm9uR7P4Wxr1hQi1q",
"networkID": 12345,
"networkName": "local",
"uptime": {
"rewardingStakePercentage": "100.0000",
"weightedAveragePercentage": "100.0000"
},
"getNodeVersion": {
"version": "avalanche/1.9.7",
"databaseVersion": "v1.4.5",
"rpcProtocolVersion": "22",
"gitCommit": "3e3e40f2f4658183d999807b724245023a13f5dc",
"vmVersions": {
"avm": "v1.9.7",
"evm": "v0.11.5",
"platform": "v1.9.7",
"subnetevm": "v0.4.8@880ec774bf5746c6c6aceb6887d08b221ed565cd"
}
},
"getVMs": {
"vms": {
"jvYyfQTxGMJLuGWa55kdP2p2zSUYsQ5Raupu4TW34ZAUBAbtq": ["avm"],
"mgj786NP7uDwBCcq6YwThhaN8FLyybkCa4zBWTQbNgmK6k9A6": ["evm"],
"qd2U4HDWUvMrVUeTcCHp6xH3Qpnn1XbU5MDdnBoiifFqvgXwT": ["nftfx"],
"rWhpuQPF1kb72esV2momhMuTYGkEb1oL29pt2EBXWmSy4kxnT": ["platform"],
"rXJsCSEYXg2TehWxCEEGj6JU2PWKTkd6cBdNLjoe2SpsKD9cy": ["propertyfx"],
"spdxUxVJQbX85MGxMHbKw1sHxMnSqJ3QBzDyDYEP3h6TLuxqQ": ["secp256k1fx"],
"srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy": ["subnetevm"]
}
},
"subnets": [
{
"id": "29uVeLPJB1eQJkzRemU8g8wZDw5uJRqpab5U2mX9euieVwiEbL",
"controlKeys": ["P-local18jma8ppw3nhx5r4ap8clazz0dps7rv5u00z96u"],
"threshold": "1"
},
{
"id": "11111111111111111111111111111111LpoYY",
"controlKeys": [],
"threshold": "0"
}
],
"blockchains": [
{
"id": "SRq2ZdVwqyQcQqVwTtjZPTDttDWKTiUEg2vyy3AeobBjeS3z3",
"name": "MyChain",
"subnetID": "29uVeLPJB1eQJkzRemU8g8wZDw5uJRqpab5U2mX9euieVwiEbL",
"vmID": "srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy"
},
{
"id": "2CA6j5zYzasynPsFeNoqWkmTCt3VScMvXUZHbfDJ8k3oGzAPtU",
"name": "C-Chain",
"subnetID": "11111111111111111111111111111111LpoYY",
"vmID": "mgj786NP7uDwBCcq6YwThhaN8FLyybkCa4zBWTQbNgmK6k9A6"
},
{
"id": "2eNy1mUFdmaxXNj1eQHUe7Np4gju9sJsEtWQ4MX3ToiNKuADed",
"name": "X-Chain",
"subnetID": "11111111111111111111111111111111LpoYY",
"vmID": "jvYyfQTxGMJLuGWa55kdP2p2zSUYsQ5Raupu4TW34ZAUBAbtq"
}
],
"aliases": {
"blockchainAliases": {
"SRq2ZdVwqyQcQqVwTtjZPTDttDWKTiUEg2vyy3AeobBjeS3z3": [
"SRq2ZdVwqyQcQqVwTtjZPTDttDWKTiUEg2vyy3AeobBjeS3z3"
],
"2CA6j5zYzasynPsFeNoqWkmTCt3VScMvXUZHbfDJ8k3oGzAPtU": [
"C",
"evm",
"2CA6j5zYzasynPsFeNoqWkmTCt3VScMvXUZHbfDJ8k3oGzAPtU"
],
"2eNy1mUFdmaxXNj1eQHUe7Np4gju9sJsEtWQ4MX3ToiNKuADed": [
"X",
"avm",
"2eNy1mUFdmaxXNj1eQHUe7Np4gju9sJsEtWQ4MX3ToiNKuADed"
]
}
},
"rpcs": {
"MyChain": "http://localhost:9650/ext/bc/SRq2ZdVwqyQcQqVwTtjZPTDttDWKTiUEg2vyy3AeobBjeS3z3/rpc"
}
}
```
This makes it easy to do something like this:
```sh
export ETH_RPC_URL=`ggt node info | jq -r '.rpcs.MyChain'`
cast chain-id
```
## Block Explorer
Once you have your node running, you can pop up a browser with the [Expedition](https://github.com/xops/expedition) blockchain explorer pointed at your node.
```sh
ggt node explorer MyChain
```
## Subnet EVM Precompiles
The [Subnet-EVM](https://github.com/ava-labs/subnet-evm) repo has some nice example contracts you can use to interact with the default subnetevm and precompiles.
However, in the interest of getting as close to the metal as possible, to really understand how things are working, `ggt` has some convenience commands that wrap the (amazing!) `cast` command from Foundry. The `ggt utils init` command creates default `accounts.json` and `contracts.json` files, that you can modify with your particular info, and we use these to make issuing `cast` commands a little more ergonomic by using those files to resolve user and contract addresses. Out of the box they come with a few users and all the default precompile contract addresses.
Assuming you have your node running, and your `ETH_RPC_URL` pointing to it, you can do things like this:
```sh
# Balances of users in accounts.json
ggt cast balances | jq
# Send eth from one user to another
ggt cast send-eth owner alice 1ether | jq
# Call read-only contract methods
ggt cast call owner TxAllowList "readAllowList(address)" bob
ggt cast call owner FeeConfigManager "getFeeConfigLastChangedAt()"
# Send a signed tx to a contract / method
ggt cast send owner NativeMinter "mintNativeCoin(address,uint256)" alice 1ether | jq
ggt cast send owner TxAllowList "setEnabled(address)" bob | jq
ggt cast send owner TxAllowList "setNone(address)" bob | jq
```
Cast has tools to decode the output of a contract call, so for example to see the current fee configuration via the precompile we can do this:
```sh
export DATA=$(ggt cast call owner FeeConfigManager "getFeeConfig()")
cast --abi-decode "getFeeConfig()(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)" $DATA
8000000
2
25000000000
50000000
36
0
1000000
200000
```
Which maps to the struct returned by the precompile
```sol
function getFeeConfig()
external
view
returns (
uint256 gasLimit,
uint256 targetBlockRate,
uint256 minBaseFee,
uint256 targetGas,
uint256 baseFeeChangeDenominator,
uint256 minBlockGasCost,
uint256 maxBlockGasCost,
uint256 blockGasCostStep
);
```
# 🚀 LFGG 🚀
This is version 0.01 of this tool, and we plan on making it so useful that it will be a core part of every Avalanche developer's toolbox. We welcome any and all idea / contributions on how to make the experience better.