chore: update readme with new contracts and add missing constants

[johnletey]

---

Summary by CodeRabbit

• New Features

  • Added three new predeployed contract address constants to improve integration with on-chain services.

• Documentation

  • Updated README to document the new contract interfaces and address constants, providing clearer reference for Solidity consumers.

[coderabbitai]

Warning

Rate limit exceeded

@johnletey has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 9 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.

📥 Commits

Reviewing files that changed from the base of the PR and between e7cc04e and 6cf2655.

📒 Files selected for processing (2)

• src/interfaces/IRegistrar.sol
• src/interfaces/IValidatorManager.sol

📝 Walkthrough

Walkthrough

README updated to list src/Constants.sol and an interfaces subdirectory; src/Constants.sol gained three new address constants: TOKEN_ADDRESS, VALIDATOR_MANAGER_ADDRESS, and REGISTRAR_ADDRESS.

Changes

Cohort / File(s)	Summary
Documentation README.md	Contracts section expanded to enumerate src/Constants.sol and an interfaces subdirectory with IRegistrar.sol and IValidatorManager.sol.
Constants src/Constants.sol	Added three new predeployed address constants: TOKEN_ADDRESS, VALIDATOR_MANAGER_ADDRESS, and REGISTRAR_ADDRESS (inserted alongside existing constants).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• chore: move constants to dedicated file #4: Also modifies src/Constants.sol to add/move predeployed address constants and establishes the pattern extended here.

Poem

🐰 I nibble on lines of code so neat,
Three new addresses find their seat,
TOKEN, VALIDATOR, REGISTRAR in a row,
Constants planted — watch them grow! ✨

🚥 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 title accurately describes the main changes: updating the README with new contracts and adding missing constants to Constants.sol.
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 chore/update-readme-and-constants

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.