circle-developer-controlled-wallets 0.1.0b1__tar.gz

circle_developer_controlled_wallets-0.1.0b1/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.1
+Name: circle-developer-controlled-wallets
+Version: 0.1.0b1
+Summary: Developer-Controlled Wallets
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: team@openapitools.org
+Keywords: OpenAPI,OpenAPI-Generator,Developer-Controlled Wallets
+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-developer-controlled-wallets
+Developer-Controlled Wallets API documentation.
+
+- API version: 1.0
+- Package version: 0.1.0b1
+
+## Requirements.
+
+Python 3.7+
+
+## Installation
+### pip install
+
+```sh
+pip install circle-developer-controlled-wallets
+```
+
+Then import the package:
+```python
+from circle.web3 import developer_controlled_wallets
+```
+
+
+## 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_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
+```
+
+4. Interact with the client:
+
+```python
+from circle.web3 import developer_controlled_wallets
+
+api_instance = developer_controlled_wallets.WalletSetsApi(client)
+
+# create wallet sets
+try:
+    request = developer_controlled_wallets.CreateDeveloperWalletSetRequest.from_dict({
+        "name": "my_wallet_set"
+    })
+    api_instance.create_wallet_set(request)
+except developer_controlled_wallets.ApiException as e:
+    print("Exception when calling WalletSetsApi->create_wallet_set: %s\n" % e)
+
+# list wallet sets
+try:
+    response = api_instance.list_wallet_sets()
+    for wallet_set in response.data.wallet_sets:
+        print(wallet_set.id)
+except developer_controlled_wallets.ApiException as e:
+    print("Exception when calling WalletSetsApi->list_wallet_sets: %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/quickstarts/developer-controlled-wallets): 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_developer_controlled_wallets-0.1.0b1/README.md

@@ -0,0 +1,95 @@
+# circle-developer-controlled-wallets
+Developer-Controlled Wallets API documentation.
+
+- API version: 1.0
+- Package version: 0.1.0b1
+
+## Requirements.
+
+Python 3.7+
+
+## Installation
+### pip install
+
+```sh
+pip install circle-developer-controlled-wallets
+```
+
+Then import the package:
+```python
+from circle.web3 import developer_controlled_wallets
+```
+
+
+## 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_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
+```
+
+4. Interact with the client:
+
+```python
+from circle.web3 import developer_controlled_wallets
+
+api_instance = developer_controlled_wallets.WalletSetsApi(client)
+
+# create wallet sets
+try:
+    request = developer_controlled_wallets.CreateDeveloperWalletSetRequest.from_dict({
+        "name": "my_wallet_set"
+    })
+    api_instance.create_wallet_set(request)
+except developer_controlled_wallets.ApiException as e:
+    print("Exception when calling WalletSetsApi->create_wallet_set: %s\n" % e)
+
+# list wallet sets
+try:
+    response = api_instance.list_wallet_sets()
+    for wallet_set in response.data.wallet_sets:
+        print(wallet_set.id)
+except developer_controlled_wallets.ApiException as e:
+    print("Exception when calling WalletSetsApi->list_wallet_sets: %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/quickstarts/developer-controlled-wallets): 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_developer_controlled_wallets-0.1.0b1/circle/web3/developer_controlled_wallets/__init__.py

@@ -0,0 +1,108 @@
+# 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.developer_controlled_wallets.api.signing_api import SigningApi
+from circle.web3.developer_controlled_wallets.api.token_lookup_api import TokenLookupApi
+from circle.web3.developer_controlled_wallets.api.transactions_api import TransactionsApi
+from circle.web3.developer_controlled_wallets.api.wallet_sets_api import WalletSetsApi
+from circle.web3.developer_controlled_wallets.api.wallets_api import WalletsApi
+
+# import ApiClient
+from circle.web3.developer_controlled_wallets.api_response import ApiResponse
+from circle.web3.developer_controlled_wallets.api_client import ApiClient
+from circle.web3.developer_controlled_wallets.configuration import Configuration
+from circle.web3.developer_controlled_wallets.exceptions import OpenApiException
+from circle.web3.developer_controlled_wallets.exceptions import ApiTypeError
+from circle.web3.developer_controlled_wallets.exceptions import ApiValueError
+from circle.web3.developer_controlled_wallets.exceptions import ApiKeyError
+from circle.web3.developer_controlled_wallets.exceptions import ApiAttributeError
+from circle.web3.developer_controlled_wallets.exceptions import ApiException
+
+# import models into sdk package
+from circle.web3.developer_controlled_wallets.models.abi_parameters_inner import AbiParametersInner
+from circle.web3.developer_controlled_wallets.models.accelerate_transaction_for_developer_request import AccelerateTransactionForDeveloperRequest
+from circle.web3.developer_controlled_wallets.models.accelerate_transaction_for_developer_response import AccelerateTransactionForDeveloperResponse
+from circle.web3.developer_controlled_wallets.models.account_type import AccountType
+from circle.web3.developer_controlled_wallets.models.balance import Balance
+from circle.web3.developer_controlled_wallets.models.blockchain import Blockchain
+from circle.web3.developer_controlled_wallets.models.cancel_transaction_for_developer_request import CancelTransactionForDeveloperRequest
+from circle.web3.developer_controlled_wallets.models.cancel_transaction_for_developer_response import CancelTransactionForDeveloperResponse
+from circle.web3.developer_controlled_wallets.models.create_contract_execution_transaction_for_developer_request import CreateContractExecutionTransactionForDeveloperRequest
+from circle.web3.developer_controlled_wallets.models.create_contract_execution_transaction_for_developer_response import CreateContractExecutionTransactionForDeveloperResponse
+from circle.web3.developer_controlled_wallets.models.create_developer_transaction_accelerate200_response import CreateDeveloperTransactionAccelerate200Response
+from circle.web3.developer_controlled_wallets.models.create_developer_transaction_cancel200_response import CreateDeveloperTransactionCancel200Response
+from circle.web3.developer_controlled_wallets.models.create_developer_transaction_contract_execution200_response import CreateDeveloperTransactionContractExecution200Response
+from circle.web3.developer_controlled_wallets.models.create_developer_transaction_transfer200_response import CreateDeveloperTransactionTransfer200Response
+from circle.web3.developer_controlled_wallets.models.create_developer_wallet200_response import CreateDeveloperWallet200Response
+from circle.web3.developer_controlled_wallets.models.create_developer_wallet_request import CreateDeveloperWalletRequest
+from circle.web3.developer_controlled_wallets.models.create_developer_wallet_response import CreateDeveloperWalletResponse
+from circle.web3.developer_controlled_wallets.models.create_developer_wallet_set_request import CreateDeveloperWalletSetRequest
+from circle.web3.developer_controlled_wallets.models.create_developer_wallet_set_response import CreateDeveloperWalletSetResponse
+from circle.web3.developer_controlled_wallets.models.create_transfer_estimate_fee200_response import CreateTransferEstimateFee200Response
+from circle.web3.developer_controlled_wallets.models.create_transfer_transaction_for_developer_request import CreateTransferTransactionForDeveloperRequest
+from circle.web3.developer_controlled_wallets.models.create_transfer_transaction_for_developer_response import CreateTransferTransactionForDeveloperResponse
+from circle.web3.developer_controlled_wallets.models.create_validate_address200_response import CreateValidateAddress200Response
+from circle.web3.developer_controlled_wallets.models.create_wallet_set200_response import CreateWalletSet200Response
+from circle.web3.developer_controlled_wallets.models.custody_type import CustodyType
+from circle.web3.developer_controlled_wallets.models.error import Error
+from circle.web3.developer_controlled_wallets.models.estimate_contract_execution_transaction_fee_request import EstimateContractExecutionTransactionFeeRequest
+from circle.web3.developer_controlled_wallets.models.estimate_transaction_fee_response import EstimateTransactionFeeResponse
+from circle.web3.developer_controlled_wallets.models.estimate_transfer_transaction_fee_request import EstimateTransferTransactionFeeRequest
+from circle.web3.developer_controlled_wallets.models.estimated_transaction_fee import EstimatedTransactionFee
+from circle.web3.developer_controlled_wallets.models.ext_get_all_wallets_response import ExtGetAllWalletsResponse
+from circle.web3.developer_controlled_wallets.models.ext_get_wallet_by_id_response import ExtGetWalletByIDResponse
+from circle.web3.developer_controlled_wallets.models.ext_update_wallet_metadata_request import ExtUpdateWalletMetadataRequest
+from circle.web3.developer_controlled_wallets.models.ext_wallet_response import ExtWalletResponse
+from circle.web3.developer_controlled_wallets.models.ext_wallet_response_wallet import ExtWalletResponseWallet
+from circle.web3.developer_controlled_wallets.models.fee_level import FeeLevel
+from circle.web3.developer_controlled_wallets.models.get_balances_response import GetBalancesResponse
+from circle.web3.developer_controlled_wallets.models.get_nfts_response import GetNftsResponse
+from circle.web3.developer_controlled_wallets.models.get_token_by_id_response import GetTokenByIDResponse
+from circle.web3.developer_controlled_wallets.models.get_token_id200_response import GetTokenId200Response
+from circle.web3.developer_controlled_wallets.models.get_transaction200_response import GetTransaction200Response
+from circle.web3.developer_controlled_wallets.models.get_transaction_by_id_response import GetTransactionByIDResponse
+from circle.web3.developer_controlled_wallets.models.get_transactions_response import GetTransactionsResponse
+from circle.web3.developer_controlled_wallets.models.get_wallet200_response import GetWallet200Response
+from circle.web3.developer_controlled_wallets.models.get_wallet_set200_response import GetWalletSet200Response
+from circle.web3.developer_controlled_wallets.models.get_wallet_set_by_id_response import GetWalletSetByIDResponse
+from circle.web3.developer_controlled_wallets.models.get_wallet_sets_response import GetWalletSetsResponse
+from circle.web3.developer_controlled_wallets.models.list_transactions200_response import ListTransactions200Response
+from circle.web3.developer_controlled_wallets.models.list_wallet_ballance200_response import ListWalletBallance200Response
+from circle.web3.developer_controlled_wallets.models.list_wallet_nfts200_response import ListWalletNfts200Response
+from circle.web3.developer_controlled_wallets.models.list_wallet_sets200_response import ListWalletSets200Response
+from circle.web3.developer_controlled_wallets.models.list_wallets200_response import ListWallets200Response
+from circle.web3.developer_controlled_wallets.models.nft import Nft
+from circle.web3.developer_controlled_wallets.models.operation import Operation
+from circle.web3.developer_controlled_wallets.models.sign_developer_message200_response import SignDeveloperMessage200Response
+from circle.web3.developer_controlled_wallets.models.sign_developer_typed_data200_response import SignDeveloperTypedData200Response
+from circle.web3.developer_controlled_wallets.models.sign_message_for_developer_request import SignMessageForDeveloperRequest
+from circle.web3.developer_controlled_wallets.models.sign_message_for_developer_response import SignMessageForDeveloperResponse
+from circle.web3.developer_controlled_wallets.models.sign_typed_data_for_developer_request import SignTypedDataForDeveloperRequest
+from circle.web3.developer_controlled_wallets.models.sign_typed_data_for_developer_response import SignTypedDataForDeveloperResponse
+from circle.web3.developer_controlled_wallets.models.token_response import TokenResponse
+from circle.web3.developer_controlled_wallets.models.token_standard import TokenStandard
+from circle.web3.developer_controlled_wallets.models.transaction import Transaction
+from circle.web3.developer_controlled_wallets.models.transaction_state import TransactionState
+from circle.web3.developer_controlled_wallets.models.transaction_type import TransactionType
+from circle.web3.developer_controlled_wallets.models.update_wallet200_response import UpdateWallet200Response
+from circle.web3.developer_controlled_wallets.models.update_wallet_set200_response import UpdateWalletSet200Response
+from circle.web3.developer_controlled_wallets.models.update_wallet_set_metadata_request import UpdateWalletSetMetadataRequest
+from circle.web3.developer_controlled_wallets.models.update_wallet_set_metadata_response import UpdateWalletSetMetadataResponse
+from circle.web3.developer_controlled_wallets.models.validate_address_request import ValidateAddressRequest
+from circle.web3.developer_controlled_wallets.models.validate_address_response import ValidateAddressResponse
+from circle.web3.developer_controlled_wallets.models.wallet_metadata import WalletMetadata
+from circle.web3.developer_controlled_wallets.models.wallet_response import WalletResponse
+from circle.web3.developer_controlled_wallets.models.wallet_set_response import WalletSetResponse
+from circle.web3.developer_controlled_wallets.models.wallet_state import WalletState

circle_developer_controlled_wallets-0.1.0b1/circle/web3/developer_controlled_wallets/api/__init__.py

@@ -0,0 +1,9 @@
+# flake8: noqa
+
+# import apis into api package
+from circle.web3.developer_controlled_wallets.api.signing_api import SigningApi
+from circle.web3.developer_controlled_wallets.api.token_lookup_api import TokenLookupApi
+from circle.web3.developer_controlled_wallets.api.transactions_api import TransactionsApi
+from circle.web3.developer_controlled_wallets.api.wallet_sets_api import WalletSetsApi
+from circle.web3.developer_controlled_wallets.api.wallets_api import WalletsApi
+