Documentation Index
Fetch the complete documentation index at: https://tech.ramses.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Ramses Concepts
This section explains the on-chain mechanics that show up throughout the Ramses contracts, API, and integration guides.What is Ramses?
Ramses is a concentrated-liquidity DEX with:- Weekly period-based liquidity accounting
- Gauge-directed emissions
- Protocol-fee routing to treasury and voter markets
- An address-based governance stack built around
xRAM,VoteModule,Voter, andAccessHub - A liquid governance wrapper exposed through
R33/hyperRAM
Core Mechanics
1. Concentrated liquidity with weekly accounting
Ramses extends Uniswap V3-style pools with weekly accounting that is later used by gauges and reward distributors.2. Non-custodial gauge rewards
CL positions can earn rewards without moving the underlying pool liquidity into a separate staking contract.3. xRAM governance stack
The current governance model is address-based:-
XRam.solconverts RAM into transfer-restrictedxRAM -
VoteModule.solholds staked xRAM and exposes voting power -
Voter.solstores votes for the next weekly period -
FeeDistributor.solpays rewards to voter addresses based on periodized vote weight - Learn about Token Contracts & Emissions →
4. Liquid governance wrapper
R33.sol is the vault contract for the liquid governance wrapper. The token it mints is hyperRAM, an ERC4626 share token backed by xRAM staked in VoteModule.
5. Governance routing through AccessHub
Operational changes across pools, gauges, xRAM, fee routing, and vault automation are coordinated throughAccessHub.
Key Concepts to Understand
| Concept | Description | Learn More |
|---|---|---|
| Concentrated Liquidity | Providing liquidity inside custom price ranges | Guide |
| Weekly Periods | Contract time is tracked as block.timestamp / 1 weeks | Guide |
| GaugeV3 | CL emissions distribution for active pools | Guide |
| xRAM | Transfer-restricted governance token created from RAM | Guide |
| VoteModule | Contract that holds staked xRAM and exposes voting power | Guide |
| Voter | Tracks votes, gauges, emissions, and claims | Guide |
| hyperRAM | ERC4626 liquid wrapper minted by R33.sol | Guide |
| AccessHub | Role, multisig, and timelock control layer | Guide |
| API | Indexed and on-chain data surface for pools and protocol metrics | Guide |
Getting Started
For Traders
- Understand concentrated liquidity and swaps
- Learn pool fee behavior and pool selection
- Explore pool and route concepts
For Liquidity Providers
- Learn how active ranges work
- Understand weekly reward accounting
- Review the contracts overview
For Governance Participants
- Learn how RAM, xRAM, VoteModule, and Voter fit together
- Review xRAM conversion and exit semantics
- Read the Voter reference
For Developers and Integrators
- Review the contracts overview
- Use the REST API overview
- Explore the contract references
- Follow the local environment guide
Additional Resources
- Ramses V3 Contracts Repository
- ConsenSys Diligence Audit
- Cantina / Spearbit Audit
- Code4rena Audit Report
- Contract Addresses
- Research Papers
