Carson Roscoe 30a847d7d1
feat: New Python SDK with v2 support (#841)
* chore: renamed python/x402 to python/legacy

* feat: initial Python core SDK

* feat: added core HTTP wrappers

* feat: added core types

* feat: added evm mechanism for exact v1/v2

* feat: added httpx client

* feat: added requests client

* feat: added fastapi middleware

* feat: added flask middleware

* feat: added integration tests

* feat: added Python SDK to e2e tests

* python-v2: fix workflow checks (#863)

* fix format

* fix lint

* fix build

* fix pytest

* Fix syntax errors and missing imports in manual integration example (#902)

- Add missing imports (base64, json, Response, JSONResponse, PaymentPayload, FacilitatorClient)
- Fix function signature syntax error
- Fix dict initialization syntax (colon to equals)
- Add missing return statement after successful payment
- Remove trailing whitespace

* feat: add Python SDK v2 server examples (FastAPI, Flask)  (#879)

* feat: add fastapi example project configuration

* feat: add fastapi example with x402 payment middleware

* docs: add comprehensive README for fastapi example

* feat: add flask example project configuration

* feat: add flask example with x402 payment middleware

* docs: add comprehensive README for flask example

* feat: add test clients for fastapi and flask examples

* docs: add test client usage to READMEs

* chore - remove python-version and test-client.py

* docs - remove test client guide from README.md

* chore - remove license and classifier

* feat - add description and mime type

* feat - update .env-local

* feat: add Python v2 client examples (httpx & requests) (#857)

* feat: add Python v2 client examples (httpx & requests)

Add simple client examples demonstrating httpx (async) and requests (sync) usage with the x402 Python v2 SDK.

- examples/python/clients/example.py - Simple example showing both httpx and requests
- Uses EthAccountSigner with register_exact_evm_client helper
- Minimal configuration required

* refactor: split Python client examples into separate directories

Address PR review feedback:
- Separate httpx/ and requests/ directories
- Add pyproject.toml for uv sync support
- Add environment variable validation
- Add payment response header extraction
- Use context manager for requests session cleanup

Tested on Base Sepolia testnet:
- httpx: tx 0xce49f668aba01c4b0b1af2eb0d9a381f4c62295506a91f20af479e0e834ef350
- requests: tx 0xb83b6feefa5a744b7779ba5b37df33f9c7241f58119454d66102acd97a92f024

* Update examples/python/clients/httpx/main.py

Co-authored-by: phdargen <pdargent@icloud.com>

* Update examples/python/clients/requests/main.py

Co-authored-by: phdargen <pdargent@icloud.com>

---------

Co-authored-by: phdargen <pdargent@icloud.com>

* feat(python): Make v2 framework and client dependencies optional extras (#901)

* python-v2: add svm mechanism (#904)

* add svm mechanism

* add unit tests

* add integration tests

* update server examples

* add e2e tests

* update clients

* make EVM/SVM dependencies optional extras

* fix legacy uv paths

* V2 python bazaar (#929)

* add bazaar extension

* strip query params for discovery

* fix 862

* updated e2e tests

* Add advanced Python client examples (#947)

* Add advanced Python client examples

Implements 5 advanced patterns demonstrating x402 SDK v2 features:
- hooks.py: Payment lifecycle hooks (before, after, failure)
- preferred_network.py: Custom network preference selector
- builder_pattern.py: Network-specific registration with wildcards
- error_recovery.py: Error classification and recovery strategies
- custom_transport.py: Custom httpx transport with retry/timing

Includes:
- CLI entry point (index.py) for running examples
- Comprehensive test suite (40 unit tests)
- E2E integration tests
- README documentation

All tests passing.

* Remove tests and examples beyond TypeScript SDK parity

Address PR review feedback:
- Remove tests directory (tests belong in SDK, not examples)
- Remove custom_transport.py (runtime error, beyond TS parity)
- Remove error_recovery.py (duplicate of hooks.py, beyond TS parity)
- Update index.py, README.md, pyproject.toml accordingly

* Address PR feedback: add SVM support and use optional deps

- Update pyproject.toml to use x402[evm,svm,httpx] instead of
  listing dependencies separately
- Add Solana/SVM network examples to preferred_network.py
- Support both EVM and SVM signers for cross-chain flexibility
- Update .env-local with SOLANA_PRIVATE_KEY option

* Python-v2: facilitator example + e2e (#950)

* add facilitator example

* improve svm signer

* add description to DiscoveredResource

* add facilitator e2e

* add paywall builder (#953)

* Add Python custom client example (#954)

Demonstrates manual x402 v2 payment flow without convenience wrappers.

Shows the 6-step process:
1. Initialize client and register payment schemes
2. Make initial request, receive 402
3. Decode PAYMENT-REQUIRED header
4. Create signed payment payload
5. Retry with PAYMENT-SIGNATURE header
6. Handle success/failure response

Useful for integrating with non-standard HTTP libraries or implementing
custom retry logic.

* feat(v2-sdk): support async dynamic hooks for price and metadata (#900)

* feat(http): implement dual class design for sync/async support

- Add x402HTTPResourceServer (async) for FastAPI/Starlette
- Add x402HTTPResourceServerSync (sync) for Flask/Django
- Share common logic via _x402HTTPServerBase
- Remove dynamic description/resource (keep only dynamic price/payTo)
- Update Flask middleware to use sync server directly
- Integrate with enrich_extensions for bazaar support
- Add per-route hook_timeout_seconds configuration

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(types): add missing Awaitable import and fix test import sorting

- Add Awaitable import to types.py for DynamicPayTo/DynamicPrice type hints
- Fix import block sorting in test_async_hooks.py and test_core.py

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor: simplify API by removing unused types and making timeout opt-in

Address reviewer feedback from @phdargen:
- Remove SyncDynamicPayTo/SyncDynamicPrice (unused types that would require SyncPaymentOption to be useful)
- Change hook_timeout_seconds default to None (opt-in, matching TS/Go parity)
- Export x402HTTPResourceServerSync from http/__init__.py

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

* python-v2: make create_facilitator_config work with both V1 and V2 (#968)

* make create_facilitator_config work with both V1 and V2

* fix lint

* feat: add Python SDK v2 server advanced example (FastAPI) (#952)

* feat - add pyproject.toml, uv.lock for advanced example

* feat - add bazaar extension

* feat - add hooks

* feat - add x402 extensions to pyproject.toml

* feat - add dynamic pricing feature

* feat - add dynamic pay-to and custom money parser features

* docs - add README for advanced server example

* style - apply lint

* chore - add comments for bazaar extension code

* fix: python v2 x402HTTPAdapter retry logic (#978)

* fix: fix consecutive payment bug in x402HTTPAdapter

- Replace instance-level _is_retry flag with per-request header
  to prevent state leakage between consecutive 402 requests.

* tests - add test case for consecutive payment with x402HTTPAdapter

* style - apply lint

* Python-v2: async lifecycle hooks (#975)

* add dual sync/async classes for server/client/facilitator

* update integration/e2e tests

* add unit tests for core, http and implement wrapHttpxWithPaymentFromConfig/wrapRequestsWithPayment

* refactor core server/client/facilitator

* refactor x402_http_server/facilitator_client/x402_http_client

* update exmamples

* add utility function that takes care of html-safe escaping

* add sdk readmes

* add retry unit tests to httpx client

* Update Python SDK Docs for v2 (#976)

* Porting docs and updating for v2 changes (#813)

* porting docs and updating for v2 changes

* update quickstart for sellers

* update quickstarts, miniapps, and mcp docs

* update doc links

* update FAQs

* fix getting started docs

* update core concepts

* remove miniapps guide

* update extensions

* fix bazaar code examples

* fix broken links and yaml file

* remove unnecessary protocol layer doc

* add migration guide

* update documentation for python v2 sdk

* testing pr preview

* docs(python): remove unused os imports and align with TS tab patterns

- Remove unused 'import os' from FastAPI and Flask examples in quickstart-for-sellers
- Update bazaar-discovery-layer Python example to use hardcoded '0xYourPrivateKey' to match TypeScript tab consistency

* update migration doc

* cleanup comments

* cleanup readme

* fix: Python facilitator e2e code

* fix: lint

---------

Co-authored-by: phdargen <p.dargent@cern.ch>
Co-authored-by: somesome <57699892+sohw400@users.noreply.github.com>
Co-authored-by: Logan Kang <kcs93023@gmail.com>
Co-authored-by: 1bcMax <viewitter@gmail.com>
Co-authored-by: phdargen <pdargent@icloud.com>
Co-authored-by: Vladimir Sotnikov <bubert9@gmail.com>
Co-authored-by: Shuhei <shuhei0866@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Faris Habib <faris.habib@coinbase.com>
2026-01-21 16:32:07 -08:00

239 lines
6.5 KiB
Python

"""x402 Facilitator Example.
FastAPI-based facilitator service that verifies and settles payments
on-chain for the x402 protocol.
Supports:
- EVM networks (Base Sepolia) via web3.py
- SVM networks (Solana Devnet) via solders
Run with: uvicorn main:app --port 4022
"""
import os
import sys
from dotenv import load_dotenv
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from solders.keypair import Keypair
from x402 import x402Facilitator
from x402.mechanisms.evm import FacilitatorWeb3Signer
from x402.mechanisms.evm.exact import register_exact_evm_facilitator
from x402.mechanisms.svm import FacilitatorKeypairSigner
from x402.mechanisms.svm.exact import register_exact_svm_facilitator
# Load environment variables
load_dotenv()
# Configuration
PORT = int(os.environ.get("PORT", "4022"))
# Validate required environment variables
if not os.environ.get("EVM_PRIVATE_KEY"):
print("❌ EVM_PRIVATE_KEY environment variable is required")
sys.exit(1)
if not os.environ.get("SVM_PRIVATE_KEY"):
print("❌ SVM_PRIVATE_KEY environment variable is required")
sys.exit(1)
# Initialize the EVM signer from private key
evm_signer = FacilitatorWeb3Signer(
private_key=os.environ["EVM_PRIVATE_KEY"],
rpc_url=os.environ.get("EVM_RPC_URL", "https://sepolia.base.org"),
)
print(f"EVM Facilitator account: {evm_signer.get_addresses()[0]}")
# Initialize the SVM signer from private key
svm_keypair = Keypair.from_base58_string(os.environ["SVM_PRIVATE_KEY"])
svm_signer = FacilitatorKeypairSigner(svm_keypair)
print(f"SVM Facilitator account: {svm_signer.get_addresses()[0]}")
# Async hook functions for the facilitator
async def before_verify_hook(ctx):
print(f"Before verify: {ctx.payment_payload}")
async def after_verify_hook(ctx):
print(f"After verify: {ctx.result}")
async def verify_failure_hook(ctx):
print(f"Verify failure: {ctx.error}")
async def before_settle_hook(ctx):
print(f"Before settle: {ctx.payment_payload}")
async def after_settle_hook(ctx):
print(f"After settle: {ctx.result}")
async def settle_failure_hook(ctx):
print(f"Settle failure: {ctx.error}")
# Initialize the x402 Facilitator with EVM and SVM support
facilitator = (
x402Facilitator()
.on_before_verify(before_verify_hook)
.on_after_verify(after_verify_hook)
.on_verify_failure(verify_failure_hook)
.on_before_settle(before_settle_hook)
.on_after_settle(after_settle_hook)
.on_settle_failure(settle_failure_hook)
)
# Register EVM and SVM schemes
register_exact_evm_facilitator(
facilitator,
evm_signer,
networks="eip155:84532", # Base Sepolia
deploy_erc4337_with_eip6492=True,
)
register_exact_svm_facilitator(
facilitator,
svm_signer,
networks="solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1", # Devnet
)
# Pydantic models for request/response
class VerifyRequest(BaseModel):
"""Verify endpoint request body."""
paymentPayload: dict
paymentRequirements: dict
class SettleRequest(BaseModel):
"""Settle endpoint request body."""
paymentPayload: dict
paymentRequirements: dict
# Initialize FastAPI app
app = FastAPI(
title="x402 Facilitator",
description="Verifies and settles x402 payments on-chain",
version="2.0.0",
)
@app.post("/verify")
async def verify(request: VerifyRequest):
"""Verify a payment against requirements.
Args:
request: Payment payload and requirements to verify.
Returns:
VerifyResponse with isValid and payer (if valid) or invalidReason.
"""
try:
from x402.schemas import PaymentRequirements, parse_payment_payload
# Parse payload (auto-detects V1/V2) and requirements
payload = parse_payment_payload(request.paymentPayload)
requirements = PaymentRequirements.model_validate(request.paymentRequirements)
# Verify payment (await async method)
response = await facilitator.verify(payload, requirements)
return {
"isValid": response.is_valid,
"payer": response.payer,
"invalidReason": response.invalid_reason,
}
except Exception as e:
print(f"Verify error: {e}")
raise HTTPException(status_code=500, detail=str(e))
@app.post("/settle")
async def settle(request: SettleRequest):
"""Settle a payment on-chain.
Args:
request: Payment payload and requirements to settle.
Returns:
SettleResponse with success, transaction, network, and payer.
"""
try:
from x402.schemas import PaymentRequirements, parse_payment_payload
# Parse payload (auto-detects V1/V2) and requirements
payload = parse_payment_payload(request.paymentPayload)
requirements = PaymentRequirements.model_validate(request.paymentRequirements)
# Settle payment (await async method)
response = await facilitator.settle(payload, requirements)
return {
"success": response.success,
"transaction": response.transaction,
"network": response.network,
"payer": response.payer,
"errorReason": response.error_reason,
}
except Exception as e:
print(f"Settle error: {e}")
# Check if this was an abort from hook
if "aborted" in str(e).lower():
return {
"success": False,
"errorReason": str(e),
"network": request.paymentPayload.get("accepted", {}).get("network", "unknown"),
"transaction": "",
}
raise HTTPException(status_code=500, detail=str(e))
@app.get("/supported")
async def supported():
"""Get supported payment kinds and extensions.
Returns:
SupportedResponse with kinds, extensions, and signers.
"""
try:
response = facilitator.get_supported()
return {
"kinds": [
{
"x402Version": k.x402_version,
"scheme": k.scheme,
"network": k.network,
"extra": k.extra,
}
for k in response.kinds
],
"extensions": response.extensions,
"signers": response.signers,
}
except Exception as e:
print(f"Supported error: {e}")
raise HTTPException(status_code=500, detail=str(e))
@app.get("/health")
async def health():
"""Health check endpoint."""
return {"status": "ok"}
if __name__ == "__main__":
import uvicorn
print(f"Facilitator listening on port {PORT}")
uvicorn.run(app, host="0.0.0.0", port=PORT)