@catena/sdk 0.0.0-alpha-20260724191736

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2025-2026 Catena Labs, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,147 @@
+# @catena/sdk
+
+Typed client for the Catena agent API: read accounts, balances, and policy, move
+money through policy-checked intents, and pay x402 (HTTP 402) challenges.
+Node >= 20; no framework dependencies.
+
+## Status: prerelease snapshots
+
+Versions published under the `alpha` dist-tag are throwaway development
+snapshots cut directly from the Catena monorepo. They carry no stability or
+semver guarantees: any API may change or disappear between snapshots, and
+snapshot versions (`0.0.0-alpha-<timestamp>`) never match ordinary semver ranges
+— only an exact version, an explicit prerelease range, or a dist-tag like
+`alpha` selects one.
+
+```sh
+npm install @catena/sdk@alpha
+```
+
+Pin the exact version you tested against; do not depend on the `alpha` tag
+resolving to anything compatible over time.
+
+## Entry points
+
+- `@catena/sdk` — the client: `createCatenaClient`, intents, accounts,
+  counterparties, error types.
+- `@catena/sdk/keypair` — generate or derive the P-256 credential and compute
+  its thumbprint.
+- `@catena/sdk/x402` — a `fetch` wrapper that pays x402 402 challenges through
+  Catena.
+
+## Authentication
+
+Every request is signed (RFC 9421) with a P-256 private key; there are no API
+tokens or sessions. The key must first be linked to a Catena agent by a host app
+— for example the Catena CLI or the Catena console. How the key was generated
+does not matter to this SDK, only that it is a valid P-256 key whose public half
+is linked. The SDK derives the public half from `privateKeyHex` at construction
+and never reads or writes stored credentials.
+
+```ts
+import { generateP256Keypair } from "@catena/sdk/keypair"
+
+const keypair = generateP256Keypair()
+// Persist keypair.privateKeyHex yourself; link keypair.publicKeyHex to an
+// agent in a host app before the client can authenticate.
+```
+
+## Quickstart
+
+```ts
+import { createCatenaClient } from "@catena/sdk"
+
+const client = createCatenaClient({
+  privateKeyHex: process.env.CATENA_PRIVATE_KEY!,
+})
+
+const { accounts } = await client.listAccounts()
+const { counterparties } = await client.listCounterparties()
+
+// The rail must match the method: "ach" and "wire" need a bank rail,
+// "on-chain" needs a wallet rail. Pass the rail id, not the counterparty id.
+const bankRail = counterparties
+  .flatMap((counterparty) => counterparty.rails)
+  .find((rail) => rail.type === "bank")!
+
+const intent = await client.submitIntent({
+  action: {
+    type: "send",
+    accountId: accounts[0].id,
+    counterpartyRailId: bankRail.id,
+    // Decimal USD string: "12.50" is $12.50. Never cents or atomic units.
+    amount: "12.50",
+    method: "ach",
+  },
+})
+```
+
+`submitIntent` returns a disposition, not a guarantee of execution — branch on
+`intent.status`:
+
+- `"completed"` — the action succeeded: money moved for send, transfer, and
+  wallet_send; for x402 the payment authorization was delivered (on-chain
+  settlement is verified separately); the counterparty exists for
+  create_counterparty.
+- `"pending"` — parked, typically awaiting a human approval; `reasons` says why,
+  `expiresAt` says when the approval request lapses.
+- `"processing"` — accepted and in progress. Executing intents advance on their
+  own; poll `getIntent(intent.id)`. An approved x402 payment instead rests here
+  until the paid request is re-run — polling never advances it.
+- `"blocked"` — declined by policy or denied by an operator; `reasons` explains
+  why approval was required, not necessarily why it was denied. Terminal.
+- `"failed"` — failed, expired, or reversed. Terminal.
+
+## Errors
+
+- `ApiError` — any non-OK API response. Branch on `code` (the stable error
+  code), not on message prose; `status` is the HTTP status.
+- `IntentSubmitError` — `submitIntent` failed after the intent was created.
+  Branch on `outcome`: `"not-submitted"` means no money moved — recovery is a
+  new `submitIntent` with a fresh explicit `idempotencyKey` (omitting it replays
+  the same stranded intent); `"unknown"` means the server may have acted — poll
+  `getIntent(err.intentId)` to a terminal status and resubmit only after blocked
+  or failed, never blindly.
+
+## Paying x402 challenges
+
+`wrapFetchWithX402Payment` returns a drop-in `fetch`: when a response is a 402
+with a decodable v2 challenge, it pays through Catena (policy checks included)
+and retries once with the `PAYMENT-SIGNATURE` header. Everything else passes
+through untouched.
+
+```ts
+import { createCatenaClient } from "@catena/sdk"
+import { wrapFetchWithX402Payment } from "@catena/sdk/x402"
+
+const client = createCatenaClient({
+  privateKeyHex: process.env.CATENA_PRIVATE_KEY!,
+})
+
+const fetchWithPayment = wrapFetchWithX402Payment(client, {
+  // Wallet account the payments draw from.
+  accountId: walletAccountId,
+  // Refuse challenges above this price, in atomic USDC units ("1000000" = $1).
+  maxAtomicAmount: 1_000_000n,
+})
+
+const response = await fetchWithPayment("https://api.example.com/paid-thing")
+```
+
+Request bodies must be replayable: pass them via the `init` argument as a
+string, `URLSearchParams`, Blob, ArrayBuffer, or typed array — a `Request`
+object carrying a body (or any stream) throws `X402PaymentError` instead of
+paying.
+
+Payment failures surface as `X402PaymentError` or a subclass documenting its
+recovery path; an `ApiError` the loop does not absorb while skipping unpayable
+candidates and a `"not-submitted"` `IntentSubmitError` propagate unchanged. Two
+subclasses deserve care: `X402ApprovalPendingError` means the payment is parked
+for human approval — re-run the same request after approval;
+`X402RetryFailedError` and `X402SubmitInterruptedError` mean money may have
+already moved — follow the recovery steps in the error message instead of paying
+again.
+
+## License
+
+[Apache-2.0](./LICENSE)