README.md

Analog's Contracts

This repository contains all the necessary ingredients for successful cross-chain development utilizing the Analog General Message Passing protocol.

Dependencies

This project uses Forge Ethereum testing framework (like Truffle, Hardhat and DappTools). Install instructions: https://book.getfoundry.sh/

Usage

Build

forge build

Test

forge test

Format

forge fmt

Gas Snapshots

forge snapshot

Documentation

Use the following command to generate project documentation:

forge doc -b

You can now read the docs from the generated mdbook as follows:

cd docs 
mdbook serve --open

License

Analog's Contracts is released under the MIT License.