From ed55c91822b9f16cb26acc4cc0370fa9edd869f2 Mon Sep 17 00:00:00 2001 From: rohan-agarwal-coinbase Date: Wed, 26 Feb 2025 20:51:47 -0700 Subject: [PATCH 1/3] Improve error message when SDK is used and not initialized (#114) --- cdp/cdp.py | 14 +++++++++++--- cdp/errors.py | 13 +++++++++++++ tests/conftest.py | 22 ++++++++++++++++++++++ tests/factories/api_key_factory.py | 4 +++- tests/test_api_key_utils.py | 3 +++ tests/test_cdp.py | 16 ++++++++++++++++ 6 files changed, 68 insertions(+), 4 deletions(-) create mode 100644 tests/test_cdp.py diff --git a/cdp/cdp.py b/cdp/cdp.py index f7a62d9..a18e7ab 100644 --- a/cdp/cdp.py +++ b/cdp/cdp.py @@ -5,7 +5,7 @@ from cdp.api_clients import ApiClients from cdp.cdp_api_client import CdpApiClient from cdp.constants import SDK_DEFAULT_SOURCE -from cdp.errors import InvalidConfigurationError +from cdp.errors import InvalidConfigurationError, UninitializedSDKError class Cdp: @@ -18,7 +18,7 @@ class Cdp: debugging (bool): Whether debugging is enabled. base_path (str): The base URL for the Platform API. max_network_retries (int): The maximum number of network retries. - api_clients (Optional[ApiClients]): The Platform API clients instance. + api_clients: The Platform API clients instance. """ @@ -30,7 +30,15 @@ class Cdp: debugging = False base_path = "https://api.cdp.coinbase.com/platform" max_network_retries = 3 - api_clients: ApiClients | None = None + + class ApiClientsWrapper: + """Wrapper that raises a helpful error when SDK is not initialized.""" + + def __getattr__(self, _name): + """Raise an error when accessing an attribute of the ApiClientsWrapper.""" + raise UninitializedSDKError() + + api_clients = ApiClientsWrapper() def __new__(cls): """Create or return the singleton instance of the Cdp class. diff --git a/cdp/errors.py b/cdp/errors.py index 03670f0..870644c 100644 --- a/cdp/errors.py +++ b/cdp/errors.py @@ -4,6 +4,19 @@ from cdp.client.exceptions import ApiException +class UninitializedSDKError(Exception): + """Exception raised when trying to access CDP API clients before SDK initialization.""" + + def __init__(self): + message = ( + "Coinbase SDK has not been initialized. Please initialize by calling either:\n\n" + + "- Cdp.configure(api_key_name='...', private_key='...')\n" + "- Cdp.configure_from_json(file_path='/path/to/api_keys.json')\n\n" + "If needed, register for API keys at https://portal.cdp.coinbase.com/ or view the docs at https://docs.cdp.coinbase.com/wallet-api/docs/welcome" + ) + super().__init__(message) + + class ApiError(Exception): """A wrapper for API exceptions to provide more context.""" diff --git a/tests/conftest.py b/tests/conftest.py index 627976e..dab2a73 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,4 +1,26 @@ import os +from unittest.mock import MagicMock + +import pytest + +from cdp import Cdp +from cdp.api_clients import ApiClients + + +@pytest.fixture(autouse=True) +def initialize_cdp(request): + """Initialize the CDP SDK with mock API clients before each test.""" + # Skip this fixture for e2e tests + if request.node.get_closest_marker("e2e"): + yield + return + + original_api_clients = Cdp.api_clients + mock_api_clients = MagicMock(spec=ApiClients) + Cdp.api_clients = mock_api_clients + yield + Cdp.api_clients = original_api_clients + factory_modules = [ f[:-3] for f in os.listdir("./tests/factories") if f.endswith(".py") and f != "__init__.py" diff --git a/tests/factories/api_key_factory.py b/tests/factories/api_key_factory.py index 1d54679..af80376 100644 --- a/tests/factories/api_key_factory.py +++ b/tests/factories/api_key_factory.py @@ -12,6 +12,7 @@ def dummy_key_factory(): - "ed25519-32": Returns a base64-encoded 32-byte Ed25519 private key. - "ed25519-64": Returns a base64-encoded 64-byte dummy Ed25519 key (the first 32 bytes will be used). """ + def _create_dummy(key_type: str = "ecdsa") -> str: if key_type == "ecdsa": return ( @@ -25,9 +26,10 @@ def _create_dummy(key_type: str = "ecdsa") -> str: return "BXyKC+eFINc/6ztE/3neSaPGgeiU9aDRpaDnAbaA/vyTrUNgtuh/1oX6Vp+OEObV3SLWF+OkF2EQNPtpl0pbfA==" elif key_type == "ed25519-64": # Create a 64-byte dummy by concatenating a 32-byte sequence with itself. - dummy_32 = b'\x01' * 32 + dummy_32 = b"\x01" * 32 dummy_64 = dummy_32 + dummy_32 return base64.b64encode(dummy_64).decode("utf-8") else: raise ValueError("Unsupported key type for dummy key creation") + return _create_dummy diff --git a/tests/test_api_key_utils.py b/tests/test_api_key_utils.py index 30f347a..21b178a 100644 --- a/tests/test_api_key_utils.py +++ b/tests/test_api_key_utils.py @@ -10,18 +10,21 @@ def test_parse_private_key_pem_ec(dummy_key_factory): parsed_key = _parse_private_key(dummy_key) assert isinstance(parsed_key, ec.EllipticCurvePrivateKey) + def test_parse_private_key_ed25519_32(dummy_key_factory): """Test that a base64-encoded 32-byte Ed25519 key is parsed correctly using a dummy key from the factory.""" dummy_key = dummy_key_factory("ed25519-32") parsed_key = _parse_private_key(dummy_key) assert isinstance(parsed_key, ed25519.Ed25519PrivateKey) + def test_parse_private_key_ed25519_64(dummy_key_factory): """Test that a base64-encoded 64-byte input is parsed correctly by taking the first 32 bytes using a dummy key from the factory.""" dummy_key = dummy_key_factory("ed25519-64") parsed_key = _parse_private_key(dummy_key) assert isinstance(parsed_key, ed25519.Ed25519PrivateKey) + def test_parse_private_key_invalid(): """Test that an invalid key string raises a ValueError.""" with pytest.raises(ValueError, match="Could not parse the private key"): diff --git a/tests/test_cdp.py b/tests/test_cdp.py new file mode 100644 index 0000000..a947ce4 --- /dev/null +++ b/tests/test_cdp.py @@ -0,0 +1,16 @@ +import pytest + +from cdp import Cdp +from cdp.errors import UninitializedSDKError + + +def test_uninitialized_error(): + """Test that direct access to API clients raises UninitializedSDKError.""" + Cdp.api_clients = Cdp.ApiClientsWrapper() + + with pytest.raises(UninitializedSDKError) as excinfo: + _ = Cdp.api_clients.wallets + + assert "Coinbase SDK has not been initialized" in str(excinfo.value) + assert "Cdp.configure(api_key_name=" in str(excinfo.value) + assert "Cdp.configure_from_json(file_path=" in str(excinfo.value) From 27b693123aaaafc53b81f06fb828f51258ed43b9 Mon Sep 17 00:00:00 2001 From: rohan-agarwal-coinbase Date: Wed, 26 Feb 2025 20:52:12 -0700 Subject: [PATCH 2/3] Update UserOperation status to support string comparison (#115) --- cdp/user_operation.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/cdp/user_operation.py b/cdp/user_operation.py index ded73a6..e78b05b 100644 --- a/cdp/user_operation.py +++ b/cdp/user_operation.py @@ -41,6 +41,16 @@ def __repr__(self) -> str: """Return a string representation of the Status.""" return str(self) + def __eq__(self, other): + """Check if the status is equal to another object. Supports string comparison.""" + if isinstance(other, str): + return self.value == other + return super().__eq__(other) + + def __hash__(self): + """Return a hash value for the enum member to allow use as dictionary keys.""" + return hash(self.name) + def __init__(self, model: UserOperationModel, smart_wallet_address: str) -> None: """Initialize the UserOperation class. From d1af7e3ca9ba7115faa3f1e0dbbaf36cd4f2ca1f Mon Sep 17 00:00:00 2001 From: rohan-agarwal-coinbase Date: Fri, 28 Feb 2025 15:03:29 -0700 Subject: [PATCH 3/3] Preparing v0.21.0 release (#116) --- CHANGELOG.md | 5 +++++ cdp/__version__.py | 2 +- docs/conf.py | 2 +- pyproject.toml | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 350d843..fcb03d8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ ## Unreleased +## [0.21.0] - 2025-02-28 + +### Added +- Ability to check UserOperation status using a string comparison. + ## [0.20.0] - 2025-02-25 ### Added diff --git a/cdp/__version__.py b/cdp/__version__.py index 5f4bb0b..6a726d8 100644 --- a/cdp/__version__.py +++ b/cdp/__version__.py @@ -1 +1 @@ -__version__ = "0.20.0" +__version__ = "0.21.0" diff --git a/docs/conf.py b/docs/conf.py index 184f31c..c6df432 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ project = 'CDP SDK' author = 'Coinbase Developer Platform' -release = '0.20.0' +release = '0.21.0' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/pyproject.toml b/pyproject.toml index a37afce..3f1c787 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "cdp-sdk" -version = "0.20.0" +version = "0.21.0" description = "CDP Python SDK" authors = ["John Peterson "] license = "LICENSE.md"