Protocol Name

Protocol Name

Brief overview of the protocol — what it does, why it matters, and what agents can build with it.

What You Probably Got Wrong

AI agents have stale training data. This section corrects the most common mistakes.

• Wrong assumption → Correct fact (with source/date)
• Wrong assumption → Correct fact (with source/date)
• Wrong assumption → Correct fact (with source/date)

Quick Start

Installation

npm install @protocol/sdk

Basic Setup

import { Client } from '@protocol/sdk';

const client = new Client({
  rpcUrl: process.env.RPC_URL,
  // Add setup code
});

Core Concepts

Explain the protocol's key abstractions and mental models.

Concept 1

Description with code examples.

Concept 2

Description with code examples.

Common Patterns

Pattern 1: Basic Operation

// Working code example — copy-paste ready

Pattern 2: Advanced Operation

// Working code example — copy-paste ready

Contract Addresses

Last verified: YYYY-MM-DD (verified onchain via eth_getCode)

Error Handling

Troubleshooting

Common Issue 1

Symptoms, root cause, and fix.

Common Issue 2

Symptoms, root cause, and fix.

Security Considerations

• Never hardcode private keys or RPC URLs
• Always verify contract addresses onchain before interacting
• Use slippage protection on all swaps
• Test on testnet/fork before mainnet

References

• Official Docs
• GitHub
• Contract Addresses