An open API service indexing awesome lists of open source software.

https://github.com/primitivefinance/rmm-sdk

Typescript based entity classes and transaction builders for the rmm-core and rmm-periphery smart contracts.
https://github.com/primitivefinance/rmm-sdk

ethereum ethers primitive sdk

Last synced: 11 months ago
JSON representation

Typescript based entity classes and transaction builders for the rmm-core and rmm-periphery smart contracts.

Awesome Lists containing this project

README

          

# 🛠 rmm-sdk

![version](https://img.shields.io/npm/v/@primitivefi/rmm-sdk) ![npm](https://img.shields.io/npm/dt/@primitivefi/rmm-sdk) ![license](https://img.shields.io/npm/l/@primitivefi/rmm-sdk) ![stars](https://img.shields.io/github/stars/primitivefinance/rmm-sdk?style=social&color=%23FFB31A)

> Software development kit for Primitive RMM-01.

## 🧩 Features

- ♟ Entities are typescript models of the RMM protocol smart contracts.
- 🧰 Managers have contract ABIs and Interfaces to build function calldata with.
- 🔧 Utilities used in Entities, e.g. computing deterministic engine address and poolIds.

## 📦 Installation

> This software is in Alpha.

Installing locally:

```bash
# Clone the repository
git clone https://github.com/primitivefinance/rmm-sdk.git

# Install dependencies
yarn install
```

Installing as a package:

```bash
# Using yarn
yarn add @primitivefi/rmm-sdk

# Or using npm
npm i @primitivefi/rmm-sdk
```

## Docs

[Docs](docs/sdk/rmm-sdk.md)