github.com/cowprotocol/cow-sdk @cow-sdk-v9.2.2

Test coverage

Coverage of the @cowprotocol/sdk-trading package. See the Package Structure section for links to each package's README, which shows its own coverage.

Statements	Branches	Functions	Lines

Use CoW Protocol

Check @cowprotocol/cow-sdk to learn how to trade on the CoW Protocol (get quote, verify amounts, sign and send order)

Supported chains

CoW Swap is currently available on the following chains:

• Ethereum (1)
• BNB (56)
• Gnosis Chain (100)
• Polygon (137)
• Base (8453)
• Plasma (9745)
• Arbitrum One (42161)
• Avalanche (43114)
• Ink (57073)
• Linea (59144)
• Sepolia (11155111) (Testnet)

Technical Overview

This is a TypeScript monorepo containing the complete CoW Protocol SDK ecosystem. The repository is organized into multiple packages that provide different levels of abstraction and functionality for interacting with CoW Protocol.

Monorepo Architecture

The project uses modern tooling for efficient development and publishing:

• 🏗️ Build System: Turbo for fast, incremental builds and task orchestration
• 📦 Package Manager: pnpm v10.8+ with workspaces for efficient dependency management
• 🔧 TypeScript: Shared TypeScript configuration across all packages
• 🧪 Testing: Jest for unit testing with coverage reporting
• 📋 Linting: ESLint v9+ with TypeScript support and unused imports detection
• 🎨 Formatting: Prettier for consistent code formatting
• 📦 Publishing: Release Please for automated versioning and publishing
• ⚡ Development: Node.js 22+ required

Package Structure

🎯 Main SDK Package

• @cowprotocol/cow-sdk - Complete package that re-exports all other packages for easy consumption

🔧 Core Trading Packages

• @cowprotocol/sdk-trading - High-level trading SDK with built-in quote fetching, order signing, and posting
• @cowprotocol/sdk-order-book - Order book API client for retrieving orders, trades, and posting orders
• @cowprotocol/sdk-order-signing - Cryptographic utilities for signing orders and cancellations

🌉 Advanced Features

• @cowprotocol/sdk-bridging - Cross-chain token transfers and bridging functionality
• @cowprotocol/sdk-composable - Programmatic orders (TWAP, conditional orders, etc.)
• @cowprotocol/sdk-cow-shed - Account abstraction with smart contract capabilities

🔌 Provider Adapters

• @cowprotocol/sdk-viem-adapter - Viem blockchain library adapter
• @cowprotocol/sdk-ethers-v6-adapter - Ethers.js v6 adapter
• @cowprotocol/sdk-ethers-v5-adapter - Ethers.js v5 adapter

📚 Supporting Packages

• @cowprotocol/sdk-app-data - AppData schema definitions and metadata handling
• @cowprotocol/sdk-config - Configuration constants and chain settings
• @cowprotocol/sdk-common - Common utilities, types, and shared functionality
• @cowprotocol/sdk-contracts-ts - TypeScript contract bindings and ABI definitions
• @cowprotocol/sdk-subgraph - GraphQL client for CoW Protocol subgraph data
• @cowprotocol/sdk-weiroll - Weiroll integration utilities

🛠️ Development Packages

• @cow-sdk/typescript-config - Shared TypeScript configuration

Development Workflow

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

# Run tests with coverage and update README coverage badges
pnpm coverage:badges

# Run linting
pnpm lint

# Format code
pnpm format

# Type checking
pnpm typecheck

# Clean build artifacts
pnpm clean

Contributing

We welcome contributions to the CoW Protocol SDK! Here's how to get started:

🚀 Quick Start

1. Fork the repository on GitHub
2. Clone your fork locally: bash git clone https://github.com/YOUR_USERNAME/cow-sdk.git cd cow-sdk
3. Follow the Development Workflow above to set up your environment
4. Make your changes following our Contributor Guidelines
5. Create a pull request short after creating it, you will be asked to sign the CLA (Contributor License Agreement). A comment with instructions will be added to the PR.

📚 Need Help?

• Check existing issues for similar problems
• Join our Discord for community support
• Read the CoW Protocol documentation