Affine Protocol

This repository contains the core SDK for the Affine Protocol.

Licensing

The primary license for Affine Protocol is the Business Source License 1.1, see LICENSE.

Governance

The Protocol currently controls access to these two multi-sig addresses: Polygon: 0x47C43be6e8B0a171eab00e42226aE2d1cEFC00fB Ethereum: 0x67Ec3Bb25a5DB6eB7Ba74f6C0b2bA193A3983FB8

Pre-requisites

Foundry

See instructions for installation here.

Node

Install nvm with these instructions. Then run

nvm use

Install yarn with

npm install -g yarn

Install the dependencies:

yarn install

Install pre-commit hooks: yarn husky install

Build the typechain files

yarn build

Testing

Configuration

See .env.example for the configuration values you will need.

Manual Browser Testing

Run yarn start and simply modify src/frontend/test.ts to have whatever javascript you'd like to try out.

Unit/Integration tests

cd src/core
yarn test