QubicKit Docs

Getting Started

Install @qubiq/core, bootstrap wallets, and run automation in minutes.

@qubiq/core mirrors the native Qubic node lifecycle in TypeScript. Follow this quickstart to derive a wallet, sign a transaction, and boot the automation runtime. Jump to deeper topics via the "Next steps" list below.

1. Install dependencies

bun add @qubiq/core

2. Quickstart script

import { QubicNodeClient, deriveWalletFromSeed } from "@qubiq/core";

const client = new QubicNodeClient();
const wallet = await deriveWalletFromSeed(process.env.QUBIC_SEED!);
const { tickInfo } = await client.getTickInfo();

const signed = await wallet.signTransfer({
  destinationPublicKey: wallet.publicKey,
  amount: BigInt(1000),
  tick: tickInfo.tick + 10,
});

await client.broadcastTransaction({
  encodedTransaction: Buffer.from(signed.bytes).toString("base64"),
});

3. Automation runtime

import { createAutomationRuntime } from "@qubiq/core";

const runtime = createAutomationRuntime("mainnet", {
  onBalanceSnapshot: (snapshots) => console.log("snapshots", snapshots.length),
  onProposals: ({ epoch, proposals }) => console.log(epoch, proposals.length),
});

await runtime.start();

4. Build artifacts

bun run build         # node + browser bundles
bun run build:node
bun run build:browser

Artifacts land in dist/node + dist/browser for cross-runtime embedding.

5. Environment tips

VariablePurpose
QUBIC_SEED55-char lowercase seed for wallet derivation
QUBIC_LIVE_URLOverride live-service HTTP base (defaults to https://api.qubic.org)
QUBIC_SMOKE_TESTSSet to true to run live smoke tests via bun test

6. Next steps

7. Guided paths