Sdk

@bolyra/sdk

TypeScript SDK for Bolyra — mutual ZKP authentication for humans and AI agents.

New here? Start with the 5-minute Quickstart — from npm install to on-chain verification.

Install

npm install @bolyra/sdk

Quick Start

import {

createHumanIdentity, createAgentCredential, Permission, proveHandshake, verifyHandshake, } from '@bolyra/sdk';

// 1. Create identities const human = await createHumanIdentity(123456789n); const agent = await createAgentCredential( 12345n, operatorPrivateKey, [Permission.READ_DATA, Permission.WRITE_DATA], BigInt(Math.floor(Date.now() / 1000) + 86400), );

// 2. Generate mutual handshake proofs (parallel, ~16s) const { humanProof, agentProof, nonce } = await proveHandshake(human, agent);

// 3. Verify locally const result = await verifyHandshake(humanProof, agentProof, nonce); console.log('Verified:', result.verified); // true console.log('Human nullifier:', result.humanNullifier); console.log('Agent scope commitment:', result.scopeCommitment);

// 4. Submit to chain (via ethers.js) // await registry.verifyHandshake(humanProof, agentProof, nonce);

Low-level primitives (v0.6.0+)

For advanced use — e.g. building an external verifier or recomputing credential/scope commitments — the SDK exports its Poseidon hashes and BabyJubjub EdDSA primitives:

import { poseidon5, eddsaSign, eddsaVerify, derivePublicKey } from '@bolyra/sdk';

const pub = await derivePublicKey(operatorPrivateKey); // { x, y } const sig = await eddsaSign(operatorPrivateKey, message); // { R8: { x, y }, S } const ok = await eddsaVerify(pub, message, sig); // boolean const h = await poseidon5(a, b, c, d, e); // bigint

eddsaVerify returns false (never throws) on malformed input. See @bolyra/cli's bolyra verify for a full external-verifier reference.

Permissions

Permissions use cumulative bit encoding — higher tiers imply lower ones:

API Status

License

Apache-2.0 — see LICENSE.