Skip to content

Latest commit

 

History

History
235 lines (157 loc) · 18.5 KB

CHANGELOG.md

File metadata and controls

235 lines (157 loc) · 18.5 KB

Changelog

All notable changes to the Proofable SDK and CLI are documented in this file.

The format follows Keep a Changelog, and this project adheres to Semantic Versioning.

Product release notes: docs.proofable.me/changelog.

0.1.14 - 2026-11-16

Changed

  • Packaged skills match MCP 0.1.11. The trust workflow hands an agent work as a job and revokes proofs and permissions. Keys are saved on the profile page, with no tool to list or remove them.

Fixed

  • CLAUDE_PLUGIN_INSTALL works on a fresh Claude Code. It adds the proofable/mcp marketplace before installing the plugin.
  • proofable examples suggests prompts that work over MCP. Handing your agent a job replaces the vault prompt.

0.1.13 - 2026-11-11

Changed

  • Packaged skills match MCP 0.1.10. The trust workflow stops on an unclear requirement, covers who owns an agent and what re-creating one does, and lists and removes saved keys without offering a tool to store one.

0.1.12 - 2026-11-04

Added

  • Your app's users can talk to your agent. ProofableSignIn signs them in with Proofable, the same sign-in every MCP host uses. start() sends the person to Proofable, finish() exchanges the code for their tokens, refresh() renews them, and register() records your callback once. Then client.agentChat({ agentId, agentWallet }) as the person runs your public agent inside their own profile, with their records and nothing of yours in the conversation.
  • Your app pays for those chats. client.sponsorApp() and proofable sponsor turn sponsorship on once. Your app may then spend up to a daily cap of your credits on its users' checks and chats. A client with appId and billingWallet carries it, and every spend record names the app. fetchSponsorGrant takes scope: 'agent-chat'.
  • client.me() says who the credential belongs to.

0.1.11 - 2026-11-01

Added

  • client.agentChat() talks to a hosted agent from any app or runtime. Name the agent and send the conversation; the turn runs on Proofable as that agent, under the delegation you signed for it, with every tool call checked before it runs. Events stream to onEvent, and the call resolves with the answer, the records the agent read as citations, and the credits it spent. Nothing to deploy.
  • client.getUsage() reads your credits and spend. The balance, recent spend events, and spend by line and by UTC day, for any period with from and to.

0.1.10 - 2026-10-28

Changed

  • proofable import creates the agent in one step. A signed-in terminal now creates the agent on your profile with its full instructions and mounts it into the current project, for the host the source names or the one you pass with --apply. Its permissions never expire unless you set an end with --expires-at (a date or Unix milliseconds); --no-mount skips the mount. It prints the agent's name, what it may do, when its permissions end, and its agent page. owner/name reads a GitHub repository, and --dry-run shows what would happen without creating anything.

Fixed

  • proofable auth --oauth signs in the CLI and leaves your editors alone. It no longer writes its short-lived token into Cursor, VS Code or Claude, which keep the sign-in proofable setup gave them, and it works on a machine with none of them installed. Name an editor with --client to write the token there too.
  • Long agent instructions are never dropped without a word. A terminal that is not signed in is sent to the browser import. When a step has to finish in the browser and the link cannot carry the instructions, the CLI says so and tells you to paste them there.

0.1.9 - 2026-10-27

Fixed

  • verifyPortableProofEnvelope verifies any CAIP-380 envelope. An envelope without a walletAddress field, such as one from another CAIP-380 implementation or the specification's test vectors, threw an error. The signer is now taken from the envelope's did:pkh identifier, and an envelope that carries walletAddress verifies exactly as before.

0.1.8 - 2026-10-27

Fixed

  • The CLI exits cleanly after an error on Windows. A failed command printed its error and then crashed Node, ending with exit code 127. It now exits with code 1.
  • A dry-run mount says what it would write. proofable mount <agentId> --apply <host> --dry-run lists the files as "would write" instead of "wrote".

Changed

  • The packaged skills offer import for an agent that already runs elsewhere. proofable-setup and proofable-trust-workflow point an agent at proofable import <repository, URL, or folder> for a GitHub repository, MCP server URL, A2A agent card or package, then at proofable mount.
  • Listing links point at /profile/listings. The setup skill and the portable proofs example link to the new listings page. Old /profile/portals links redirect.

0.1.7 - 2026-10-20

Fixed

  • fulfillGate() completes AI service orders. It now sends serviceParameters, the buyer's values for the listing's serviceInputs, so an order for a service with a required input no longer fails with SERVICE_PARAMETER_REQUIRED. PublicGateSnapshot.serviceInputs, FulfillGateParams.serviceParameters and the response's serviceJob are typed. The run's answer appears on the buyer's receipt at meta.marketplace.serviceJob.result.

0.1.6 - 2026-10-12

Changed

  • Runtime selection stays with the executing host. Removed an unused runtime field and resolver from mounted agents and the SDK surface.
  • A named agent uses only its own delegation. A delegation that does not name the requested agent can no longer be applied to it.
  • Packaged skills match MCP 0.1.7. The SDK skills now include the external-signer prepare-and-submit flow and current version metadata.

0.1.5 - 2026-10-09

Changed

  • User-visible wallet error names Proofable, not NEUS. The personal_sign failure message reads Proofable never falls back to eth_sign for security reasons, matching the product name.
  • CLI help stops assuming an IDE. proofable --help describes --live as using your client credential, not an IDE credential.
  • The packaged skills match the 0.1.6 set from proofable/mcp, including the simplified setup flow and the finalized identity, scoped access, and proof line.

Fixed

  • Portable proof fields survive the type contract. types.d.ts declares options.disclosePortableProof and the portableProof result field so a TypeScript consumer can read and set the disclosed envelope instead of casting.
  • A mounted agent no longer carries a dead skills field. The bundle dropped delegation.skills; authority already travels as allowedActions minus deniedActions, and no consumer read the removed field.

0.1.4 - 2026-10-05

Fixed

  • A delegated agent can only do what the permission lists. A delegated action is denied when the mounted permission proof has an empty or missing allowedActions list, and a present-but-empty list is preserved instead of dropped. Mounts you own (no delegation) keep their existing behavior.

Upgrade

npm install @proofable/sdk@0.1.4

0.1.3 - 2026-09-28

Fixed

  • The proof badge and pill link meet the WCAG 2.2 AA target size. Both render a 24 by 24 pixel target, so they are easy to tap on a phone.

0.1.2 - 2026-09-24

Changed

  • Agent authority is listed explicitly. getHostedAgentCreateUrl and verify no longer accept or forward scope and permissions. Authority is allowedActions minus deniedActions only; spend delegations carry allowedPaymentTypes and maxSpend, and allowedOrigins bounds app-agent origins. Runtime mounts surface allowedActions/deniedActions without a scope string.
  • Trust guidance follows the hosted workflow. The packaged trust-workflow skill and runtime-mount trust instructions use proofable_verify_or_guide first; proofable_proofs_check is only for an explicit yes/no eligibility, gate, or access question.
  • The packaged proofable-setup skill ships with the SDK. The plugin bundle and @proofable/sdk ship the same skill content, so the two packages cannot describe different setup steps.

Upgrade

npm install @proofable/sdk@0.1.2

scope and permissions are removed. Pass allowedActions (and deniedActions to exclude); pass allowedPaymentTypes with maxSpend for spend authority.

0.1.1 - 2026-09-13

Added

  • One description for the package. npm and the README share one description: SDK and CLI for verification gates, reusable proof, and agent permissions.
  • Inline Gate Policy. defineGate plus gateCheck({ gate, subject }) evaluates a visitor by account without a published listing or a Proofable profile. POST /api/v1/proofs/check is the server path.
  • Subject reuse. VerifyGate accepts subject and reuses public or unlisted proofs for that account without requiring a connected wallet or Proofable sign-in.
  • x402 quotes on API errors. ApiError.fromResponse keeps PAYMENT-REQUIRED on HTTP 402 so callers can settle and retry with PAYMENT-SIGNATURE.
  • Generic MCP config builder. buildGenericMcpJsonConfig and buildGenericMcpJsonConfigUrlOnly from @proofable/sdk/mcp-hosts produce the copy-paste mcpServers JSON block for any MCP client. URL-only output is the OAuth path; an npk_* Profile access key becomes a static Authorization: Bearer header.

Changed

  • README opens with install and a runnable gate. The hosted MCP URL, npx -y @proofable/sdk setup, and a defineGate / gateCheck example lead the page.
  • The install host list renamed for what it is. MCP_INSTALL_HOSTS is now MCP_INSTALL_SHORTCUT_HOSTS. The four entries (cursor, claude, codex, vscode) are deep-link conveniences, not the compatibility boundary.

Upgrade

npm install @proofable/sdk@0.1.1

gateCheck({ gateId }) still works for published listings. New apps should use defineGate and subject.

0.1.0 - 2026-09-06

First Proofable SDK and CLI release. The predecessor @neus/sdk 1.x releases remain on npm as history.

Added

  • Library. Hosted verification flows, reusable proof checks, server gate checks, React widgets, and agent permissions, implementing CAIP-380 Portable Proof.
  • CLI. proofable setup, proofable doctor --live, proofable auth, and proofable mount for hosted MCP setup and agent context.
  • proofable setup support for hosted MCP clients. Cursor, Claude Code, Codex, and VS Code register https://mcp.proofable.me/mcp and sign in with hosted OAuth.
  • Widgets. VerifyGate and ProofBadge from @proofable/sdk/widgets.

Changed

  • Package identity. @neus/sdk is now @proofable/sdk. The CLI binary is proofable (was neus).
  • SDK exports. NeusClient is now ProofableClient. NEUS_* exports are now PROOFABLE_*. buildNeusMcpHttpConfig is now buildMcpHttpConfig.
  • Environment. PROOFABLE_ACCESS_KEY is the server and CI environment variable (was NEUS_ACCESS_KEY).
  • Local state. The CLI token store moved from ~/.neus/ to ~/.proofable/, and proofable mount writes .proofable/mount.json (was .neus/mount.json). Sign in once after upgrading.

Upgrade

npm install @proofable/sdk
npx -y @proofable/sdk setup
npx -y @proofable/sdk doctor --live

Full rename map and stale-state fixes: Migration guide.

History: @neus/sdk

The @proofable/sdk package continues the line published as @neus/sdk. The notes below are the user-facing highlights of each predecessor release. The complete record stays with the predecessor package on npm and in the archived source at proofable/network under the neus-final tag.

Release Date What it changed for a builder
1.3.9 2026-08-13 Removed the OAuth browser command-injection sink. The CLI opens authorization URLs with fixed executables, never a shell command. Retired the neus import / neus export / neus revoke alias paths. The CLI defers skill install when the plugin already bundles the trust workflow.
1.3.8 2026-07-30 Added RFC 9207 issuer validation in neus setup and neus auth, preventing authorization-code interception. Rebalanced per-host setup guidance and removed the retired neus-trust plugin probe.
1.3.7 2026-07-30 Restored marketplace click-install for Cursor and normalized the RFC 8707 resource parameter so canonicalizing clients stop failing with invalid_target.
1.3.6 2026-07-30 The neus-mcp plugin became the MCP registration owner in Cursor while the CLI defers, ending duplicate entries. The trust-workflow skill moved into the package as its single home.
1.3.5 2026-07-21 Aligned the optional ZKPassport dependency (0.16.1) with the hosted verifier runtime patch.
1.3.4 2026-07-21 Added offline portable-proof verification (EIP-191, Ed25519, provider-backed EIP-1271) with strict canonical JSON, exact signed-data binding, and a CAIP-380 interoperability fixture.
1.3.3 2026-07-16 ZKPassport 0.16 alignment. neus setup warns when both the plugin and a manual neus entry are present. neus doctor --live reports handle, wallet, proof count, and mounted agent. Tag pushes now publish matching GitHub Releases.
1.3.2 2026-07-09 Restored one-click Cursor marketplace install (the plugin again ships the required MCP config). Sharpened the trust-workflow skill and aligned docs and examples with the live assistant guidance.
1.3.1 2026-07-08 neus mount and @neus/sdk/runtime-mount became the supported path for loading a Trusted Agent into a project.
1.3.0 2026-07-08 Added llms.txt and pricing.txt for AI search, opened docs to AI crawlers, published the Codex plugin metadata, and tightened the public SDK surface to documented integrator exports.
1.2.5 2026-07-03 One plugin install path for every editor: Cursor, Claude Code, Codex, and VS Code, with a refreshed marketplace mark.
1.2.4 2026-06-23 SDK, MCP server, plugin, and trust-workflow skill report one version: 1.2.4.
1.2.3 2026-06-21 VS Code joined neus setup and the install docs. neus doctor --live works with browser OAuth sessions, and a sign-in challenge counts as reachable, not down.
1.2.2 2026-06-21 OAuth docs now match the real editor sign-in flow, and Cursor setup stopped warning about a stale local token format.
1.2.1 2026-06-18 Clean installs include the CLI and agent-context modules, and Node-only adapters left the main entry point for browser builds.
1.2.0 2026-06-18 Added agent context mount: neus mount <agentId> writes project context for Cursor, Claude Code, or Codex, and @neus/sdk/runtime-mount plus runtime-adapters expose it to apps.
1.1.7 2026-06-16 Fixed gate checkout paths and proof revocation response parsing.
1.1.6 2026-06-12 Fixed a Node ESM crash in neus auth browser sign-in. neus setup --oauth forces browser sign-in even when an access key is present.
1.1.5 2026-06-07 One install path across README, install, MCP, plugin, and SDK, leading with portable proofs. Removed the redundant per-host install files.
1.1.3 2026-06-05 Install docs start from hosted MCP setup with platform cards, and the Claude Code plugin loads the trust workflow skill correctly.
1.1.2 2026-06-04 Added @neus/sdk/mcp-hosts helpers for MCP install URLs, setup commands, and editor deep links. neus import --from auto prefers Claude Code, Cursor, and Claude Desktop.
1.1.1 2026-05-28 neus_context returns the current profile when connected, and neus setup writes the correct config path for each editor.
1.1.0 2026-05-26 First public SDK release on npm: OAuth-first setup, the CLI, public MCP tools including encrypted Vault secrets, and the Claude Code plugin with the trust workflow skill.
1.0.12 2026-05-26 First @neus/sdk release with the hosted MCP CLI (neus setup, neus auth, import/export) and the OAuth browser flow.