Skip to content

keep-starknet-strange/satoru-keeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

85 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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

πŸ› οΈ 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:

🫢 Contributors ✨

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare
Abdel @ StarkWare

πŸ’»
akhercha
akhercha

πŸ’»
zarboq
zarboq

πŸ’»
bacharif
bacharif

πŸ’»

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

About

Satoru keeper service πŸ¦€.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published