* [Docs and guide](#docs-and-guide)
* [Quick start](#quick-start)
* [Base image and dev container](#base-image-and-dev-container)
* [Config](#config)
* [Network Management](#network-management)
* [Development and contributing](#development-and-contributing)
* [Reporting issues](#reporting-issues)
* [Command help](#command-help)
# Docs and guide
You can find more detailed info on installing and using Swanky CLI on [official astar docs page](https://docs.astar.network/docs/build/wasm/swanky-suite/cli/)
# Quick start
If you use a devcontainer (see next section), or a [`swanky-base`](https://github.com/inkdevhub/swanky-cli/pkgs/container/swanky-cli%2Fswanky-base) image, swanky will be preinstalled and globally available and you can use it to generate and develop smart contracts right away.
Otherwise, you can install it from [`npm`](https://www.npmjs.com/package/@astar-network/swanky-cli), or download the [binaries for your system](https://github.com/inkdevhub/swanky-cli/releases/)
For a quick start, you can run
```
swanky init my_project_name
```
Then cd into the project and compile:
```
swanky contract compile my_contract_name
```
Once done, open a new terminal window and start the node (assuming you chose to download it. If not, skip this part, edit the config to point to your node and use `--network` flag when deploying):
```
swanky node start
```
and, assuming you contract is based on flipper template and it's called flipper:
```
swanky contract deploy flipper --account alice -a true
```
Now you can interact with it by `query` and `tx` commands:
```
swanky contract query flipper get
swanky contract tx flipper flip --account alice
```
Your tests are located in the `/test` directory, and can be run either by calling `yarn test`, or `swanky contract test contract_name`.
The latter will produce a web-based report, but is unstable at the moment and might not work correctly.
# Base image and dev container
This repo hosts a pre built Docker image that comes with the latest version of swanky-cli installed, as well as required dependencies.
You can use it directly as a container on your machine, or as a base for a dev container (or codespaces).
[Here is a template repo with a .devcontainer preconfigured](https://github.com/inkdevhub/swanky-dev-container).
To use it, create a new repo from the template, and either start a devcontainer locally, or run it in a GitHub Codespace
# Config
A newly generated project will have a `swanky.config.json` file that will get populated as you interact with your contracts and accounts.
## Example:
```json
{
"node": {
"localPath": "/Users/sasapul/Work/astar/swanky-cli/temp_proj/bin/swanky-node",
"polkadotPalletVersions": "polkadot-v0.9.39",
"supportedInk": "v5.0.0"
},
"accounts": [
{
"alias": "alice",
"mnemonic": "//Alice",
"isDev": true,
"address": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
},
{
"alias": "bob",
"mnemonic": "//Bob",
"isDev": true,
"address": "5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty"
}
],
"networks": {
"local": {
"url": "ws://127.0.0.1:9944"
},
"astar": {
"url": "wss://rpc.astar.network"
},
"shiden": {
"url": "wss://rpc.shiden.astar.network"
},
"shibuya": {
"url": "wss://shibuya.public.blastapi.io"
}
},
"contracts": {
"flipper": {
"name": "flipper",
"moduleName": "flipper",
"deployments": [
{
"timestamp": 1685526140801,
"address": "5GsW2psSHADG1rSe6eZLof2qvSj7EV5KFcP5SQLswyZdoPsq",
"networkUrl": "ws://127.0.0.1:9944",
"deployerAlias": "alice"
}
]
}
}
}
```
Also, global config will be created in your home directory, in `~/swanky` folder.
## Example:
```json
{
"accounts": [
{
"alias": "alice",
"mnemonic": "//Alice",
"isDev": true,
"address": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
},
{
"alias": "bob",
"mnemonic": "//Bob",
"isDev": true,
"address": "5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty"
},
{
"mnemonic": "broken estate advance smooth noble place wine choose scare east effort evil",
"isDev": true,
"alias": "global",
"address": "5FhfjMxbrJnjxuP5rP1ZorNaDJdE1n5LYpd7jTi9ByfVX1P1"
}
],
"networks": {
"local": {
"url": "ws://127.0.0.1:9944"
},
"astar": {
"url": "wss://rpc.astar.network"
},
"shiden": {
"url": "wss://rpc.shiden.astar.network"
},
"shibuya": {
"url": "wss://shibuya.public.blastapi.io"
}
}
}
```
You can use accounts and networks from the global config in any swanky project.
# Network Management
You can deploy/call wasm smart contracts on any chains supporting the substrate contracts module ([`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts)) by swanky-cli.
`--network` flag is available for `deploy` and `query`/`tx` commands. For example,
```
swanky contract deploy flipper --account alice --gas 100000000000 --args true --network shibuya
```
By default, `swanky init` prepares local/astar/shiden/shibuya endpoint for you.
To add networks or change endpoint to interact with, you need to update `swanky.config.json` `networks` section.
```
"networks": {
"local": {
"url": "ws://127.0.0.1:9944"
},
"your_network": {
"url": "wss://your.network"
}
}
```
# Development and contributing
To work on swanky-cli itself, you'll need nodeJs, `yarn`, and `ts-node` installed globally.
Running `yarn dev` will start a watch process for both `ts` files and `/templates`, and you can run it by calling:
```
yarn dev:run COMMAND
```
or directly
```
./bin/run.js COMMAND
```
Directory names `temp_project`, `temp_proj`, and `test_project` are ignored by git so it's safe to test in the root directory of the project.
For example
```
./bin/run.js init temp_project
cd temp_project
../bin/run.js contract compile flipper
```
# Reporting issues
Please report any issue or bug you encounter, as well as any feature and improvement requests to the [issues section](https://github.com/inkdevhub/swanky-cli/issues)
# Command help
```sh-session
$ npm install -g @astar-network/swanky-cli
$ swanky COMMAND
running command...
$ swanky (--version|-V|-v)
@astar-network/swanky-cli/4.0.0 darwin-x64 node-v20.11.1
$ swanky --help [COMMAND]
USAGE
$ swanky COMMAND
...
```
* [`swanky account balance [ALIAS]`](#swanky-account-balance-alias)
* [`swanky account create`](#swanky-account-create)
* [`swanky account default [ACCOUNTALIAS]`](#swanky-account-default-accountalias)
* [`swanky account faucet ALIAS`](#swanky-account-faucet-alias)
* [`swanky account list`](#swanky-account-list)
* [`swanky account ls`](#swanky-account-ls)
* [`swanky clear [CONTRACTNAME]`](#swanky-clear-contractname)
* [`swanky contract compile [CONTRACTNAME]`](#swanky-contract-compile-contractname)
* [`swanky contract deploy CONTRACTNAME`](#swanky-contract-deploy-contractname)
* [`swanky contract explain CONTRACTNAME`](#swanky-contract-explain-contractname)
* [`swanky contract new CONTRACTNAME`](#swanky-contract-new-contractname)
* [`swanky contract query CONTRACTNAME MESSAGENAME`](#swanky-contract-query-contractname-messagename)
* [`swanky contract test [CONTRACTNAME]`](#swanky-contract-test-contractname)
* [`swanky contract tx CONTRACTNAME MESSAGENAME`](#swanky-contract-tx-contractname-messagename)
* [`swanky contract verify [CONTRACTNAME]`](#swanky-contract-verify-contractname)
* [`swanky env check`](#swanky-env-check)
* [`swanky env install`](#swanky-env-install)
* [`swanky generate tests [CONTRACTNAME]`](#swanky-generate-tests-contractname)
* [`swanky generate types CONTRACTNAME`](#swanky-generate-types-contractname)
* [`swanky help [COMMAND]`](#swanky-help-command)
* [`swanky init PROJECTNAME`](#swanky-init-projectname)
* [`swanky node chopsticks init`](#swanky-node-chopsticks-init)
* [`swanky node chopsticks start`](#swanky-node-chopsticks-start)
* [`swanky node install`](#swanky-node-install)
* [`swanky node purge`](#swanky-node-purge)
* [`swanky node start`](#swanky-node-start)
* [`swanky node version`](#swanky-node-version)
* [`swanky plugins`](#swanky-plugins)
* [`swanky plugins:install PLUGIN...`](#swanky-pluginsinstall-plugin)
* [`swanky plugins:inspect PLUGIN...`](#swanky-pluginsinspect-plugin)
* [`swanky plugins:install PLUGIN...`](#swanky-pluginsinstall-plugin-1)
* [`swanky plugins:link PLUGIN`](#swanky-pluginslink-plugin)
* [`swanky plugins:uninstall PLUGIN...`](#swanky-pluginsuninstall-plugin)
* [`swanky plugins reset`](#swanky-plugins-reset)
* [`swanky plugins:uninstall PLUGIN...`](#swanky-pluginsuninstall-plugin-1)
* [`swanky plugins:uninstall PLUGIN...`](#swanky-pluginsuninstall-plugin-2)
* [`swanky plugins update`](#swanky-plugins-update)
* [`swanky version`](#swanky-version)
* [`swanky zombienet init`](#swanky-zombienet-init)
* [`swanky zombienet start`](#swanky-zombienet-start)
## `swanky account balance [ALIAS]`
Balance of an account
```
USAGE
$ swanky account balance [ALIAS] [-v]
ARGUMENTS
ALIAS Alias of account to be used
FLAGS
-v, --verbose Display more info in the result logs
DESCRIPTION
Balance of an account
```
_See code: [src/commands/account/balance.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/balance.ts)_
## `swanky account create`
Create a new dev account in config
```
USAGE
$ swanky account create [-v] [-g] [-n] [-d]
FLAGS
-d, --dev Make this account a dev account for local network usage.
-g, --global Create account globally stored in Swanky system config.
-n, --new Generate a brand new account.
-v, --verbose Display more info in the result logs
DESCRIPTION
Create a new dev account in config
```
_See code: [src/commands/account/create.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/create.ts)_
## `swanky account default [ACCOUNTALIAS]`
Set default account to use
```
USAGE
$ swanky account default [ACCOUNTALIAS] [-v] [-g]
ARGUMENTS
ACCOUNTALIAS Alias of account to be used as default
FLAGS
-g, --global Set default account globally in Swanky system config.
-v, --verbose Display more info in the result logs
DESCRIPTION
Set default account to use
```
_See code: [src/commands/account/default.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/default.ts)_
## `swanky account faucet ALIAS`
Transfer some tokens from faucet to an account
```
USAGE
$ swanky account faucet ALIAS [-v]
ARGUMENTS
ALIAS Alias of account to be used
FLAGS
-v, --verbose Display more info in the result logs
DESCRIPTION
Transfer some tokens from faucet to an account
```
_See code: [src/commands/account/faucet.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/faucet.ts)_
## `swanky account list`
List dev accounts stored in config
```
USAGE
$ swanky account list [-v]
FLAGS
-v, --verbose Display more info in the result logs
DESCRIPTION
List dev accounts stored in config
ALIASES
$ swanky account ls
```
_See code: [src/commands/account/list.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/list.ts)_
## `swanky account ls`
List dev accounts stored in config
```
USAGE
$ swanky account ls [-v]
FLAGS
-v, --verbose Display more info in the result logs
DESCRIPTION
List dev accounts stored in config
ALIASES
$ swanky account ls
```
## `swanky clear [CONTRACTNAME]`
```
USAGE
$ swanky clear [CONTRACTNAME] [-v] [-a]
ARGUMENTS
CONTRACTNAME Name of the contract artifact to clear
FLAGS
-a, --all Select all the project artifacts for delete
-v, --verbose Display more info in the result logs
```
_See code: [src/commands/clear/index.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/clear/index.ts)_
## `swanky contract compile [CONTRACTNAME]`
Compile the smart contract(s) in your contracts directory
```
USAGE
$ swanky contract compile [CONTRACTNAME] [-v] [-r] [--verifiable] [-a]
ARGUMENTS
CONTRACTNAME Name of the contract to compile
FLAGS
-a, --all Set all to true to compile all contracts
-r, --release A production contract should always be build in `release` mode for building optimized wasm
-v, --verbose Display more info in the result logs
--verifiable A production contract should be build in `verifiable` mode to deploy on a public network. Ensure
Docker Engine is up and running.
DESCRIPTION
Compile the smart contract(s) in your contracts directory
```
_See code: [src/commands/contract/compile.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/compile.ts)_
## `swanky contract deploy CONTRACTNAME`
Deploy contract to a running node
```
USAGE
$ swanky contract deploy CONTRACTNAME [-v] [--account ] [-g ] [-a ] [-c ] [-n ]
ARGUMENTS
CONTRACTNAME Name of the contract to deploy
FLAGS
-a, --args=...
-c, --constructorName= [default: new] Constructor function name of a contract to deploy
-g, --gas=
-n, --network= [default: local] Network name to connect to
-v, --verbose Display more info in the result logs
--account= Account alias to deploy contract with
DESCRIPTION
Deploy contract to a running node
```
_See code: [src/commands/contract/deploy.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/deploy.ts)_
## `swanky contract explain CONTRACTNAME`
Explain contract messages based on the contracts' metadata
```
USAGE
$ swanky contract explain CONTRACTNAME [-v]
ARGUMENTS
CONTRACTNAME Name of the contract
FLAGS
-v, --verbose Display more info in the result logs
DESCRIPTION
Explain contract messages based on the contracts' metadata
```
_See code: [src/commands/contract/explain.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/explain.ts)_
## `swanky contract new CONTRACTNAME`
Generate a new smart contract template inside a project
```
USAGE
$ swanky contract new CONTRACTNAME [-v] [--template blank|flipper|psp22]
ARGUMENTS
CONTRACTNAME Name of the new contract
FLAGS
-v, --verbose
--template=
