@percayso-community/cayso-contracts 0.23.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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,114 @@
+# `@percayso-community/cayso-contracts`
+
+The versioned capability contract surface through which anything outside this
+repository reads a wallet. This is the package Piper — and any third-party
+integrator — depends on. Published to the public registry under **Apache-2.0**,
+even though the repository that builds it is private (CAY-0025): a
+possibly-public Piper cannot depend on a private package.
+
+It exists to prevent one specific failure. Piper's own `walletApi.ts` redeclares
+the wallet shape by hand instead of importing it, and in doing so widened a
+literal `0` to `number` — so the one structural guarantee in that surface dies at
+the HTTP boundary. The fix is a single published package whose types a consumer
+imports rather than retypes.
+
+## The Piper-facing surface only
+
+Published here: the record and response types, the closed failure-reason union,
+the assertion claims and the route constants — the surface Piper reads.
+
+**Deliberately not published:** peer types, admin types, holdings and carves.
+They are not a consumer's business, and putting them on the public surface widens
+it for nothing.
+
+**This package carries no numbers.** Amounts, rates, tiers, schedules and
+thresholds live in the canon PRD and are read from one place. None of them are
+restated here.
+
+## Three entry points
+
+| Import | What it gives you |
+|---|---|
+| `@percayso-community/cayso-contracts` | Types and constants. No runtime. |
+| `@percayso-community/cayso-contracts/client` | The thin client — fetch, assertion header, idempotent retry. |
+| `@percayso-community/cayso-contracts/schema` | A machine-readable descriptor of the published surface. |
+
+The split is the point: a consumer wanting only the types takes on no runtime at
+all. The client owns the fetch, the assertion header and the idempotent retry.
+
+The `schema` entry point serves a data description of the same surface —
+generated from these very types, never hand-written — for tooling that needs the
+shape at runtime (a diff, a doc generator, a compatibility check). It is a
+diagnostic, **not** a stand-in for depending on the package: see below.
+
+## Independent versioning
+
+`CONTRACT_VERSION` is exported from the barrel and is **independent** — its own
+semantic version, starting `0.1.0`, not a repo-wide constant shared with anything
+else. Piper's own contracts share one global version bumped across all of them
+together; independent versioning across a service boundary is exactly what this
+money surface gains that theirs lack (CAY-0026). The constant and the package's
+`version` field must agree, and a test fails when they drift.
+
+## The version endpoint, and why it is not the package
+
+A Cayso deployment serves `GET /api/version`, and a consumer reads it to
+negotiate which contract this server speaks before speaking it. It answers four
+fields: the `contractVersion` this deployment publishes, the
+`supportedContractVersions` it will still honour (the negotiation set), the
+`schemaVersion` of its database, and the build `commit` (the honest word
+`unknown` when the build stamped none). The route is **public** — no assertion —
+because you cannot negotiate the contract from behind the gate the contract
+describes. The thin client's `getVersion()` reads it and warns once, per client
+instance, when the server's contract *major* differs from the one the client was
+built against.
+
+Alongside it, `GET /api/version/schema` serves the same machine-readable
+descriptor as `@percayso-community/cayso-contracts/schema` — the Piper-facing surface only, with no
+operator, webhook or peer route. It exists for tooling and diagnostics.
+
+**It is not a substitute for depending on this package.** The descriptor is
+data; the guarantee is the *types*, and the types do not exist at runtime — they
+are erased when TypeScript compiles. A consumer that reads the schema off the
+wire and validates against it has re-created Piper's original mistake by another
+route: hand-rolling the shape instead of importing it, and losing every
+compile-time guarantee the moment the wire description and the code drift. Import
+`@percayso-community/cayso-contracts` and let the compiler hold the surface. Read the schema
+endpoint when you are building a tool *about* the contract, never to stand in for
+having it.
+
+## No dependencies
+
+Not one — not a runtime dependency, not a peer dependency. A published contract
+surface that drags a tree behind it is a liability a consumer did not ask for.
+
+## Licence and the source-file header
+
+The package is **Apache-2.0** (see [`LICENSE`](./LICENSE)) — permissive, with the
+explicit patent grant, because Piper, the Companion and third-party integrators
+all need to depend on it. Everything else in this repository is proprietary; do
+not carry this licence beyond this package.
+
+Every source file in this package — and only in this package — starts with the
+Apache boilerplate header, above the file's own docblock:
+
+```ts
+/*
+ * Copyright 2026 Percayso Community
+ *
+ * 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.
+ */
+```
+
+Add it to any new file you create here, so the next person follows the
+convention rather than guessing it.