Skip to content

CLAUDE.md

Latest commit

 

History

History
49 lines (40 loc) · 2.38 KB

CLAUDE.md

File metadata and controls

49 lines (40 loc) · 2.38 KB
Raw

CLAUDE.md

Only what a capable agent would get wrong from this repo alone. Layout, dev shells, build/test commands and dependency lists are discoverable and deliberately absent (rainlanguage/rainix#298).

What this repo is

The deploy half of rain.math.float: the concrete DecimalFloat, its generated deploy records and the deploy scripts + tests. The pure math (LibDecimalFloat*, LibLogTable, the errors) is NOT here — it arrives as the rain-math-float Soldeer package.

Conventions an agent would get wrong

  • Optimizer 1,000,000 runs, NOT the 100,000 sibling deploy repos use. Deterministic (Zoltu) deploy: the address is a pure function of the creation bytecode, so this, solc =0.8.25, evm_version = "cancun", no CBOR metadata, and the pinned rain-math-float sources all move the pins if changed.
  • Pragma: concretes, scripts and tests pin =0.8.25; shipped libs and generated files float ^0.8.25.
  • All source files carry SPDX headers (LicenseRef-DCL-1.0).
  • No skipped tests. Comments describe current behaviour only.
  • recursive_deps is off: every package an import resolves through is declared in foundry.toml, including ones reached only via rain-math-float.

Deploy-pin invariants (the hazards)

  • src/generated/candidate/ is the rolling record, rewritten by script/Build.sol and currency-checked by CI; src/lib/deploy/LibDecimalFloatDeploy.sol aliases it and adds hand-written helpers. src/generated/<tag>/ snapshots are frozen: a release only ADDS one. Never hand-edit generated files (src/generated/, src/lib/Lib*Released*.sol).
  • [external.package].version moves only in a release cut, in lockstep with the frozen src/generated/<tag>/ snapshot; a normal PR never bumps it.
  • DecimalFloat's constructor reverts unless the log tables are at their Zoltu address: tables deploy/build/broadcast FIRST, always.
  • src/generated/LogTables.pointers.sol is table BYTES (a pure function of LibLogTable), not a deploy record — it stays at the generated root, never in a tag dir.

Release / deploy shape

  • The on-chain deploy is a human-dispatched Manual sol artifacts run, BEFORE tagging, never on merge: log-tables then decimal-float.
  • A manual sol-v* tag is the sole Soldeer release trigger (rainix-tag-release); the Rust crate + npm wrapper publish on merge instead (crate-npm-release.yaml). See README.md.