Skip to content

Revise README and CI workflows for 1.1.0 deployment update#60

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

Revise README and CI workflows for 1.1.0 deployment update#60
0xdevcollins merged 5 commits into
testnetfrom
docs/readme-refresh

Conversation

@0xdevcollins

@0xdevcollins 0xdevcollins commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation

    • Updated deployment, architecture, threat-model, and runbook docs to reflect the latest contract setup and new deployment flow.
    • Clarified that profile setup now uses only an admin argument, with credits handled off-chain.
    • Added current deployment addresses and upgrade guidance.
  • Chores

    • Removed an obsolete contract deployment workflow.
    • Simplified CI checks and updated branch coverage for testnet.
  • Bug Fixes

    • Aligned deployment scripts and verification steps with the updated profile contract behavior.

0xdevcollins and others added 5 commits July 5, 2026 08:08
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>
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>
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f527223e-e5fd-4719-b42d-93402841e7d7

📥 Commits

Reviewing files that changed from the base of the PR and between 2fc00a8 and 935f406.

📒 Files selected for processing (17)
  • .env.deploy.example
  • .github/workflows/contract-deploy.yml
  • .github/workflows/rustfmt.yml
  • .github/workflows/verify-build.yml
  • README.md
  • deploy_and_upgrade.sh
  • deploy_mainnet.sh
  • docs/ARCHITECTURE.md
  • docs/DEPLOYMENT.md
  • docs/audit-2026-06-stellar-skill.md
  • docs/contract-ops-runbook.md
  • docs/mainnet-deploy-runbook.md
  • docs/multisig-guide.md
  • docs/scout-audit-report.md
  • docs/threat-model.md
  • scripts/deploy/deploy.sh
  • scripts/deploy/verify.sh

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

This PR removes on-chain bootstrap credits from the profile contract deployment flow across deploy scripts, verification scripts, documentation, runbooks, architecture/threat-model docs, and audit reports, reflecting the 1.1.0 upgrade that moved credits to an off-chain ledger. It also updates CI workflow triggers and removes chained deploy jobs, deleting the standalone contract-deploy workflow.

Changes

Bootstrap Credits Removal

Layer / File(s) Summary
Deploy and verify scripts
.env.deploy.example, deploy_and_upgrade.sh, deploy_mainnet.sh, scripts/deploy/deploy.sh, scripts/deploy/verify.sh
Removes BOOTSTRAP_CREDITS/BOOTSTRAP_PROFILE_CREDITS env validation, logging, deploy args (--default_bootstrap_credits), deployment record fields, and verification queries (get_default_bootstrap_credits); profile deploy now passes only --admin.
Runbooks and guides
docs/DEPLOYMENT.md, docs/contract-ops-runbook.md, docs/multisig-guide.md, docs/mainnet-deploy-runbook.md, README.md
Updates deployment parameter tables, required env var lists, constructor invocation examples, and verification steps to drop bootstrap credits; README adds Deployments section, revised architecture summary, and upgrade lifecycle docs.
Architecture and threat model
docs/ARCHITECTURE.md, docs/threat-model.md
Revises on-chain/off-chain boundary descriptions, cross-contract flow diagrams, data-store tables, and retires/rewords credit-related threats (Tamp.7, EoP.5, DoS.1); bumps threat-model version to 1.2.
Audit report annotations
docs/audit-2026-06-stellar-skill.md, docs/scout-audit-report.md
Adds historical notes clarifying that reports reflect pre-1.1.0 on-chain credit state, preserved as originally audited.
CI workflow cleanup
.github/workflows/rustfmt.yml, .github/workflows/verify-build.yml, .github/workflows/contract-deploy.yml
Adds testnet branch trigger to push/pull_request filters, removes chained deploy/rustfmt jobs, and deletes the standalone contract-deployment workflow.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

  • boundlessfi/boundless-contract#49: Removes the same default_bootstrap_credits/BOOTSTRAP_CREDITS constructor parameter, affecting related reputation test snapshots asserting bootstrap-credit state.

Suggested reviewers: Benjtalkshow

Poem

A rabbit hops through docs and scripts,
Snipping credits, tidying tips,
No more --default_bootstrap to type,
Off-chain ledgers now hold the hype. 🐇
Admin alone unlocks the gate,
Testnet branches now integrate!

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 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 merged commit e1f1793 into testnet Jul 7, 2026
2 of 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