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

Primitive Replicating Market Maker smart contracts
https://github.com/primitivefinance/rmm-core

amm ethereum primitive rmm

Last synced: 5 days ago
JSON representation

Primitive Replicating Market Maker smart contracts

• Host: GitHub
• URL: https://github.com/primitivefinance/rmm-core
• Owner: primitivefinance
• License: gpl-3.0
• Created: 2021-03-26T15:29:20.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-23T13:20:01.000Z (6 months ago)
• Last Synced: 2024-12-29T11:03:37.444Z (12 days ago)
• Topics: amm, ethereum, primitive, rmm
• Language: Solidity
• Homepage: https://primitive.xyz
• Size: 6.88 MB
• Stars: 131
• Watchers: 12
• Forks: 35
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audits/README.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
![](https://pbs.twimg.com/profile_banners/1241234631707381760/1588727988/1500x500)

# Primitive Replicating Market Maker

[![](https://img.shields.io/github/stars/primitivefinance/rmm-core?style=social)](https://img.shields.io/github/stars/primitivefinance/rmm-core?style=social)

![Twitter Follow](https://img.shields.io/twitter/follow/primitivefi?style=social)

[![Tests](https://github.com/primitivefinance/rmm-core/actions/workflows/ci.yaml/badge.svg)](https://github.com/primitivefinance/rmm-core/actions/workflows/ci.yaml)

[![npm version](https://img.shields.io/npm/v/@primitivefi/rmm-core/latest.svg)](https://www.npmjs.com/package/@primitivefi/rmm-core/v/latest)

Core contracts of Primitive RMM protocol.

# Bug Bounty

This repository has a **$1,000,000** bug bounty through Immunefi. Details are on their website [https://immunefi.com/bounty/primitive](https://immunefi.com/bounty/primitive/).

# Documentation

The contract documentation is hosted here: [Primitive Docs](https://docs.primitive.finance).

# Testing

## Compile contracts

`yarn compile`

## Run typechain

`yarn typechain`

## Run the tests

`yarn test`

## Run the tests using --parallel flag

`yarn test:fast`

## Notes

Running tests using the default `yarn test` will run it through hardhat, it takes approximately 10 minutes on a good CPU.

The testing environment is unique. Make sure that `yarn typechain` has been run first, or else there could be typescript compilation issues.

The `test:fast` script makes use of the `parallel` tag, which will take up a considerable amount of CPU power. It makes the tests run faster.

In the `/test/shared/poolConfigs.ts` file is an array of different curve parameters. Each of these pools will go through the entire test suite.

**Note**: When running tests with parallel, the `swap` tests will not be logged. If the tests are frozen, it means the swap tests are the last tests to be run.

# Security

All audits are located in the `audits/` folder.