Skip to content

README.md

Latest commit

 

History

History
106 lines (72 loc) · 3.01 KB

README.md

File metadata and controls

106 lines (72 loc) · 3.01 KB

PayNode Python SDK

Official Documentation PyPI Version

The official Python SDK for the PayNode Protocol (v3.1). PayNode allows autonomous AI Agents to seamlessly pay for APIs and computational resources using USDC on Base L2, utilizing the standardized HTTP 402 protocol with support for both on-chain receipts and off-chain signatures (EIP-3009).

📖 Read the Docs

For complete installation guides, advanced usage, API references, and architecture details, please visit our official documentation: 👉 docs.paynode.dev

⚡ Quick Start

Installation

pip install paynode-sdk-python web3

Agent Client (Payer)

from paynode_sdk import PayNodeAgentClient

agent = PayNodeAgentClient(
    private_key="YOUR_AGENT_PRIVATE_KEY",
    rpc_urls=["https://mainnet.base.org", "https://rpc.ankr.com/base"]
)

# Automatically handles the 402 challenge, executes the Base L2 transaction, and gets the data.
response = agent.request_gate("https://api.merchant.com/premium-data", method="POST", json={"agent": "PythonAgent"})

print(response.json())

Key Features (v2.1)

  • EIP-3009 Support: Sign payments off-chain using TransferWithAuthorization, allowing for gasless or relayer-mediated settlement.
  • X402 V2 Protocol: JSON-based handshake for more structured and machine-readable payment instructions.
  • Dual Flow: Automatic fallback to V1 (on-chain receipts) for legacy merchant support.
  • FastAPI Middleware: Easy-to-use middleware for merchants to protect their API routes.

🗺️ Roadmap

  • TRON Support: USDT (TRC-20) payment integration.
  • Solana Support: SPL USDC/USDT payment integration.
  • Cross-chain: Universal settlement via bridges.

🚀 Run the Demo

The SDK includes a complete Merchant/Agent demo in the examples/ directory.

1. Setup Environment

Copy the example environment file and fill in your keys:

cp .env.example .env
# Edit .env with your private key and RPC URLs

2. Get Test Tokens (Required for Base Sepolia)

If you're testing on Sepolia, run the helper script to mint 1,000 mock USDC:

python examples/mint_test_tokens.py

3. Run the Merchant Server (FastAPI)

python examples/fastapi_server.py

4. Run the Agent Client

In another terminal:

python examples/agent_client.py

The demo will perform a full loop: 402 Handshake -> On-chain Payment -> 200 Verification.

📦 Publishing to PyPI

To publish a new version of the SDK:

  1. Install build tools: 
    pip install build twine
  2. Build the package: 
    python -m build
  3. Upload to PyPI: 
    python -m twine upload dist/*

Built for the Autonomous AI Economy by PayNodeLabs.