Skip to main content

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.

​
Quick Start

mkdir ramses-integration-example
cd ramses-integration-example
npm init -y
npm add --save-dev hardhat @uniswap/v3-periphery @uniswap/v3-core
npx hardhat init
Then hop to the Local Node with a Mainnet Fork section to complete your setup.

​
Start from Scratch

​
Set Up Dependencies

$ npm init

$ npm add --save-dev hardhat
Initialize Hardhat and follow the prompts (use a templated JS or TS project): 
$ npx hardhat init
Install the V3 contract interfaces: 
$ npm add @uniswap/v3-periphery @uniswap/v3-core
Ramses V3 uses interfaces compatible with Uniswap V3, so you can use the @uniswap/v3-periphery and @uniswap/v3-core npm packages for interface definitions. The actual contract addresses will differ based on the chain you’re deploying to.
Set the Solidity compiler version in ./hardhat.config.js: 
// ...
module.exports = {
  solidity: "0.7.6",
};
Verify your setup: 
$ npx hardhat compile

​
Local Node with a Mainnet Fork

See the SDK getting started guide for a full example on how to use forks. Run tests against your local fork: 
$ npx hardhat test --network localhost