Satoru keeper service 🦀

📝 Description

The keeper is an offchain service for Satoru protocol. It is responsible for:

• Watching the user initiated actions and execute them onchain, following the 2-steps process mechanism of GMX v2.

📦 Installation

📋 Prerequisites

• Rust

🛠️ Build

cargo build --release

Usage

RUST_LOG=info cargo run

Configuration

The keeper is configured using environment variables.

Name	Description
KEEPER_RPC_URL	The RPC URL of the Starket node.
KEEPER_SIGNER_PRIVATE_KEY	The private key controlling the keeper account contract.
KEEPER_ACCOUNT_ADDRESS	The address of the account contract of the keeper.
KEEPER_SATORU_EXCHANGE_ROUTER_ADDRESS	The address of the Satoru exchange router contract.

As library

#[tokio::main]
async fn main() {
    let config = KeeperConfigBuilder::default()
        .rpc_url("https://127.0.0.1:5050")
        .signer_private_key("0x...")
        .account_address("0x...")
        .build()?;
    let keeper = Keeper::new(config).await.unwrap();

    // Then you can use the keeper to execute actions.
    // keeper.execute_deposit(...);
}

📄 License

This project is licensed under the MIT license.

See LICENSE for more information.

Happy coding! 🎉

📚 Resources

Here are some resources to help you get started:

• Satoru Book
• Starknet Book
• GMX v2 resources
  • GMX Synthetics
  • Trading on v2
  • Contracts for v2
  • Liquidity on v2
• Some DeFi offchain services example implementations
  • swaps-offchain-infra
  • swaps-liquidator

🫶 Contributors ✨

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare 💻

akhercha 💻

This project follows the all-contributors specification. Contributions of any kind welcome!