@cardanowall/poe-standard 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,213 @@
+# @cardanowall/poe-standard — the CIP-309 wire-format library
+
+The wire-format library for [CIP-309](https://cips.cardano.org/) Proof-of-Existence records: the
+record schema, the canonical-CBOR encoder, the pure structural validator, and the canonical
+error-code catalogue. Pure functions over bytes — no I/O, no network, no clock.
+
+## What it is
+
+This package owns the **bytes**. It builds the exact canonical CBOR that goes on chain under Cardano
+metadata label 309, and it decides whether an arbitrary byte string is a structurally valid CIP-309
+record. It is the **structural validator** of the three CIP-309 verifier roles: a pure function over
+CBOR bytes, with no cryptographic signature checks, no chain resolution, and no decryption — those
+belong to the verifier layer in [`@cardanowall/sdk-ts`](https://www.npmjs.com/package/@cardanowall/sdk-ts)
+and its byte-parity twins.
+
+Everything here is deterministic and side-effect-free, which is what makes a CIP-309 proof
+independently checkable: the same bytes always encode to the same record and validate to the same
+result, in any implementation, against shared test vectors.
+
+## Install
+
+The CIP-309 TypeScript packages are pre-1.0 and not yet published to npm. Build from the workspace:
+
+```sh
+pnpm install
+pnpm --filter @cardanowall/poe-standard typecheck
+```
+
+Once published, the install will be:
+
+```sh
+# once published
+npm install @cardanowall/poe-standard
+```
+
+## Quick start
+
+### Encode a content-first record
+
+```ts
+import { encodePoeRecord, type PoeRecord } from '@cardanowall/poe-standard';
+
+// The content hash is the primary claim; everything else is metadata about it.
+const digest = new Uint8Array(32); // the 32-byte SHA-256 digest of your content
+const record: PoeRecord = {
+  v: 1,
+  items: [{ hashes: { 'sha2-256': digest } }],
+};
+
+// Canonical CBOR (RFC 8949 §4.2.1 deterministic encoding) for submission
+// under Cardano metadata label 309.
+const bytes: Uint8Array = encodePoeRecord(record);
+```
+
+### Validate any record's bytes — never throws
+
+```ts
+import { validatePoeRecord } from '@cardanowall/poe-standard';
+
+const result = validatePoeRecord(bytes);
+if (result.ok) {
+  // result.record is the decoded PoeRecord.
+  // result.info / result.warnings carry non-fatal issues (e.g. an
+  // unsupported-but-tolerated signature algorithm id).
+  console.log('valid', result.record.v);
+} else {
+  // result.issues is a list of { code, path, message, severity }.
+  for (const issue of result.issues) {
+    console.error(`${issue.code} at ${issue.path.join('.')}: ${issue.message}`);
+  }
+}
+```
+
+`validatePoeRecord` never throws: every failure — malformed/non-canonical CBOR, schema mismatch,
+registry violation, bad URI, malformed signature entry — is returned as data in a discriminated
+`ValidateResult` union. The result is sorted, stable, and identical across the TS/Python/Rust
+implementations.
+
+### Build the bytes a record-level signature covers
+
+```ts
+import { encodeRecordBodyForSigning, type PoeRecord } from '@cardanowall/poe-standard';
+
+const record: PoeRecord = { v: 1, items: [{ hashes: { 'sha2-256': digest } }] };
+
+// record_body = the full record map MINUS sigs. Producers prepend the CIP-309
+// domain-separation prefix and wrap the result in a COSE Sig_structure before
+// signing with Ed25519 (see @cardanowall/crypto-core for the COSE helper).
+const body: Uint8Array = encodeRecordBodyForSigning(record);
+```
+
+## Records on chain: chunk → validate
+
+The Cardano ledger caps every metadata byte string and text string at 64 bytes, so a CIP-309 record
+is stored as an **array of ≤64-byte CBOR-bytes chunks** under label 309, and the metadata map itself
+is wrapped in the Conway tag-259 form. A verifier reassembles the chunk array (and unwraps tag-259)
+before calling `validatePoeRecord` — the validator operates on the single reconstructed record byte
+string. The chunking helpers are exported from the root:
+
+```ts
+import { chunkBytes, bytesChunkArrayConcat } from '@cardanowall/poe-standard';
+
+const chunks = chunkBytes(bytes); // Uint8Array[] of ≤64-byte chunks, for label 309
+const whole = bytesChunkArrayConcat(chunks); // reassemble before validate
+```
+
+`chunkUri` / `reconstructChunkedUri` do the same for the chunked URI arrays carried in
+`items[i].uris` and `merkle[i].uris`, splitting on UTF-8 codepoint boundaries.
+
+## API overview
+
+The package root re-exports every group. Subpath imports are available for `./schema`, `./encoder`,
+`./validator`, and `./error-codes`.
+
+**Encode** (`@cardanowall/poe-standard/encoder`)
+- `encodePoeRecord(record)` — canonical CBOR for chain submission.
+- `encodeRecordBodyForSigning(record)` — the `record_body` (full map minus `sigs`) that record-level
+  COSE_Sign1 signatures sign over.
+
+**Validate** (`@cardanowall/poe-standard/validator`)
+- `validatePoeRecord(bytes)` — the structural pipeline: canonical decode → schema parse → cross-field
+  domain checks. Returns a discriminated `ValidateResult`; never throws.
+- `validateCidProfile(cid)` — offline IPFS CID-profile parser (CIDv0 and the CIP-309 CIDv1 multibase
+  / multicodec / multihash profile).
+- `type ValidateResult`, `type ValidationIssue`.
+
+**Error codes** (`@cardanowall/poe-standard/error-codes`)
+- `STRUCTURAL_ERROR_CODES` — the codes the structural validator emits (Part A).
+- `VERIFIER_ERROR_CODES` — the verifier-layer codes (Part B), re-exported so downstream verifiers
+  dispatch on a single union without round-tripping through the SDK.
+- `ERROR_CODES` — their union; `SEVERITY` / `severityOf(code)` map each to `'error' | 'warning' |
+  'info'`. Codes are SCREAMING_SNAKE_CASE and byte-exact across implementations.
+- `type ErrorCode`, `type StructuralErrorCode`, `type VerifierErrorCode`, `type Severity`.
+
+**Schema + types** (`@cardanowall/poe-standard/schema`)
+- Zod schemas for the full v1 wire surface: `PoeRecordSchema`, `ItemEntrySchema`,
+  `MerkleCommitSchema`, `EncryptionEnvelopeSchema`, `SlotSchema`, `PassphraseBlockSchema`,
+  `Argon2idParamsSchema`, `HashesMapSchema`, `HashDigestSchema`, `SigEntrySchema`,
+  `SupersedesSchema`, `VersionLiteralSchema`, and the `ChunkedBytesArraySchema` / `UriChunkArraySchema`
+  chunk-array schemas.
+- Inferred types: `PoeRecord`, `ItemEntry`, `MerkleCommit`, `EncryptionEnvelope`, `Slot`,
+  `PassphraseBlock`, `Argon2idParams`, `HashesMap`, `UriChunkArray`, `ChunkedBytesArray`, `SigEntry`,
+  `Supersedes`.
+- Extension-key helpers: `TOP_LEVEL_BASE_KEYS`, `isExtensionKey`, `EXTENSION_KEY_VENDOR_RE`,
+  `EXTENSION_KEY_COMPANION_RE`.
+
+**Chunking** (re-exported from the root)
+- `chunkBytes` / `bytesChunkArrayConcat` — split/reassemble chunked byte strings (COSE_Sign1,
+  COSE_Key blobs).
+- `chunkUri` / `reconstructChunkedUri` — split/reassemble chunked URI arrays on UTF-8 boundaries.
+- `type ReconstructUriResult`.
+
+For the exhaustive surface, see `src/index.ts`.
+
+## The record shape
+
+A `PoeRecord` is content-first and storage-agnostic. The smallest valid record is a single item
+committed by its content digest; a record may also (or instead) carry one or more Merkle
+list-commitments, an optional `supersedes` link, optional record-level `sigs`, and an optional
+sealed-PoE encryption envelope per item:
+
+```ts
+const record: PoeRecord = {
+  v: 1,
+  items: [
+    {
+      hashes: { 'sha2-256': digest, 'blake2b-256': altDigest },
+      // Optional plural storage list (chunked URI arrays): ar:// , ipfs://
+      // Optional `enc` sealed-PoE envelope (slots or passphrase key path)
+    },
+  ],
+  // merkle: [{ alg: 'rfc9162-sha256', root, leaf_count }],
+  // supersedes: prevTxId32,
+  // sigs: [{ cose_sign1: [...] }],
+};
+```
+
+The validator enforces the CIP-309 registries (hash algorithms, AEAD, KEM, Merkle commitment, and
+passphrase-KDF), rejects unauthenticated ciphers by name, pins each KEM's recipient-slot shape, and
+guards against publishing private key material on chain.
+
+## Cross-implementation parity
+
+The encoder and validator are byte-identical across the CIP-309 implementations —
+`@cardanowall/poe-standard` (TS), the Python twin, and the Rust crate — validated against the same
+shared canonical-CBOR known-answer test vectors. Encoding the same record yields byte-identical CBOR
+in every implementation; validating the same bytes yields the same ordered list of issue codes with
+the same severities. That parity is what lets a proof published by one tool verify under any other.
+
+## Standard / service independence
+
+A CIP-309 proof is verifiable from transaction metadata, the optional content bytes, and a public
+blockchain explorer — no issuer server is required. This package is the structural half of that
+guarantee: given the reassembled record bytes, `validatePoeRecord` decides structural validity
+offline, with no trust in the publisher, the gateway, or any domain. Signature verification, chain
+resolution, and sealed-PoE decryption (the public and recipient verifier roles) build on top of it
+in the SDKs.
+
+## Relation to the other packages
+
+- **`@cardanowall/crypto-core`** — closed-catalogue cryptographic primitives (hash, KDF, signature,
+  KEM, AEAD, CBOR, COSE, sealed-PoE, Merkle). Supplies the canonical CBOR codec and COSE decoder this
+  package builds on.
+- **`@cardanowall/poe-standard`** — this package: the CIP-309 wire format (schema, encoder, structural
+  validator, error codes).
+- **`@cardanowall/sdk-ts`** — the browser + Node SDK: the standalone verifier (all three roles), the
+  gateway-agnostic HTTP client, off-host signing, and seed-derived identity helpers.
+- **`@cardanowall/sdk-py`** — the Python SDK: a byte-identical parity twin of `sdk-ts`.
+- **`cardanowall`** (Rust crate) — the Rust SDK twin; the `cardanowall` CLI binary builds on it.
+
+## License
+
+Apache-2.0