Skip to content

docs: rewrite README with deployed addresses and versions#59

Merged
0xdevcollins merged 4 commits into
testnetfrom
docs/readme-refresh
Jul 5, 2026
Merged

docs: rewrite README with deployed addresses and versions#59
0xdevcollins merged 4 commits into
testnetfrom
docs/readme-refresh

Conversation

@0xdevcollins

@0xdevcollins 0xdevcollins commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

What

Rewrites the README to match the shipped contracts and live deployments.

  • Deployments table for both networks with live version() reads:
    • Mainnet: events CCFVEGOQ…JGQZ and profile CD3KH4OE…E3PC, both 1.1.0
    • Testnet: events CBEODVJG…VTZP and profile CCA3OAIB…Q6T3, both 1.0.0
  • Contract descriptions cover all four pillars (hackathon, bounty, grant, crowdfunding) and the current profile surface (reputation + per-token earnings, lazy bootstrap).
  • Repo layout matches the actual tree (bootstrap.rs, crowdfunding.rs, profile_client.rs, scripts/admin + scripts/deploy).
  • Deploy sequence reflects the current constructors; upgrade section documents the timelocked propose / apply / migrate flow.
  • Drops external spec references and stale audit/deployment notes.

Notes

  • Addresses and versions were verified against on-chain version() reads, not copied from notes.
  • Testnet is intentionally shown at 1.0.0: it has not been upgraded since the mainnet 1.1.0 apply.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the project overview to reflect the current contract set and their responsibilities.
    • Added a deployments table with mainnet and testnet addresses plus version information.
    • Refreshed setup requirements to match the current Rust and Soroban SDK versions.
    • Expanded repository layout details and added guidance for regenerating test snapshots.
    • Replaced deployment/audit guidance with a clearer deployment and upgrade workflow, including proposal review and cancellation steps.

Replace the stale README with one that matches the shipped contracts:

- Deployments table: mainnet events/profile at 1.1.0, testnet
  events/profile at 1.0.0 (addresses + live version() reads)
- Contract descriptions cover all four pillars and the current
  profile surface (reputation + earnings, lazy bootstrap)
- Repo layout matches the tree (bootstrap.rs, crowdfunding.rs,
  profile_client.rs, scripts/admin + scripts/deploy)
- Deploy sequence reflects the current constructors; upgrade section
  documents the timelocked propose/apply/migrate flow
- Drop external spec references and stale audit/deployment notes

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@0xdevcollins, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 45 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 31cd9bff-5175-4978-9903-8a3467d06bb3

📥 Commits

Reviewing files that changed from the base of the PR and between 035f4df and a8e38d8.

📒 Files selected for processing (3)
  • .github/workflows/contract-deploy.yml
  • .github/workflows/rustfmt.yml
  • .github/workflows/verify-build.yml
📝 Walkthrough

Walkthrough

Documentation-only update to README.md replacing contract descriptions with boundless-events/boundless-profile summaries, adding a deployments table, revising the architecture paragraph, updating prerequisites, refreshing the repo layout tree, and replacing the Deployment/Audit sections with a new "Deployment and upgrades" section.

Changes

README documentation update

Layer / File(s) Summary
Overview, deployments table and architecture summary
README.md
Adds a live deployments/version table for boundless-events and boundless-profile, revises the architecture paragraph, and updates prerequisites to reference Rust 1.90.0 and Soroban SDK 23.5.x pins.
Repo layout and module listing updates
README.md
Refreshes the repo layout tree with new deployment helper scripts, adjusted workflow entries, snapshot regeneration guidance, expanded events/profile module listings, and a new "Deployment and upgrades" section replacing the old Deployment/Audit sections.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit hops through docs anew,
Tables of deploys in tidy view,
Modules listed, layouts clean,
Upgrades timelocked, safe and keen,
Thump thump — README shines through! 🐇📜

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README rewrite centered on deployed addresses and version updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-refresh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@0xdevcollins 0xdevcollins requested a review from Benjtalkshow July 5, 2026 07:10
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 5, 2026
@0xdevcollins 0xdevcollins removed the request for review from Benjtalkshow July 5, 2026 07:13
0xdevcollins and others added 2 commits July 5, 2026 08:17
rustfmt.yml: drop the workflow_call trigger, deploy job, and secret
declarations that existed only to chain into contract-deploy.yml.
verify-build.yml: drop the chained rustfmt job that called rustfmt.yml
as a reusable workflow (no longer reusable) with secrets it no longer
declares; the standalone rustfmt workflow covers the same push branches.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@0xdevcollins 0xdevcollins merged commit 2fc00a8 into testnet Jul 5, 2026
3 checks passed
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.

1 participant