Ultimate Synthetic Delta Neutral - USDN

Using from Other Projects

To import contracts, interfaces or ABIs into other projects, you can use one of the following options:

Soldeer

[forge] soldeer install @smardex-usdn-contracts~1.1.0

NPM, pnpm

npm i @smardex/usdn-contracts
pnpm add @smardex/usdn-contracts

JSR

deno add jsr:@smardex/usdn-contracts
bunx jsr add @smardex/usdn-contracts
pnpm i jsr:@smardex/usdn-contracts

Install Development Environment

Foundry

To install Foundry, run the following commands in your terminal:

curl -L https://foundry.paradigm.xyz | bash
source ~/.bashrc
foundryup

Dependencies

To install existing dependencies, run the following commands:

forge soldeer install
npm install

The forge soldeer install command is only used to add libraries for the smart contracts. Other dependencies should be managed with npm.

In order to add a new dependency, use the forge soldeer install [packagename]~[version] command with any package from the soldeer registry.

For instance, to add OpenZeppelin library version 5.0.2:

forge soldeer install @openzeppelin-contracts~5.0.2

The last step is to update the remappings array in the foundry.toml config file.

You must have Node.js >= 20 installed.

Nix

If using nix, the repository provides a development shell in the form of a flake.

The devshell can be activated with the nix develop command.

To automatically activate the dev shell when opening the workspace, install direnv (available on nixpkgs) and run the following command inside this folder:

direnv allow

The environment provides the following tools:

• load .env file as environment variables
• foundry
• lcov
• Node 20 + Typescript
• Rust toolchain
• just
• lintspec
• mdbook
• trufflehog
• typst (with gyre-fonts)
• test_utils dependencies

Usage

Tests

Compile the test utils by running the following command at the root of the repo (requires the Rust toolchain):

cargo build --release

This requires some dependencies to build (the m4 lib notably). Using the provided nix devShell should provide everything.

To run tests, use forge test -vvv or npm run test.

Deployment Scripts

Deployment for anvil forks should be done with a custom bash script at script/fork/deployFork.sh which can be run without arguments. It must set up any environment variable required by the foundry deployment script.

Deployment for mainnet should be done with a custom bash script at script/deployMainnet.sh. To know which variables are required, run the following command:

script/deployMainnet.sh --help

All information about the script can be found in the script/ folder's README.

Docker Anvil Fork

You can deploy the contracts to an anvil fork using docker. The following commands will build the docker image and run the deployment script.

docker build -t usdn-anvil .
docker run --rm -it -p 8545:8545 usdn-anvil script/deployFork.sh

Foundry Documentation

For comprehensive details on Foundry, refer to the Foundry book.

Helpful Resources

• Forge Cheat Codes
• Forge Commands
• Cast Commands

Code Standards and Tools

Forge Formatter

Foundry comes with a built-in code formatter that we configured like this (default values were omitted):

[profile.default.fmt]
line_length = 120 # Max line length
bracket_spacing = true # Spacing the brackets in the code
wrap_comments = true # use max line length for comments as well
number_underscore = "thousands" # add underscore separators in large numbers

Husky

The pre-commit configuration for Husky runs forge fmt --check to check the code formatting before each commit. It also checks for any private key in the codebase with trufflehog.

In order to setup the git pre-commit hook, run npm install.

Contributors

Implemented by Stéphane Ballmer, Lilyan Bastien, Valentin Bersier, Yoan Capron, Sami Darnaud, Nicolas Decosterd, Léo Fasano, Alfred Gaillard, Paul-Alexandre Tessier