feat(PSDK-584): Read contract support

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Added
+
+- Support for read_contract to read from smart contracts
+
 ## [0.0.5] - 2024-10-3
 
 ### Added

cdp/client/__init__.py

@@ -98,6 +98,7 @@
 from cdp.client.models.network_identifier import NetworkIdentifier
 from cdp.client.models.payload_signature import PayloadSignature
 from cdp.client.models.payload_signature_list import PayloadSignatureList
+from cdp.client.models.read_contract_request import ReadContractRequest
 from cdp.client.models.seed_creation_event import SeedCreationEvent
 from cdp.client.models.seed_creation_event_result import SeedCreationEventResult
 from cdp.client.models.server_signer import ServerSigner
@@ -112,6 +113,7 @@
 from cdp.client.models.smart_contract_list import SmartContractList
 from cdp.client.models.smart_contract_options import SmartContractOptions
 from cdp.client.models.smart_contract_type import SmartContractType
+from cdp.client.models.solidity_value import SolidityValue
 from cdp.client.models.sponsored_send import SponsoredSend
 from cdp.client.models.staking_balance import StakingBalance
 from cdp.client.models.staking_context import StakingContext

cdp/client/api/smart_contracts_api.py

@@ -20,8 +20,10 @@
 from typing_extensions import Annotated
 from cdp.client.models.create_smart_contract_request import CreateSmartContractRequest
 from cdp.client.models.deploy_smart_contract_request import DeploySmartContractRequest
+from cdp.client.models.read_contract_request import ReadContractRequest
 from cdp.client.models.smart_contract import SmartContract
 from cdp.client.models.smart_contract_list import SmartContractList
+from cdp.client.models.solidity_value import SolidityValue
 
 from cdp.client.api_client import ApiClient, RequestSerialized
 from cdp.client.api_response import ApiResponse
@@ -1217,3 +1219,304 @@ def _list_smart_contracts_serialize(
         )
 
 
+
+
+    @validate_call
+    def read_contract(
+        self,
+        network_id: StrictStr,
+        contract_address: StrictStr,
+        read_contract_request: ReadContractRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> SolidityValue:
+        """Read data from a smart contract
+
+        Perform a read operation on a smart contract without creating a transaction
+
+        :param network_id: (required)
+        :type network_id: str
+        :param contract_address: (required)
+        :type contract_address: str
+        :param read_contract_request: (required)
+        :type read_contract_request: ReadContractRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._read_contract_serialize(
+            network_id=network_id,
+            contract_address=contract_address,
+            read_contract_request=read_contract_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SolidityValue",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def read_contract_with_http_info(
+        self,
+        network_id: StrictStr,
+        contract_address: StrictStr,
+        read_contract_request: ReadContractRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[SolidityValue]:
+        """Read data from a smart contract
+
+        Perform a read operation on a smart contract without creating a transaction
+
+        :param network_id: (required)
+        :type network_id: str
+        :param contract_address: (required)
+        :type contract_address: str
+        :param read_contract_request: (required)
+        :type read_contract_request: ReadContractRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._read_contract_serialize(
+            network_id=network_id,
+            contract_address=contract_address,
+            read_contract_request=read_contract_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SolidityValue",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def read_contract_without_preload_content(
+        self,
+        network_id: StrictStr,
+        contract_address: StrictStr,
+        read_contract_request: ReadContractRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Read data from a smart contract
+
+        Perform a read operation on a smart contract without creating a transaction
+
+        :param network_id: (required)
+        :type network_id: str
+        :param contract_address: (required)
+        :type contract_address: str
+        :param read_contract_request: (required)
+        :type read_contract_request: ReadContractRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._read_contract_serialize(
+            network_id=network_id,
+            contract_address=contract_address,
+            read_contract_request=read_contract_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SolidityValue",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _read_contract_serialize(
+        self,
+        network_id,
+        contract_address,
+        read_contract_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if network_id is not None:
+            _path_params['network_id'] = network_id
+        if contract_address is not None:
+            _path_params['contract_address'] = contract_address
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if read_contract_request is not None:
+            _body_params = read_contract_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v1/networks/{network_id}/smart_contracts/{contract_address}/read',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

cdp/client/models/__init__.py

@@ -64,6 +64,7 @@
 from cdp.client.models.network_identifier import NetworkIdentifier
 from cdp.client.models.payload_signature import PayloadSignature
 from cdp.client.models.payload_signature_list import PayloadSignatureList
+from cdp.client.models.read_contract_request import ReadContractRequest
 from cdp.client.models.seed_creation_event import SeedCreationEvent
 from cdp.client.models.seed_creation_event_result import SeedCreationEventResult
 from cdp.client.models.server_signer import ServerSigner
@@ -78,6 +79,7 @@
 from cdp.client.models.smart_contract_list import SmartContractList
 from cdp.client.models.smart_contract_options import SmartContractOptions
 from cdp.client.models.smart_contract_type import SmartContractType
+from cdp.client.models.solidity_value import SolidityValue
 from cdp.client.models.sponsored_send import SponsoredSend
 from cdp.client.models.staking_balance import StakingBalance
 from cdp.client.models.staking_context import StakingContext