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.

The Ramses V3 SDK

Welcome to the V3 Ramses SDK!
The Ramses V3 SDK provides abstractions to assist you with interacting with the Ramses V3 smart contracts in a Typescript/Javascript environment (e.g. websites, node scripts). It makes use of the Core SDK to gain access to abstractions that are common amongst V3-compatible SDKs. With the SDK, you can manipulate data that has been queried from the EVM using libraries that assist with needs such as data modeling, protection from rounding errors, and compile time enforced typing. To begin, we recommend looking at our Guides which include walkthroughs of core usages. These guides will help you better understand how to use the SDK and integrate it into your application. For complete documentation of the SDK’s offerings, see the Technical Reference.

Installation

To interact with the V3 SDK we recommend installing though npm:
npm i --save @kingdomdotone/v3-sdk
npm i --save @uniswap/sdk-core
The @kingdomdotone/v3-sdk is Ramses’ fork of the Uniswap V3 SDK, tailored for Ramses V3 pools. Use it alongside @uniswap/sdk-core for core token abstractions. The actual contract addresses will differ — refer to the Ramses contract addresses for your target chain.