Skip to content

Repo sharpening + professional README + clean redeploy#1

Merged
gamween merged 12 commits into
mainfrom
docs/readme-refactor
Jun 16, 2026
Merged

Repo sharpening + professional README + clean redeploy#1
gamween merged 12 commits into
mainfrom
docs/readme-refactor

Conversation

@gamween

@gamween gamween commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Sharpens the whole repo and ships a clean, professional README.

Cleanup (audited; every deletion grep-verified)

  • contracts: drop dead FeeHelper + selfScheduling residue, fix stale HSS comments
  • scripts/config: remove 2 scratch scripts, fix tsconfig glob + .env.example
  • web: remove 5 orphan components + 4 unused deps (−63 pkgs) + 126 dead CSS lines
  • docs: move prep/internal notes to a gitignored notes/, scrub dead-address residue

Pro README + CI

  • production README (badges, ToC, architecture, bounty matrix, what's-live-vs-roadmap, leveraged ETHGlobal NYC win) + MIT LICENSE
  • GitHub Actions CI (compile · typecheck · 78 tests · web build)

Clean redeploy

  • redeployed the dead-code-free contract → 0x8Fb4439f…, Sourcify full-match, lifecycle re-proven by smoke; addresses synced

pnpm test 78 ✓ · typecheck ✓ · web build ✓ · CI ✓

gamween added 12 commits June 16, 2026 07:29
Rewrite the README to production standard: award + live links, ToC, the DePIN insight,
lifecycle, architecture diagram, and an explicit Tokenization-bounty requirements matrix
(HTS system contracts, @hiero-ledger/hiero-contracts, KYC/freeze/pause compliance,
HIP-1215 scheduled ops — what's met vs. roadmap). Adds a candid 'what's live vs. roadmap'
section: admin-gated underwriting, KYC provider, and the simulated reward cashflow are
deliberate hackathon control surfaces with on-chain foundations in place, not omissions.
Matches the deployed reality (vault 0x4B821d6b…, Sourcify-verified, live on Vercel).
Adds the MIT LICENSE file the README references.
- Fix the app emoji: 🗽 (not 🪙); keep 🪙 only where it cites the '🪙 Tokenization on
  Hedera' track name.
- Drop the per-header emojis for a standard, restrained README style (à la viem /
  Foundry / OpenZeppelin) so a reviewer/devrel lands on familiar structure; realign the
  table-of-contents anchors to the clean headers.
…x stale HSS docs

- WaferVault: remove the unused FeeHelper base (residue from the removed custom-fee
  design, D11) — never called; empty fee arrays are built via IHederaTokenService.
- MockRewardSource: delete the write-only selfScheduling mapping (vestige of the
  abandoned recursive self-drip) + the contradictory first @notice and stale DRIP_GAS
  rationale — the shipped design is a single maturity settle.
- English-only: 'virement' -> 'locked transfer' (×2) + smoke-hss header.
No behavior change; compile clean, 78 tests pass.
…ample

- Delete one-off scratch scripts finish-deploy.ts (deploy-recovery, dups deploy.ts) and
  test-redeem.ts (one-off probe) — both unreferenced anywhere.
- tsconfig.hardhat.json: include 'scripts/**/*.ts' (smoke-hss + redeploy-mock were
  silently un-typechecked).
- .env.example: drop dead HEDERA_NETWORK var.
- Delete 5 unrendered components (Beams, CardNav, Dashboard, Pools, Sidebar) + their CSS.
- Drop 4 now-unused deps (three, @react-three/fiber, @react-three/drei, gsap) — imported
  only by the deleted components; -63 packages.
- Strip 126 lines of dead CSS (.sb* sidebar block + Beams backdrop). Build green.
…dress residue

- Move French prep (DEMO/PITCH/ONE-PAGER.fr) and internal artifacts (TRACKS, AUDIT,
  superpowers/specs, art-refs) to a gitignored notes/ dir — public docs = README, SPEC,
  ONE-PAGER.md, CONTRIBUTING, LICENSE.
- SPEC: remove dead vault 0xc452D2 + present-tense the migration section (it shipped).
- README: complete the scripts tree, fix SPEC.md location, drop the now-local AUDIT link.
Two jobs on push/PR: contracts (pnpm install + compile + typecheck + 78 tests, no
network) and web (build). Catches regressions and signals maturity.
Redeployed the dead-code-free contract to Hedera Testnet and re-verified on Sourcify
(full match). Lifecycle re-proven by pnpm run smoke (NAV 1.0->1.1 repaid/burn, default
write-down 1.16->0.80, live SaucerSwap pair). Synced deployments/testnet.json + the
README address table to the new vault 0x8Fb4439f…fb311; fixed a stale HIP-1215 self-drip
test description (single maturity settle, not recursive).
pnpm/action-setup@v4 requires an explicit version (or a packageManager field); both jobs
were failing at setup before any step ran. Pin version: 10.
Add a prominent callout — winner of the 'Tokenization on Hedera' bounty at ETHGlobal
New York 2026, selected by the Hedera team — framing the RWA→on-chain story (KYC-gated
fund share, full credit lifecycle, HIP-1215 settlement, live + verified).
Reframe the award callout to sell the win itself — ETHGlobal NY 2026's scale (486
hackers, 682 attendees, 44 countries, 6 continents) and the Hedera team's selection —
instead of re-explaining the product (already covered below).
The Live app / Contract / Verified-source text links pointed to the same destinations as
the demo / Hedera Testnet / Sourcify badges above them. Keep the badges (they also carry
status), remove the redundant row.
Copilot AI review requested due to automatic review settings June 16, 2026 19:36
@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
wafer Ready Ready Preview, Comment Jun 16, 2026 7:36pm

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@gamween gamween merged commit 5d7e7b1 into main Jun 16, 2026
6 checks passed
@gamween gamween deleted the docs/readme-refactor branch June 16, 2026 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants