Interact with contracts: upload, instantiate and call commands

Cargo.toml

@@ -28,7 +28,7 @@ heck = "0.4.0"
 zip = { version = "0.5.13", default-features = false }
 parity-wasm = "0.42.2"
 cargo_metadata = "0.14.1"
-codec = { package = "parity-scale-codec", version = "2.3.1", features = ["derive"] }
+scale = { package = "parity-scale-codec", version = "2.3.1", features = ["derive"] }
 which = "4.2.4"
 colored = "2.0.0"
 toml = "0.5.8"
@@ -43,14 +43,26 @@ url = { version = "2.2.2", features = ["serde"] }
 impl-serde = "0.3.2"
 regex = "1.5.4"
 
-# dependencies for optional extrinsics feature
-async-std = { version = "1.10.0", optional = true }
-sp-core = { version = "2.0.1", optional = true }
-subxt = { version = "0.14.0", package = "substrate-subxt", optional = true }
-futures = { version = "0.3.21", optional = true }
-hex = { version = "0.4.3", optional = true }
-
-funty = "2.0.0"
+# dependencies for extrinsics (deploying and calling a contract)
+async-std = { version = "1.10.0", features = ["attributes", "tokio1"] }
+ink_metadata = { version = "3.0.0-rc8", features = ["derive"] }
+ink_env = "3.0.0-rc8"
+scale-info = { version = "1.0.0", default-features = false, features = ["derive"] }
+sp-arithmetic = "4.0.0"
+sp-core = "5.0.0"
+sp-keyring = "4.0.0"
+sp-runtime = "5.0.0"
+pallet-contracts-primitives = "5.0.0"
+subxt = "0.17.0"
+futures = "0.3.19"
+hex = "0.4.3"
+jsonrpsee = { version = "0.6.1", features = ["ws-client"] }
+nom = "7.1.0"
+nom-supreme = "0.6.0"
+indexmap = "1.8.0"
+thiserror = "1.0.30"
+escape8259 = "0.5.1"
+itertools = "0.10.3"
 
 [build-dependencies]
 anyhow = "1.0.53"
@@ -60,19 +72,28 @@ substrate-build-script-utils = "3.0.0"
 platforms = "2.0.0"
 
 [dev-dependencies]
+assert_cmd = "2.0.4"
 assert_matches = "1.5.0"
 pretty_assertions = "1.1.0"
 wabt = "0.10.0"
+regex = "1.5.4"
+predicates = "2.1.1"
 
-[features]
-default = []
+ink_primitives = "3.0.0-rc8"
+ink_storage = "3.0.0-rc8"
+ink_lang = "3.0.0-rc8"
 
-# Enable this for (experimental) commands to deploy, instantiate and call contracts.
-#
-# Disabled by default
-extrinsics = ["sp-core", "subxt", "async-std", "futures", "hex"]
+[features]
+# This `std` feature is required for testing using an inline contract's metadata, because `ink!` annotates the metadata
+# generation code with `#[cfg(feature = "std")]`.
+default = ["std"]
+std = []
 
 # Enable this to execute long running tests, which usually are only run on the CI server
 #
 # Disabled by default
 test-ci-only = []
+
+# Enable this to execute tests which depend on a locally running contracts enabed chain
+# e.g.https://github.com/paritytech/canvas-node
+integration-tests = []

README.md

@@ -112,6 +112,18 @@ artifact to the `target/` directory.
 
 Runs test suites defined for a smart contract off-chain.
 
+##### `cargo contract upload`
+
+Upload a contract to a `pallet-contracts` enabled chain. See [extrinsics](docs/extrinsics.md).
+
+##### `cargo contract instantiate`
+
+Create an instance of a contract on chain. See [extrinsics](docs/extrinsics.md).
+
+##### `cargo contract call`
+
+Invoke a message on an existing contract on chain. See [extrinsics](docs/extrinsics.md).
+
 ## License
 
 The entire code within this repository is licensed under the [GPLv3](LICENSE).

docs/extrinsics.md

@@ -0,0 +1,103 @@
+# Extrinsics
+`cargo-contract` provides CLI support for uploading, instantiating and calling your contracts directly from the command 
+line.
+
+## Common arguments
+
+```
+--suri
+```
+The Secret URI used for signing the extrinsic. For development chains, the well known endowed accounts can be used e.g.
+`//Alice`. For other accounts, the actual secret key must be provided e.g. an `0x` prefixed 64 bit hex string, or the
+seed phrase. See usage of [`subkey`](https://docs.substrate.io/v3/tools/subkey/) for examples, and docs for the expected
+values in the [parsing code](https://docs.rs/sp-core/latest/sp_core/crypto/trait.Pair.html#method.from_string_with_seed).
+
+:warning: **WARNING** :warning:
+
+It is strongly recommended NOT to use secret keys from actual value bearing chains on the command line, since they are
+visible on screen and are often saved to the command line shell's history. For now this tool should only be used for
+development and testnets. It is a priority to implement a safer method of signing here before using this tool with value
+bearing chains.
+
+```
+--password
+```
+*Optional*. The password for the `--suri`, see https://docs.substrate.io/v3/tools/subkey/#password-protected-keys.
+
+```
+--manfest-path
+```
+*Optional*. The path to the `Cargo.toml` of the contract crate. Use this to run commands on a contract from outside of 
+its project directory.
+
+```
+--url
+```
+*Optional*. The websockets url of an RPC node on the target chain. Defaults to a locally running node at 
+"ws://localhost:9944".
+
+```
+---dry-run
+```
+*Optional*. All extrinsic commands can be run without altering the chain state. Useful for testing if a command will be
+successful, estimating gas costs or querying the result of `ink!` readonly messages.
+
+```
+--storage-deposit-limit
+```
+*Optional*. The maximum amount of balance that can be charged from the caller to pay for the storage consumed.
+
+## Commands
+
+### `upload`
+
+Upload the Wasm code of the contract to the target chain. Invokes the [`upload_code`](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/lib.rs#L509)
+dispatchable.
+
+e.g. `cargo contract upload --suri //Alice`
+
+Assumes that `cargo contract build` has already been run to produce the contract artifacts.
+
+### `instantiate`
+
+Create an instance of a contract on chain. If the code has already been uploaded via `upload`, specify the resulting 
+`--code-hash` which will result in a call to [`instantiate`](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/lib.rs#L460).
+If no `--code-hash` is specified it will attempt to both upload the code and instantiate via the 
+[`instantiate_with_code`](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/lib.rs#L419) 
+dispatchable.
+
+e.g.
+```
+cargo contract instantiate \
+       --constructor new \
+       --args false \
+       --suri //Alice \
+       --code-hash 0xbc1b42256696c8a4187ec3ed79fc602789fc11287c4c30926f5e31ed8169574e
+```
+- `--constructor` the name of the contract constructor method to invoke.
+- `--args` accepts a space separated list of values, encoded in order as the arguments of the constructor to invoke. 
+- `--code-hash` the hash of the uploaded code, returned from a call to `contract upload` or a previous
+`contract instantiate`
+
+### `call`
+
+Invoke a message on an instance of a contract via the [`call`](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/lib.rs#L359)
+dispatchable.
+
+e.g.
+```
+cargo contract call \
+       --contract 5FKy7RwXBCCACCEPjM5WugkhUd787FjdgieTkdj7TPngJzxN \
+       --message transfer \
+       --args 5FKy7RwXBCCACCEPjM5WugkhUd787FjdgieTkdj7TPngJzxN 1000 \
+       --suri //Alice
+```
+
+- `--contract` the account id of the contract to invoke, returned after a successful `contract instantiate`.
+- `--message` the name of the contract message to invoke.
+- `--args` accepts a space separated list of values, encoded in order as the arguments of the message to invoke. 
+
+
+
+
+