Skip to content

Fix build issue with links#125

Merged
mod merged 1 commit intomasterfrom
feat/micawp2
Mar 9, 2026
Merged

Fix build issue with links#125
mod merged 1 commit intomasterfrom
feat/micawp2

Conversation

@mod
Copy link
Contributor

@mod mod commented Mar 9, 2026

Summary by CodeRabbit

  • Documentation

    • Updated API reference documentation across multiple contract interfaces.
    • Whitepaper upgraded from v2.0 to v2.1 with expanded governance, tokenomics, technology architecture, and risk disclosures.
    • Added new comprehensive MiCA-compliant whitepaper document.
  • New Features

    • Introduced minimum slash amount configuration and per-adjudicator slash cooldown mechanics.
    • Added destination parameter to Withdrawn event.
    • Added new error types for slash operations.

@mod mod requested a review from dpatsora as a code owner March 9, 2026 20:50
@coderabbitai
Copy link

coderabbitai bot commented Mar 9, 2026

Warning

Rate limit exceeded

@mod has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 7 minutes and 56 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9fc41317-f773-4b30-864b-04886fe4000c

📥 Commits

Reviewing files that changed from the base of the PR and between 36d56dd and 87b2140.

📒 Files selected for processing (1)
  • docs/build/api/contracts/sdk/_category_.json
📝 Walkthrough

Walkthrough

This PR updates API documentation with new commit references, introduces per-adjudicator slash cooldown mechanics with minimum amount requirements to AppRegistry, updates event signatures in ILock, adds new error types to ISlash, bumps the whitepaper to v2.1 with extensive content enhancements, adds a comprehensive MiCA-compliant regulatory whitepaper, and updates the vendors/yellow submodule pointer.

Changes

Cohort / File(s) Summary
Git Source Link Updates
docs/build/api/contracts/api-reference/faucet.md, locker.md, node-registry.md, treasury.md, yellow-governor.md, yellow-token.md
Updated commit hash references in Git Source links; no functional or API changes.
AppRegistry Contract API
docs/build/api/contracts/api-reference/app-registry.md
Core slash mechanics updated: lastSlashTimestamp changed from uint256 to mapping(address => uint256) for per-adjudicator tracking; added minSlashAmount state variable and setMinSlashAmount() setter; introduced MinSlashAmountUpdated event; updated design notes on adjudicator incentives and cooldown scoping.
Event and Error Updates
docs/build/api/contracts/api-reference/interfaces/ilock.md, islash.md
ILock: Withdrawn event signature updated to include indexed destination parameter. ISlash: Two new errors added—RecipientIsUser() and SlashAmountTooLow().
Integration Documentation
docs/build/api/contracts/integration/events.md
Staking Events: Withdrawn event parameters updated with new destination field. Slashing Events: MinSlashAmountUpdated event added.
SDK and Configuration
docs/build/api/contracts/sdk/_category_.json, sdk/api-reference.md
Position metadata reordered in category file. SDK API reference: AppRegistryAbi entry count updated from 46 to 51; ISlashAbi updated from 4 to 6; deployed addresses link path updated.
Contracts Index
docs/build/api/contracts/index.md
Minor formatting: blank line added before "Deployed Addresses" section; semicolons appended to TypeScript code sample property accesses.
FAQ Reorganization
docs/build/api/contracts/faq.md
Sidebar position updated from 7 to 2 for navigation reordering.
Whitepaper v2.1 Updates
src/pages/whitepaper.md
Version bumped from v2.0 to v2.1; extensive content enhancements including: expanded governance and organizational context; detailed tokenomics and offering phases; updated technology architecture references (Nitrolite framework); refined risk/mitigation taxonomy; clarified MiCA compliance scope; updated milestones to 2026; added GitHub repository link.
Regulatory Whitepaper Document
yellow_whitepaper_v2.1.md
New comprehensive MiCA-compliant crypto-asset white paper (1209 lines) covering: issuer and management information; token offering details; underlying technology architecture; governance and rights; risk disclosures; sustainability indicators; regulatory filing history.
Submodule Update
vendors/yellow
Submodule pointer updated from commit 8abb527 to be1cb1e.

Sequence Diagram

sequenceDiagram
    participant Adj as Adjudicator
    participant AR as AppRegistry
    participant State as State Storage

    Adj->>AR: slash(recipient, amount, ...)
    
    AR->>State: Check minSlashAmount
    alt Amount < minSlashAmount
        AR-->>Adj: Revert: SlashAmountTooLow
    else Amount >= minSlashAmount
        AR->>State: Check lastSlashTimestamp[adjudicator]
        alt Current time < lastSlash + cooldown
            AR-->>Adj: Revert: SlashCooldownNotMet
        else Cooldown period passed
            AR->>State: Update lastSlashTimestamp[adjudicator]
            AR->>State: Apply slash to recipient
            AR->>Adj: Emit Slashed event
        end
    end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • dpatsora
  • dimast-x
  • philanton

Poem

🐰 Hops through hashes, old to new,
Per-adjudicator cooldowns brew,
Whitepaper crowned in v2.1 dress,
Regulations documented—what a success! 📋✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fix build issue with links' is vague and generic. While the changeset does involve documentation link updates (Git source links, event documentation links, and URL corrections in integration guides), the title doesn't convey the specific nature of these changes, using the non-descriptive term 'build issue' which could refer to many types of problems. Revise the title to be more specific about the actual changes, such as 'Update documentation links to new commit hash and add event signatures' or 'Update API reference links and document new AppRegistry/ISlash changes'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/micawp2

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.

@mod mod added this pull request to the merge queue Mar 9, 2026
Merged via the queue into master with commit b696984 Mar 9, 2026
6 checks passed
@mod mod deleted the feat/micawp2 branch March 9, 2026 20:54
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