circle-smart-contract-platform 8.1.1

Circle Contracts

circle-smart-contract-platform

This is the Circle Contracts API documentation.

• API version: 1.0
• Package version: 8.1.1

Requirements.

Python 3.7+

Installation

pip install

pip install circle-smart-contract-platform

Then import the package:

from circle.web3 import smart_contract_platform

Usage

1. Generate an API key, if you haven't already, in the Web3 Services Console. 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

export CIRCLE_WEB3_API_KEY="Your API KEY"

2. Register an entity secret following Circle's Developer-Controlled QuickStart. 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

export CIRCLE_ENTITY_SECRET="Your entity secret"

3. Initiate API client

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:

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 and QuickStart guides 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: Check out our official Developer-Controlled Wallets QuickStart.
• 🎮 Join our Discord Community: Engage, learn, and collaborate.
• 🛎 Visit our Help-Desk Page: Dive into curated FAQs and guides.
• 📧 Direct Email: We're always a message away.
• 📖 Read docs: Check out our developer documentation. Happy coding!