Caution
The code has not been audited yet, tread with caution.
EBO is a mechanism for clock synchronization in the multichain world. It allows The Graph to permissionlessly sync up clocks between the protocol chain (Arbitrum) and multiple other chains supported by them to pay rewards to indexers.
This project uses Foundry. To build it locally, run:
git clone [email protected]:defi-wonderland/EBO-core.git
cd EBO-core
yarn install
yarn buildMake sure to set ARBITRUM_RPC environment variable before running end-to-end tests.
| Yarn Command | Description |
|---|---|
yarn build |
Compile all contracts. |
yarn coverage |
See forge coverage report. |
yarn deploy:arbitrum |
Deploy the contracts to Arbitrum mainnet. |
yarn test |
Run all unit and integration tests. |
yarn test:unit |
Run unit tests. |
yarn test:deep |
Run unit tests with 5000 fuzz runs. |
yarn test:integration |
Run integration tests. |
EBO uses Prophet. A versatile and fully adaptable optimistic oracle solution that allows users to set custom modules to achieve the functionality they need. It works by implementing multiple modules to get the resulting block in other chains for an epoch in the protocol chain.
RequestModule
The custom EBORequestModule holds the parameters for the request. Including the epoch and the requested chain to fetch the data.
ResponseModule
EBO uses the BondedResponseModule built for Prophet which allows users to respond to a request by locking a bond.
DisputeModule
Prophet's BondEscalationModule is used to solve disputes by starting a bond escalation process.
ResolutionModule
ArbitratorModule allows an arbitrator appointed by The Graph's council to be the ultimate source of truth in case a dispute can't be closed by bond escalation.
FinalityModule
The new EBOFinalityModule emits events with the finalized data so it can be indexed by a subgraph.
AccountingExtension
Provides integration with The Graph's Horizon Staking contract for bonding tokens.
EBORequestCreator
Simplifies request creation and validates requested data.
Warning
Only allows one pair of epoch-chainId request to be active at a time.
CouncilArbitrator
Simplifies the interaction by The Graph's arbitrator with the ResolutionModule by doing multiple actions in one transaction.
- Install Foundry by following the instructions from their repository.
- Copy the
.env.examplefile to.envand fill in the variables. - Install the dependencies by running:
yarn install. In case there is an error with the commands, runfoundryupand try them again.
The default way to build the code is suboptimal but fast, you can run it via:
yarn buildIn order to build a more optimized code (via IR), run:
yarn build:optimizedUnit tests should be isolated from any externalities, while Integration usually run in a fork of the blockchain. In this boilerplate you will find example of both.
In order to run both unit and integration tests, run:
yarn testIn order to just run unit tests, run:
yarn test:unitIn order to run unit tests and run way more fuzzing than usual (5x), run:
yarn test:unit:deepIn order to just run integration tests, run:
yarn test:integrationIn order to just run the echidna fuzzing campaign (requires Echidna installed), run:
yarn test:fuzzIn order to just run the symbolic execution tests (requires Halmos installed), run:
yarn test:symbolicIn order to check your current code coverage, run:
yarn coverageConfigure the .env variables.
Import your private keys into Foundry's encrypted keystore:
cast wallet import $ARBITRUM_DEPLOYER_NAME --interactiveyarn deploy:arbitrumThe deployments are stored in ./broadcast
See the Foundry Book for available options.
TODO
EBO was built with ❤️ by Wonderland.
Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.
DeFi sucks, but Wonderland is here to make it better.