Smart Contract Platform
Project description
circle-smart-contract-platform
This is the Smart Contract Platform API documentation.
- API version: 1.0
- Package version: 3.0.0
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
- 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"
- 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"
- 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")
- 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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file circle_smart_contract_platform-3.0.0.tar.gz
.
File metadata
- Download URL: circle_smart_contract_platform-3.0.0.tar.gz
- Upload date:
- Size: 52.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 255054227b747401c617ad2f3591eada9d4a683f990e2bfe7d2c9ef6c32c6c41 |
|
MD5 | 6ebda2057f671497a81ec2af4ba73e40 |
|
BLAKE2b-256 | 1ed65628f0f48784d1b39e2371250899583ed30478d7ddef39d1342a311b2cbc |
File details
Details for the file circle_smart_contract_platform-3.0.0-py3-none-any.whl
.
File metadata
- Download URL: circle_smart_contract_platform-3.0.0-py3-none-any.whl
- Upload date:
- Size: 97.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81e377edd9cea1667510eb02da2dd725c8e8fa40196875a426a9189a0c3f4b0a |
|
MD5 | 05a84572662057d1d611ea9b380feab2 |
|
BLAKE2b-256 | 279feff01473e32bf3e3246351cf18e638dc81252acd49ff4360fb40e791eb88 |