Skip to content

docs: sync READMEs with the v0.4.0 architecture#67

Merged
aguilar1x merged 2 commits into
devfrom
docs/sync-readmes
Jun 23, 2026
Merged

docs: sync READMEs with the v0.4.0 architecture#67
aguilar1x merged 2 commits into
devfrom
docs/sync-readmes

Conversation

@aguilar1x

@aguilar1x aguilar1x commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs all four READMEs with the v0.4.0 architecture (single-tenant vaults + factory + open issuance). No code changes — docs only.

contracts/vc-vault/README.md — full rewrite

The old README described the defunct multi-tenant model. Updated to the current ABI:

  • Removed create_vault, create_sponsored_vault, authorize_issuer(s), revoke_issuer, issue_linked/get_vc_parent, the fee tiers (fee_admin/fee_standard/fee_early), fee_override, sponsors, and the ContractUpgraded event.
  • Documented the real API: single-tenant (no owner params), deny_issuer/allow_issuer, set_vault_did, push/receive_push, the 4-arg constructor, immutable contract (no upgrade), fees quoted by the factory.
  • Refreshed error codes (added 24/25/26, marked 2/3/20 deprecated), events, storage layout, and the template deploy model.

README.md (root)

  • Added the missing vc-vault-factory section.
  • Rewrote the vc-vault section (dropped "fee collection in USDC" and the stale function list).
  • Updated the testnet deployments table (new addresses + versions).
  • Fixed deploy examples for the template/factory model.
  • Corrected test counts (127/56 → 61 / 27 / 58, 146 total).

contracts/vc-vault-factory/README.md

  • Added the fee ABI (set_fee_*, quote_fee, set_min_fee) and admin ABI (nominate_admin/accept_admin/get_admin).
  • Completed the events table (10 events) and added the error-codes table (1–7).

contracts/did-stellar-registry/README.md

  • Added error 21 DuplicateServiceId.
  • Corrected the id_suffix format to ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (no leading/trailing hyphen) in both places.

Rewrites the vc-vault README and the root vc-vault section for the single-tenant + open-issuance + factory model (removes create_vault/authorize_issuer/issue_linked/sponsored/fee-tiers; documents deny/allow, the immutable contract, current errors/events). Adds the vc-vault-factory to the root README and documents its fee + admin ABI, events, and error codes. Adds did-registry error 21 (DuplicateServiceId) and corrects the id_suffix format. Updates testnet addresses and test counts.
@almanax-ai

almanax-ai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Plan expired

Your subscription has expired. Please renew your subscription to continue using CI/CD integration and other features.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@aguilar1x, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 10 minutes and 21 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

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 credits.

🚦 How do rate limits work?

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

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, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 700b504d-502a-426c-adaa-f94b2625aabf

📥 Commits

Reviewing files that changed from the base of the PR and between 7be51bb and b4c62de.

📒 Files selected for processing (4)
  • README.md
  • contracts/did-stellar-registry/README.md
  • contracts/vc-vault-factory/README.md
  • contracts/vc-vault/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-readmes

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.

@aguilar1x aguilar1x self-assigned this Jun 23, 2026
@aguilar1x aguilar1x merged commit d54e922 into dev Jun 23, 2026
4 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