diff --git a/README.md b/README.md index 1fedbedf..4bc281dd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@

- +

- -- [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](#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 @@ -20,9 +19,9 @@ You can find more detailed info on installing and using Swanky CLI on [official # Quick start -If you use a devcontainer (see next section), or a [`swanky-base`](https://github.com/AstarNetwork/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. +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/AstarNetwork/swanky-cli/releases/) +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 @@ -65,7 +64,7 @@ This repo hosts a pre built Docker image that comes with the latest version of s 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/AstarNetwork/swanky-dev-container). +[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 @@ -80,7 +79,7 @@ A newly generated project will have a `swanky.config.json` file that will get po "node": { "localPath": "/Users/sasapul/Work/astar/swanky-cli/temp_proj/bin/swanky-node", "polkadotPalletVersions": "polkadot-v0.9.39", - "supportedInk": "v4.3.0" + "supportedInk": "v5.0.0" }, "accounts": [ { @@ -223,135 +222,134 @@ cd temp_project # 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/AstarNetwork/swanky-cli/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.2.0 +@astar-network/swanky-cli/4.0.0-beta.0 darwin-x64 node-v21.7.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]` -- [`swanky account create`](#swanky-account-create) -- [`swanky account list`](#swanky-account-list) -- [`swanky account ls`](#swanky-account-ls) -- [`swanky account balance`](#swanky-account-balance) -- [`swanky account faucet`](#swanky-account-faucet) -- [`swanky account default`](#swanky-account-default) -- [`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`](#swanky-generate-tests) -- [`swanky generate types`](#swanky-generate-types) -- [`swanky help [COMMANDS]`](#swanky-help-commands) -- [`swanky init PROJECTNAME`](#swanky-init-projectname) -- [`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 node chopsticks init`](#swanky-node-chopsticks-init) -- [`swanky node chopsticks start`](#swanky-node-chopsticks-start) -- [`swanky zombienet init`](#swanky-zombienet-init) -- [`swanky zombienet start`](#swanky-zombienet-start) -- [`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: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 account create` - -Create a new dev account in config +Balance of an account ``` USAGE - $ swanky account create [-v] [-g] [-n] [-d] + $ swanky account balance [ALIAS] [-v] + +ARGUMENTS + ALIAS Alias of account to be used 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 + Balance of an account ``` -_See code: [src/commands/account/create.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/account/create.ts)_ +_See code: [src/commands/account/balance.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/account/balance.ts)_ -## `swanky account list` +## `swanky account create` -List dev accounts stored in config +Create a new dev account in config ``` USAGE - $ swanky account list [-v] + $ 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 - List dev accounts stored in config - -ALIASES - $ swanky account ls + Create a new dev account in config ``` -_See code: [src/commands/account/list.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/account/list.ts)_ +_See code: [src/commands/account/create.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/account/create.ts)_ -## `swanky account ls` +## `swanky account default [ACCOUNTALIAS]` -List dev accounts stored in config +Set default account to use ``` USAGE - $ swanky account ls [-v] + $ 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 - List dev accounts stored in config - -ALIASES - $ swanky account ls + Set default account to use ``` -_See code: [src/commands/account/list.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/account/list.ts)_ +_See code: [src/commands/account/default.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/account/default.ts)_ -## `swanky account balance` +## `swanky account faucet ALIAS` -Balance of an account +Transfer some tokens from faucet to an account ``` USAGE - $ swanky account balance [ALIAS] [-v] + $ swanky account faucet ALIAS [-v] ARGUMENTS ALIAS Alias of account to be used @@ -360,56 +358,51 @@ FLAGS -v, --verbose Display more info in the result logs DESCRIPTION - Balance of an account + Transfer some tokens from faucet to an account ``` -_See code: [src/commands/account/balance.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/account/balance.ts)_ +_See code: [src/commands/account/faucet.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/account/faucet.ts)_ -## `swanky account faucet` +## `swanky account list` -Transfer some tokens from faucet to an account +List dev accounts stored in config ``` USAGE - $ swanky account faucet ALIAS [-v] - -ARGUMENTS - ALIAS Alias of account to be used + $ swanky account list [-v] FLAGS -v, --verbose Display more info in the result logs DESCRIPTION - Transfer some tokens from faucet to an account + List dev accounts stored in config + +ALIASES + $ swanky account ls ``` -_See code: [src/commands/account/faucet.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/account/faucet.ts)_ +_See code: [src/commands/account/list.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/account/list.ts)_ -## `swanky account default` +## `swanky account ls` -Set default account to use +List dev accounts stored in config ``` USAGE -$ swanky account default [ACCOUNTALIAS] [-v] [-g] - -ARGUMENTS - ACCOUNTALIAS Alias of account to be used as default + $ swanky account ls [-v] 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 -``` + List dev accounts stored in config -_See code: [src/commands/account/default.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/account/default.ts)_ +ALIASES + $ swanky account ls +``` ## `swanky clear [CONTRACTNAME]` -Clear the artifacts - ``` USAGE $ swanky clear [CONTRACTNAME] [-v] [-a] @@ -420,11 +413,10 @@ ARGUMENTS FLAGS -a, --all Select all the project artifacts for delete -v, --verbose Display more info in the result logs - -DESCRIPTION - Clear the artifacts ``` +_See code: [src/commands/clear/index.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/clear/index.ts)_ + ## `swanky contract compile [CONTRACTNAME]` Compile the smart contract(s) in your contracts directory @@ -437,16 +429,17 @@ 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. + -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/master/src/commands/contract/compile.ts)_ +_See code: [src/commands/contract/compile.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/contract/compile.ts)_ ## `swanky contract deploy CONTRACTNAME` @@ -454,7 +447,7 @@ Deploy contract to a running node ``` USAGE - $ swanky contract deploy CONTRACTNAME --account [-v] [-g ] [-a ] [-c ] [-n ] + $ swanky contract deploy CONTRACTNAME [-v] [--account ] [-g ] [-a ] [-c ] [-n ] ARGUMENTS CONTRACTNAME Name of the contract to deploy @@ -463,15 +456,15 @@ FLAGS -a, --args=... -c, --constructorName= [default: new] Constructor function name of a contract to deploy -g, --gas= - -n, --network= Network name to connect to + -n, --network= [default: local] Network name to connect to -v, --verbose Display more info in the result logs - --account= (required) Alias of account to be used + --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/master/src/commands/contract/deploy.ts)_ +_See code: [src/commands/contract/deploy.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/contract/deploy.ts)_ ## `swanky contract explain CONTRACTNAME` @@ -491,7 +484,7 @@ DESCRIPTION Explain contract messages based on the contracts' metadata ``` -_See code: [src/commands/contract/explain.ts](https://github.com/inkdevhub/swanky-cli/blob/master/src/commands/contract/explain.ts)_ +_See code: [src/commands/contract/explain.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0-beta.0/src/commands/contract/explain.ts)_ ## `swanky contract new CONTRACTNAME` @@ -506,13 +499,13 @@ ARGUMENTS FLAGS -v, --verbose - --template=