feat: Update network field to use caip2 schema BREAKING CHANGE #29
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ def require_payment( | |
| price: Union[str, int, TokenAmount], | ||
| pay_to_address: str, | ||
| resource: Optional[str] = None, | ||
| network: str = "eip155:8453", | ||
| description: str = "Payment required for this service", | ||
| message: Optional[str] = None, | ||
| ) -> x402PaymentRequiredException: | ||
|
|
@@ -34,9 +34,10 @@ def require_payment( | |
|
|
||
| Args: | ||
| price: Payment amount (e.g., "$1.00", 1.00, TokenAmount) | ||
| pay_to_address: Address to receive payment (format depends on network) | ||
| resource: Resource identifier (auto-generated if None) | ||
| network: Blockchain network in CAIP-2 format (default: "eip155:8453" for Base). | ||
| Examples: "eip155:1" (Ethereum), "bip122:000000000019d6689c085ae165831e93" (Bitcoin) | ||
| description: Human-readable description | ||
| message: Exception message (default: uses description) | ||
|
|
||
|
|
@@ -98,16 +99,16 @@ def paid_service( | |
| price: Union[str, int, TokenAmount], | ||
| pay_to_address: str, | ||
| resource: Optional[str] = None, | ||
| network: str = "eip155:8453", | ||
| description: str = "Payment required for this service", | ||
| ): | ||
| """Decorator to automatically require payment for a function or method. | ||
|
|
||
| Args: | ||
| price: Payment amount (e.g., "$1.00", 1.00, TokenAmount) | ||
| pay_to_address: Address to receive payment (format depends on network) | ||
| resource: Resource identifier (auto-generated from function name if None) | ||
| network: Blockchain network in CAIP-2 format (default: "eip155:8453" for Base) | ||
| description: Human-readable description | ||
|
|
||
| Example: | ||
|
|
@@ -149,16 +150,16 @@ def create_tiered_payment_options( | |
| pay_to_address: str, | ||
| resource: str, | ||
| tiers: Optional[List[dict]] = None, | ||
| network: str = "eip155:8453", | ||
| ) -> List[PaymentRequirements]: | ||
| """Create multiple payment options with different tiers/features. | ||
|
|
||
| Args: | ||
| base_price: Base payment amount | ||
| pay_to_address: Address to receive payment (format depends on network) | ||
| resource: Base resource identifier | ||
| tiers: List of tier definitions with 'multiplier', 'suffix', 'description' | ||
| network: Blockchain network in CAIP-2 format (default: "eip155:8453" for Base) | ||
|
|
||
| Returns: | ||
| List of PaymentRequirements for different service tiers | ||
|
|
@@ -246,7 +247,7 @@ def smart_paid_service( | |
| price: Union[str, int, TokenAmount], | ||
| pay_to_address: str, | ||
| resource: Optional[str] = None, | ||
| network: str = "eip155:8453", | ||
| description: str = "Payment required for this service", | ||
| ): | ||
| """Smart decorator that only requires payment if not already paid. | ||
|
|
@@ -256,9 +257,9 @@ def smart_paid_service( | |
|
|
||
| Args: | ||
| price: Payment amount (e.g., "$1.00", 1.00, TokenAmount) | ||
| pay_to_address: Address to receive payment (format depends on network) | ||
| resource: Resource identifier (auto-generated from function name if None) | ||
| network: Blockchain network in CAIP-2 format (default: "eip155:8453" for Base) | ||
| description: Human-readable description | ||
|
|
||
| Example: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ def create_payment_requirements( | |
| price: Price, | ||
| pay_to_address: str, | ||
| resource: str, | ||
| network: str = "eip155:8453", | ||
| description: str = "", | ||
| mime_type: str = "application/json", | ||
| scheme: str = "exact", | ||
|
|
@@ -37,10 +37,13 @@ def create_payment_requirements( | |
| price: Payment price. Can be: | ||
| - Money: USD amount as string/int (e.g., "$3.10", 0.10, "0.001") - defaults to USDC | ||
| - TokenAmount: Custom token amount with asset information | ||
| pay_to_address: Address to receive the payment (format depends on network) | ||
| resource: Resource identifier (e.g., "/generate-image") | ||
| network: Blockchain network in CAIP-2 format (default: "eip155:8453" for Base) | ||
| Examples: | ||
| - EVM chains: "eip155:1" (Ethereum), "eip155:8453" (Base), "eip155:137" (Polygon) | ||
| - Bitcoin: "bip122:000000000019d6689c085ae165831e93" (mainnet) | ||
| - Solana: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" (mainnet) description: Human-readable description | ||
| mime_type: Expected response content type | ||
| scheme: Payment scheme (default: "exact") | ||
| max_timeout_seconds: Payment validity timeout | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -102,7 +102,7 @@ async def _auto_pay(self, task, event_queue: EventQueue): | |
| from ..types import SettleResponse, x402ErrorCode | ||
|
|
||
| failure_response = SettleResponse( | ||
| success=False, network="eip155:8453", error_reason=f"Payment failed: {e}" | ||
| ) | ||
| task = self.utils.record_payment_failure( | ||
| task, x402ErrorCode.INVALID_SIGNATURE, failure_response | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -362,7 +362,7 @@ async def _fail_payment( | |
| ): | ||
| """Handle payment failure.""" | ||
| failure_response = SettleResponse( | ||
| success=False, network="eip155:8453", error_reason=error_reason | ||
| ) | ||
| task = self.utils.record_payment_failure(task, error_code, failure_response) | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,7 +37,7 @@ class x402ServerConfig(BaseModel): | |
|
|
||
| price: Union[str, int, TokenAmount] | ||
| pay_to_address: str | ||
| network: str = "eip155:8453" # Base network in CAIP-2 format | ||
| description: str = "Payment required..." | ||
| mime_type: str = "application/json" | ||
| max_timeout_seconds: int = 600 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -112,7 +112,7 @@ def for_service( | |
| price: Union[str, int, TokenAmount], | ||
| pay_to_address: str, | ||
| resource: str, | ||
| network: str = "eip155:8453", | ||
| description: str = "Payment required for this service", | ||
| message: Optional[str] = None, | ||
| ) -> "x402PaymentRequiredException": | ||
|
|
@@ -122,9 +122,9 @@ def for_service( | |
|
|
||
| Args: | ||
| price: Payment amount (e.g., "$1.00", 1.00, TokenAmount) | ||
| pay_to_address: Address to receive payment (format depends on network) | ||
| resource: Resource identifier (e.g., "/api/generate") | ||
| network: Blockchain network in CAIP-2 format (default: "eip155:8453" for Base) | ||
| description: Human-readable description | ||
| message: Exception message (default: uses description) | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -118,7 +118,7 @@ When a Client Agent requests a service, the Merchant Agent determines that payme | |
| "x402Version": 1, | ||
| "accepts": [{ | ||
| "scheme": "exact", | ||
| "network": "eip155:8453", | ||
| "resource": "https://api.example.com/generate-image", | ||
| "description": "Generate an image", | ||
| "mimeType": "application/json", | ||
|
|
@@ -202,7 +202,7 @@ The Agent **MUST** include ALL payment receipts created in the lifetime of a Tas | |
| "x402.payment.receipts": [{ | ||
| "success": true, | ||
| "transaction": "0xabc123...", | ||
| "network": "eip155:8453", | ||
| "payer": "0xpayerAddress" | ||
| }] | ||
| } | ||
|
|
@@ -338,7 +338,7 @@ The management of Task states at payment failure is at the discretion of the Mer | |
| "x402.payment.receipts": [{ | ||
| "success": false, | ||
| "errorReason": "Payment authorization was submitted after its 'validBefore' timestamp.", | ||
| "network": "eip155:8453", | ||
| "transaction": "" | ||
| }] | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The network is hardcoded to
"eip155:8453"(Base mainnet) in this failure case. This is incorrect if the payment was intended for a different network. You should use the network from thepayment_requirementsobject, which is available in this function's scope.