circle-smart-contract-platform


Namecircle-smart-contract-platform JSON
Version 6.3.0 PyPI version JSON
download
home_pageNone
SummaryCircle Contracts
upload_time2025-07-08 16:15:18
maintainerNone
docs_urlNone
authorOpenAPI Generator community
requires_pythonNone
licenseNone
keywords openapi openapi-generator circle contracts
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # circle-smart-contract-platform
This is the Circle Contracts API documentation.

- API version: 1.0
- Package version: 6.3.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, Circle Contracts",
    "author": "OpenAPI Generator community",
    "author_email": "team@openapitools.org",
    "download_url": "https://files.pythonhosted.org/packages/19/57/5db50521d36ea8d3deb55098a086b1e958141e303ae4eff6853c6f808897/circle_smart_contract_platform-6.3.0.tar.gz",
    "platform": null,
    "description": "# circle-smart-contract-platform\nThis is the Circle Contracts API documentation.\n\n- API version: 1.0\n- Package version: 6.3.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": "Circle Contracts",
    "version": "6.3.0",
    "project_urls": null,
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " circle contracts"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "627a39733d418332d49b9fe7a38946c83a29fe57905ba95a258278a23e970277",
                "md5": "0bbec9f5383f1f4dd183b4efe3d81959",
                "sha256": "d7b49e2122474cbfb077e8928f083dcc58663f6fc2cc48d3b00f05bc8ec0b5f0"
            },
            "downloads": -1,
            "filename": "circle_smart_contract_platform-6.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0bbec9f5383f1f4dd183b4efe3d81959",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 96911,
            "upload_time": "2025-07-08T16:15:17",
            "upload_time_iso_8601": "2025-07-08T16:15:17.645942Z",
            "url": "https://files.pythonhosted.org/packages/62/7a/39733d418332d49b9fe7a38946c83a29fe57905ba95a258278a23e970277/circle_smart_contract_platform-6.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "19575db50521d36ea8d3deb55098a086b1e958141e303ae4eff6853c6f808897",
                "md5": "9b8af24d73fac68f96a3448ebb8ddd69",
                "sha256": "54dd122b3f07fda44232e9bc4a14190c705f8ebdb861af4e0c23569e42ef5760"
            },
            "downloads": -1,
            "filename": "circle_smart_contract_platform-6.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9b8af24d73fac68f96a3448ebb8ddd69",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 53398,
            "upload_time": "2025-07-08T16:15:18",
            "upload_time_iso_8601": "2025-07-08T16:15:18.994515Z",
            "url": "https://files.pythonhosted.org/packages/19/57/5db50521d36ea8d3deb55098a086b1e958141e303ae4eff6853c6f808897/circle_smart_contract_platform-6.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 16:15:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "circle-smart-contract-platform"
}
        
Elapsed time: 0.75147s