📖 OpenBook

A CLI and library for interacting with the OpenBook market on the Solana blockchain.

Table of Contents

• Installation
• Functionalities
• Usage
• Usage as Dependency
• Options
• Contributing
• License

🚀 Installation

To install openbook cli, use the following Cargo command:

cargo install --locked openbook --all-features

✨ Functionalities

• Fetch market info in the OpenBook market.
• Place a limit bid in the OpenBook market.
• Cancel an existing order in the OpenBook market.
• Settle balances in the OpenBook market.
• Cancel settle place order in the OpenBook market.
• Cancel settle place bid order in the OpenBook market.
• Cancel settle place ask order in the OpenBook market.
• Consume events instructions in the OpenBook market.
• Consume events permissioned instructions in the OpenBook market.
• Load orders for a specific owner in the OpenBook market.
• Find open orders accounts for a specific owner in the OpenBook market.

Usage

Before using the openbook crate or CLI, make sure to set the following environment variables:

export RPC_URL=https://api.mainnet-beta.solana.com
export KEY_PATH=<path_to_your_key_file>

[!NOTE] Certain RPC methods, like getProgramAccounts, are no longer available on api.mainnet-beta.solana.com. We recommend utilizing helius.dev as an alternative.

⌨ Usage as CLI

Fetch Market Info:

openbook info

Place a limit bid order:

openbook place -t 10.0 -s bid -b 0.5 -e -p 15.0

Place a limit ask order:

openbook place -t 10.0 -s ask -b 0.5 -e -p 15.0

Cancel all limit orders:

openbook cancel -e

Settle balances:

openbook settle -e

Cancel Settle Place Order:

openbook cancel-settle-place -u 10.0 -t 0.5 -p 15.0 -a 1.3

Cancel Settle Place Bid Order:

openbook cancel-settle-place-bid -t 0.5 -b 15.0

Cancel Settle Place Ask Order:

openbook cancel-settle-place-ask -t 0.5 -a 15.0

Fetch all orders for current owner (bids + asks):

openbook load

Make match orders transaction:

openbook match --limit 3

Make consume events instruction:

openbook consume --limit 2

Make consume events permissioned instruction:

openbook consume-permissioned --limit 2

💻 Usage as Dependency

[dependencies]
openbook = "0.0.8"

use openbook::{pubkey::Pubkey, signature::Keypair, rpc_client::RpcClient};
use openbook::market::Market;
use openbook::utils::read_keypair;
use openbook::matching::Side;
use openbook::commitment_config::CommitmentConfig;
use openbook::market::OrderReturnType;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rpc_url = std::env::var("RPC_URL").expect("RPC_URL is not set in .env file");
    let key_path = std::env::var("KEY_PATH").expect("KEY_PATH is not set in .env file");

    let commitment_config = CommitmentConfig::confirmed();
    let rpc_client = RpcClient::new_with_commitment(rpc_url, commitment_config);
    
    let keypair = read_keypair(&key_path);
    
    let mut market = Market::new(rpc_client, 3, "usdc", keypair).await;

    println!("Initialized Market: {:?}", market);

    println!("[*] Place Limit Order");
    if let Some(ord_ret_type) = market
        .place_limit_order(
            10.0,
            Side::Bid, // or Side::Ask
            0.5,
            true,
            15.0,
        )
        .await?
    {
        match ord_ret_type {
            OrderReturnType::Instructions(insts) => {
                println!("[*] Got Instructions: {:?}", insts);
            }
            OrderReturnType::Signature(sign) => {
                println!("[*] Transaction successful, signature: {:?}", sign);
            }
        }
    }

    println!("[*] Cancel Orders");
    if let Some(ord_ret_type) = market
        .cancel_orders(
            true
        )
        .await?
    {
        match ord_ret_type {
            OrderReturnType::Instructions(insts) => {
                println!("[*] Got Instructions: {:?}", insts);
            }
            OrderReturnType::Signature(sign) => {
                println!("[*] Transaction successful, signature: {:?}", sign);
            }
        }
    }

    println!("[*] Settle Balance");
    if let Some(ord_ret_type) = market
        .settle_balance(
            true
        )
        .await?
    {
        match ord_ret_type {
            OrderReturnType::Instructions(insts) => {
                println!("[*] Got Instructions: {:?}", insts);
            }
            OrderReturnType::Signature(sign) => {
                println!("[*] Transaction successful, signature: {:?}", sign);
            }
        }
    }

    println!("[*] Cancel Settle Place Order");
    let result = market
        .cancel_settle_place(
            10.0,
            0.5,
            15.0,
            1.3,
        )
        .await?;
    println!("[*] Transaction successful, signature: {:?}", result);

    println!("[*] Cancel Settle Place Bid Order");
    let result = market
        .cancel_settle_place_bid(0.5, 15.0)
        .await?;
    println!("[*] Transaction successful, signature: {:?}", result);

    println!("[*] Cancel Settle Ask Order");
    let result = market
        .cancel_settle_place_ask(0.5, 15.0)
        .await?;
    println!("[*] Transaction successful, signature: {:?}", result);

    let m = market.make_match_orders_transaction(1).await?;
    println!("Match Order Result: {:?}", m);

    let open_orders_accounts = vec![Pubkey::new_from_array([0; 32])];
    let limit = 10;

    let e = market.make_consume_events_instruction(open_orders_accounts.clone(), limit).await?;
    println!("Consume Events Result: {:?}", e);

    let p = market.make_consume_events_permissioned_instruction(open_orders_accounts.clone(), limit).await?;
    println!("Consume Events Permissioned Result: {:?}", p);

    Ok(())
}

🎨 Options

🤝 Contributing

Contributions and feedback are welcome! If you'd like to contribute, report an issue, or suggest an enhancement, please engage with the project on GitHub. Your contributions help improve this CLI and library for the community.

📄 License

This project is licensed under the MIT License.