safeheron-api-sdk-python 1.1.18__py3-none-any.whl

safeheron_api_sdk_python/api/account_api.py

@@ -0,0 +1,272 @@
+from safeheron_api_sdk_python.client import *
+
+
+class ListAccountRequest:
+    def __init__(self):
+        # Page number, start from 1 (default)
+        self.pageNumber = None
+        # The number of bars per page, the default is 10, max is 100
+        self.pageSize = None
+        # Filter whether there are not-displayed wallet accounts in Safeheron Console
+        # True: retrieve hidden wallet accounts
+        # False: retrieve displayed wallet accounts
+        # Default: retrieve all wallet accounts
+        self.hiddenOnUI = None
+        # Filter the response based on this account name prefix
+        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
+
+
+
+class CreateAccountRequest:
+    def __init__(self):
+        # Account name, 50 characters max
+        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
+        # Default: false
+        self.hiddenOnUI = None
+        # Account tag
+        self.accountTag = None
+        # Coin key list, 20 array elements max
+        self.coinKeyList = None
+
+
+class BatchCreateAccountRequest:
+    def __init__(self):
+        # The prefix of wallet account name, 50 characters max
+        self.accountName = None
+        # Display status in Safeheron App
+        # True: not display
+        # False: display
+        # Default: true
+        self.hiddenOnUI = None
+        # Number of wallets to be created, greater than 0, less than 100
+        self.count = None
+        # Account tag
+        self.accountTag = None
+
+
+class UpdateAccountShowStateRequest:
+    def __init__(self):
+        # Wallet account key
+        self.accountKey = None
+        # 	Whether display in Safeheron Console
+        # True: not display
+        # False: display
+        # Default: false
+        self.hiddenOnUI = None
+
+class BatchUpdateAccountTagRequest:
+    def __init__(self):
+        # Wallet account key
+        self.accountKeyList = None
+        # Account tag
+        self.accountTag = None
+
+
+class CreateAccountCoinRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Account key
+        self.accountKey = None
+
+class CreateAccountCoinRequestV2:
+    def __init__(self):
+        # Coin key list, 20 array elements max
+        self.coinKeyList = None
+        # Account key
+        self.accountKey = None
+
+
+class BatchCreateAccountCoinRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Account key, max is 100
+        self.accountKeyList = None
+        # Address group name, 30 characters max
+        self.addressGroupName = None
+
+
+class ListAccountCoinRequest:
+    def __init__(self):
+        # Account key
+        self.accountKey = None
+
+
+class ListAccountCoinAddressRequest:
+    def __init__(self):
+        # Page number, start from 1 (default)
+        self.pageNumber = None
+        # The number of bars per page, the default is 10, max is 100
+        self.pageSize = None
+        # Coin key
+        self.coinKey = None
+        # Account key
+        self.accountKey = None
+        # Merchant unique business ID (100 characters max) when adding an address group
+        self.customerRefId = None
+
+
+class InfoAccountCoinAddressRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Coin receiving address
+        self.address = None
+
+class AccountCoinBalanceRequest:
+    def __init__(self):
+        # Coin Keys, max 10
+        self.coinKeyList = None
+
+
+class RenameAccountCoinAddressRequest:
+    def __init__(self):
+        # Address group key
+        self.addressGroupKey = None
+        # Address group name, 30 characters max
+        self.addressGroupName = None
+
+
+class CreateAccountCoinAddressRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Account key
+        self.accountKey = None
+        # Address group name, 30 characters max
+        self.addressGroupName = None
+        # Merchant unique business ID (100 characters max)
+        # The customerRefId uniquely represents an address group. 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 BatchCreateAccountCoinUTXORequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Account key
+        self.accountKey = None
+        # The number, max is 100
+        self.count = None
+        # Address group name, 30 characters max
+        self.addressGroupName = None
+
+
+class AccountApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    # List Wallet Accounts
+    # Filter wallet account lists in team according to different combinations of conditions.
+    def list_accounts(self, request: ListAccountRequest):
+        return self.api_client.send_request(request, '/v1/account/list')
+
+    # Retrieve a Single Wallet Account
+    # Retrieve a single wallet account in the team by providing accountKey.
+    def one_accounts(self, request: OneAccountRequest):
+        return self.api_client.send_request(request, '/v1/account/one')
+
+    # Create a new wallet account.
+    def create_account(self, request: CreateAccountRequest):
+        return self.api_client.send_request(request, '/v1/account/create')
+
+    # Batch Create Wallet Accounts V1
+    # Generate a batch of wallet accounts based on a specified quantity. By default, the wallet accounts created in bulk will not be displayed in the Safeheron App. For optimal results, we recommend using the V2 version.
+    def batchCreate_accountV1(self, request: BatchCreateAccountRequest):
+        return self.api_client.send_request(request, '/v1/account/batch/create')
+
+    # Batch Create Wallet Accounts V2
+    # Generate a batch of wallet accounts based on a specified quantity. By default, the wallet accounts created in bulk will not be displayed in the Safeheron App.
+    def batch_create_accountV2(self, request: BatchCreateAccountRequest):
+        return self.api_client.send_request(request, '/v2/account/batch/create')
+
+    # Change Display of Wallet Account in App
+    # Change wallet account status in Safeheron App.
+    def update_account_show_state(self, request: UpdateAccountShowStateRequest):
+        return self.api_client.send_request(request, '/v1/account/update/show/state')
+
+    # Batch Label Wallet Accounts
+    # Relabel a batch of wallet accounts.
+    # Please note that it only supports to label wallets which are created by API. And, the wallets have been used to sweep the target account cannot be relabelled.
+    def batch_update_account_tag(self, request: BatchUpdateAccountTagRequest):
+        return self.api_client.send_request(request, '/v1/account/batch/update/tag')
+
+    # Add Coins to a Wallet Account V1
+    # Add a new coin to your wallet account, while generating the default address group for the added coin. Once successfully completed, it will return the address information of the newly created default address group. In case the added currency already exists within the account, it will promptly return the existing default address group information for that coin.
+    # In a wallet account, UTXO-based cryptocurrencies can have multiple address groups, while other types of cryptocurrencies usually have only one. To check whether a particular cryptocurrency supports the addition of multiple address groups, simply check the 'isMultipleAddress' parameter through the Coin List.
+    def create_account_coin(self, request: CreateAccountCoinRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/create')
+
+    # Add Coins to a Wallet Account V2
+    # Add a new coin to your wallet account, and it will generate address information for the added coin. If the added currency already exists within the account, it will promptly return the existing address information for that coin.
+    def create_account_coin_v2(self, request: CreateAccountCoinRequestV2):
+        return self.api_client.send_request(request, '/v2/account/coin/create')
+
+    # Batch Add Coins to Wallet Accounts
+    # Bulk addition of specified coins to designated wallet accounts. And, it creates a default address group for each coin and returns the address information contained within the newly created default address group. If a wallet account already contains the currency being added, the function will return the default address group data for that existing coin.
+    #
+    def batch_create_account_coin(self, request: BatchCreateAccountCoinRequest):
+        return self.api_client.send_request(request, '/v1/account/batch/coin/create')
+
+    # List Coins Within a Wallet Account
+    # Retrieve a complete list of all coins associated with a wallet account, along with the default address group information for each coin.
+    #
+    def list_account_coin(self, request: ListAccountCoinRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/list')
+
+    # List Coin Address Group of a Wallet Account
+    # Retrieve all address groups for a coin within the wallet account.
+    #
+    def list_account_coin_address(self, request: ListAccountCoinAddressRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/address/list')
+
+    # Retrieve The Balance of an Address
+    # Retrieve the balance of a specific coin address.
+    def info_account_coin_address(self, request: InfoAccountCoinAddressRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/address/info')
+
+    # Retrieve Coin Balance
+    # Get the coin balance of all asset wallets under the team.
+    def account_coin_balance(self, request: AccountCoinBalanceRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/balance')
+
+
+    # Rename Coin Address Group of a Wallet Account
+    # Rename a coin address group of a wallet account.
+    def rename_account_coin_address(self, request: RenameAccountCoinAddressRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/address/name')
+
+    # Add Address Group for UTXO-Based Coin V1
+    # Add a new address group for UTXO-based cryptocurrencies under a wallet account. If the coin does not exist, it will be added first, followed by the new address group. The function will return the details of the added address(es).
+    def create_account_coin_address(self, request: CreateAccountCoinAddressRequest):
+        return self.api_client.send_request(request, '/v1/account/coin/address/create')
+
+    # Add Address Group for UTXOs V2
+    # Add a new address group for UTXO-based cryptocurrencies under a wallet account.If the coin has not been added to the wallet, it will be added automatically.
+    def create_account_coin_address_v2(self, request: CreateAccountCoinAddressRequest):
+        return self.api_client.send_request(request, '/v2/account/coin/address/create')
+
+    # Batch Add Address Groups for UTXO-Based Coin
+    # For UTXO-based coins in a wallet account, it is possible to add multiple address groups to the account in bulk by specifying the wallet account and the desired number of address groups. The function will return the details of the added address groups. If the specified coin does not exist in the account, it will be added first, followed by the addition of the corresponding number of address groups.
+    def batch_create_account_coin_UTXO(self, request: BatchCreateAccountCoinUTXORequest):
+        return self.api_client.send_request(request, '/v1/account/coin/utxo/batch/create')

safeheron_api_sdk_python/api/api_key_management_api.py

@@ -0,0 +1,18 @@
+from safeheron_api_sdk_python.client import *
+
+
+class ApiKeyManagementApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    #
+    # Deactivate API Key
+    # This interface is used to apply to deactivate the currently used API Key (this can also be done in the Web Console). After the application is submitted, it will only take effect once a team administrator approves it in the Safeheron App. Once an API Key is deactivated, it will no longer be able to access any interfaces. For example, you can apply to deactivate an API Key in the following situations to protect your assets:
+    #
+    # The API Key is no longer in use and should be deactivated promptly to avoid risk;
+    # The API Key's private key is suspected of being leaked, and it needs to be deactivated immediately to ensure fund security;
+    # You receive an Illegal IP Request Event via Webhook and, after evaluation, need to deactivate the API Key (Event Type: ILLEGAL_IP_REQUEST);
+    # To resume using it, you can submit an activation request through the Web Console. This will also require approval from a team administrator before the API Key can be reactivated.
+    def disable_apikey(self):
+        return self.api_client.send_request(None, '/v1/apikey/disable')

safeheron_api_sdk_python/api/coin_api.py

@@ -0,0 +1,65 @@
+from safeheron_api_sdk_python.client import *
+
+
+class CheckCoinAddressRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Coin receiving address
+        self.address = None
+        # Verify contract address (If no value is provided, 'false' by default)
+        # True: verify
+        # False: not verify
+        self.checkContract = None
+        # Verify AML compliance (If no value is provided or be verified, AML-compliant address by default)
+        # True: verify
+        # False: not verify
+        self.checkAml = None
+        # Verify the validity of address format (If no value is provided, 'false' by dafault)
+        # True: verify
+        # False: not verify
+        self.checkAddressValid = None
+
+
+class CoinBalanceSnapshotRequest:
+    def __init__(self):
+        # Only supports querying data within the last 30 days, with the parameter a GMT+8 time in the format of yyyy-MM-dd provided.
+        # Note: If the provided value is the current date (not a historical date), it will return the balance up to the current time.
+        self.gmt8Date = None
+
+
+class CoinBlockHeightRequest:
+    def __init__(self):
+        # Coin key, multiple coin keys are separated by commas
+        self.coinKey = None
+
+
+class CoinApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    # Coin List
+    # Retrieve the list of coins supported by Safeheron.
+    def list_coin(self):
+        return self.api_client.send_request(None, '/v1/coin/list')
+
+    # Coin Maintenance List
+    # Retrieve the information of coins under maintenance in Safeheron.
+    def list_coin_maintain(self):
+        return self.api_client.send_request(None, '/v1/coin/maintain/list')
+
+    # Verify Coin Address
+    # Verify the correctness of a cryptocurrency address based on the provided validation attributes.
+    def check_coin_address(self, request: CheckCoinAddressRequest):
+        return self.api_client.send_request(request, '/v1/coin/address/check')
+
+    # Snapshot the Coin Balance
+    # Safeheron takes and stores daily snapshots of balances based on the transaction block's creation time in GMT+8. Please note that the snapshot only keeps data within 30 days.
+    def coin_balance_snapshot(self, request: CoinBalanceSnapshotRequest):
+        return self.api_client.send_request(request, '/v1/coin/balance/snapshot')
+
+    # Retrieve Current Block Height for Currency
+    # Retrieve the current block height for a specific cryptocurrency by providing its key.
+    def coin_block_height(self, request: CoinBlockHeightRequest):
+        return self.api_client.send_request(request, '/v1/coin/block/height')

safeheron_api_sdk_python/api/gas_api.py

@@ -0,0 +1,21 @@
+from safeheron_api_sdk_python.client import *
+class GasTransactionsGetByTxKeyRequest:
+    def __init__(self):
+        # Transaction key, obtained from transactions created via the Create a Transaction V3 API, App, or Web Console.
+        self.txKey = None
+
+
+class GasApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    # Retrieve Gas Balance
+    # Retrieve your Gas balance for the TRON energy rental service.
+    def gas_status(self):
+        return self.api_client.send_request(None, '/v1/gas/status')
+
+    # Retrieve Automatic Gas Records for Transactions
+    # When the TRON energy rental service is enabled, Safeheron automatically tops up the required Gas fees for TRON network transactions. This API allows you to query the energy rental records used by a transaction. A single transaction may have multiple records. The actual Gas fee consumed by the transaction is the sum of all records with SUCCESS and FAILURE_GAS_CONSUMED statuses.
+    def gas_transactions_ge_b_tx_key(self, request: GasTransactionsGetByTxKeyRequest):
+        return self.api_client.send_request(request, '/v1/gas/transactions/getByTxKey')

safeheron_api_sdk_python/api/mpc_sign_api.py

@@ -0,0 +1,73 @@
+from safeheron_api_sdk_python.client import *
+
+
+class CreateMPCSignTransactionRequest:
+    def __init__(self):
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+        # Merchant extended field (defined by merchant) shown to merchant (255 characters max)
+        self.customerExt1 = None
+        # Merchant extended field (defined by merchant) shown to merchant (255 characters max)
+        self.customerExt2 = None
+        # Source account key
+        self.sourceAccountKey = None
+        # Signature algorithm
+        self.signAlg = None
+        # Transaction fee rate, either txFeeLevel or feeRateDto
+        self.dataList = [self.Date()]
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["dataList"] = [data.__dict__ for data in dict["dataList"]]
+        return dict
+
+    class Date:
+        def __init__(self):
+            # Transaction note (180 characters max)
+            self.note = None
+            # Transaction data to be signed (view description below for details)
+            self.data = None
+
+
+class OneMPCSignTransactionsRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+
+
+class ListMPCSignTransactionsRequest:
+    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
+        # Start time for creating a transaction, UNIX timestamp (ms) (If no value is provided, the default value is createTimeMax minus 24 hours)
+        self.createTimeMin = None
+        # End time for creating a transaction, UNIX timestamp (ms) (If no value is provided, the default value is the current UTC time)
+        self.createTimeMax = None
+
+
+class MPCSignApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    # Create an MPC Sign Transaction
+    # Merchant can initiate MPC Sign via this interface. The merchant must first serialize the transaction data and generate a hash before using this interface to submit the hash and create a transaction. The resulting signature can be retrieved via the MPC Sign transaction interface or webhook. The merchant can proceed with the necessary follow-up processes to obtain the signature according to their specific needs.
+    def create_mpc_sign_transactions(self, request: CreateMPCSignTransactionRequest):
+        request.asDict()
+        return self.api_client.send_request(request, '/v1/transactions/mpcsign/create')
+
+    # Retrieve a Single MPC Sign Transaction
+    # To query a specific MPC Sign transaction, either customerRefId or txKey must be provided. If both parameters are provided, the query will be based on the txKey parameter.
+    def one_mpc_sign_transactions(self, request: OneMPCSignTransactionsRequest):
+        return self.api_client.send_request(request, '/v1/transactions/mpcsign/one')
+
+    # MPC Sign Transaction List
+    # Filter MPC Sign transaction history by various conditions.
+    def list_mpc_sign_transactions(self, request: ListMPCSignTransactionsRequest):
+        return self.api_client.send_request(request, '/v1/transactions/mpcsign/list')

safeheron_api_sdk_python/api/tools_api.py

@@ -0,0 +1,32 @@
+from safeheron_api_sdk_python.client import *
+
+
+class AmlCheckerRequestRequest:
+    def __init__(self):
+        # Blockchain network, supports:
+        # Bitcoin
+        # Ethereum
+        # Tron
+        self.network = None
+        # Address
+        self.address = None
+
+
+class AmlCheckerRetrievesRequest:
+    def __init__(self):
+        # Risk assessment request ID, which can be created through the Create AML Risk Assessment Request interface.
+        self.requestId = None
+
+
+class ToolsApi:
+
+    def __init__(self, config):
+        self.api_client = Client(config)
+
+    # Create AML Risk Assessment Request
+    def aml_checker_request(self, request: AmlCheckerRequestRequest):
+        return self.api_client.send_request(request, '/v1/tools/aml-checker/request')
+
+    # Retrieve AML Risk Assessment Result
+    def aml_checker_retrieves(self, request: AmlCheckerRetrievesRequest):
+        return self.api_client.send_request(request, '/v1/tools/aml-checker/retrieves')