Skip to content

Commit

Permalink
Release initial versions of subxt-codegen and subxt-cli (#320)
Browse files Browse the repository at this point in the history
* Bump codegen and cli to 0.2

* Add CLI README.md
  • Loading branch information
ascjones authored Nov 15, 2021
1 parent 57ab87b commit da8ec3d
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 4 deletions.
4 changes: 2 additions & 2 deletions cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "subxt-cli"
version = "0.1.0"
version = "0.2.0"
authors = ["Parity Technologies <admin@parity.io>"]
edition = "2021"

Expand All @@ -16,7 +16,7 @@ path = "src/main.rs"

[dependencies]
# perform subxt codegen
subxt-codegen = { version = "0.1.0", path = "../codegen" }
subxt-codegen = { version = "0.2.0", path = "../codegen" }
# parse command line args
structopt = "0.3.25"
# make the request to a substrate node to get the metadata
Expand Down
58 changes: 58 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# subxt-cli

Utilities for working with substrate metadata for `subxt`

```
USAGE:
subxt <SUBCOMMAND>
FLAGS:
-h, --help
Prints help information
-V, --version
Prints version information
SUBCOMMANDS:
codegen Generate runtime API client code from metadata
help Prints this message or the help of the given subcommand(s)
metadata Download metadata from a substrate node, for use with `subxt` codegen
```

## Metadata

Use to download metadata for inspection, or use in the `subxt` macro. e.g.

`subxt metadata -f bytes > metadata.scale`

```
USAGE:
subxt metadata [OPTIONS]
OPTIONS:
-f, --format <format> the format of the metadata to display: `json`, `hex` or `bytes` [default: json]
--url <url> the url of the substrate node to query for metadata [default: http://localhost:9933]
```

## Codegen

Use to invoke the `subxt-codegen` crate which is used by `subxt-macro` to generate the the runtime API and types. Useful
for troubleshooting codegen as an alternative to `cargo expand`, and also provides the possibility of customizing the
generated code if the macro does not produce the desired API. e.g.

`subxt codegen | rustfmt --edition=2018 --emit=stdout`

```
USAGE:
subxt codegen [OPTIONS]
OPTIONS:
-f, --file <file>
the path to the encoded metadata file
--url <url>
the url of the substrate node to query for metadata for codegen
```

2 changes: 1 addition & 1 deletion codegen/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "subxt-codegen"
version = "0.1.0"
version = "0.2.0"
authors = ["Parity Technologies <admin@parity.io>"]
edition = "2021"

Expand Down
2 changes: 1 addition & 1 deletion macro/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ quote = "1.0.8"
syn = "1.0.58"
scale-info = "1.0.0"

subxt-codegen = { version = "0.1.0", path = "../codegen" }
subxt-codegen = { version = "0.2.0", path = "../codegen" }

[dev-dependencies]
pretty_assertions = "0.6.1"
Expand Down

0 comments on commit da8ec3d

Please sign in to comment.