Kuru SDK

A comprehensive Rust SDK for interacting with the Kuru Protocol, providing orderbook management, margin trading, and meta-transaction capabilities.

Overview

The Kuru SDK enables seamless interaction with Kuru Protocol's smart contracts, offering:

• Order management (limit & market orders)
• Margin trading capabilities
• Meta-transaction support
• Real-time order tracking
• Asset management

📚 Module Documentation

Core Components

• Order Processing System

  • Multi-threaded transaction processing
  • WebSocket event handling
  • Order state management
  • Real-time status updates

• Orderbook

  • Limit order placement
  • Market order execution
  • Order cancellation
  • L2 book viewing
  • AMM integration

• Margin Account

  • Deposit management
  • Withdrawal processing
  • Balance queries
  • Margin position tracking

Supporting Systems

• Inventory System

  • Order state tracking
  • WebSocket event processing
  • Transaction monitoring
  • Status updates

• Token Management

  • ERC20 interactions
  • Balance checking
  • Allowance management

• Meta-Transaction Forwarder

  • Gasless transactions
  • Request signing
  • Transaction relaying

• Utility Functions

  • Value conversion
  • Data formatting
  • Blockchain helpers

🚀 Quick Start

use kuru_sdk::{Orderbook, MarginAccount, Token, KuruForwarder};

// Initialize core components
let orderbook = Orderbook::new("0x...", provider.clone())?;
let margin_account = MarginAccount::new("main", "0x...", provider.clone())?;
let token = Token::new("USDC", "0x...", provider.clone())?;

// Place a limit order
let (tx_hash, order_id) = orderbook.add_buy_order(
    "100.5",  // price
    "1.5",    // size
    false,    // post_only
    None,     // gas_price
    None      // gas_limit
).await?;

// Deposit to margin account
let tx_hash = margin_account.deposit(
    &user_address,
    &token,
    &amount
).await?;

🏗️ Architecture

┌─────────────────────────────────────────────────┐
│                  Kuru SDK                       │
│                                                 │
│  ┌─────────────┐  ┌──────────┐  ┌───────────┐   │
│  │  Orderbook  │  │  Margin  │  │   Meta    │   │
│  │   System    │◄─┤  Account │◄─┤   TX      │   │
│  └─────────────┘  └──────────┘  └───────────┘   │
│         ▲              ▲             ▲          │
│         │              │             │          │
│    ┌────┴──────────────┴─────────────┴───┐      │
│    │        Order Processing System      │      │
│    └────────────────────────────────────┬┘      │
│                                         │       │
│    ┌────────────────────────────────────┴─┐     │
│    │             Inventory                │     │
│    └──────────────────────────────────────┘     │
└─────────────────────────────────────────────────┘

📋 Features

• Order Management

  • Limit orders
  • Market orders
  • Post-only orders
  • Order cancellation
  • Batch operations

• Margin Trading

  • Deposit/withdrawal
  • Position management
  • Balance tracking
  • Risk monitoring

• Meta Transactions

  • Gasless trading
  • Signature verification
  • Transaction relaying

• Real-time Updates

  • WebSocket integration
  • Order status tracking
  • Event processing
  • State management

🧪 Testing

# Run all tests
cargo test