Quickstart

Canonical flow (SDK v0.17.0+): register() -> init() -> heartbeat() -> public verify.

If you only want public clock/timestamp APIs (no agent identity), use Beats-only Quickstart.

Prerequisites

Node.js 18+ (Node 22 recommended)
npm or yarn

1) Install SDK (v0.17.0+)


npm install @provenonce/sdk

2) Register agent


import { register } from '@provenonce/sdk';
 
const creds = await register('my-first-agent', {
  registryUrl: 'https://provenonce.io',
  // registrationSecret: 'xxx' // required only when operator enables root gating
});
 
console.log(creds.hash);
console.log(creds.api_key);

3) Initialize beat chain


import { BeatAgent } from '@provenonce/sdk';
 
const agent = new BeatAgent({
  apiKey: creds.api_key,
  registryUrl: 'https://provenonce.io',
});
 
await agent.init();

4) Send first heartbeat


const hb = await agent.heartbeat('5xYzAbCd...'); // Solana transaction signature

For long-running liveness:


agent.startHeartbeat(() => getPaymentTxSignature());
// ...work...
agent.stopHeartbeat();

5) Verify publicly


curl https://provenonce.io/api/v1/verify/YOUR_AGENT_HASH

Certificate page:

https://provenonce.io/certificate/YOUR_AGENT_HASH

Notes

Root registration can be no-wallet for simplicity.
Production paid routes are BYO-wallet gated by policy.