@probemesh/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 ProbeMesh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,160 @@
+# ProbeMesh SDK
+
+The ProbeMesh SDK makes paid API capabilities easier for agents and applications to call, route, verify, and audit.
+
+This repository is the source of truth for the public npm package:
+
+```sh
+pnpm add @probemesh/sdk
+```
+
+Public website and developer docs live at [https://probemesh.io](https://probemesh.io). Internal product notes live in [ProbeMesh/internal](https://github.com/ProbeMesh/internal).
+
+## What Is Included
+
+- Local SDK calls with `createProbeMesh(...)` and adapters.
+- Provider Kit manifests and protocol adapters.
+- Hosted router for paid calls, receipts, route metadata, timelines, fallback, safe manual retry, and audit artifacts.
+- x402 sandbox, local facilitator, EVM signer, and opt-in testnet helpers.
+- Payment option negotiation and deterministic payment strategy scoring.
+- Provider conformance, x402 acceptance, onboarding dossiers, buyer dossier import, catalog policy, and audit trail CLIs.
+- Integration templates via `probemesh-init`.
+
+## Quickstart
+
+```ts
+import { createPriceLookupAdapter, createProbeMesh } from "@probemesh/sdk";
+
+const probemesh = createProbeMesh({
+  adapters: [createPriceLookupAdapter()],
+});
+
+const response = await probemesh.call({
+  capability: "price-lookup",
+  input: {
+    symbol: "ETH",
+    currency: "USD",
+  },
+  constraints: {
+    maxCostUsd: 0.03,
+    requireReceipt: true,
+  },
+});
+
+console.log(response.provider.id, response.cost, response.receiptRefs);
+```
+
+Repo-local demo:
+
+```sh
+pnpm example:price
+pnpm example:paid-price-lookup
+```
+
+## CLIs
+
+The built package exposes:
+
+- `probemesh-init`
+- `probemesh-x402-accept`
+- `probemesh-conformance`
+- `probemesh-dossier`
+- `probemesh-dossier-check`
+- `probemesh-catalog-check`
+- `probemesh-audit-trail-export`
+
+Repo-local equivalents:
+
+```sh
+pnpm template:init -- --list
+pnpm accept:x402 -- --config examples/x402-acceptance.config.ts
+pnpm conformance:provider -- --config examples/provider-conformance.config.ts
+pnpm dossier:provider -- --config examples/provider-dossier.config.ts
+pnpm check:dossiers -- --config examples/provider-dossier-check.config.ts
+pnpm check:catalog -- --config examples/catalog-policy.config.ts
+pnpm export:audit-trail -- --config examples/audit-trail-export.config.ts
+```
+
+`examples/provider-dossier-check.config.ts` writes artifacts to `/tmp/probemesh-provider-dossier-check-artifacts` by default. Set `PROBEMESH_EXAMPLE_ARTIFACT_DIR` only when you intentionally want a different artifact directory.
+
+## Development
+
+```sh
+pnpm install
+pnpm test
+pnpm typecheck
+pnpm build
+pnpm smoke:dist
+pnpm release:verify
+```
+
+Full local release gate:
+
+```sh
+pnpm ci:release
+pnpm dogfood:internal
+```
+
+`pnpm dogfood:internal` packs the SDK tarball, generates the provider starter, rewrites that starter to use the local tarball before npm publish, runs provider acceptance/conformance/dossier flows, runs buyer/safety/audit examples, and verifies the repo stays clean.
+
+## Beta Release Readiness
+
+The SDK is beta-ready locally, but it is not published until the manual npm
+publish command is run by a release owner. No command in this repository
+publishes automatically. The controlled beta flow is:
+
+```sh
+pnpm install
+pnpm build
+pnpm ci:release
+pnpm dogfood:internal
+pnpm release:beta:dry-run
+pnpm release:beta:candidate
+pnpm release:beta:owner-check
+npm publish --tag beta --access public
+pnpm release:beta:postpublish:verify -- --version 0.1.0
+```
+
+`pnpm release:beta:owner-check` requires npm login and performs read-only npm account/package checks before printing the final manual publish command.
+
+## Live x402 Testnet Runbook
+
+Live x402 execution is opt-in and should use a dedicated disposable test wallet
+only. For the full setup, wallet funding, expected output, and settlement-failure
+handling checklist, see
+[`docs/live-x402-testnet-runbook.md`](docs/live-x402-testnet-runbook.md).
+
+Set the environment variables below before running the testnet examples:
+
+```sh
+PROBEMESH_X402_EVM_PRIVATE_KEY=...
+PROBEMESH_X402_PAY_TO=0x...
+PROBEMESH_X402_ASSET=0x...
+PROBEMESH_X402_NETWORK=eip155:84532
+PROBEMESH_X402_FACILITATOR_URL=https://x402.org/facilitator
+PROBEMESH_X402_RPC_URL=...
+PROBEMESH_X402_AMOUNT=10000
+```
+
+`PROBEMESH_X402_AMOUNT` is an integer in token base units. For the Base Sepolia
+USDC test asset, `10000` is `0.01` USDC.
+
+Then run:
+
+```sh
+pnpm example:x402-evm-testnet
+pnpm example:x402-acceptance
+pnpm accept:x402 -- --config examples/x402-acceptance.config.ts
+```
+
+A successful live run should produce `payment_proof`,
+`settlement_confirmation`, and `provider_delivery` receipts; mark payment safety
+as money-may-have-moved; block unsafe retry/fallback after payment evidence; and
+avoid serializing private keys or payment headers in output artifacts.
+
+## Scope Boundaries
+
+- The SDK is local/standalone by default and does not require ProbeMesh Cloud.
+- Live x402/testnet execution is opt-in through environment variables.
+- Dossier, catalog, policy, conformance, and audit artifacts are local metadata; they do not register providers or create marketplace listings.
+- Publishing to npm remains manual.