Skip to content

README.md

Latest commit

 

History

History
263 lines (235 loc) · 14.3 KB

README.md

File metadata and controls

263 lines (235 loc) · 14.3 KB
Raw

CellScript Documentation Map

This directory is organized by document role. Keep new docs in the smallest stable category that matches how readers should use them.

The 0.30 release candidate notes record the version, accepted compatibility axes, validation commands, and the separate no-TAC publication constraint.

The current alpha.2 implementation work uses metadata schema 74; its runtime matrix is cellscript-ckb-runtime-view-v1. The native certification boundary records CLI, proposal-engine, packaging, dependency and validation ownership. The additive six-domain Since, typed HeaderDep, and checked EpochDuration subset of issue #12 is recorded in the typed CKB temporal-domain contract. The runtime-view matrix also records the bounded source-level script::new/script::hash contract and its lowering-record-v10 machine evidence. The experimental 0.26b baseline used schema 67. The existing unreleased 0.26 implementation record below retains the historical schema 62 baseline; its contents may be folded into 0.30 without publishing a stable 0.26 release.

Stable Tutorials

docs/wiki/ contains the GitHub Wiki source. These pages are version-neutral, reader-facing tutorials and cookbook material. They should teach the current stable surface rather than act as release logs.

The ProtocolBundle end-to-end tutorial separates the stable closed-role workflow from bounded 0.32 development profiles. The Chinese Nervos Talk draft explains cross-contract organization, a raw Rust responsibility comparison, the unfinished #47/#48/#49 roadmap and the SSRI/IPC design reviews (#81–#83). The community draft is not a release announcement or a published forum post.

Release Records

docs/releases/ contains finalized release notes and active release-note drafts. Released versions should use non-draft filenames.

  • docs/releases/CELLSCRIPT_0_13_2_RELEASE_NOTES.md is the final 0.13.2 release note and the canonical 0.13 release summary.
  • docs/releases/CELLSCRIPT_0_13_RELEASE_SCOPE.md records the closed 0.13 implementation scope and release evidence boundary.
  • docs/releases/CELLSCRIPT_0_13_2_ACCEPTANCE_COMMUNITY_POST.md is a community-facing summary of the 0.13.2 CKB acceptance and stateful flow evidence.
  • docs/releases/CELLSCRIPT_0_14_RELEASE_NOTES.md is the final 0.14.0 release note and release-evidence summary.
  • docs/releases/CELLSCRIPT_0_15_RELEASE_NOTES.md is the final 0.15.0 release note and release-evidence summary.
  • docs/releases/CELLSCRIPT_0_16_RELEASE_NOTES.md is the initial 0.16.0 release note and release-evidence summary.
  • docs/releases/CELLSCRIPT_0_16_1_RELEASE_NOTES.md is the final 0.16.1 release note and release-evidence summary.
  • docs/releases/CELLSCRIPT_0_20_RELEASE_NOTES.md records the generated-builder and live-registry line.
  • docs/releases/CELLSCRIPT_0_21_RELEASE_NOTES.md records semantic closure, authenticated evidence, the canonical CLI tree, MCP, and skill-pack scope.
  • docs/releases/CELLSCRIPT_0_22_RELEASE_NOTES.md is the final stable 0.22 record for its typed language, diagnostics, metadata schema 55, and bounded Fiber boundary.
  • docs/releases/CELLSCRIPT_0_23_RELEASE_NOTES.md is the final stable 0.23 record for Edition 2026, resolved compatibility profiles, metadata schema 57, recoverable browser tooling, and the Registry publisher-session flow.
  • docs/releases/CELLSCRIPT_0_24_RELEASE_NOTES.md is the stable 0.24 record for metadata schema 58, independently checked ELF/lowering evidence, executable package scenarios, and the least-privilege Registry artifact worker.
  • docs/releases/CELLSCRIPT_0_25_RELEASE_NOTES.md is the predecessor record for metadata schema 61, bounded generics, public interfaces, typed-semantics verification, executable-surface closure, bounded-collection fail-closed hardening, local evidence retention, and the upgraded Playground inspector.
  • docs/releases/CELLSCRIPT_0_25_RELEASE_POST.md is the publication-gated community announcement draft for the same 0.25 boundary, with a shorter social version for release-day use.
  • docs/releases/CELLSCRIPT_0_26_RELEASE_NOTES.md is the active implementation record for metadata schema 62, typed-semantics v3, exact Type Script group input scans, versioned bounded output plans, and the four checked dynamic batching examples.
  • CELLSCRIPT_0_30_CAPABILITY_LEDGER.md defines the versioned distinction between admitted executable-surface closure and wider product-capability completeness; its machine record covers issues #7 through #27 without making a release promise.
  • CELLSCRIPT_0_30_BUSINESS_CORPUS.md defines the bounded eight-family application corpus and its evidence ceilings.
  • CELLSCRIPT_COMMITTED_SUBSTATE.md defines the candidate fixed-width Commitment<T>/Opening<T> hash, witness ABI, one-shot safety rules, builder encoding, stable mismatch error, and current review boundary.

Release candidates and planning notes should not live here unless they are the final release record.

Reference And Evidence Contracts

Top-level docs/CELLSCRIPT_*.md files are active reference material when they describe current compiler behavior, target-profile evidence, runtime errors, syntax governance, metadata, capacity, deployment manifests, or support matrices.

High-value active references include:

  • CELLSCRIPT_0_30_CAPABILITY_CLOSURE_RFC.md for the proposed direct 0.25-to-0.30 release path, issue coverage, missing work owners, bounded Rust-comparable business portfolio, and release gates
  • CELLSCRIPT_0_30_CKB_RUNTIME_VIEW_MATRIX.md for typed CKB transaction-view fields, bounded syscall families, stable failures, executable evidence, and the remaining issue #24 work
  • CELLSCRIPT_0_30_CRYPTOGRAPHIC_CAPABILITY_MATRIX.md for the native, standard-Lock, exact-identity, and trusted-external cryptographic capabilities used by the frozen eight-family business corpus
  • CELLSCRIPT_COMMITTED_SUBSTATE.md for the fixed-width typed commitment/opening profile, canonical hash preimage, witness encoding, and post-validation materialization rule
  • CELLSCRIPT_COMPILER_REQUIREMENTS.md for the enforced package SemVer range, dependency preflight diagnostics, Registry selection, and Cell.lock v5 evidence
  • CELLSCRIPT_WORKSPACE_GRAPH.md and CELLSCRIPT_PACKAGE_INSPECTION.md for the canonical member graph and stable resolve/build inspection schemas
  • CELLSCRIPT_TRANSACTIONAL_UPGRADES.md for candidate resolution, graph/interface/build evidence, policy acknowledgements, stale-plan rejection, and explicit lock-only apply
  • CELLSCRIPT_AUTHORING_TARGET.md for the adopted 2026-style authoring direction, shared-policy multi-action contracts, schema review, authorization boundaries, and required acceptance examples
  • CELLSCRIPT_AUTHORING_IMPLEMENTATION.md for the complete implementation goal, 2026 parity requirements, current evidence, and remaining production acceptance work
  • CELLSCRIPT_ALPHA_2_BOUNDARY_REVIEW.md for retained source/storage boundaries, removed effect protocols, emission failure propagation and the scoped phase-invariant review
  • CELLSCRIPT_PUBLIC_VALUE_GENERICS.md for the accepted restricted public-generic decision, fixed_value profile, structural derivation, interface compatibility, and migration contract
  • CELLSCRIPT_BOUNDED_GROUP_INPUT_CONTRACT.md for the accepted bounded dynamic Type Script GroupInput semantics, fail-closed boundary, independent machine checks, shared fixtures, and maximum-resource budget
  • CELLSCRIPT_SCHEMA_ACKNOWLEDGEMENTS.md for the versioned same except schema-change plan, explicit new-field rule, review receipt, stale verification, and deployment boundary
  • CELLSCRIPT_EXACT_SCRIPT_HANDLES.md for the fixed exact-artifact handle layout, source API, on-chain checks, and the boundary before generic compatible/open handles
  • CELLSCRIPT_OPEN_HANDLE_POLICY.md for the experimental bounded authorization-set codec, independent wire vectors and remaining compatible-handle admission/runtime requirements
  • CELLSCRIPT_DEPLOYMENT_LINE_HANDLES.md for the Type-hash upgrade receipt chain, six-dimensional compatibility policy, fixed line-handle encoding, and remaining unique admission-Cell and runtime blockers
  • CELLSCRIPT_POLICY_WITNESS_ABI.md for explicit policy selection, tagged multi-record witnesses, builder contracts, and signature-field ownership
  • CELLSCRIPT_TRUSTED_EXTERNAL_VERIFIERS.md for exact-hash EXEC/SPAWN composition, manifest declarations, the trusted-external evidence tier, and its explicit no-proof-of-internals boundary
  • CELLSCRIPT_1_0_SEMANTIC_FOUNDATION_RFC.md for the post-0.26 design agenda, issue/conflict reconciliation, staged acceptance gates, and the experimental 0.26b implementation boundary
  • CELLSCRIPT_2027_PREVIEW_GRAMMAR.md for the exact bounded native grammar, lowering, diagnostics, issue constraints, and deferred surface introduced by preview4, recorded under cellscript-source-semantics-2027-authoring1, and retained by the current cellscript-source-semantics-2027-0.33-effect-facts-v1 route
  • releases/CELLSCRIPT_0_13_2_RELEASE_NOTES.md for the final 0.13 syntax governance summary
  • CELLSCRIPT_GATE_POLICY.md
  • CELLSCRIPT_GRAMMAR_GOVERNANCE_RFC.md for the active grammar-governance direction around transition shape, verification, require, and accounting syntax
  • CELLSCRIPT_SURFACE_ELEGANCE_RFC.md for deferred syntax candidates that require full parser/typechecker/lowering/metadata/formatter/LSP coverage
  • CELLSCRIPT_CAPACITY_AND_BUILDER_CONTRACT.md
  • CELLSCRIPT_CKB_ADAPTER.md
  • CELLSCRIPT_CELLFABRIC_BRIDGE.md
  • CELLSCRIPT_PACKAGE_PROVENANCE_AND_DEPLOYMENT_IDENTITY.md
  • CELLSCRIPT_REGISTRY_PRODUCTION_BOUNDARY_ADR.md for the accepted production boundary of the wallet-rooted public registry write/read architecture and isolated Pudge testnet sandbox
  • CELLSCRIPT_LS_IDL_REGISTRY_PROFILE.md for byte-exact LS-IDL admission, executable suffix commitment, Script-identity lookup, tooling, and operator boundaries
  • ../services/registry-api/README.md for the Cloudflare Workers + R2 + Neon write API implementation and deployment checklist
  • CELLSCRIPT_COLLECTIONS_SUPPORT_MATRIX.md
  • CELLSCRIPT_ENTRY_WITNESS_ABI.md
  • CELLSCRIPT_EXAMPLE_BUSINESS_FLOWS.md
  • CELLSCRIPT_LINEAR_OWNERSHIP.md
  • CELLSCRIPT_OUTPUT_BINDINGS.md
  • CELLSCRIPT_RUNTIME_ERROR_CODES.md
  • CELLSCRIPT_VERIFIED_ARTIFACT_BOUNDARY.md
  • Runtime ABI evidence coverage
  • CELLSCRIPT_PUBLIC_INTERFACES.md
  • CELLSCRIPT_EXECUTABLE_TEST_SCENARIOS.md
  • CELLSCRIPT_MYELIN_0_24_HANDOFF.md
  • CELLSCRIPT_COMPILER_ERROR_CODES.md
  • CELLSCRIPT_SCHEDULER_HINTS.md
  • ../examples/fiber/README.md for the bounded 0.22 Fiber interoperability operator workflow

Specs And Future Tracks

  • docs/spec/ contains normative or semi-normative specifications. The 0.16 operational semantics live there.
  • docs/0.20/ now keeps only release-facing evidence material for the 0.20 line, including CELLSCRIPT_PROTOCOL_MULTI_FILE_EVIDENCE.md for the evidence-gated NovaSeal/iCKB/DobEvo protocol-source boundary. Superseded 0.20 audit notes have been removed from the main branch.

Examples

docs/examples/ contains focused example notes and matrices that support the bundled .cell examples. These are not release notes.

  • docs/examples/token_amm_bootstrap.md records the concrete token authority bootstrap and AMM builder path for the bundled launch, token, and amm_pool examples.

Design And Release Records

Shipped behavior is recorded in releases/, while forward-looking work must be owned by a concrete RFC under docs/ or a scoped implementation proposal under proposals/. The documentation set does not maintain a separate roadmap layer.

Active design and evidence records include:

  • CELLSCRIPT_INSTANCE_POLICY.md for the #80 constrained-instance contract, implementation boundaries and acceptance ledger
  • CELLSCRIPT_OPEN_HANDLE_DESIGN.md for the #28 compatible-open handle design record and threat model over the implemented authorization-set boundary
  • CELLSCRIPT_CKB_STD_COMPAT.md for the ckb-std compatibility boundary
  • CELLSCRIPT_GRAMMAR_GOVERNANCE_RFC.md for 0.19 grammar/syntax governance scope
  • CELLSCRIPT_REGISTRY_PHASE1.md for the current artifact, verification, deployment-evidence, and public API contract
  • CELLSCRIPT_LS_IDL_REGISTRY_PROFILE.md for the 0.24 Lock Script interface profile and compatibility evidence
  • releases/CELLSCRIPT_0_22_RELEASE_NOTES.md for the typed transaction-view, bounded collection, validity, borrow, capability, payload-enum, and Fiber release boundary
  • releases/CELLSCRIPT_0_23_RELEASE_NOTES.md and releases/CELLSCRIPT_0_24_RELEASE_NOTES.md for the Edition/ABI, Registry, verified-artifact, executable-test, and ecosystem evidence boundaries

Archive

docs/archive/ contains historical plans and superseded execution documents. Archived files may remain useful for design archaeology, but they are not the current stable contract.

Current archive:

  • docs/archive/0.17/CELLSCRIPT_0_17_ICKB_FINAL_REPORT.md
  • docs/archive/0.17/CELLSCRIPT_0_17_ICKB_PRODUCTION_EQUIVALENCE_GATE.md
  • docs/archive/0.17/CELLSCRIPT_0_17_REVIEW_FINDINGS_CLOSURE.md

When moving a document into the archive, update all public links and add a short status note if the file could otherwise be mistaken for active guidance.