Skip to content

Latest commit

 

History

History
119 lines (77 loc) · 3.09 KB

README.md

File metadata and controls

119 lines (77 loc) · 3.09 KB
Raw

🥬 SpinArch

asciicast

About

SpinArch (c) 2022, Surya Handika Putratama [email protected]

Spin local Archway testnet for faster dApps development

⚠️ This application is in early development

Features

  • Run persistent/non-persistent local testnet node
  • Generate pre-funded accounts
  • Take snapshot of running node

Requirements

  • Linux/macOS (not tested on Windows yet).
  • Node.js (>= 16) and NPM
  • Docker

Installation

npm install -g spinarch

Usage

Usage: spinarch [options]

🥬 Spin local Archway testnet for faster dApps development 🚀

Options:
  -V, --version            output the version number
  --project-id <string>    Your project ID
  --chain-id <string>      Chain ID (default: "spinarch-1")
  --num-accounts <number>  Number of accounts to generate (default: 10)
  --balance <number>       Default balance of each generated account (default: 1000000000)
  --update-image           Update the Archway image to latest version
  --reset-state            Reset the blockchain to the genesis state
  -h, --help               display help for command

1. Run a throwaway node

This command will run a temporary, non-persistent Archway node. Node's data will be deleted on exit.

spinarch

2. Run a persistent node

Specify a project ID if you want to run a persistent Archway node. Node's data is saved to disk and can be loaded again next time you run SpinArch with the same project ID.

spinarch --project-id my-dapp

3. Reset a persistent node

Saved state will be reset to the genesis.

spinarch --project-id my-dapp --reset-state

4. Run with custom chain ID

You can run a node with a custom chain ID by specifying --chain-id option. This applies to both throwaway and persistent node.

spinarch --chain-id mainnet-1

5. Run with N number of prefunded accounts

By default, SpinArch will generate 10 prefunded accounts. You can generate an N number of accounts with B balance by specifying --num-accounts and/or --balance.

spinarch --num-accounts 5 --balance 10000000

Troubleshooting

Cannot store/compile Wasm contract because of missing AVX instruction

If you are running SpinArch on Apple Silicon (M1 CPU family), try enabling native binary.

$ USE_NATIVE=1 spinarch --project-id my-project

Contract size exceeds limit

By default, Wasm code size is limited to 1228800 bytes (~1.2 mbytes). To change this, you need to run a persistent project (with --project-id), stop it, edit genesis.json, and do a state reset with --reset-state. For example:

Run a persistent node:

$ spinarch --project-id my-project

Stop SpinArch (Ctrl-C) after node is running and then edit genesis.json.

$ nano ~/.spinarch/my-project/config/genesis.json

Look for "max_wasm_code_size" and change the value to higher number like 12288000. After that, run the same project with --reset-state to reset the blockchain.

$ spinarch --project-id my-project --reset-state