safeheron-api-sdk-python 1.1.7__tar.gz → 1.1.8__tar.gz

{safeheron_api_sdk_python-1.1.7/safeheron_api_sdk_python.egg-info → safeheron_api_sdk_python-1.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: safeheron_api_sdk_python
-Version: 1.1.7
+Version: 1.1.8
 Summary: Python for Safeheron API
 Home-page: https://github.com/Safeheron/safeheron-api-sdk-python
 Author: safeheron
@@ -10,7 +10,7 @@ Platform: all
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 License-File: LICENSE
-Requires-Dist: pycryptodome
+Requires-Dist: pycryptodomex
 Requires-Dist: requests
 Requires-Dist: cryptography
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/api/account_api.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.client import *
 
 
@@ -19,12 +16,16 @@ class ListAccountRequest:
         self.namePrefix = None
         # Filter the response based on this account name suffix
         self.nameSuffix = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
 
 
 class OneAccountRequest:
     def __init__(self):
         # Wallet account key
         self.accountKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
 
 
 
@@ -32,6 +33,9 @@ class CreateAccountRequest:
     def __init__(self):
         # Account name, within 30 characters
         self.accountName = None
+        # Merchant unique business ID (100 characters max)
+        # The customerRefId uniquely represents a wallet. In the case of duplicate customerRefId values (for example, when resubmitting due to request timeouts or other errors), the data returned by the interface will remain consistent
+        self.customerRefId = None
         # 	Whether display in Safeheron Console
         # True: not display
         # False: display

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/api/coin_api.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.client import *
 
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/api/mpc_sign_api.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.client import *
 
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/api/transaction_api.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.client import *
 
 
@@ -202,8 +199,8 @@ class CreateTransactionsUTXOMultiDestRequest:
         dict = self.__dict__
         dict["feeRateDto"] = dict["feeRateDto"].__dict__
         destinationAddressList = []
-        for time in dict["destinationAddressList"]:
-            destinationAddressList.append(time.__dict__)
+        for item in dict["destinationAddressList"]:
+            destinationAddressList.append(item.__dict__)
         dict["destinationAddressList"] = destinationAddressList
         return dict
 
@@ -263,8 +260,8 @@ class TransactionsFeeRateRequest:
     def asDict(self):
         dict = self.__dict__
         destinationAddressList = []
-        for time in dict["destinationAddressList"]:
-            destinationAddressList.append(time.__dict__)
+        for item in dict["destinationAddressList"]:
+            destinationAddressList.append(item.__dict__)
         dict["destinationAddressList"] = destinationAddressList
         return dict
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/api/web3_api.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.client import *
 
 
@@ -13,6 +10,9 @@ class CreateWeb3AccountRequest:
         # False: display
         # Default: false
         self.hiddenOnUI = None
+        # Merchant unique business ID (100 characters max)
+        # The customerRefId uniquely represents a wallet. In the case of duplicate customerRefId values (for example, when resubmitting due to request timeouts or other errors), the data returned by the interface will remain consistent
+        self.customerRefId = None
 
 
 class BatchCreateWeb3AccountRequest:
@@ -33,6 +33,8 @@ class ListWeb3AccountRequest:
         self.fromId = None
         # Filter the response based on this account name prefix
         self.namePrefix = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
 
 
 class CreateWeb3EthSignRequest:

safeheron_api_sdk_python-1.1.8/safeheron_api_sdk_python/api/webhook_api.py

@@ -0,0 +1,49 @@
+from safeheron_api_sdk_python.client import *
+
+class ResendWebhookRequest:
+    def __init__(self):
+        # Supported events:
+        # TRANSACTION
+        # MPC_SIGN
+        # WEB3_SIGN
+        self.category = None
+        # Transaction key
+        self.txKey = None
+
+class ResendFailedRequest:
+    def __init__(self):
+        # Start time in UNIX timestamp (ms). The time interval [startTime, endTime] is up to 1 hour
+        self.startTime = None
+        # End time in UNIX timestamp (ms). The time interval [startTime, endTime] is up to 1 hour
+        self.endTime = None
+
+
+class WebhookApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+    # Re-push Transaction Webhook Events
+    # Re-push the transaction webhook events generated in the last month. In certain situations, such as network jitter or your system being unavailable to receive webhook events, you may miss receiving notifications. You can use this interface to notify Safeheron to re-push the webhook events. It is important to note that for a single transaction, only the last webhook event will be re-pushed. For example, during the lifecycle of a transaction, multiple TRANSACTION_STATUS_CHANGED webhook events such as BROADCASTING, CONFIRMING, COMPLETED, etc., may be generated. The re-push will only send the last webhook event recorded by the current system. Re-pushing is supported for the following types of webhook events:
+    # Events related to asset transactions, including TRANSACTION_CREATED and TRANSACTION_STATUS_CHANGED.
+    # Events related to MPC signing, including MPC_SIGN_CREATED and MPC_SIGN_STATUS_CHANGED.
+    # Events related to Web3, including WEB3_SIGN_CREATED and WEB3_SIGN_STATUS_CHANGED.
+    # More types of webhook events will be supported in the future.
+    def resend_webhook(self, request: ResendWebhookRequest):
+        return self.api_client.send_request(request, '/v1/webhook/resend')
+
+    # Push All Failed Webhook Events
+    # Resend all webhook events that failed to push within any duration not exceeding 1 hour in the past 7 days (limited to 1 call every 10 minutes). In certain situations, such as network failures or your system being unavailable to receive webhook events, you may miss receiving notifications. Once the issue is resolved, you can use this interface to notify Safeheron to resend all webhook events that failed to push within a certain period. Support re-pushing the following types of webhook events:
+    # TRANSACTION_CREATED
+    # TRANSACTION_STATUS_CHANGED
+    # MPC_SIGN_CREATED
+    # MPC_SIGN_STATUS_CHANGED
+    # WEB3_SIGN_CREATED
+    # WEB3_SIGN_STATUS_CHANGED
+    # ILLEGAL_IP_REQUEST
+    # NO_MATCHING_TRANSACTION_POLICY
+    # More types of webhook events will be supported in the future.
+    # Please note that when re-pushing all failed webhook events, your system needs to avoid rollback issues. For example, during the lifecycle of a transaction, multiple TRANSACTION_STATUS_CHANGED webhook events may be generated, such as BROADCASTING, CONFIRMING, and COMPLETED. If your system did not receive the CONFIRMING event due to network issues but did receive the COMPLETED event, using this interface would cause Safeheron to attempt resending the CONFIRMING event to your system. Your system needs to ensure that the transaction does not incorrectly revert from the COMPLETED status back to the CONFIRMING status.
+    def resend_failed(self, request: ResendFailedRequest):
+        return self.api_client.send_request(request, '/v1/webhook/resend/failed')
+
+

safeheron_api_sdk_python-1.1.8/safeheron_api_sdk_python/api/whitelist_api.py

@@ -0,0 +1,116 @@
+from safeheron_api_sdk_python.client import *
+
+
+class ListWhitelistRequest:
+    def __init__(self):
+        # Query page direction, NEXT by default
+        self.direct = None
+        # The number of items to retrieve at a time, default max value is 500
+        self.limit = None
+        # Txkey of the first transaction record. If the first page has no value, provide the txKey of the last transaction record from the previous result
+        self.fromId = None
+        # The supported public blockchains for whitelist addresses are:
+        # EVM: Ethereum-compatible public chain networks or Layer 2 addresses that can receive its native token and other tokens
+        # Bitcoin: Bitcoin mainnet addresses that can receive Bitcoin
+        # Bitcoin Cash: Bitcoin Cash network, which can receive BCH
+        # Dash: anonymous Dash network, which can receive DASH
+        # TRON: Tron mainnet addresses, which can receive TRX and TRC20 tokens, such as USDT and USDC
+        # NEAR: NEAR mainnet, which can receive native token NEAR
+        # Filecoin: Receive Filecoin native token FIL, but does not support receiving FIL or tokens from the FVM network
+        # Sui: Sui mainnet, which can receive native token Sui and other tokens
+        # Aptos: Aptos mainnet, which only supports receiving native token Aptos and does not support other tokens yet
+        # Solana: Solana mainnet, which can receive native token SOL and other tokens
+        # Bitcoin Testnet: Bitcoin testnet, which can receive Bitcoin testnet ass
+        self.chainType = None
+        # Whitelist status
+        # AUDIT: pending approval
+        # APPROVED: active
+        # REJECTED: rejected
+        self.whitelistStatus = None
+        # Start time for creating a whitelist in UNIX timestamp (ms) (If no value is provided, the default value is createTimeMax minus 24 hours)
+        self.createTimeMin = None
+        # End time for creating a whitelist in UNIX timestamp (ms) (If no value is provided, the default value is the current UTC time)
+        self.createTimeMax = None
+
+
+class OneWhitelistRequest:
+    def __init__(self):
+        # Whitelist unique identifier. It is required if address is not provided. If both are provided, the whitelistKey takes precedence
+        self.whitelistKey = None
+        # Whitelist address. It is required if whitelistKey is not provided and please make sure the provided address is correct
+        self.address = None
+
+
+
+class CreateWhitelistRequest:
+    def __init__(self):
+        # Whitelist unique name, 20 characters max
+        self.whitelistName = None
+        # The supported public blockchains for whitelist addresses are:
+        # EVM: Ethereum-compatible public chain networks or Layer 2 addresses that can receive its native token and other tokens
+        # Bitcoin: Bitcoin mainnet addresses that can receive Bitcoin
+        # Bitcoin Cash: Bitcoin Cash network, which can receive BCH
+        # Dash: anonymous Dash network, which can receive DASH
+        # TRON: Tron mainnet addresses, which can receive TRX and TRC20 tokens, such as USDT and USDC
+        # NEAR: NEAR mainnet, which can receive native token NEAR
+        # Filecoin: Receive Filecoin native token FIL, but does not support receiving FIL or tokens from the FVM network
+        # Sui: Sui mainnet, which can receive native token Sui and other tokens
+        # Aptos: Aptos mainnet, which only supports receiving native token Aptos and does not support other tokens yet
+        # Solana: Solana mainnet, which can receive native token SOL and other tokens
+        # Bitcoin Testnet: Bitcoin testnet, which can receive Bitcoin testnet assets
+        self.chainType = None
+        # Public blockchain address and the address format needs to meet the requirements of the chain
+        self.address = None
+
+class EditWhitelistRequest:
+    def __init__(self):
+        # Whitelist unique identifier
+        self.whitelistKey = None
+        # Whitelist unique name, 20 characters max
+        self.whitelistName = None
+        # Public blockchain address and the address format needs to meet the requirements of the chain
+        self.address = None
+        # When the whitelist is involved in a transaction approval policy, modifications will result in the new whitelist being directly applied to the approval policy. False by default, meaning that when involved in a transaction approval policy, it will not be modified.
+        self.force = None
+
+class DeleteWhitelistRequest:
+    def __init__(self):
+        # Whitelist unique identifier
+        self.whitelistKey = None
+
+
+class WhitelistApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    # List Whitelist Data
+    # Paginate the whitelist data based on the query criteria.
+    def list_whitelist(self, request: ListWhitelistRequest):
+        return self.api_client.send_request(request, '/v1/whitelist/list')
+
+    # Retrieve a Single Whitelist
+    #      * Retrieve the data of a whitelist.
+    def one_whitelist(self, request: OneWhitelistRequest):
+        return self.api_client.send_request(request, '/v1/whitelist/one')
+
+    # Create a Whitelist
+    # Add a new whitelisted address. The newly added address needs to be approved in the Safeheron App before it becomes effective. The approval details are as follows:
+    # Admin approval: If a custom whitelist approval process is not set, it will become effective after being approved by the team admins according to the team's decision-making process.
+    # Custom whitelist approval: If a whitelist approval process is set, it will become effective after being approved according to the process.
+    def create_whitelist(self, request: CreateWhitelistRequest):
+        return self.api_client.send_request(request, '/v1/whitelist/create')
+
+    # Modify a Whitelist
+    # Modify a whitelist based on its unique identifier. The whitelist only supports modifying its name and address; whitelists pending for approval cannot be modified. After modifying the whitelist, it needs to be reviewed and approved in the Safeheron App before it becomes effective. The approval details are as follows:
+    # Admin approval: If a custom whitelist approval process is not set, it will become effective after being approved by the team admins according to the team's decision-making process.
+    # Custom whitelist approval: If a whitelist approval process is set, it will become effective after being approved according to the process.
+    def edit_whitelist(self, request: EditWhitelistRequest):
+        return self.api_client.send_request(request, '/v1/whitelist/edit')
+
+    # Delete a Whitelist
+    # To delete a whitelisted address, note that no approval is required for deletion. If a whitelisted address that is under approval is deleted, the approval task will also be automatically cancelled.
+    def delete_whitelist(self, request: DeleteWhitelistRequest):
+        return self.api_client.send_request(request, '/v1/whitelist/delete')
+
+

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/cosigner/co_signer_converter.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.tools import *
 
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python/webhook/webhook_converter.py

@@ -1,6 +1,3 @@
-import sys
-
-sys.path.pop(0)
 from safeheron_api_sdk_python.tools import *
 
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8/safeheron_api_sdk_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: safeheron_api_sdk_python
-Version: 1.1.7
+Version: 1.1.8
 Summary: Python for Safeheron API
 Home-page: https://github.com/Safeheron/safeheron-api-sdk-python
 Author: safeheron
@@ -10,7 +10,7 @@ Platform: all
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 License-File: LICENSE
-Requires-Dist: pycryptodome
+Requires-Dist: pycryptodomex
 Requires-Dist: requests
 Requires-Dist: cryptography
 

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python.egg-info/SOURCES.txt

@@ -1,5 +1,4 @@
 LICENSE
-README.md
 README.rst
 setup.py
 safeheron_api_sdk_python/client.py
@@ -14,5 +13,7 @@ safeheron_api_sdk_python/api/coin_api.py
 safeheron_api_sdk_python/api/mpc_sign_api.py
 safeheron_api_sdk_python/api/transaction_api.py
 safeheron_api_sdk_python/api/web3_api.py
+safeheron_api_sdk_python/api/webhook_api.py
+safeheron_api_sdk_python/api/whitelist_api.py
 safeheron_api_sdk_python/cosigner/co_signer_converter.py
 safeheron_api_sdk_python/webhook/webhook_converter.py

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/safeheron_api_sdk_python.egg-info/requires.txt

@@ -1,3 +1,3 @@
-pycryptodome
+pycryptodomex
 requests
 cryptography

{safeheron_api_sdk_python-1.1.7 → safeheron_api_sdk_python-1.1.8}/setup.py

@@ -3,14 +3,14 @@ from setuptools import find_packages
 with open("README.rst", "r") as f:
     long_description = f.read()
 setup(name='safeheron_api_sdk_python',
-      version='1.1.7',
+      version='1.1.8',
       description='Python for Safeheron API',
       long_description=long_description,
       author='safeheron',
       author_email='support@safeheron.com',
       url='https://github.com/Safeheron/safeheron-api-sdk-python',
       install_requires=[
-            'pycryptodome',
+            'pycryptodomex',
             'requests',
             'cryptography'
       ],

safeheron_api_sdk_python-1.1.7/README.md

@@ -1,135 +0,0 @@
-# Python SDK for Safeheron API
-
-![GitHub last commit](https://img.shields.io/github/last-commit/Safeheron/safeheron-api-sdk-python)
-![GitHub top language](https://img.shields.io/github/languages/top/Safeheron/safeheron-api-sdk-python?color=red)
-
-# API Documentation
-- [Official documentation](https://docs.safeheron.com/api/index.html)
-
-# Installation
-
-```shell
-$ pip install safeheron-api-sdk-python
-```
-
-# Usage
-```python
-from safeheron_api_sdk_python.api.account_api import *
-```
-
-> Take [`/v1/account/create`](https://docs.safeheron.com/api/index.html) as an example to explain, the complete code can be found in `demo/api_demo` directory
-
-* Construct `config`
-    ```python
-    # You can get `ApiKey` and `SafeheronRsaPublicKey` from Safeheron Web Console: https://www.safeheron.com/console.
-    config={
-            'apiKey': '5921aa306f*******368db9abf', 
-            'privateKeyPemFile': './my_private.pem',
-            'safeheronPublicKey': 'MIICIjANBgkqhkiG9w0***********+zSdC+8eBdZyI7nMdPIj6xOhUCAwEAAQ==',
-            'baseUrl': 'https://api.safeheron.vip',
-            'RequestTimeout': 20000
-  }
-    ```
-* Call `create_account` api with `config`
-    ```python
-    account_api = AccountApi(config)
-    param = CreateAccountRequest()
-    param.accountName = "accountNameTest"
-    res = account_api.create_account(param)
-    # Your code to process response
-    ...
-    ...
-    ```
-
-# Test
-
-## Test Create Wallet Account
-* Before run the test code, modify `demo/api_demo/account/config.yaml.example` according to the comments
-    ```yaml
-    # Your api key, you can get it from Safeheron Web Console: https://www.safeheron.com/console.
-    apiKey: 080d****e06e60
-    # Your private key, as an alternative, you can use privateKeyPemFile to config your private key
-    privateKey: MIIJRQIBA*******DtGRBdennqu8g95jcrMxCUhsifVgzP6vUyg==
-    # path to your private key file, pem encoded.PrivateKeyPemFile priority is higher than privateKey.
-    privateKeyPemFile: './my_private.pem'
-    # Safeheron API public key, you can get it from Safeheron Web Console: https://www.safeheron.com/console.
-    safeheronPublicKey: MIICI****QuTOTECAwEAAQ==
-    # Safeheron API url
-    baseUrl: https://api.safeheron.vip
-    # RequestTimeout (Millisecond), Default: 20000
-    requestTimeout: 20000
-    ```
-* Copy config to `config.yaml` file.
-    ```bash
-    $ cd demo/api_demo/account
-    $ cp config.yaml.example config.yaml
-    ```
-* Pytest
-
-  Execute `test_create_account` unit in `/demo/api_demo/account/account_api_demo.py` Python file.
-
-## Test Send A Transaction
-* Before run the test code, modify `demo/api_demo/transaction/config.yaml.example` according to the comments
-    ```yaml
-    # Your api key, you can get it from Safeheron Web Console: https://www.safeheron.com/console.
-    apiKey: 080d****e06e60
-    # Your private key, as an alternative, you can use privateKeyPemFile to config your private key
-    privateKey: MIIJRQIBA*******DtGRBdennqu8g95jcrMxCUhsifVgzP6vUyg==
-    # path to your private key file, pem encoded.PrivateKeyPemFile priority is higher than privateKey.
-    privateKeyPemFile: './my_private.pem'
-    # Safeheron API public key, you can get it from Safeheron Web Console: https://www.safeheron.com/console.
-    safeheronPublicKey: MIICI****QuTOTECAwEAAQ==
-    # Safeheron API url
-    baseUrl: https://api.safeheron.vip
-    # RequestTimeout (Millisecond), Default: 20000
-    requestTimeout: 20000
-    # Wallet Account key
-    accountKey: account****5ecad40
-    # To address
-    destinationAddress: "0x943****0BF95f5"
-    ```
-* Copy config to `config.yaml` file.
-    ```bash
-    $ cd demo/api_demo/transaction
-    $ cp config.yaml.example config.yaml
-    ```
-* Pytest
-
-  Execute `test_create_transactions` unit in `/demo/api_demo/transaction/transaction_api_demo.py` Python file.
-
-
-## Test MPC Sign
-* Before run the test code, modify `demo/api_demo/mpc_sign/config.yaml.example` according to the comments
-    ```yaml
-    # Your api key, you can get it from Safeheron Web Console: https://www.safeheron.com/console.
-    apiKey: 080d****e06e60
-    # Your private key, as an alternative, you can use privateKeyPemFile to config your private key
-    privateKey: MIIJRQIBA*******DtGRBdennqu8g95jcrMxCUhsifVgzP6vUyg==
-    # path to your private key file, pem encoded.PrivateKeyPemFile priority is higher than privateKey.
-    privateKeyPemFile: './my_private.pem'
-    # Safeheron API public key, you can get it from Safeheron Web Console: https://www.safeheron.com/console.
-    safeheronPublicKey: MIICI****QuTOTECAwEAAQ==
-    # Safeheron API url
-    baseUrl: https://api.safeheron.vip
-    # RequestTimeout (Millisecond), Default: 20000
-    requestTimeout: 20000
-    # Wallet Account key
-    accountKey: account****5ecad40
-    # Goerli testnet token address in wallet account
-    accountTokenAddress: "0x970****4ffD59"
-    # erc20 token contract address
-    erc20ContractAddress: "0x078****Eaa37F"
-    # address to receive token
-    toAddress: "0x53B****321789"
-    # Ethereum RPC API
-    ethereumRpcApi: https://goerli.infura.io/v3/802******bc2fcb
-    ```
-
-* Copy config to `config.yaml` file.
-    ```bash
-    $ cd demo/api_demo/mpc_sign
-    $ cp config.yaml.example config.yaml
-    ```
-* Pytest
-
-  Execute `test_create_mpc_sign_transactions` unit in `/demo/api_demo/mpc_sign/mpc_sign_api_demo.py` Python file.