Skip to content

Update contracts docs to v1.0.4#126

Merged
mod merged 1 commit intomasterfrom
feat/micawp3
Mar 12, 2026
Merged

Update contracts docs to v1.0.4#126
mod merged 1 commit intomasterfrom
feat/micawp3

Conversation

@mod
Copy link
Contributor

@mod mod commented Mar 12, 2026

Summary by CodeRabbit

  • New Features

    • Mainnet deployed addresses now available for NodeRegistry, AppRegistry, YellowGovernor, and TimelockController contracts with direct Etherscan links.
    • Updated SDK contract type structure with separate treasury-related fields for better organization.
  • Documentation

    • Updated contract and API reference documentation.
    • Reorganized SDK documentation structure.
  • Chores

    • Dependency version update.

@mod mod requested a review from dpatsora as a code owner March 12, 2026 18:14
@coderabbitai
Copy link

coderabbitai bot commented Mar 12, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This pull request updates API reference documentation links to a newer contract commit hash, adds mainnet deployment addresses for previously placeholder contracts, updates the Contracts SDK type definitions to separate treasury into six distinct fields, and bumps the contracts dependency version.

Changes

Cohort / File(s) Summary
API Reference Documentation
docs/build/api/contracts/api-reference/app-registry.md, docs/build/api/contracts/api-reference/faucet.md, docs/build/api/contracts/api-reference/interfaces/ilock.md, docs/build/api/contracts/api-reference/interfaces/islash.md, docs/build/api/contracts/api-reference/locker.md, docs/build/api/contracts/api-reference/node-registry.md, docs/build/api/contracts/api-reference/treasury.md, docs/build/api/contracts/api-reference/yellow-governor.md, docs/build/api/contracts/api-reference/yellow-token.md
Git Source links updated from commit dcd9928... to 11ed85c... across nine contract reference files.
Mainnet Addresses & SDK Documentation
docs/build/api/contracts/index.md, docs/build/api/contracts/sdk/api-reference.md
Mainnet Deployed Addresses table populated with actual addresses for NodeRegistry, AppRegistry, YellowGovernor, and TimelockController. ContractAddresses type updated to replace single treasury field with six separate treasury-related fields (treasuryFounder, treasuryCommunity, treasuryTokenSale, treasuryFoundation, treasuryNetwork, treasuryLiquidity).
SDK Configuration
docs/build/api/contracts/sdk/_category_.json
Category label changed from "Contracts SDK" to "SDK" and new key field added with value "contracts-sdk".
Build & Dependencies
package.json, scripts/sync-contracts-docs.js, vendors/yellow
Bumped @yellow-org/contracts from ^1.0.1 to ^1.0.4, updated documentation sync script to propagate key property to category metadata, and updated submodule pointer to newer commit.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • dpatsora

Poem

🐰 Git hashes dance in a quarterly refrain,
Treasury splits into six, not one domain,
Mainnet addresses bloom where placeholders waned,
Documentation refreshed, SDK configured with care,
The contracts SDK hops with updated flair! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately reflects the main objective of updating contracts documentation to version 1.0.4, as evidenced by the package.json bump from ^1.0.1 to ^1.0.4 and corresponding documentation updates across multiple files.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/micawp3
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

Tip

CodeRabbit can enforce grammar and style rules using `languagetool`.

Configure the reviews.tools.languagetool setting to enable/disable rules and categories. Refer to the LanguageTool Community to learn more.

@mod mod added this pull request to the merge queue Mar 12, 2026
Merged via the queue into master with commit a1fb886 Mar 12, 2026
8 of 9 checks passed
@mod mod deleted the feat/micawp3 branch March 12, 2026 18:17
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