perpcity-sdk 0.2.1

Rust SDK for the PerpCity perpetual futures protocol on Base L2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Open a maker (LP) position on PerpCity.
//!
//! Demonstrates the maker flow:
//! 1. Query the current mark price
//! 2. Calculate a ±5% price range centered around mark
//! 3. Estimate liquidity for the desired margin
//! 4. Open the maker position
//!
//! **Note:** Makers are currently subject to a 7-day lockup, so the position
//! cannot be closed immediately after opening.
//!
//! # Running
//!
//! ```bash
//! # Set these in .env or export them:
//! export RPC_URL="https://sepolia.base.org"
//! export PERPCITY_PRIVATE_KEY="0x..."
//! export PERPCITY_MANAGER="0x..."
//! export PERPCITY_PERP_ID="0x..."
//! cargo run --example open_maker
//! ```

use alloy::primitives::{Address, B256, U256, address};
use alloy::signers::local::PrivateKeySigner;
use perpcity_sdk::math::liquidity::estimate_liquidity;
use perpcity_sdk::math::tick::{align_tick_down, align_tick_up, price_to_tick};
use perpcity_sdk::*;
use std::env;

fn env_or(key: &str, default: &str) -> String {
    env::var(key).unwrap_or_else(|_| default.into())
}

#[tokio::main]
async fn main() -> Result<()> {
    dotenvy::dotenv().ok();
    let rpc_url = env_or("RPC_URL", "https://sepolia.base.org");

    // -- Connect --
    let transport = HftTransport::new(
        TransportConfig::builder()
            .shared_endpoint(&rpc_url)
            .build()?,
    )?;

    let signer: PrivateKeySigner = env::var("PERPCITY_PRIVATE_KEY")
        .expect("set PERPCITY_PRIVATE_KEY")
        .parse()
        .unwrap();

    let deployments = Deployments {
        perp_manager: env::var("PERPCITY_MANAGER")
            .expect("set PERPCITY_MANAGER")
            .parse::<Address>()
            .unwrap(),
        usdc: address!("C1a5D4E99BB224713dd179eA9CA2Fa6600706210"),
        fees_module: None,
        margin_ratios_module: None,
        lockup_period_module: None,
        sqrt_price_impact_limit_module: None,
    };

    let client = PerpClient::new(transport, signer, deployments, 84532)?;
    println!("connected to {rpc_url}");

    // -- Warm caches --
    client.sync_nonce().await?;
    client.refresh_gas().await?;
    client.ensure_approval(U256::MAX).await?;

    // -- Read market state --
    let perp_id: B256 = env::var("PERPCITY_PERP_ID")
        .expect("set PERPCITY_PERP_ID")
        .parse()
        .unwrap();

    let mark = client.get_mark_price(perp_id).await?;
    println!("mark price: {mark:.2}");

    // -- Calculate tick range (±5% around mark) --
    let tick_spacing = constants::TICK_SPACING;
    let price_lower = mark * 0.95;
    let price_upper = mark * 1.05;

    let tick_lower = align_tick_down(price_to_tick(price_lower)?, tick_spacing);
    let tick_upper = align_tick_up(price_to_tick(price_upper)?, tick_spacing);
    println!("range: {price_lower:.2} – {price_upper:.2} (ticks {tick_lower}..{tick_upper})");

    // -- Estimate liquidity for 100 USDC margin --
    let margin = 100.0;
    let margin_scaled = (margin * 1_000_000.0) as u128;
    let liquidity_u256 = estimate_liquidity(tick_lower, tick_upper, margin_scaled)?;
    let max_u120: u128 = (1u128 << 120) - 1;
    let liquidity: u128 = u128::try_from(liquidity_u256)
        .unwrap_or(max_u120)
        .min(max_u120);
    println!("liquidity: {liquidity}");

    // -- Open maker position --
    let pos_id = client
        .open_maker(
            perp_id,
            &OpenMakerParams {
                margin,
                price_lower,
                price_upper,
                liquidity,
                max_amt0_in: u128::MAX,
                max_amt1_in: u128::MAX,
            },
            Urgency::Normal,
        )
        .await?
        .pos_id;
    println!("opened maker position {pos_id}");
    println!("note: this position is subject to a 7-day lockup before it can be closed");

    Ok(())
}