circle-developer-controlled-wallets 1.1.1__tar.gz → 2.0.0__tar.gz

{circle_developer_controlled_wallets-1.1.1 → circle_developer_controlled_wallets-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: circle-developer-controlled-wallets
-Version: 1.1.1
+Version: 2.0.0
 Summary: Developer-Controlled Wallets
 Home-page: 
 Author: OpenAPI Generator community
@@ -12,14 +12,13 @@ Requires-Dist: python-dateutil
 Requires-Dist: pydantic<2,>=1.10.5
 Requires-Dist: aenum
 Requires-Dist: pycryptodome>=3.20.0
-Requires-Dist: circle-configurations==1.1.1
-Requires-Dist: circle-web3-sdk-util==1.1.1
+Requires-Dist: circle-configurations==2.0.0
+Requires-Dist: circle-web3-sdk-util==2.0.0
 
 # circle-developer-controlled-wallets
-Developer-Controlled Wallets API documentation.
+This SDK provides convenient access to Circle's Developer Controlled Wallets APIs for applications written in Python. For the API reference, see the [Circle Web3 API docs](https://developers.circle.com/w3s/reference).
 
-- API version: 1.0
-- Package version: 1.1.1
+- Package version: 2.0.0
 
 ## Requirements.
 
@@ -40,49 +39,67 @@ 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.
+1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/api-keys). This API key will be used for authentication and authorization when making requests to Circle's APIs.
 
-```sh
-export CIRCLE_WEB3_API_KEY="Your API KEY"
-```
+    ```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
+2. Generate a new entity secret by using the helper function in the SDK. This will print a new entity secret which will be used in step 3 to register it. 
 
-```sh
-export CIRCLE_ENTITY_SECRET="Your entity secret"
-```
+    ```python
+    from circle.web3 import utils
 
-3. Initiate API client
+    utils.generate_entity_secret()
+    ```
 
-```python
-from circle.web3 import utils
+    > [!IMPORTANT]  
+    Protect your Entity Secret as you would protect your house key. Losing it or sharing it with others can have serious consequences. As the name suggests, the Entity Secret is sensitive information. Store it securely and treat it with the highest level of confidentiality to prevent unauthorized access or use.
 
-client = utils.init_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
-```
+3. Register the entity secret either by using the SDK or by following Circle's [Developer-Controlled QuickStart](https://learn.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.
+
+    ```python
+        from circle.web3 import utils
+        result =  utils.register_entity_secret_ciphertext(api_key='your_api_key', entity_secret='new_entity_secret')
+        print(result)
+    ```
+    > [!IMPORTANT] 
+    The `register_entity_secret_ciphertext` function downloads a recovery file named `recovery_file_<timestamp>.dat`. This file should be stored securely, similar to the entity secret. Additionally, the function returns the content of the recovery file as a JSON response. 
+
+4. In your code, use the `init_developer_controlled_wallets_client` function from the utils and initialize the client using your API key and entity secret:
+
+    ```python
+    from circle.web3 import utils
 
-4. Interact with the client:
+    client = utils.init_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
+    ```
+
+5. Interact with the client:
 
 ```python
+from circle.web3 import utils
 from circle.web3 import developer_controlled_wallets
 
+client = utils.init_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
 api_instance = developer_controlled_wallets.WalletSetsApi(client)
 
 # create wallet sets
 try:
-    request = developer_controlled_wallets.CreateDeveloperWalletSetRequest.from_dict({
+    request = developer_controlled_wallets.CreateWalletSetRequest.from_dict({
         "name": "my_wallet_set"
     })
-    api_instance.create_wallet_set(request)
+    response = api_instance.create_wallet_set(request)
+    print(response)
 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()
+    response = api_instance.get_wallet_sets()
     for wallet_set in response.data.wallet_sets:
-        print(wallet_set.id)
+        print(wallet_set.actual_instance.id)
 except developer_controlled_wallets.ApiException as e:
-    print("Exception when calling WalletSetsApi->list_wallet_sets: %s\n" % e)
+    print("Exception when calling WalletSetsApi->get_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.

{circle_developer_controlled_wallets-1.1.1 → circle_developer_controlled_wallets-2.0.0}/README.md

@@ -1,8 +1,7 @@
 # circle-developer-controlled-wallets
-Developer-Controlled Wallets API documentation.
+This SDK provides convenient access to Circle's Developer Controlled Wallets APIs for applications written in Python. For the API reference, see the [Circle Web3 API docs](https://developers.circle.com/w3s/reference).
 
-- API version: 1.0
-- Package version: 1.1.1
+- Package version: 2.0.0
 
 ## Requirements.
 
@@ -23,49 +22,67 @@ 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.
+1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/api-keys). This API key will be used for authentication and authorization when making requests to Circle's APIs.
 
-```sh
-export CIRCLE_WEB3_API_KEY="Your API KEY"
-```
+    ```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
+2. Generate a new entity secret by using the helper function in the SDK. This will print a new entity secret which will be used in step 3 to register it. 
 
-```sh
-export CIRCLE_ENTITY_SECRET="Your entity secret"
-```
+    ```python
+    from circle.web3 import utils
 
-3. Initiate API client
+    utils.generate_entity_secret()
+    ```
 
-```python
-from circle.web3 import utils
+    > [!IMPORTANT]  
+    Protect your Entity Secret as you would protect your house key. Losing it or sharing it with others can have serious consequences. As the name suggests, the Entity Secret is sensitive information. Store it securely and treat it with the highest level of confidentiality to prevent unauthorized access or use.
 
-client = utils.init_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
-```
+3. Register the entity secret either by using the SDK or by following Circle's [Developer-Controlled QuickStart](https://learn.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.
+
+    ```python
+        from circle.web3 import utils
+        result =  utils.register_entity_secret_ciphertext(api_key='your_api_key', entity_secret='new_entity_secret')
+        print(result)
+    ```
+    > [!IMPORTANT] 
+    The `register_entity_secret_ciphertext` function downloads a recovery file named `recovery_file_<timestamp>.dat`. This file should be stored securely, similar to the entity secret. Additionally, the function returns the content of the recovery file as a JSON response. 
+
+4. In your code, use the `init_developer_controlled_wallets_client` function from the utils and initialize the client using your API key and entity secret:
+
+    ```python
+    from circle.web3 import utils
 
-4. Interact with the client:
+    client = utils.init_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
+    ```
+
+5. Interact with the client:
 
 ```python
+from circle.web3 import utils
 from circle.web3 import developer_controlled_wallets
 
+client = utils.init_developer_controlled_wallets_client(api_key="Your API KEY", entity_secret="Your entity secret")
 api_instance = developer_controlled_wallets.WalletSetsApi(client)
 
 # create wallet sets
 try:
-    request = developer_controlled_wallets.CreateDeveloperWalletSetRequest.from_dict({
+    request = developer_controlled_wallets.CreateWalletSetRequest.from_dict({
         "name": "my_wallet_set"
     })
-    api_instance.create_wallet_set(request)
+    response = api_instance.create_wallet_set(request)
+    print(response)
 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()
+    response = api_instance.get_wallet_sets()
     for wallet_set in response.data.wallet_sets:
-        print(wallet_set.id)
+        print(wallet_set.actual_instance.id)
 except developer_controlled_wallets.ApiException as e:
-    print("Exception when calling WalletSetsApi->list_wallet_sets: %s\n" % e)
+    print("Exception when calling WalletSetsApi->get_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.

{circle_developer_controlled_wallets-1.1.1 → circle_developer_controlled_wallets-2.0.0}/circle/web3/developer_controlled_wallets/__init__.py

@@ -10,7 +10,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.1.1"
+__version__ = "2.0.0"
 
 # import apis into sdk package
 from circle.web3.developer_controlled_wallets.api.signing_api import SigningApi
@@ -32,24 +32,24 @@ 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 import AccelerateTransactionForDeveloper
+from circle.web3.developer_controlled_wallets.models.accelerate_transaction_for_developer_data import AccelerateTransactionForDeveloperData
 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.bad_request_response import BadRequestResponse
 from circle.web3.developer_controlled_wallets.models.balance import Balance
+from circle.web3.developer_controlled_wallets.models.balances import Balances
+from circle.web3.developer_controlled_wallets.models.balances_data import BalancesData
+from circle.web3.developer_controlled_wallets.models.base_screening_decision import BaseScreeningDecision
 from circle.web3.developer_controlled_wallets.models.blockchain import Blockchain
+from circle.web3.developer_controlled_wallets.models.cancel_transaction_for_developer import CancelTransactionForDeveloper
 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 import CreateContractExecutionTransactionForDeveloper
+from circle.web3.developer_controlled_wallets.models.create_contract_execution_transaction_for_developer_data import CreateContractExecutionTransactionForDeveloperData
 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_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_transfer_transaction_for_developer_response_data import CreateTransferTransactionForDeveloperResponseData
 from circle.web3.developer_controlled_wallets.models.create_wallet_request import CreateWalletRequest
 from circle.web3.developer_controlled_wallets.models.create_wallet_set_request import CreateWalletSetRequest
 from circle.web3.developer_controlled_wallets.models.custody_type import CustodyType
@@ -59,48 +59,55 @@ from circle.web3.developer_controlled_wallets.models.end_user_wallet_set import
 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_contract_execution_transaction_fee_request_blockchain import EstimateContractExecutionTransactionFeeRequestBlockchain
-from circle.web3.developer_controlled_wallets.models.estimate_transaction_fee_response import EstimateTransactionFeeResponse
+from circle.web3.developer_controlled_wallets.models.estimate_transaction_fee import EstimateTransactionFee
+from circle.web3.developer_controlled_wallets.models.estimate_transaction_fee_data import EstimateTransactionFeeData
 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.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.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.nft import Nft
+from circle.web3.developer_controlled_wallets.models.nfts import Nfts
+from circle.web3.developer_controlled_wallets.models.nfts_data import NftsData
 from circle.web3.developer_controlled_wallets.models.not_authorized_response import NotAuthorizedResponse
 from circle.web3.developer_controlled_wallets.models.not_found_response import NotFoundResponse
 from circle.web3.developer_controlled_wallets.models.operation import Operation
+from circle.web3.developer_controlled_wallets.models.risk_action import RiskAction
+from circle.web3.developer_controlled_wallets.models.risk_category import RiskCategory
+from circle.web3.developer_controlled_wallets.models.risk_score import RiskScore
+from circle.web3.developer_controlled_wallets.models.risk_signal import RiskSignal
+from circle.web3.developer_controlled_wallets.models.risk_type import RiskType
 from circle.web3.developer_controlled_wallets.models.sca_wallet import SCAWallet
-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.sign_message_request import SignMessageRequest
+from circle.web3.developer_controlled_wallets.models.sign_transaction_request import SignTransactionRequest
+from circle.web3.developer_controlled_wallets.models.sign_transaction_response import SignTransactionResponse
+from circle.web3.developer_controlled_wallets.models.sign_transaction_response_data import SignTransactionResponseData
+from circle.web3.developer_controlled_wallets.models.sign_typed_data_request import SignTypedDataRequest
+from circle.web3.developer_controlled_wallets.models.signature_response import SignatureResponse
+from circle.web3.developer_controlled_wallets.models.signature_response_data import SignatureResponseData
+from circle.web3.developer_controlled_wallets.models.token import Token
 from circle.web3.developer_controlled_wallets.models.token_blockchain import TokenBlockchain
 from circle.web3.developer_controlled_wallets.models.token_response import TokenResponse
+from circle.web3.developer_controlled_wallets.models.token_response_data import TokenResponseData
 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_fee import TransactionFee
+from circle.web3.developer_controlled_wallets.models.transaction_response import TransactionResponse
+from circle.web3.developer_controlled_wallets.models.transaction_response_data import TransactionResponseData
+from circle.web3.developer_controlled_wallets.models.transaction_screening_decision import TransactionScreeningDecision
 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.transactions import Transactions
+from circle.web3.developer_controlled_wallets.models.transactions_data import TransactionsData
 from circle.web3.developer_controlled_wallets.models.update_wallet_request import UpdateWalletRequest
 from circle.web3.developer_controlled_wallets.models.update_wallet_set_request import UpdateWalletSetRequest
+from circle.web3.developer_controlled_wallets.models.validate_address import ValidateAddress
+from circle.web3.developer_controlled_wallets.models.validate_address_data import ValidateAddressData
 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 import Wallet
-from circle.web3.developer_controlled_wallets.models.wallet2 import Wallet2
-from circle.web3.developer_controlled_wallets.models.wallet2_data import Wallet2Data
 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_response_data import WalletResponseData
 from circle.web3.developer_controlled_wallets.models.wallet_set import WalletSet
-from circle.web3.developer_controlled_wallets.models.wallet_set2 import WalletSet2
-from circle.web3.developer_controlled_wallets.models.wallet_set2_data import WalletSet2Data
+from circle.web3.developer_controlled_wallets.models.wallet_set_response import WalletSetResponse
+from circle.web3.developer_controlled_wallets.models.wallet_set_response_data import WalletSetResponseData
 from circle.web3.developer_controlled_wallets.models.wallet_sets import WalletSets
 from circle.web3.developer_controlled_wallets.models.wallet_sets_data import WalletSetsData
 from circle.web3.developer_controlled_wallets.models.wallet_sets_data_wallet_sets_inner import WalletSetsDataWalletSetsInner