Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated aleph-client readme #846

Merged
merged 2 commits into from
Jan 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions aleph-client/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
### Metadata
# API for [aleph-node](https://github.com/Cardinal-Cryptography/aleph-node) chain.

We use autogenerated metadata in this lib. To generate it you will need subxt-cli. See [here](https://github.com/paritytech/subxt) for instructions how to install it.
The metadata is generated by:
```bash
subxt codegen --derive Clone Debug Eq PartialEq | rustfmt --edition=2021 > src/aleph_zero.rs
```
This crate provides a Rust application interface for submitting transactions to `aleph-node` chain.
Most of the [pallets](https://docs.substrate.io/reference/frame-pallets/) are common to any
[Substrate](https://github.com/paritytech/substrate) chain, but there are some unique to `aleph-node`,
e.g. [`pallets::elections::ElectionsApi`](./src/pallets/elections.rs).

## Build

Just use `cargo build` or `cargo build --release`, depends on your usecase.

## Contributions

All contributions are welcome, e.g. adding new API for pallets in `aleph-node`.

## Metadata

`aleph-client` uses [`subxt`](https://github.com/paritytech/subxt) to communicate with a Substrate-based chain which
`aleph-node` is. In order to provide a strong type safety, it uses a manually generated file [`aleph_zero.rs`](src/aleph_zero.rs)
which refers to top of the `main` branch in `aleph-node` repository. See more info [here](docker/README.md).