Synthetix keepers

This repository contains keeper scripts for the Synthetix system. These keepers are designed to perform various automated tasks such as order settlement, liquidations, and balance management.

Features

• Flexible deployment across multiple networks (Ethereum, Base, Optimism, Arbitrum)
• Support logic for V3 perps and BFP contracts
• Order settlement for perps markets
• Account flagging and liquidations
• Balance checks and automated swaps using Odos

Components

1. main.py: Main keeper script for V3 systems
2. main_l1.py: Main keeper script for BFP system

Configuration

Create a .env.{network} file in the root directory for each of the networks listed in the docker-compose.yml file. Adjust the values as needed for your specific setup. See the .env_example file for the required variables.

Run Using Docker

You can run the keepers using docker, by configuring the docker compose figuration as you want and running it:

# mainnet
docker compose build
docker compose up

# testnet
docker compose -f docker-compose.sepolia.yml build
docker compose -f docker-compose.sepolia.yml up

Run Locally

You can also run the keepers locally using Silverback, a framework for running bots. Use the following command structure:

# V3 on base sepolia
uv run silverback run main:app --network base:sepolia:alchemy --runner silverback.runner:WebsocketRunner

Note that you must have the uv package manager installed in order to run this, otherwise you can install the pyproject.toml file using your preferred environment and package manager

Publishing images

Images can be built and published to a registry using the following commands. Before publishing, ensure that you have a github token with the read:packages and write:packages scopes and can authenticate to the ghcr.io registry.

# Make sure you are authenticated to the github registry
docker login ghcr.io

# Build the image
docker build . --platform linux/arm64 -t ghcr.io/synthetixio/keeper:0.1.0-test
docker build . --platform linux/arm64 -t ghcr.io/synthetixio/keeper:latest

# Publish the image to a package on github
docker build . --platform linux/arm64 -t ghcr.io/synthetixio/keeper:0.1.0-test
docker build . --platform linux/arm64 -t ghcr.io/synthetixio/keeper:latest