TypeScript SDK packages for qbit wallets and applications.
This repo is intentionally a workspace. Each package publishes separately while sharing one toolchain, CI and release line. Each package README starts with install lines, a quick start and a table of common tasks.
@qbit-oss/protocolto derive addresses, build, sign and finalize PSBTs, and handle descriptors,qbit:URIs and message proofs. It makes no network requests.@qbit-oss/apito read balances, UTXOs, history and fee estimates from a qbit block explorer and to broadcast a signed transaction.- A wallet usually needs both, plus a PQC signer for the signatures
@qbit-oss/protocolasks for (see the PQC note below).
npm install @qbit-oss/protocol @qbit-oss/api
pnpm add @qbit-oss/protocol @qbit-oss/api
yarn add @qbit-oss/protocol @qbit-oss/apiBoth packages are released together at one version, which names one tested
combination; see RELEASING.md for versions and the candidate
dist-tag.
@qbit-oss/protocol: qbit protocol primitives for networks, P2MR addresses, scripts, descriptors, sighash, PSBT fields, and transaction helpers.@qbit-oss/api: typed REST clients for qbit block explorers.EsploraClienttalks to an electrs/esplora endpoint, andMempoolQbitClientto a mempool-qbit backend (qbit's port of the mempool explorer) such asmempool.qbit.org/api/v1. Both cover address balance, UTXOs and history, transaction lookup, fee estimates and broadcast.
Runnable examples of both packages, tested in CI, are in examples/.
Planned packages:
@qbit-oss/wallet-coreor@qbit-oss/keyring: seed phrase, derivation, encrypted vault interfaces, address rotation, and PQC signature-counter lifecycle helpers.
Low-level PQC signing is not part of these packages. It is in a separate
package, @qbit-oss/pqc, published from
Qbit-Org/qbit-pqc.
Prerequisites, setup, CI checks and the change process are in CONTRIBUTING.md.
corepack pnpm install
corepack pnpm verifyVersioning, release branches and tags are described in RELEASING.md; changes are listed in CHANGELOG.md.