Skip to content

CLAUDE.md

Latest commit

 

History

History
40 lines (27 loc) · 1.46 KB

CLAUDE.md

File metadata and controls

40 lines (27 loc) · 1.46 KB
Raw

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

CCRXT is a Rust library providing low-latency wrappers around cryptocurrency exchange APIs. The project prioritizes performance for high-frequency trading applications while maintaining strict adherence to exchange-specific rate limits and API behaviors.

Build and Run Commands

  • Build the entire project: cargo build
  • Run tests: cargo test
  • Build with release optimizations: cargo build --release
  • Run a specific example:
    • Coinbase market data: cargo run --example coinbase_market_data -- --products "BTC-USD,ETH-USD" --orderbook --ticker
    • Authenticated WebSocket: cargo run --example authenticated_websocket
  • Format code: cargo fmt
  • Run linter: cargo clippy
  • Generate documentation: cargo doc --no-deps --open

Authentication Setup

For examples requiring API authentication:

  1. Create a .env file in the venues directory
  2. Add the required tokens/keys (e.g., COINBASE_JWT_TOKEN=your_jwt_token_here)
  3. Use the dotenv crate to load environment variables in your code

Code Architecture

Workspace Structure

The project is organized into three main crates:

  • venues: Implementation of specific exchange APIs
  • websockets: Common WebSocket traits and utilities
  • rest: Common REST client traits and utilities

Architecture & Coding Standards.

@path/.cursorrules