Skip to content

qorechain/qorechain-rdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

qorechain-rdk

Rollup Development Kit for designing, launching, configuring, and operating application-specific rollups (app-chains) on the QoreChain network β€” a quantum-safe Layer 1 with first-class CosmWasm, EVM/Solidity, and SVM runtimes.

πŸ“– Documentation: https://qorechain.github.io/qorechain-rdk/

The RDK is a client and operator toolkit. It talks to QoreChain nodes over their public RPC / REST / gRPC / JSON-RPC surfaces and drives the on-chain rdk module: rollup creation, settlement-batch submission, lifecycle management, and data-availability queries. It contains no node internals β€” it is the developer-facing front door for launching rollups on the network.

Packages

Package Language Status
@qorechain/rdk TypeScript Available (v0.2.0)
@qorechain/rdk-cli (qorollup) Operator CLI Available (v0.1.0)
create-qorechain-rollup Project scaffolding CLI Available (v0.2.0)
qorechain-rdk (Python) Python Available on PyPI (v0.3.1)
github.com/qorechain/qorechain-rdk/packages/go Go Available (v0.3.1)
qorechain-rdk (Rust crate) Rust Available on crates.io (v0.3.1)
io.github.qorechain:qorechain-rdk Java (JVM) Available on Maven Central (v0.3.1)

The Python, Go, Rust, and Java (JVM) clients mirror the TypeScript surface β€” config builder and validation, presets, utilities, Merkle/withdrawal helpers, manifests, REST and qor_ JSON-RPC read clients, preflight/health, accounts, and transaction signing + broadcast β€” and are verified against shared cross-language golden vectors. (Live broadcast requires a node endpoint.)

The TypeScript package is built first and at the highest polish; the other language packages mirror the same conceptual surface and are marked "coming soon" until filled in. The TypeScript RDK depends on @qorechain/sdk for accounts, quantum-safe signing, and transport.

What is a rollup on QoreChain?

A rollup is an application-specific chain that executes transactions off the Main Chain and periodically anchors its state to QoreChain for verifiable, quantum-safe integrity. You choose how it settles, who sequences it, where its data lives, and which runtime it exposes.

Settlement paradigms

Paradigm Finality Proofs Notes
optimistic Delayed (challenge window) Interactive fraud proofs Default 7-day window with a challenge bond
zk Instant on a valid proof SNARK or STARK On-chain verification gates finalization
based ~2 blocks None Host-chain proposers sequence; requires the based sequencer mode
sovereign The rollup's own consensus None Self-sequenced, no proofs or challenges

Sequencer modes

dedicated (single operator), shared (distributed sequencer set), and based (host-chain proposers). Based settlement requires the based sequencer mode.

Proof systems

fraud (optimistic), snark and stark (zk), and none (based / sovereign). The RDK enforces the compatibility matrix before anything is submitted: optimistic β†’ fraud, zk β†’ snark | stark, based β†’ none, sovereign β†’ none.

Data availability

native (on-chain blob storage, auto-pruned), celestia (a selectable but not-yet-active backend β€” configs may target it, but the network does not serve it yet and the kit fails gracefully with a clear message), and both (redundant).

Preset profiles

Five first-class presets produce sensible, documented defaults you can override field by field:

Profile Settlement Sequencer DA Block time Gas model VM Max tx/block
defi zk (snark) dedicated native 500 ms eip1559 EVM 10,000
gaming based based native 200 ms flat custom 50,000
nft optimistic dedicated celestia 2,000 ms standard CosmWasm 5,000
enterprise based based native 1,000 ms subsidized EVM 20,000
custom optimistic dedicated native 1,000 ms standard EVM 10,000

A QCAI-assisted suggestProfile(useCase) helper recommends a starting profile from a plain-language description of your app, falling back to defi when the advisory service is unavailable.

Quickstart (TypeScript)

The TypeScript package is published at v0.2.0 (npm i @qorechain/rdk).

npm install @qorechain/rdk
import { createRdkClient, presets } from "@qorechain/rdk";

// Targets the public testnet (chain id "qorechain-diana") by default.
// Override endpoints to reach a real node.
const rdk = createRdkClient({
  endpoints: {
    rest: "https://rest.testnet.example",
    rpc: "https://rpc.testnet.example",
    evmRpc: "https://evm.testnet.example",
  },
});

// Read live module parameters from the chain (never hardcoded).
const params = await rdk.params();

// Start from a preset, then override fields as needed.
const config = presets.defi({ rollupId: "my-defi-rollup" });

// Validate against the compatibility matrix before submitting.
config.validate();

Operate a rollup from the command line

qorollup (the @qorechain/rdk-cli package) takes you from zero to a live, monitored rollup β€” no code required:

npx @qorechain/rdk-cli keygen            # generate an operator key
npx @qorechain/rdk-cli doctor            # preflight: endpoints, params, signer, balance
npx @qorechain/rdk-cli create --rollup-id my-roll --profile defi
npx @qorechain/rdk-cli status my-roll    # status + health + challenge-window countdown
npx @qorechain/rdk-cli watch my-roll     # live updates

It also covers suggest, pause/resume/stop, manifest export|import, withdraw, and faucet, with --dry-run and --json everywhere. See the zero-to-rollup tutorial and the qorollup reference.

The library exposes the same surface for programmatic use: checkPreflight (doctor), getRollupHealth / watchRollup (monitoring), signerFromEnv and generateMnemonic (accounts), toManifest / fromManifest (manifests), assembleWithdrawalProof (bridge), MockTxClient and RdkTxClient.simulate (offline / dry run).

Network reference

  • Mainnet chain id: qorechain-vladi (live).
  • Testnet chain id: qorechain-diana (live). The RDK defaults to testnet.
  • Token: QOR (display) / uqor (base), 10^6 base units per QOR.
  • Rollup creation requires a stake (default 10,000 QOR) and burns a small percentage on creation (default 1%). The kit reads the live values from the chain and shows the cost before you submit.

License

Apache-2.0. See LICENSE.

About

Rollup Development Kit for launching and operating application-specific rollups on the QoreChain network.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors