Install
Install the RDK for your language. The TypeScript packages and the Go module are published; the Python and Rust clients are fully implemented and awaiting their registry publications (PyPI / crates.io) — until then, build them from the monorepo.
| Package | Language | Install | Status |
|---|---|---|---|
@qorechain/rdk | TypeScript | npm i @qorechain/rdk | Available (v0.2.0) |
@qorechain/rdk-cli (qorollup) | CLI | npm i -g @qorechain/rdk-cli | Available |
qorechain-rdk | Python | pip install qorechain-rdk (imports as qorrdk) | Available on PyPI (v0.3.1) |
qorechain-rdk | Go | go get github.com/qorechain/qorechain-rdk/packages/go | Available (v0.3.1) |
qorechain-rdk | Rust | cargo add qorechain-rdk | Available on crates.io (v0.3.1) |
io.github.qorechain:qorechain-rdk | Java (JVM) | Maven/Gradle (io.github.qorechain:qorechain-rdk:0.3.1) | Available on Maven Central (v0.3.1) |
create-qorechain-rollup | CLI | npm create qorechain-rollup | Available (v0.2.0) |
The Python, Go, Rust, and Java (JVM) clients are fully implemented and tested in
the monorepo (config, presets,
utilities, read clients, accounts, and transaction signing + broadcast). Python
is on PyPI (pip install qorechain-rdk, imported as qorrdk), Rust is on
crates.io (cargo add qorechain-rdk), Java is on Maven Central
(io.github.qorechain:qorechain-rdk), and Go is installable from the tagged
module.
TypeScript
The core package:
npm i @qorechain/rdk
It targets Node.js 20+ and ships ESM, CommonJS, and type definitions.
Signing dependencies
The RDK accepts any @cosmjs
OfflineSigner. For local development with a raw key or mnemonic, install
@cosmjs/proto-signing:
npm i @cosmjs/proto-signing
For hybrid post-quantum signing, install
@qorechain/sdk and use its
signer in place of the standard one:
npm i @qorechain/sdk
Operator CLI (qorollup)
@qorechain/rdk-cli installs the qorollup binary for creating, operating, and
monitoring rollups from the command line. It is a thin wrapper over
@qorechain/rdk.
npm i -g @qorechain/rdk-cli
# or run it without installing:
npx @qorechain/rdk-cli doctor
It targets Node.js 20+. See the qorollup reference for every command and flag, and Zero to a live rollup for a guided walkthrough.
Python
pip install qorechain-rdk
Available on PyPI. The distribution installs as qorechain-rdk and imports as
qorrdk (e.g. from qorrdk import create_rdk_client).
Go
go get github.com/qorechain/qorechain-rdk/packages/go
Available today from the tagged module.
Rust
cargo add qorechain-rdk
Available on crates.io.
Java / JVM
Available on Maven Central as io.github.qorechain:qorechain-rdk.
Maven:
<dependency>
<groupId>io.github.qorechain</groupId>
<artifactId>qorechain-rdk</artifactId>
<version>0.3.1</version>
</dependency>
Gradle:
implementation("io.github.qorechain:qorechain-rdk:0.3.1")
Scaffolding CLI
create-qorechain-rollup scaffolds a complete starter project from one of five
templates:
npm create qorechain-rollup my-rollup -- --template defi-rollup
See the CLI reference for usage and flags.
Next
Continue to the Quickstart to connect, read parameters, and create your first rollup.