cryptonly-x402 0.1.0__tar.gz

cryptonly_x402-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: cryptonly-x402
+Version: 0.1.0
+Summary: Cryptonly facilitator client for the x402 payment protocol.
+Author-email: Cryptonly <noreply@cryptonly.net>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/cryptonly-net/x402/tree/main/python
+Project-URL: Documentation, https://cryptonly.gitbook.io/docs
+Project-URL: Repository, https://github.com/cryptonly-net/x402
+Project-URL: Issues, https://github.com/cryptonly-net/x402/issues
+Keywords: cryptonly,x402,facilitator,payments,client,python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: x402>=2
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+
+<img src="https://raw.githubusercontent.com/cryptonly-net/.github/main/profile/assets/header-banner.svg" alt="Cryptonly" width="100%" />
+
+<div align="center">
+
+# Cryptonly — x402 facilitator
+
+Facilitator client for x402 payments.
+
+[Website](https://cryptonly.net) · [Documentation](https://cryptonly.gitbook.io/docs) · [Contact](https://cryptonly.net/contact/)
+
+</div>
+
+---
+
+Pass the async client to `x402ResourceServer` for FastAPI. Pass the sync client to `x402ResourceServerSync` for Flask.
+
+```bash
+pip install cryptonly-x402 "x402[fastapi,evm]"
+```
+
+`x402` >=2 is a dependency. Install the extra for the framework and chain you use, such as `x402[fastapi,evm]` or `x402[flask,evm]`.
+
+```python
+import os
+
+from cryptonly_x402 import CryptonlyFacilitatorClient
+from x402.mechanisms.evm.exact import ExactEvmServerScheme
+from x402.server import x402ResourceServer
+
+facilitator = CryptonlyFacilitatorClient(os.environ["CRYPTONLY_API_KEY"])
+
+server = x402ResourceServer(facilitator)
+server.register("eip155:8453", ExactEvmServerScheme())
+```
+
+`api_key` is your Cryptonly API key. It is sent as `x-tenant-api-key` on verify, settle, and supported.
+
+```python
+facilitator = CryptonlyFacilitatorClient(os.environ["CRYPTONLY_API_KEY"])
+```
+
+Flask uses the sync client:
+
+```python
+from cryptonly_x402 import CryptonlyFacilitatorClientSync
+from x402.mechanisms.evm.exact import ExactEvmServerScheme
+from x402.server import x402ResourceServerSync
+
+facilitator = CryptonlyFacilitatorClientSync(os.environ["CRYPTONLY_API_KEY"])
+
+server = x402ResourceServerSync(facilitator)
+server.register("eip155:8453", ExactEvmServerScheme())
+```
+
+Set `sandbox=True` to use the sandbox facilitator with testnest.

cryptonly_x402-0.1.0/README.md

@@ -0,0 +1,55 @@
+<img src="https://raw.githubusercontent.com/cryptonly-net/.github/main/profile/assets/header-banner.svg" alt="Cryptonly" width="100%" />
+
+<div align="center">
+
+# Cryptonly — x402 facilitator
+
+Facilitator client for x402 payments.
+
+[Website](https://cryptonly.net) · [Documentation](https://cryptonly.gitbook.io/docs) · [Contact](https://cryptonly.net/contact/)
+
+</div>
+
+---
+
+Pass the async client to `x402ResourceServer` for FastAPI. Pass the sync client to `x402ResourceServerSync` for Flask.
+
+```bash
+pip install cryptonly-x402 "x402[fastapi,evm]"
+```
+
+`x402` >=2 is a dependency. Install the extra for the framework and chain you use, such as `x402[fastapi,evm]` or `x402[flask,evm]`.
+
+```python
+import os
+
+from cryptonly_x402 import CryptonlyFacilitatorClient
+from x402.mechanisms.evm.exact import ExactEvmServerScheme
+from x402.server import x402ResourceServer
+
+facilitator = CryptonlyFacilitatorClient(os.environ["CRYPTONLY_API_KEY"])
+
+server = x402ResourceServer(facilitator)
+server.register("eip155:8453", ExactEvmServerScheme())
+```
+
+`api_key` is your Cryptonly API key. It is sent as `x-tenant-api-key` on verify, settle, and supported.
+
+```python
+facilitator = CryptonlyFacilitatorClient(os.environ["CRYPTONLY_API_KEY"])
+```
+
+Flask uses the sync client:
+
+```python
+from cryptonly_x402 import CryptonlyFacilitatorClientSync
+from x402.mechanisms.evm.exact import ExactEvmServerScheme
+from x402.server import x402ResourceServerSync
+
+facilitator = CryptonlyFacilitatorClientSync(os.environ["CRYPTONLY_API_KEY"])
+
+server = x402ResourceServerSync(facilitator)
+server.register("eip155:8453", ExactEvmServerScheme())
+```
+
+Set `sandbox=True` to use the sandbox facilitator with testnest.

cryptonly_x402-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=69"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cryptonly-x402"
+version = "0.1.0"
+description = "Cryptonly facilitator client for the x402 payment protocol."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+keywords = ["cryptonly", "x402", "facilitator", "payments", "client", "python"]
+authors = [{ name = "Cryptonly", email = "noreply@cryptonly.net" }]
+dependencies = ["x402>=2"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8"]
+
+[project.urls]
+Homepage = "https://github.com/cryptonly-net/x402/tree/main/python"
+Documentation = "https://cryptonly.gitbook.io/docs"
+Repository = "https://github.com/cryptonly-net/x402"
+Issues = "https://github.com/cryptonly-net/x402/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+cryptonly_x402 = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

cryptonly_x402-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cryptonly_x402-0.1.0/src/cryptonly_x402/__init__.py

@@ -0,0 +1,16 @@
+"""Cryptonly facilitator client for the x402 payment protocol."""
+
+from .client import CryptonlyFacilitatorClient, CryptonlyFacilitatorClientSync
+from .constants import (
+    MERCHANT_API_BASE_URL,
+    MERCHANT_API_KEY_HEADER,
+    SANDBOX_MERCHANT_API_BASE_URL,
+)
+
+__all__ = [
+    "CryptonlyFacilitatorClient",
+    "CryptonlyFacilitatorClientSync",
+    "MERCHANT_API_BASE_URL",
+    "MERCHANT_API_KEY_HEADER",
+    "SANDBOX_MERCHANT_API_BASE_URL",
+]

cryptonly_x402-0.1.0/src/cryptonly_x402/client.py

@@ -0,0 +1,70 @@
+"""Cryptonly facilitator clients for the x402 protocol."""
+
+from __future__ import annotations
+
+from x402.http import (
+    FacilitatorConfig,
+    HTTPFacilitatorClient,
+    HTTPFacilitatorClientSync,
+)
+from x402.http.facilitator_client_base import AuthHeaders
+
+from .constants import (
+    MERCHANT_API_BASE_URL,
+    MERCHANT_API_KEY_HEADER,
+    SANDBOX_MERCHANT_API_BASE_URL,
+)
+
+
+class _ApiKeyAuth:
+    """Sends the Cryptonly API key on verify, settle, and supported."""
+
+    def __init__(self, api_key: str) -> None:
+        self._headers = {MERCHANT_API_KEY_HEADER: api_key}
+
+    def get_auth_headers(self) -> AuthHeaders:
+        headers = dict(self._headers)
+        return AuthHeaders(verify=headers, settle=dict(headers), supported=dict(headers))
+
+
+def _resolve_facilitator_url(sandbox: bool) -> str:
+    origin = SANDBOX_MERCHANT_API_BASE_URL if sandbox else MERCHANT_API_BASE_URL
+    return f"{origin}/x402"
+
+
+def _require_api_key(api_key: str, client_name: str) -> str:
+    if not api_key:
+        raise TypeError(f"{client_name}: api_key is required")
+    return api_key
+
+
+class CryptonlyFacilitatorClient(HTTPFacilitatorClient):
+    """Async Cryptonly facilitator client.
+
+    Pass it to ``x402ResourceServer`` for FastAPI and other async servers.
+    """
+
+    def __init__(self, api_key: str, *, sandbox: bool = False) -> None:
+        key = _require_api_key(api_key, "CryptonlyFacilitatorClient")
+        super().__init__(
+            FacilitatorConfig(
+                url=_resolve_facilitator_url(sandbox),
+                auth_provider=_ApiKeyAuth(key),
+            )
+        )
+
+
+class CryptonlyFacilitatorClientSync(HTTPFacilitatorClientSync):
+    """Sync Cryptonly facilitator client.
+
+    Pass it to ``x402ResourceServerSync`` for Flask and other sync servers.
+    """
+
+    def __init__(self, api_key: str, *, sandbox: bool = False) -> None:
+        key = _require_api_key(api_key, "CryptonlyFacilitatorClientSync")
+        super().__init__(
+            FacilitatorConfig(
+                url=_resolve_facilitator_url(sandbox),
+                auth_provider=_ApiKeyAuth(key),
+            )
+        )

cryptonly_x402-0.1.0/src/cryptonly_x402/constants.py

@@ -0,0 +1,5 @@
+"""Cryptonly merchant API origins and the tenant API key header."""
+
+MERCHANT_API_BASE_URL = "https://api-merchant.cryptonly.net"
+SANDBOX_MERCHANT_API_BASE_URL = "https://sandbox-api-merchant.cryptonly.net"
+MERCHANT_API_KEY_HEADER = "x-tenant-api-key"

cryptonly_x402-0.1.0/src/cryptonly_x402.egg-info/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: cryptonly-x402
+Version: 0.1.0
+Summary: Cryptonly facilitator client for the x402 payment protocol.
+Author-email: Cryptonly <noreply@cryptonly.net>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/cryptonly-net/x402/tree/main/python
+Project-URL: Documentation, https://cryptonly.gitbook.io/docs
+Project-URL: Repository, https://github.com/cryptonly-net/x402
+Project-URL: Issues, https://github.com/cryptonly-net/x402/issues
+Keywords: cryptonly,x402,facilitator,payments,client,python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: x402>=2
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+
+<img src="https://raw.githubusercontent.com/cryptonly-net/.github/main/profile/assets/header-banner.svg" alt="Cryptonly" width="100%" />
+
+<div align="center">
+
+# Cryptonly — x402 facilitator
+
+Facilitator client for x402 payments.
+
+[Website](https://cryptonly.net) · [Documentation](https://cryptonly.gitbook.io/docs) · [Contact](https://cryptonly.net/contact/)
+
+</div>
+
+---
+
+Pass the async client to `x402ResourceServer` for FastAPI. Pass the sync client to `x402ResourceServerSync` for Flask.
+
+```bash
+pip install cryptonly-x402 "x402[fastapi,evm]"
+```
+
+`x402` >=2 is a dependency. Install the extra for the framework and chain you use, such as `x402[fastapi,evm]` or `x402[flask,evm]`.
+
+```python
+import os
+
+from cryptonly_x402 import CryptonlyFacilitatorClient
+from x402.mechanisms.evm.exact import ExactEvmServerScheme
+from x402.server import x402ResourceServer
+
+facilitator = CryptonlyFacilitatorClient(os.environ["CRYPTONLY_API_KEY"])
+
+server = x402ResourceServer(facilitator)
+server.register("eip155:8453", ExactEvmServerScheme())
+```
+
+`api_key` is your Cryptonly API key. It is sent as `x-tenant-api-key` on verify, settle, and supported.
+
+```python
+facilitator = CryptonlyFacilitatorClient(os.environ["CRYPTONLY_API_KEY"])
+```
+
+Flask uses the sync client:
+
+```python
+from cryptonly_x402 import CryptonlyFacilitatorClientSync
+from x402.mechanisms.evm.exact import ExactEvmServerScheme
+from x402.server import x402ResourceServerSync
+
+facilitator = CryptonlyFacilitatorClientSync(os.environ["CRYPTONLY_API_KEY"])
+
+server = x402ResourceServerSync(facilitator)
+server.register("eip155:8453", ExactEvmServerScheme())
+```
+
+Set `sandbox=True` to use the sandbox facilitator with testnest.

cryptonly_x402-0.1.0/src/cryptonly_x402.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+src/cryptonly_x402/__init__.py
+src/cryptonly_x402/client.py
+src/cryptonly_x402/constants.py
+src/cryptonly_x402/py.typed
+src/cryptonly_x402.egg-info/PKG-INFO
+src/cryptonly_x402.egg-info/SOURCES.txt
+src/cryptonly_x402.egg-info/dependency_links.txt
+src/cryptonly_x402.egg-info/requires.txt
+src/cryptonly_x402.egg-info/top_level.txt
+tests/test_client.py

cryptonly_x402-0.1.0/src/cryptonly_x402.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cryptonly_x402-0.1.0/src/cryptonly_x402.egg-info/requires.txt

@@ -0,0 +1,4 @@
+x402>=2
+
+[dev]
+pytest>=8

cryptonly_x402-0.1.0/src/cryptonly_x402.egg-info/top_level.txt

@@ -0,0 +1 @@
+cryptonly_x402

cryptonly_x402-0.1.0/tests/test_client.py

@@ -0,0 +1,33 @@
+import pytest
+
+from cryptonly_x402 import (
+    MERCHANT_API_BASE_URL,
+    MERCHANT_API_KEY_HEADER,
+    SANDBOX_MERCHANT_API_BASE_URL,
+    CryptonlyFacilitatorClient,
+    CryptonlyFacilitatorClientSync,
+)
+
+
+@pytest.mark.parametrize(
+    "client_cls",
+    [CryptonlyFacilitatorClient, CryptonlyFacilitatorClientSync],
+)
+def test_requires_an_api_key(client_cls):
+    with pytest.raises(TypeError, match="api_key is required"):
+        client_cls("")
+
+
+@pytest.mark.parametrize(
+    "client_cls",
+    [CryptonlyFacilitatorClient, CryptonlyFacilitatorClientSync],
+)
+def test_points_at_production_by_default_and_sandbox_when_asked(client_cls):
+    production = client_cls("k")
+    assert production.url == f"{MERCHANT_API_BASE_URL}/x402"
+
+    sandbox = client_cls("k", sandbox=True)
+    assert sandbox.url == f"{SANDBOX_MERCHANT_API_BASE_URL}/x402"
+    assert sandbox._get_settle_headers()[MERCHANT_API_KEY_HEADER] == "k"
+    assert sandbox._get_verify_headers()[MERCHANT_API_KEY_HEADER] == "k"
+    assert sandbox._get_supported_headers()[MERCHANT_API_KEY_HEADER] == "k"