# circle-smart-contract-platform
This is the Smart Contract Platform API documentation.
- API version: 1.0
- Package version: 2.1.0
## 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://developers.circle.com/interactive-quickstarts/dev-controlled-wallets#setup-your-entity-secret). 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/docs) and [QuickStart guides](https://developers.circle.com/interactive-quickstarts) 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://developers.circle.com/interactive-quickstarts): 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!
Raw data
{
"_id": null,
"home_page": null,
"name": "circle-smart-contract-platform",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Smart Contract Platform",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/fb/3e/178fe2df75f7c299f3763f16d5d22d525bf1725e3c768efc31f0ab23dfd7/circle_smart_contract_platform-2.1.0.tar.gz",
"platform": null,
"description": "# circle-smart-contract-platform\nThis is the Smart Contract Platform API documentation.\n\n- API version: 1.0\n- Package version: 2.1.0\n\n## Requirements.\n\nPython 3.7+\n\n## Installation\n### pip install\n\n```sh\npip install circle-smart-contract-platform\n```\n\nThen import the package:\n```python\nfrom circle.web3 import smart_contract_platform\n```\n\n\n## Usage\n\n1. 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\n\n```sh\nexport CIRCLE_WEB3_API_KEY=\"Your API KEY\"\n```\n\n2. Register an entity secret following Circle's [Developer-Controlled QuickStart](https://developers.circle.com/interactive-quickstarts/dev-controlled-wallets#setup-your-entity-secret). 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\n\n```sh\nexport CIRCLE_ENTITY_SECRET=\"Your entity secret\"\n```\n\n3. Initiate API client\n\n```python\nfrom circle.web3 import utils\n\nclient = utils.init_smart_contract_platform_client(api_key=\"Your API KEY\", entity_secret=\"Your entity secret\")\n```\n\n4. Interact with the client:\n\n```python\nfrom circle.web3 import smart_contract_platform\n\napi_instance = smart_contract_platform.DeployImportApi(client)\n\n# import contract\ntry:\n request = smart_contract_platform.ImportContractRequest.from_dict({\n \"name\": \"UChildERC20Proxy\",\n \"address\": \"0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174\",\n \"blockchain\": \"MATIC\"\n })\n response = api_instance.import_contract(request)\n print(response)\nexcept smart_contract_platform.ApiException as e:\n print(\"Exception when calling DeployImportApi->import_contract: %s\\n\" % e)\n```\n\nWe recommend reading through the official [documentation](https://developers.circle.com/w3s/docs) and [QuickStart guides](https://developers.circle.com/interactive-quickstarts) mentioned above to ensure a smooth setup and usage experience.\n\n## Configuration\n\nThe client accept following configuration parameters:\n\nOption | Required | Description\n------------ | ------------- | -------------\napi_key | Yes | Api Key that is used to authenticate against Circle APIs. Must be provided by ether env variable or function parameter.\nentity_secret | Yes | Your configured entity secret. Must be provided by ether env variable or function parameter.\nhost | No | Optional base URL to override the default: https://api.circle.com/v1/w3s.\nuser_agent | No | Optional custom user agent request header. We will prepend it to default user agent header if provided.\n\n\n## Need help or have questions?\n\nHere are some helpful links, if you encounter any issues or have questions about this SDK:\n\n- \ud83d\udcd6 [Getting started](https://developers.circle.com/interactive-quickstarts): Check out our official Developer-Controlled Wallets QuickStart.\n- \ud83c\udfae [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.\n- \ud83d\udece [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.\n- \ud83d\udce7 [Direct Email](mailto:customer-support@circle.com): We're always a message away.\n- \ud83d\udcd6 [Read docs](https://developers.circle.com/w3s/docs?_gl=1*15ozb5b*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Check out our developer documentation.\nHappy coding!\n",
"bugtrack_url": null,
"license": null,
"summary": "Smart Contract Platform",
"version": "2.1.0",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" smart contract platform"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2206d04a6c161bae4ee613080864a37284f3945fe04c4fc9e7781a99c5ded24",
"md5": "8d043ff6634ec5b4cbe6efbffcd47fa1",
"sha256": "9ad9dea47844cd52cbd8679a54a791486eef01439fa94187fc44ff3b600fe9f4"
},
"downloads": -1,
"filename": "circle_smart_contract_platform-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d043ff6634ec5b4cbe6efbffcd47fa1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 77503,
"upload_time": "2024-10-25T17:49:16",
"upload_time_iso_8601": "2024-10-25T17:49:16.962367Z",
"url": "https://files.pythonhosted.org/packages/d2/20/6d04a6c161bae4ee613080864a37284f3945fe04c4fc9e7781a99c5ded24/circle_smart_contract_platform-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb3e178fe2df75f7c299f3763f16d5d22d525bf1725e3c768efc31f0ab23dfd7",
"md5": "342818827313cdf2b1f4fac1f18242ab",
"sha256": "be2fd254e7008ed864db4409e89d10cfdc33185b13abe26614d790ffac517bf3"
},
"downloads": -1,
"filename": "circle_smart_contract_platform-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "342818827313cdf2b1f4fac1f18242ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 45060,
"upload_time": "2024-10-25T17:49:18",
"upload_time_iso_8601": "2024-10-25T17:49:18.932019Z",
"url": "https://files.pythonhosted.org/packages/fb/3e/178fe2df75f7c299f3763f16d5d22d525bf1725e3c768efc31f0ab23dfd7/circle_smart_contract_platform-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 17:49:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "circle-smart-contract-platform"
}
JSON