docs: README in the same form as the other hackathon builds, working notes out of the repository

[gamween]

Metaphor was a finalist on the ADI Foundation bounty (Open Project Submission, $300) at ETHDenver 2026. This turns the repository into the public record of the build, in the same form as the team's other hackathon repositories.

README

• Hero with the one-line pitch, badges, the result and a paragraph on the event; table of contents, License section and footer
• How it works, the four layers, the architecture, and what is live vs. simulated at submission
• Deployed contracts on ADI Chain testnet, Sepolia and Hedera Testnet, all twelve checked on chain on 16 September 2026
• Test counts (111 Forge ADI, 74 Forge Hedera, 28 Daml Script, 21 Vitest); the Forge and Vitest suites re-run green
• Team with roles instead of Dev A, B and C; clone URL fixed (DVB-ANS/Metaphor, no longer ETH-DENVER)

Repository

• markdown/ becomes docs/ with the three public documents (SPEC, bounty compliance, demo guide), corrected
• Working notes removed and kept outside the repository (CLAUDE.md, TIMELINE, PROJECT_OVERVIEW, DEPLOY, Explication, AUDIT, devC, A-FAIRE-DANS-FRONT, DEPLOYED_CONTRACTS)
• Root copies of images and sponsor logos removed (the app serves its own from packages/frontend/public), plus a local Claude Code skill, a Yarn install state and the create-next-app README
• MIT licence for the three authors; the vendored Hedera interfaces keep their Apache-2.0 headers

No code change.

https://claude.ai/code/session_012G1hYLp2Jgaqw3X37XaM1j

[Copilot]

🟡 Changes recommended

Six moderate documentation issues remain unresolved.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

This documentation-only PR turns Metaphor’s repository into a public hackathon record, consolidating documentation, removing internal artifacts, and adding licensing.

Changes:

• Rewrites the README with architecture, deployment, setup, testing, and team details.
• Consolidates public documents under docs/.
• Removes working notes, scaffold files, unused assets, and local tooling; adds MIT licensing and ignore rules.

Review findings:

• README.md:152 — Moderate (3 votes): Reconcile the Canton Devnet deployment status with docs/BOUNTY_COMPLIANCE.md.
• README.md:174 — Moderate (3 votes): Document running the backend in the background or a second terminal.
• README.md:31 — Moderate (1 vote): Clarify the $25,000 bounty versus the $300 finalist award.
• README.md:149 — Moderate (1 vote): Reconcile the documented five bonds with the two actually registered.
• README.md:189 — Moderate (1 vote): Build the Hedera package before invoking deployment.
• docs/SPEC.md:188 — Moderate (1 vote): Update the demo guide to use dpm test or pnpm test:canton.

File summaries

File	Reviewed change
README.md	Rewritten public overview and setup guide
packages/frontend/README.md	Removed scaffold README
markdown/TIMELINE.md	Removed internal roadmap
markdown/PROJECT_OVERVIEW.md	Removed internal overview
markdown/Explication.md	Removed internal technical notes
markdown/devC.md	Removed progress notes
markdown/DEPLOYED_CONTRACTS.md	Removed; deployment details consolidated into README
markdown/DEPLOY.md	Removed obsolete deployment guide
markdown/CLAUDE.md	Removed internal Claude context
markdown/AUDIT.md	Removed internal audit
markdown/A-FAIRE-DANS-FRONT.md	Removed private task list
logo bandeau/Canton Network.svg	Removed unused sponsor asset
logo bandeau/ADI Foundation.svg	Removed unused sponsor asset
logo bandeau/0G Labs.svg	Removed unused sponsor asset
LICENSE	Added MIT license
docs/SPEC.md	Updated toolchain, tests, and submission details
docs/DEMO_GUIDE.md	Updated demo documentation
docs/BOUNTY_COMPLIANCE.md	Updated bounty compliance documentation
.gitignore	Added local tooling exclusions
.claude/skills/audit/SKILL.md	Removed local audit skill

Review details

Suppressed comments (4)

README.md:31

• This says the project was a finalist on a $25,000 bounty, while the new result line above and the PR description identify the finalist award as $300. Please clarify the total bounty versus the award, or use one consistent amount so the public result is not contradictory.

> a finalist on ADI Foundation's $25,000 Open Project Submission bounty.

README.md:151

• The README now claims five registered bonds, but the checked-in register-bond.ts registers exactly two and the demo guide's on-chain verification expects bondCount() == 2. Readers cannot reproduce this documented state; reconcile the count with the verified on-chain result and update the related procedure/documentation together.

- **On chain:** the ADI contracts on ADI Chain testnet and Sepolia, and `CouponScheduler` and
  `YieldDistributor` on Hedera Testnet, where `CouponScheduler` holds five registered bonds with their
  coupon dates computed on chain.

README.md:190

• On a fresh checkout, pnpm install does not create the Forge output that packages/contracts-hedera/src/deploy.ts reads (out/CouponScheduler.sol/CouponScheduler.json and out/YieldDistributor.sol/YieldDistributor.json), so this documented deploy command fails before deployment. Build the Hedera package before invoking deploy.

# Hedera Testnet, with HEDERA_OPERATOR_ID and HEDERA_OPERATOR_KEY
pnpm --filter contracts-hedera run deploy

docs/SPEC.md:188

• This updates the Canton toolchain to Daml SDK 3.4.11 via DPM, but docs/DEMO_GUIDE.md still instructs users to run cd packages/contracts-canton && daml test; the package script and Canton README use dpm test. On a DPM-only setup the documented demo test command is unavailable, so update that guide to use dpm test or pnpm test:canton.

• Files reviewed: 16/29 changed files
• Comments generated: 2
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.