search

chronicleprotocol / chronicle-std

chronicle-std provides a set of contracts used throughout the Chronicle Protocol
MIT License
3 stars 3 forks source link

readme

Chronicle Std Library • Unit Tests License: MIT

The Chronicle Std Library provides a set of contracts used throughout the Chronicle Protocol.

Contracts

src
├─ IChronicle - "Interface for Chronicle Protocol's oracle products"
├─ auth
│   ├─ Auth — "`auth` access control module"
│   └─ IAuth — "Auth's interface specification"
└─ toll
    ├─ Toll — "`toll` access control module"
    └─ IToll — "Toll's interface specification"

script
├─ Chaincheck - "Verifiable onchain configurations"
├─ IAuthChaincheck - "Chaincheck implementation for IAuth interface"
└─ ITollChaincheck - "Chaincheck implementation for IToll interface"

Installation

Install module via Foundry:

$ forge install chronicleprotocol/chronicle-std@v2

Contributing

The project uses the Foundry toolchain. You can find installation instructions here.

Setup:

$ git clone https://github.com/chronicleprotocol/chronicle-std
$ cd chronicle-std/
$ forge install

Run tests:

$ forge test
$ forge test -vvvv # Run with full stack traces
$ FOUNDRY_PROFILE=intense forge test # Run in intense mode

Lint:

$ forge fmt [--check]

Update gas snapshots:

$ forge snapshot [--check]