Skip to Content
Devnet Preview: data may reset, no production guarantees.
Getting StartedInstallation

Installation

Beats-only client (no Registry dependency)

If you only need the public Beats service (beats.provenonce.dev), use the standalone client package from the Beats repo.

npm i @provenonce/beats-client

npm

npm install @provenonce/sdk

yarn

yarn add @provenonce/sdk

pnpm

pnpm add @provenonce/sdk

Requirements

  • Node.js 18+ (22 recommended). The SDK uses crypto.createHash from the Node.js built-in crypto module.
  • Server-side only. Not browser-compatible without a polyfill for Node.js crypto. The SDK is designed for server-side agent processes.

Package contents

The SDK ships as:

  • CommonJS (dist/index.js) — for require()
  • ESM (dist/index.mjs) — for import
  • TypeScript declarations (dist/index.d.ts)

Version compatibility

SDK VersionRegistry APIBreaking Changes
0.18.0/api/v1/*RFC-021 Phase 2: batch heartbeat, delegation chains, grandchild sponsorship
0.17.0/api/v1/*Breaking: paymentTx required for heartbeat(), startHeartbeat(), reissuePassport(), purchaseSigil()
0.16.0/api/v1/*Passport rename: LineageProofPassport (old names deprecated, sunset 2026-09-01)
0.15.0/api/v1/*mapApiError() prefers body.code over status heuristics
0.14.0/api/v1/*Breaking: Model A (self-custody wallet) removed. walletModel narrowed to 'operator' only
0.13.0/api/v1/*Breaking: pulse() / checkin() removed. computeWorkProof() added for spawn/resync
0.12.0/api/v1/*verifyAnchorHash() local verification
0.11.0/api/v1/*Self-service registration tokens
0.10.1/api/v1/*SIGIL Namespace v0.4 types, updateMetadata(), purchaseSigil() options object
0.9.0/api/v1/*Breaking: checkin() / resync() removed (410 Gone), new heartbeat() / purchaseSigil() methods
0.8.0/api/v1/*No-wallet default, multi-chain wallets, v2 hash formula
0.7.0/api/v1/*Wallet-per-agent, anchor-hash weaving

Source

Last updated on