@specularl2/contracts v0.0.0-develop-20230926212139

Specular Contracts

These are the L1 contracts and L2 pre-deploys of Specular. It is configured for both Hardhat and Founrdry. Currently, Hardhat is used for deployment and Froundry is used for testing.

Setup

Install following tools:

• Node.js v16
• pnpm
• foundry

Clone the repository:

git clone https://github.com/SpecularL2/specular
git submodule update --init

Install npm packages and git hooks:

pnpm install

Go to contracts directory:

cd contracts

Setup the environment variables needed for deployment. An example config for running locally can be found in ./contracts/.env.example.

Run Tests

forge test

Local Slither Check

Install slither:

pip3 install slither-analyzer

Run slither:

slither .

Run Local Development Node

npx hardhat node

Above command will start a Ethereum node serving as L1. It can be accessed via http://localhost:8545 or ws://localhost:8545.

It is configured to mine immediately when there is any transaction, or after 5 seconds idle.

As a convention, the first funded account is the sequencer, the second is the validator.

See hardhat.config.js for detailed configuration.

See deploy/deploy.js for how contracts are deployed and initialized.

Attach to Local Development Node

npx hardhat console

Above command will start a Node.js console.

You can run const provider = waffle.provider in the console to obtain the ethers.js provider connected to the local development node.