Sdk

io.github.bolyra由 GitHub 账号 bolyra 发布v0.5.2更新于 Oct 24, 2026

TypeScript SDK for mutual ZKP authentication between humans and AI agents.

已验证STDIO仅桌面开发者工具安全与监控

概览

AI 生成的概览

面向 Bolyra 的本地 TypeScript SDK,为助手提供人与 AI 代理之间双向零知识证明认证的构建模块。

可以做什么
创建人类身份和带权限位掩码的代理凭证,并提供委托与校验辅助函数;生成人与代理之间的双向握手证明,在本地验证并读取生成的 nullifier 与范围承诺。使用底层 Poseidon 哈希和 BabyJubjub EdDSA 签名、验证与公钥派生,用于自定义验证器或重新计算承诺。通过 ethers.js 将证明提交到链上注册表。
适用场景
在构建或测试基于 Bolyra 的代理授权流程时适用,可让助手用 TypeScript 搭建身份创建、权限编码、握手证明与验证,或外部验证器逻辑。
运行要求
作为本地 stdio 进程在桌面运行,从 npm 包 @bolyra/sdk 安装,需要 Node.js 和 npm。未声明认证、环境变量或请求头。链上验证需要 ethers.js 和注册表合约,握手证明据说明约需 16 秒。
安装前请注意
该 SDK 涉及私钥:代理凭证由操作者私钥创建,README 示例直接传入该私钥。权限层级包含最高无限的财务支出额度,以及代表签名和再委托权限,位掩码配置错误会授予过大权限。向链上提交证明会写入数据并可能产生 gas 费用。清单未列出任何工具,安装前应确认服务器实际提供的能力。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Sdk,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@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

bash
npm install @bolyra/sdk

Quick Start

typescript
import {  createHumanIdentity,  createAgentCredential,  Permission,  proveHandshake,  verifyHandshake,} from '@bolyra/sdk';
// 1. Create identitiesconst 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 locallyconst result = await verifyHandshake(humanProof, agentProof, nonce);console.log('Verified:', result.verified); // trueconsole.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:

typescript
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);         // booleanconst 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:

BitPermissionNotes
0READ_DATA
1WRITE_DATA
2FINANCIAL_SMALL< $100
3FINANCIAL_MEDIUM< $10,000 (implies bit 2)
4FINANCIAL_UNLIMITEDUnlimited (implies 2+3)
5SIGN_ON_BEHALF
6SUB_DELEGATE
7ACCESS_PII

API Status

FunctionStatus
createHumanIdentity()v0.1
createAgentCredential()v0.1
permissionsToBitmask()v0.1
validateCumulativeBitEncoding()v0.1
proveHandshake()v0.2
verifyHandshake()v0.2
delegate()v0.3
verifyDelegation()v0.3

License

Apache-2.0 — see LICENSE.

来源:sdk/README.md,提交 5e9de85

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.5.2最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分