musd Contracts

Smart contracts powering mUSD

Development

Installation

This project uses pnpm as a package manager (installation documentation).

To install dependencies run:

pnpm install

Install slither locally

brew install slither

Testing

$ pnpm test

slither .

Environment Setup

This project uses dotenv-safer, which provides environment variable checking. If there is a field in .env.example but not .env, execution will halt early with an error.

Both pnpm run deploy and pnpm test will automatically create a blank .env from the .env.example template, if .env does not exist.

To do this manually:

$ pnpm run prepare:env

Deploying

We deploy our contracts with hardhat-deploy via

$ pnpm run deploy [--network <network>]

Check the "networks" entry of hardhat.config.ts for supported networks.

Deploying to real chains will require configuring the .env environment, detailed in .env.example.

Examples:

In-Memory Hardhat (great for development)

pnpm run deploy

matsnet

To deploy contracts on Sepolia run:

$ pnpm run deploy --network matsnet