28 releases (breaking)

new 0.35.3 Apr 11, 2024
0.35.0 Mar 21, 2024
0.33.0 Dec 7, 2023
0.32.1 Oct 5, 2023
0.15.0 Nov 8, 2021

#1423 in Magic Beans

Download history 3517/week @ 2023-12-21 3058/week @ 2023-12-28 5518/week @ 2024-01-04 5110/week @ 2024-01-11 5354/week @ 2024-01-18 5762/week @ 2024-01-25 6759/week @ 2024-02-01 7917/week @ 2024-02-08 5949/week @ 2024-02-15 5481/week @ 2024-02-22 5882/week @ 2024-02-29 6074/week @ 2024-03-07 6155/week @ 2024-03-14 6569/week @ 2024-03-21 6593/week @ 2024-03-28 8317/week @ 2024-04-04

28,692 downloads per month
Used in 35 crates (28 directly)

Apache-2.0 OR GPL-3.0 and maybe GPL-3.0-or-later…

1MB
15K SLoC

subxt · build Latest Version Documentation

A library to submit extrinsics to a substrate node via RPC.

Usage

Take a look in the examples folder or the examples folder for various smaller or larger subxt usage examples, or read the guide to learn more.

Downloading metadata from a Substrate node

Use the subxt-cli tool to download the metadata for your target runtime from a node.

  1. Install:
cargo install subxt-cli
  1. Save the encoded metadata to a file:
subxt metadata -f bytes > metadata.scale

This defaults to querying the metadata of a locally running node on the default http://localhost:9933/. If querying a different node then the metadata command accepts a --url argument.

Subxt Documentation

For more details regarding utilizing subxt, please visit the documentation.

Integration Testing

Most tests require a running substrate node to communicate with. This is done by spawning an instance of the substrate node per test. It requires an up-to-date substrate executable on your path.

This can be installed from source via cargo:

cargo install --git https://github.com/paritytech/polkadot-sdk staging-node-cli --force

Real world usage

Please add your project to this list via a PR.

  • cargo-contract CLI for interacting with Wasm smart contracts.
  • xcm-cli CLI for submitting XCM messages.
  • phala-pherry The relayer between Phala blockchain and the off-chain Secure workers.
  • crunch CLI to claim staking rewards in batch every Era or X hours for substrate-based chains.
  • interbtc-clients Client implementations for the interBTC parachain; notably the Vault / Relayer and Oracle.
  • tidext Tidechain client with Stronghold signer.
  • staking-miner-v2 Submit NPos election solutions and get rewards.
  • polkadot-introspector Tools for monitoring Polkadot nodes.
  • ink! Smart contract language that uses subxt for allowing developers to conduct End-to-End testing of their contracts.
  • Chainflip A decentralised exchange for native cross-chain swaps.

Alternatives

substrate-api-client provides similar functionality.

License

The entire code within this repository is dual licensed under the GPL-3.0 or Apache-2.0 licenses. See the LICENSE file for more details.

Please contact us if you have questions about the licensing of our products.

Dependencies

~18–38MB
~608K SLoC