docs: document the full contract surface + remove Meteora DAMM v1#296
Merged
Conversation
Remove the Meteora DAMM v1 integration (no real use case) — contracts, tests, and scripts — and properly present what rome-solidity actually exposes: - Rewritten README, ordered by importance: precompile interfaces, CPI toolkit, SPL<->ERC-20 wrappers (both tracks), bridge, oracle, primitives. - New docs/ARCHITECTURE.md — the full catalog: every contract, what it is, why it exists, and where it is used across the ecosystem. - Document the two SPL wrapper tracks (cached vs CPI) and when to use which. - Surface the bridge (RomeBridgeWithdraw + CCTP v2 + Wormhole) and oracle (Pyth/Switchboard via Chainlink AggregatorV3Interface), which the old README did not mention at all. - Add MIT LICENSE (contracts are already MIT-SPDX; no root license file existed).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two changes
1. Remove Meteora DAMM v1 — it's a single narrow third-party liquidity-pool binding with no real use case, and it was the headline of the README while the core primitives weren't surfaced. Removed the 3 contracts + their tests + deploy scripts; verified self-contained (nothing else imports them).
setup-local.tsand a few dangling comment references cleaned up.2. Properly document the surface — the README badly under-represented what this repo is (the Solidity SDK for Rome). Now:
docs/ARCHITECTURE.md— the full catalog: every contract, what it is, why it exists, and where it's used across the ecosystem.SPL_ERC20_cachedvsSPL_ERC20) documented with a clear when-to-use.RomeBridgeWithdraw+ CCTP v2 + Wormhole) and oracle (Pyth/Switchboard via ChainlinkAggregatorV3Interface) surfaced — the old README mentioned neither.Validation
hardhat compilegreen — 86 files (was 89; the 3 DAMM contracts gone), no errors.oracle + bridge + cpi) — 209 passing.