Skip to content

defi-wonderland/xkeeper-core

Repository files navigation

xKeeper Core

License: AGPL-3.0

⚠️ The code has not been audited yet, tread with caution.

Overview

xKeeper is a keeper network aggregator which aims to decentralise the on-chain automation of DeFi. With xKeeper, using multiple keeper networks, such as Keep3r Network, Gelato, or others, will be a walk in the park.

xKeeper is a fully modular framework, designed to be the backbone of future onchain automation.

Setup

This project uses Foundry. To build it locally, run:

git clone [email protected]:defi-wonderland/xkeeper-core.git
cd xkeeper-core
yarn install
yarn build

Available Commands

Make sure to set ETHEREUM_MAINNET_RPC environment variable before running integration tests.

Yarn Command Description
yarn build Compile all contracts.
yarn coverage See forge coverage report.
yarn deploy:mainnet Deploy the contracts to mainnet.
yarn deploy:goerli Deploy the contracts to goerli testnet
yarn docs:build Generate documentation with forge doc.
yarn docs:run Start the documentation server.
yarn test Run all unit and integration tests.
yarn test:unit Run unit tests.
yarn test:integration Run integration tests.
yarn test:gas Run all unit and integration tests, and make a gas report.

Licensing

The primary license for xKeeper contracts is AGPL-3.0, see LICENSE.

Contributors

xKeeper was built with ❤️ by Wonderland.

Wonderland is the largest core development group in web3. Our commitment is to a financial future that's open, decentralized, and accessible to all.

DeFi sucks, but Wonderland is here to make it better.