circle-smart-contract-platform 0.1.0b1__tar.gz

circle_smart_contract_platform-0.1.0b1/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: circle-smart-contract-platform
+Version: 0.1.0b1
+Summary: Smart Contract Platform
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: team@openapitools.org
+Keywords: OpenAPI,OpenAPI-Generator,Smart Contract Platform
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic<2,>=1.10.5
+Requires-Dist: aenum
+Requires-Dist: pycryptodome>=3.20.0
+Requires-Dist: circle-configurations==0.1.0b1
+Requires-Dist: circle-web3-sdk-util==0.1.0b1
+
+# circle-smart-contract-platform
+This is the Smart Contract Platform API documentation.
+
+- API version: 1.0
+- Package version: 0.1.0b1
+
+## Requirements.
+
+Python 3.7+
+
+## Installation
+### pip install
+
+```sh
+pip install circle-smart-contract-platform
+```
+
+Then import the package:
+```python
+from circle.web3 import smart_contract_platform
+```
+
+
+## Usage
+
+1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/). This API key will be used for authentication and authorization when making requests to Circle's APIs. API key can be set by environment variable or function parameter
+
+```sh
+export CIRCLE_WEB3_API_KEY="Your API KEY"
+```
+
+2. Register an entity secret following Circle's [Developer-Controlled QuickStart](https://learn.circle.com/quickstarts/dev-controlled-wallets). This step ensures that your account is correctly set up to interact with Circle's APIs. Entity secret can be set by environment variable or function parameter
+
+```sh
+export CIRCLE_ENTITY_SECRET="Your entity secret"
+```
+
+3. Initiate API client
+
+```python
+from circle.web3 import utils
+
+client = utils.init_smart_contract_platform_client(api_key="Your API KEY", entity_secret="Your entity secret")
+```
+
+4. Interact with the client:
+
+```python
+from circle.web3 import smart_contract_platform
+
+api_instance = smart_contract_platform.DeployImportApi(client)
+
+# import contract
+try:
+    request = smart_contract_platform.ImportContractRequest.from_dict({
+        "name": "UChildERC20Proxy",
+        "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
+        "blockchain": "MATIC"
+    })
+    response = api_instance.import_contract(request)
+    print(response)
+except smart_contract_platform.ApiException as e:
+    print("Exception when calling DeployImportApi->import_contract: %s\n" % e)
+```
+
+We recommend reading through the official [documentation](https://developers.circle.com/w3s) and [QuickStart guides](https://learn.circle.com/) mentioned above to ensure a smooth setup and usage experience.
+
+## Configuration
+
+The client accept following configuration parameters:
+
+Option | Required | Description
+------------ | ------------- | -------------
+api_key | Yes | Api Key that is used to authenticate against Circle APIs. Must be provided by ether env variable or function parameter.
+entity_secret | Yes | Your configured entity secret. Must be provided by ether env variable or function parameter.
+host | No | Optional base URL to override the default: https://api.circle.com/v1/w3s.
+user_agent | No | Optional custom user agent request header. We will prepend it to default user agent header if provided.
+
+
+## Need help or have questions?
+
+Here are some helpful links, if you encounter any issues or have questions about this SDK:
+
+- 📖 [Getting started](https://learn.circle.com/): Check out our official Developer-Controlled Wallets QuickStart.
+- 🎮 [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.
+- 🛎 [Visit our Help-Desk Page](https://support.usdc.circle.com/hc/en-us/p/contactus?_gl=1*1va6vat*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Dive into curated FAQs and guides.
+- 📧 [Direct Email](mailto:customer-support@circle.com): We're always a message away.
+- 📖 [Read docs](https://developers.circle.com/w3s/docs?_gl=1*15ozb5b*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Check out our developer documentation.
+Happy coding!

circle_smart_contract_platform-0.1.0b1/README.md

@@ -0,0 +1,89 @@
+# circle-smart-contract-platform
+This is the Smart Contract Platform API documentation.
+
+- API version: 1.0
+- Package version: 0.1.0b1
+
+## Requirements.
+
+Python 3.7+
+
+## Installation
+### pip install
+
+```sh
+pip install circle-smart-contract-platform
+```
+
+Then import the package:
+```python
+from circle.web3 import smart_contract_platform
+```
+
+
+## Usage
+
+1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/). This API key will be used for authentication and authorization when making requests to Circle's APIs. API key can be set by environment variable or function parameter
+
+```sh
+export CIRCLE_WEB3_API_KEY="Your API KEY"
+```
+
+2. Register an entity secret following Circle's [Developer-Controlled QuickStart](https://learn.circle.com/quickstarts/dev-controlled-wallets). This step ensures that your account is correctly set up to interact with Circle's APIs. Entity secret can be set by environment variable or function parameter
+
+```sh
+export CIRCLE_ENTITY_SECRET="Your entity secret"
+```
+
+3. Initiate API client
+
+```python
+from circle.web3 import utils
+
+client = utils.init_smart_contract_platform_client(api_key="Your API KEY", entity_secret="Your entity secret")
+```
+
+4. Interact with the client:
+
+```python
+from circle.web3 import smart_contract_platform
+
+api_instance = smart_contract_platform.DeployImportApi(client)
+
+# import contract
+try:
+    request = smart_contract_platform.ImportContractRequest.from_dict({
+        "name": "UChildERC20Proxy",
+        "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
+        "blockchain": "MATIC"
+    })
+    response = api_instance.import_contract(request)
+    print(response)
+except smart_contract_platform.ApiException as e:
+    print("Exception when calling DeployImportApi->import_contract: %s\n" % e)
+```
+
+We recommend reading through the official [documentation](https://developers.circle.com/w3s) and [QuickStart guides](https://learn.circle.com/) mentioned above to ensure a smooth setup and usage experience.
+
+## Configuration
+
+The client accept following configuration parameters:
+
+Option | Required | Description
+------------ | ------------- | -------------
+api_key | Yes | Api Key that is used to authenticate against Circle APIs. Must be provided by ether env variable or function parameter.
+entity_secret | Yes | Your configured entity secret. Must be provided by ether env variable or function parameter.
+host | No | Optional base URL to override the default: https://api.circle.com/v1/w3s.
+user_agent | No | Optional custom user agent request header. We will prepend it to default user agent header if provided.
+
+
+## Need help or have questions?
+
+Here are some helpful links, if you encounter any issues or have questions about this SDK:
+
+- 📖 [Getting started](https://learn.circle.com/): Check out our official Developer-Controlled Wallets QuickStart.
+- 🎮 [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.
+- 🛎 [Visit our Help-Desk Page](https://support.usdc.circle.com/hc/en-us/p/contactus?_gl=1*1va6vat*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Dive into curated FAQs and guides.
+- 📧 [Direct Email](mailto:customer-support@circle.com): We're always a message away.
+- 📖 [Read docs](https://developers.circle.com/w3s/docs?_gl=1*15ozb5b*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Check out our developer documentation.
+Happy coding!

circle_smart_contract_platform-0.1.0b1/circle/web3/smart_contract_platform/__init__.py

@@ -0,0 +1,67 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    The version of the OpenAPI document: 1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.1.0b1"
+
+# import apis into sdk package
+from circle.web3.smart_contract_platform.api.deploy_import_api import DeployImportApi
+from circle.web3.smart_contract_platform.api.interact_api import InteractApi
+from circle.web3.smart_contract_platform.api.templates_api import TemplatesApi
+from circle.web3.smart_contract_platform.api.view_update_api import ViewUpdateApi
+
+# import ApiClient
+from circle.web3.smart_contract_platform.api_response import ApiResponse
+from circle.web3.smart_contract_platform.api_client import ApiClient
+from circle.web3.smart_contract_platform.configuration import Configuration
+from circle.web3.smart_contract_platform.exceptions import OpenApiException
+from circle.web3.smart_contract_platform.exceptions import ApiTypeError
+from circle.web3.smart_contract_platform.exceptions import ApiValueError
+from circle.web3.smart_contract_platform.exceptions import ApiKeyError
+from circle.web3.smart_contract_platform.exceptions import ApiAttributeError
+from circle.web3.smart_contract_platform.exceptions import ApiException
+
+# import models into sdk package
+from circle.web3.smart_contract_platform.models.abi_parameters_inner import AbiParametersInner
+from circle.web3.smart_contract_platform.models.blockchain import Blockchain
+from circle.web3.smart_contract_platform.models.contract import Contract
+from circle.web3.smart_contract_platform.models.contract_deployment_estimate_fee_request import ContractDeploymentEstimateFeeRequest
+from circle.web3.smart_contract_platform.models.contract_deployment_estimate_fee_response import ContractDeploymentEstimateFeeResponse
+from circle.web3.smart_contract_platform.models.contract_deployment_request import ContractDeploymentRequest
+from circle.web3.smart_contract_platform.models.contract_deployment_response import ContractDeploymentResponse
+from circle.web3.smart_contract_platform.models.contract_input_type import ContractInputType
+from circle.web3.smart_contract_platform.models.contract_response import ContractResponse
+from circle.web3.smart_contract_platform.models.contract_status import ContractStatus
+from circle.web3.smart_contract_platform.models.contracts_response import ContractsResponse
+from circle.web3.smart_contract_platform.models.deploy_contract200_response import DeployContract200Response
+from circle.web3.smart_contract_platform.models.deploy_contract_template200_response import DeployContractTemplate200Response
+from circle.web3.smart_contract_platform.models.error import Error
+from circle.web3.smart_contract_platform.models.estimate_contract_deploy200_response import EstimateContractDeploy200Response
+from circle.web3.smart_contract_platform.models.estimate_contract_template_deploy200_response import EstimateContractTemplateDeploy200Response
+from circle.web3.smart_contract_platform.models.estimate_deploy_contract_by_template_fee_request import EstimateDeployContractByTemplateFeeRequest
+from circle.web3.smart_contract_platform.models.estimate_deploy_contract_by_template_fee_response import EstimateDeployContractByTemplateFeeResponse
+from circle.web3.smart_contract_platform.models.estimated_transaction_fee import EstimatedTransactionFee
+from circle.web3.smart_contract_platform.models.event import Event
+from circle.web3.smart_contract_platform.models.fee_level import FeeLevel
+from circle.web3.smart_contract_platform.models.function import Function
+from circle.web3.smart_contract_platform.models.import_contract200_response import ImportContract200Response
+from circle.web3.smart_contract_platform.models.import_contract_request import ImportContractRequest
+from circle.web3.smart_contract_platform.models.list_contracts200_response import ListContracts200Response
+from circle.web3.smart_contract_platform.models.param_type import ParamType
+from circle.web3.smart_contract_platform.models.patch_contract_request import PatchContractRequest
+from circle.web3.smart_contract_platform.models.query_contract200_response import QueryContract200Response
+from circle.web3.smart_contract_platform.models.read_contract_state_by_id_request import ReadContractStateByIDRequest
+from circle.web3.smart_contract_platform.models.read_contract_state_request import ReadContractStateRequest
+from circle.web3.smart_contract_platform.models.read_contract_state_response import ReadContractStateResponse
+from circle.web3.smart_contract_platform.models.sol_file import SolFile
+from circle.web3.smart_contract_platform.models.template_contract_deployment_request import TemplateContractDeploymentRequest
+from circle.web3.smart_contract_platform.models.template_contract_deployment_response import TemplateContractDeploymentResponse
+from circle.web3.smart_contract_platform.models.verification_status import VerificationStatus

circle_smart_contract_platform-0.1.0b1/circle/web3/smart_contract_platform/api/__init__.py

@@ -0,0 +1,8 @@
+# flake8: noqa
+
+# import apis into api package
+from circle.web3.smart_contract_platform.api.deploy_import_api import DeployImportApi
+from circle.web3.smart_contract_platform.api.interact_api import InteractApi
+from circle.web3.smart_contract_platform.api.templates_api import TemplatesApi
+from circle.web3.smart_contract_platform.api.view_update_api import ViewUpdateApi
+