safeheron-api-sdk-python 1.0.5__tar.gz → 1.0.6__tar.gz

{safeheron_api_sdk_python-1.0.5/safeheron_api_sdk_python.egg-info → safeheron_api_sdk_python-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: safeheron_api_sdk_python
-Version: 1.0.5
+Version: 1.0.6
 Summary: Python for Safeheron API
 Home-page: https://github.com/Safeheron/safeheron-api-sdk-python
 Author: safeheron

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/api/account_api.py

@@ -0,0 +1,219 @@
+import sys
+
+sys.path.pop(0)
+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
+
+
+class CreateAccountRequest:
+    def __init__(self):
+        # Account name, within 30 characters
+        self.accountName = 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, 30 characters max
+        self.accountName = 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.accountKey = None
+        # Account tag
+        self.accountTag = None
+
+
+class CreateAccountCoinRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = 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
+
+
+class InfoAccountCoinAddressRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Coin receiving address
+        self.address = 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
+
+
+class BatchCreateAccountCoinUTXORequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Account key
+        self.accountKey = None
+        # Address group name, 30 characters max
+        self.count = None
+        # The number, max is 100
+        self.addressGroupName = None
+
+
+class AccountApi:
+
+    def __init__(self, config):
+        global api_client
+        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 api_client.send_request(request, '/v1/account/list')
+
+    # Create a new wallet account.
+    def create_account(self, request: CreateAccountRequest):
+        return 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 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 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 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 api_client.send_request(request, '/v1/account/batch/update/tag')
+
+    # Add Coins to a Wallet Account
+    # 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 api_client.send_request(request, '/v1/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 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 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 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 api_client.send_request(request, '/v1/account/coin/address/info')
+
+    # 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 api_client.send_request(request, '/v1/account/coin/address/name')
+
+    # Add Address Group for UTXO-Based Coin
+    # 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 api_client.send_request(request, '/v1/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 api_client.send_request(request, '/v1/account/coin/utxo/batch/create')

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/api/coin_api.py

@@ -0,0 +1,69 @@
+import sys
+
+sys.path.pop(0)
+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):
+        global api_client
+        api_client = Client(config)
+
+    # Coin List
+    # Retrieve the list of coins supported by Safeheron.
+    def list_coin(self):
+        return 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 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 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 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 api_client.send_request(request, '/v1/coin/block/height')

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/api/mpc_sign_api.py

@@ -0,0 +1,77 @@
+import sys
+
+sys.path.pop(0)
+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):
+        global api_client
+        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 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 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 api_client.send_request(request, '/v1/transactions/mpcsign/list')

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/api/transaction_api.py

@@ -0,0 +1,298 @@
+import sys
+
+sys.path.pop(0)
+from safeheron_api_sdk_python.client import *
+
+
+class ListTransactionsV1Request:
+    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
+        # Source account key
+        self.sourceAccountKey = None
+        # Source account type
+        self.sourceAccountType = None
+        # Destination account key
+        self.destinationAccountKey = None
+        # Destination account type
+        self.destinationAccountType = None
+        # Start time for creating a transaction, UNIX timestamp (ms)
+        self.createTimeMin = None
+        # End time for creating a transaction, UNIX timestamp (ms)
+        self.createTimeMax = None
+        # Min transaction amount
+        self.txAmountMin = None
+        # Max transaction amount
+        self.txAmountMax = None
+        # Coin key, multiple coin keys are separated by commas
+        self.coinKey = None
+        # Transaction fee coin key, multiple coin keys are separated by commas
+        self.feeCoinKey = None
+        # Transaction status
+        self.transactionStatus = None
+        # Transaction substatus
+        self.transactionSubStatus = None
+        # Min duration for completing a transaction, UNIX timestamp (ms)
+        self.completedTimeMin = None
+        # Max duration for completing a transaction, UNIX timestamp (ms)
+        self.completedTimeMax = None
+        # Merchant unique business ID
+        self.customerRefId = None
+        # Type of actual destination account
+        self.realDestinationAccountType = None
+        # Filter out custom transaction amounts, excluding transaction records below a certain amount specified in USD from the query results
+        self.hideSmallAmountUsd = None
+
+
+class ListTransactionsV2Request:
+    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
+        # Source account key
+        self.sourceAccountKey = None
+        # Source account type
+        self.sourceAccountType = None
+        # Destination account key
+        self.destinationAccountKey = None
+        # Destination account type
+        self.destinationAccountType = None
+        # Start time for creating a transaction, UNIX timestamp (ms)
+        self.createTimeMin = None
+        # End time for creating a transaction, UNIX timestamp (ms)
+        self.createTimeMax = None
+        # Min transaction amount
+        self.txAmountMin = None
+        # Max transaction amount
+        self.txAmountMax = None
+        # Coin key, multiple coin keys are separated by commas
+        self.coinKey = None
+        # Transaction fee coin key, multiple coin keys are separated by commas
+        self.feeCoinKey = None
+        # Transaction status
+        self.transactionStatus = None
+        # Transaction substatus
+        self.transactionSubStatus = None
+        # Min duration for completing a transaction, UNIX timestamp (ms)
+        self.completedTimeMin = None
+        # Max duration for completing a transaction, UNIX timestamp (ms)
+        self.completedTimeMax = None
+        # Merchant unique business ID
+        self.customerRefId = None
+        # Type of actual destination account
+        self.realDestinationAccountType = None
+        # Filter out custom transaction amounts, excluding transaction records below a certain amount specified in USD from the query results
+        self.hideSmallAmountUsd = None
+
+
+class CreateTransactionRequest:
+    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
+        # Transaction note (180 characters max)
+        self.note = None
+        # Coin key
+        self.coinKey = None
+        # Transaction Fee Rate Grade
+        # Choose between transaction fees. If the transaction fee rate is preset, it will take priority
+        self.txFeeLevel = None
+        # Transaction fee rate, either txFeeLevel or feeRateDto
+        self.feeRateDto = FeeRateDto()
+        # Maximum estimated transaction fee rate for a given transaction
+        self.maxTxFeeRate = None
+        # Transaction amount
+        self.txAmount = None
+        # Deduct transaction fee from the transfer amount
+        # False by default. If set to true, transaction fee will be deducted from the transfer amount
+        # Note: This parameter can only be considered if a transaction’s asset is a base asset, such as ETH or MATIC. If the asset can’t be used for transaction fees, like USDC, this parameter is ignored
+        self.treatAsGrossAmount = None
+        # Source account key
+        self.sourceAccountKey = None
+        # Account type
+        self.sourceAccountType = None
+        # Destination account key
+        # Whitelist key if the destination is a whitelisted account;
+        # Wallet account key if the destination is a wallet account;
+        # No key for unknown address
+        self.destinationAccountKey = None
+        # Destination account type
+        self.destinationAccountType = None
+        # If the destinationAccountType is ONE_TIME_ADDRESS, then this field should have a value
+        self.destinationAddress = None
+        # Destination Tag
+        self.destinationTag = None
+        # Bitcoin enabled for RBF (Replace-by-fee is a protocol in the Bitcoin mempool that allows for the replacement of an unconfirmed transaction with another one)
+        self.isRbf = None
+        # The default setting for the parameter is [true]. This parameter determines whether a transaction can be created when the target address is a smart contract. If set to [false], a transaction can still be created for a contract address
+        self.failOnContract = None
+        # Custom nonce
+        self.nonce = None
+        # Balance verification, BALANCE_CHECK by default
+        self.balanceVerifyType = None
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["feeRateDto"] = dict["feeRateDto"].__dict__
+        return dict
+
+
+class FeeRateDto:
+    def __init__(self):
+        # Fee rate: fee per byte for UTXO, gas price for EVM chains, free limit for TRON (optional) and gas price for SUI
+        self.feeRate = None
+        # EVM gas limit
+        self.gasLimit = None
+        # EIP-1559 max priority fee
+        self.maxPriorityFee = None
+        # EIP-1559 max fee
+        self.maxFee = None
+        # Filecoin gas premium, similar to EIP-1559 max priority fee
+        self.gasPremium = None
+        # Filecoin gas fee cap, similar to EIP-1559 max fee
+        self.gasFeeCap = None
+        # SUI gas budget, similar to EIP-1559 max fee
+        self.gasBudget = None
+
+
+class RecreateTransactionRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+        # Transaction hash
+        self.txHash = None
+        # Coin key
+        self.coinKey = None
+        # Transaction Fee Rate Grade
+        # Choose between transaction fees. If the transaction fee rate is preset, it will take priority
+        self.txFeeLevel = None
+        # Transaction fee rate, either txFeeLevel or feeRateDto
+        self.feeRateDto = FeeRateDto()
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["feeRateDto"] = dict["feeRateDto"].__dict__
+        return dict
+
+
+class OneTransactionsRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+
+
+class TransactionsFeeRateRequest:
+    def __init__(self):
+        # Coin key
+        self.coinKey = None
+        # Transaction hash, pass the original transaction hash when speed up transaction estimation
+        self.txHash = None
+        # Source account key, required for UTXO-based coins
+        self.sourceAccountKey = None
+        # Source address are required for TRON when estimating transaction fees. For EVM-based transactions, the source address is required when retrieving the gas limit on the blockchain. Otherwise, a default fixed gas limit value will be returned
+        self.sourceAddress = None
+        # Destination address is optional for TRON and FIL when estimating transaction fees (although providing it may result in a more accurate fee estimation). For EVM-based transactions, the destination address is required when retrieving the gas limit on the blockchain. Otherwise, a default fixed gas limit value will be returned
+        self.destinationAddress = None
+        # Transfer amount is required to calculate gas limit more accurately when using EVM chains. When using UTXO, providing the amount can estimate transaction fees more accurately. If no amount is provided, the calculation is based on the maximum UTXO quantity. When using SUI, providing the amount can estimate gas budget more accurately
+        self.value = None
+
+
+class CancelTransactionRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+        # Transaction type, TRANSACTION by default
+        self.txType = None
+
+
+class CollectionTransactionsUTXORequest:
+    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
+        # Transaction note (180 characters max)
+        self.note = None
+        # Coin key
+        self.coinKey = None
+        # Transaction fee rate, the unit is the feeUnit returned by the coin list
+        self.txFeeRate = None
+        # Transaction Fee Rate Grade
+        # Choose between the transaction fee rate. If the transaction fee rate is preset, it will take priority
+        self.txFeeLevel = None
+        # Maximum estimated transaction fee rate for a given transaction
+        self.maxTxFeeRate = None
+        # Minimum sweeping amount
+        self.minCollectionAmount = None
+        # Source account key
+        self.sourceAccountKey = None
+        # Account type
+        self.sourceAccountType = None
+        # Destination account key
+        self.destinationAccountKey = None
+        # Destination account type
+        self.destinationAccountType = None
+        # If the destinationAccountType is ONE_TIME_ADDRESS, then this field should have a value
+        self.destinationAddress = None
+        # Destination Tag
+        self.destinationTag = None
+
+
+class TransactionApi:
+
+    def __init__(self, config):
+        global api_client
+        api_client = Client(config)
+
+    # Transaction List V1
+    # Filter transaction history by various conditions. For optimal results, we recommend using the V2 version.
+    def list_transactions_v1(self, request: ListTransactionsV1Request):
+        return api_client.send_request(request, '/v1/transactions/list')
+
+    # Transaction List V2
+    # Filter transaction history by various conditions.
+    def list_transactions_v2(self, request: ListTransactionsV2Request):
+        return api_client.send_request(request, '/v2/transactions/list')
+
+    # Create a new transaction.
+    def create_transactions(self, request: CreateTransactionRequest):
+        request.asDict()
+        return api_client.send_request(request, '/v2/transactions/create')
+
+    # Speed up EVM and UTXO-based Transactions
+    # Transactions with low transaction fees and those that have been pending for a long time can be sped up. EVM-based and BTC transactions can be sped up through RBF(If 'isRbf' is set to true during transaction creation, the transaction will be accelerated using RBF acceleration. Otherwise, CPFP acceleration will be used.) For other UTXO-based transactions, CPFP will be used.
+    def recreate_transactions(self, request: RecreateTransactionRequest):
+        request.asDict()
+        return api_client.send_request(request, '/v2/transactions/recreate')
+
+    # Retrieve a Transaction
+    # To query a transaction, either customerRefId or txKey are required. If both values are provided, the retrieval will be based on the txKey.
+    def one_transactions(self, request: OneTransactionsRequest):
+        return api_client.send_request(request, '/v1/transactions/one')
+
+    # Estimate Transaction Fee
+    # This interface provides users with an estimated range of transaction fee rates of a given cryptocurrency when creating or speeding up transactions.
+    def transaction_fee_rate(self, request: TransactionsFeeRateRequest):
+        return api_client.send_request(request, '/v2/transactions/getFeeRate')
+
+    # Cancel Transaction
+    # Cancel the authorization-pending transaction and the signing-in-progress transaction.
+    def cancel_transactions(self, request: CancelTransactionRequest):
+        return api_client.send_request(request, '/v1/transactions/cancel')
+
+    # UTXO-Based Coin Sweeping
+    # For multi-address UTXO coins under a wallet account, this interface allows users to collect the balances of certain qualifying addresses into a specified destination address.
+    def collectionTransactionsUTXO(self, request: CollectionTransactionsUTXORequest):
+        return api_client.send_request(request, '/v1/transactions/utxo/collection')

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/api/web3_api.py

@@ -0,0 +1,257 @@
+import sys
+
+sys.path.pop(0)
+from safeheron_api_sdk_python.client import *
+
+
+class CreateWeb3AccountRequest:
+    def __init__(self):
+        # Account name, within 30 characters
+        self.accountName = None
+        # 	Whether display in Safeheron Console
+        # True: not display
+        # False: display
+        # Default: false
+        self.hiddenOnUI = None
+
+
+class BatchCreateWeb3AccountRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+
+
+class ListWeb3AccountRequest:
+    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
+        # Filter the response based on this account name prefix
+        self.namePrefix = None
+
+
+class CreateWeb3EthSignRequest:
+    def __init__(self):
+        # Source account key
+        self.accountKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+        # Transaction note (180 characters max)
+        self.note = 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
+        # Message Hash
+        self.messageHash = self.MessageHash()
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["messageHash"] = dict["messageHash"].__dict__
+        return dict
+
+    class MessageHash:
+        def __init__(self):
+            # Chain ID (does not participate in signing, only the hash is used for signing)
+            self.chainId = None
+            # Pending signature hash, hexadecimal string (currently only supports one input)
+            self.hash = None
+
+
+class CreateWeb3PersonalSignRequest:
+    def __init__(self):
+        # Source account key
+        self.accountKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+        # Transaction note (180 characters max)
+        self.note = 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
+        # Message Hash
+        self.message = self.Message()
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["message"] = dict["message"].__dict__
+        return dict
+
+    class Message:
+        def __init__(self):
+            # Chain ID (does not participate in signing, only the hash is used for signing)
+            self.chainId = None
+            # Data to be signed
+            self.data = None
+
+
+class CreateWeb3EthSignTypedDataRequest:
+    def __init__(self):
+        # Source account key
+        self.accountKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+        # Transaction note (180 characters max)
+        self.note = 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
+        # Message Hash
+        self.message = self.Message()
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["message"] = dict["message"].__dict__
+        return dict
+
+    class Message:
+        def __init__(self):
+            # Chain ID (does not participate in signing, only the hash is used for signing)
+            self.chainId = None
+            # Data to be signed
+            self.data = None
+            # EthSignTypedData Version
+            self.version = None
+
+
+class CreateWeb3EthSignTransactionRequest:
+    def __init__(self):
+        # Source account key
+        self.accountKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+        # Transaction note (180 characters max)
+        self.note = 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
+        # Transaction
+        self.transaction = self.Transaction()
+
+    def asDict(self):
+        dict = self.__dict__
+        dict["transaction"] = dict["transaction"].__dict__
+        return dict
+
+    class Transaction:
+        def __init__(self):
+            # To
+            self.to = None
+            # Value (Unit: wei)
+            self.value = None
+            # Chain ID
+            self.chainId = None
+            # Gas price
+            self.gasPrice = None
+            # Gas limit
+            self.gasLimit = None
+            # Max priority fee per gas for EIP-1559
+            self.maxPriorityFeePerGas = None
+            # Max fee per gas for EIP-1559
+            self.maxFeePerGas = None
+            # Nonce
+            self.nonce = None
+            # Data
+            self.data = None
+
+
+class CancelWeb3SignRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+
+
+class OneWeb3SignRequest:
+    def __init__(self):
+        # Transaction key
+        self.txKey = None
+        # Merchant unique business ID (100 characters max)
+        self.customerRefId = None
+
+
+class ListWeb3SignRequest:
+    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
+        # Web3 Sign type
+        self.subjectType = None
+        # Transaction status
+        self.transactionStatus = None
+        # Source account key
+        self.accountKey = 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 Web3Api:
+
+    def __init__(self, config):
+        global api_client
+        api_client = Client(config)
+
+    # Create a Web3 Wallet Account
+    def createWeb3Account(self, request: CreateWeb3AccountRequest):
+        return api_client.send_request(request, '/v1/web3/account/create')
+
+    # Batch Create Web3 Wallet Accounts
+    # Create a batch of wallet accounts based on specified number. Web3 wallet accounts created in batches are not displayed in the Safeheron App by default.
+    def batchCreateWeb3Account(self, request: BatchCreateWeb3AccountRequest):
+        return api_client.send_request(request, '/v1/web3/batch/account/create')
+
+    # List Web3 Wallet Accounts
+    # Filter Web3 wallet account lists by various conditions.
+    def listWeb3Accounts(self, request: ListWeb3AccountRequest):
+        return api_client.send_request(request, '/v1/web3/account/list')
+
+    # Create ethSign
+    # Merchants can initiate an ethSign signature through this interface. The merchant is required to serialize the transaction data, generating a corresponding hash (supporting both 0x and non-0x formatted data). The hash is then submitted through this interface to create a signature, which can be obtained by Retrieve a Single Web3 Signature interface or webhook. From there, merchants can complete the subsequent steps according to their own needs once they have obtained the signature.
+    def createWeb3EthSign(self, request: CreateWeb3EthSignRequest):
+        request.asDict();
+        return api_client.send_request(request, '/v1/web3/sign/ethSign')
+
+    # Create personalSign
+    # Merchants can initiate a personalSign signature for any text using this interface. The merchant only needs to prepare the data to be signed and submit it through this interface to create the signature. The resulting signature can then be obtained by Retrieve a Single Web3 Signature interface or via webhook. From there, merchants can complete the subsequent steps according to their own needs once they have obtained the signature.
+    def createWeb3PersonalSign(self, request: CreateWeb3PersonalSignRequest):
+        request.asDict()
+        return api_client.send_request(request, '/v1/web3/sign/personalSign')
+
+    # Create ethSignTypedData
+    # Merchants can initiate an ethSignTypedData signature of specific formatted data (supporting data formats of v1, v3, and v4) through this interface. Merchants will need to format their signature data and submit it through the interface. Once the signature is created, the result can be retrieved via Retrieve a Single Web3 Signature interface or webhook. From there, merchants can complete the subsequent steps according to their own needs once they have obtained the signature.
+    def createWeb3EthSignTypedData(self, request: CreateWeb3EthSignTypedDataRequest):
+        request.asDict()
+        return api_client.send_request(request, '/v1/web3/sign/ethSignTypedData')
+
+    # Create ethSignTransaction
+    # Merchants can initiate ethSignTransaction signature transactions through this interface. The merchant must prepare transaction-related data, such as from, to, nonce, gas limit, gas price, value, data, and more. Once this data is submitted, a signature is created and the result can be obtained by Retrieve a Single Web3 Signature interface or webhook. From there, merchants can complete the subsequent steps according to their own needs once they have obtained the signature.
+    def createWeb3EthSignTransaction(self, request: CreateWeb3EthSignTransactionRequest):
+        request.asDict()
+        return api_client.send_request(request, '/v1/web3/sign/ethSignTransaction')
+
+    # Cancel Signature
+    # Cancel pending signatures.
+    def cancelWeb3Sign(self, request: CancelWeb3SignRequest):
+        return api_client.send_request(request, '/v1/web3/sign/cancel')
+
+    # Retrieve a Single Web3 Signature
+    # To query a transaction, either customerRefId or txKey are required. If both values are provided, the retrieval will be based on the txKey.
+    def oneWeb3Sign(self, request: OneWeb3SignRequest):
+        return api_client.send_request(request, '/v1/web3/sign/one')
+
+    # Web3 Sign Transaction List
+    # Filter Web3 Sign history by various conditions.
+    def listWeb3Sign(self, request: ListWeb3SignRequest):
+        return api_client.send_request(request, '/v1/web3/sign/list')

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/cosigner/co_signer_converter.py

@@ -0,0 +1,90 @@
+import sys
+
+sys.path.pop(0)
+from safeheron_api_sdk_python.tools import *
+
+
+class CoSignerResponse:
+    def __init__(self):
+        # approve
+        self.approve = None
+        # txKey
+        self.txKey = None
+
+
+class CoSignerConverter:
+
+    def __init__(self, config):
+        global api_pub_key
+        global biz_privKey
+        api_pub_key = config['apiPubKey']
+        if 'bizPrivKey' in config:
+            biz_privKey = PEM_PRIVATE_HEAD + config['bizPrivKey'] + PEM_PRIVATE_END
+        if 'bizPrivKeyPemFile' in config:
+            private_key_pem_file = config['bizPrivKeyPemFile']
+            if private_key_pem_file is not None and private_key_pem_file != '':
+                biz_privKey = load_rsa_private_key(private_key_pem_file)
+
+    def request_convert(self, co_signer_call_back):
+        platform_rsa_pk = get_rsa_key(PEM_PUBLIC_HEAD + api_pub_key + PEM_PUBLIC_END)
+        api_user_rsa_sk = get_rsa_key(biz_privKey)
+        required_keys = {
+            'key',
+            'sig',
+            'bizContent',
+            'timestamp',
+        }
+
+        missing_keys = required_keys.difference(co_signer_call_back.keys())
+        if missing_keys:
+            raise Exception(co_signer_call_back)
+
+        # 1 rsa verify
+        sig = co_signer_call_back.pop('sig')
+        need_sign_message = sort_request(co_signer_call_back)
+        v = rsa_verify(platform_rsa_pk, need_sign_message, sig)
+        if not v:
+            raise Exception("rsa verify: false")
+
+        # 2 get aes key and iv
+        key = co_signer_call_back.pop('key')
+        aes_data = rsa_decrypt(api_user_rsa_sk, key)
+        aes_key = aes_data[0:32]
+        aes_iv = aes_data[32:48]
+
+        # 3 aes decrypt data, get response data
+        r = aes_decrypt(aes_key, aes_iv, b64decode(co_signer_call_back['bizContent']))
+        # response_dict['bizContent'] = json.loads(r.decode())
+
+        return json.loads(r.decode())
+
+    def response_converter(self, co_signer_response: CoSignerResponse):
+        platform_rsa_pk = get_rsa_key(PEM_PUBLIC_HEAD + api_pub_key + PEM_PUBLIC_END)
+        api_user_rsa_sk = get_rsa_key(PEM_PRIVATE_HEAD + biz_privKey + PEM_PRIVATE_END)
+
+        ret = dict()
+
+        # prepare aes key and iv
+        aes_key = get_random_bytes(32)
+        aes_iv = get_random_bytes(16)
+        response_data = json.dumps(co_signer_response.__dict__).replace('\'', '\"').replace('\n', '').encode('utf-8')
+
+        # 1 rsa encrypt aes key + iv
+        aes_data = aes_key + aes_iv
+        ret['key'] = rsa_encrypt(platform_rsa_pk, aes_data)
+
+        # 2 aes encrypt request data
+        if response_data is not None:
+            aes_encrypted_bytes = aes_encrypt(aes_key, aes_iv, response_data)
+            ret['bizContent'] = b64encode(aes_encrypted_bytes).decode()
+
+        # 3 set timestamp
+        ret['timestamp'] = str(int(time.time() * 1000))
+        ret['code'] = str('200')
+        ret['message'] = str('SUCCESS')
+
+        # 4 sign request
+        need_sign_message = sort_request(ret)
+        ret['sig'] = rsa_sign(api_user_rsa_sk, need_sign_message)
+
+        return ret

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python/webhook/webhook_converter.py

@@ -0,0 +1,51 @@
+import sys
+
+sys.path.pop(0)
+from safeheron_api_sdk_python.tools import *
+
+
+class WebhookConverter:
+
+    def __init__(self, config):
+        global safeheron_webHook_rsa_public_key
+        global web_hook_rsa_private_key
+        safeheron_webHook_rsa_public_key = config['safeheronWebHookRsaPublicKey']
+        if 'webHookRsaPrivateKey' in config:
+            web_hook_rsa_private_key = PEM_PRIVATE_HEAD + config['webHookRsaPrivateKey'] + PEM_PRIVATE_END
+        if 'webHookRsaPrivateKeyPemFile' in config:
+            private_key_pem_file = config['webHookRsaPrivateKeyPemFile']
+            if private_key_pem_file is not None and private_key_pem_file != '':
+                web_hook_rsa_private_key = load_rsa_private_key(private_key_pem_file)
+
+    def converter(self, webhook):
+        platform_rsa_pk = get_rsa_key(PEM_PUBLIC_HEAD + safeheron_webHook_rsa_public_key + PEM_PUBLIC_END)
+        api_user_rsa_sk = get_rsa_key(web_hook_rsa_private_key)
+        required_keys = {
+            'key',
+            'sig',
+            'bizContent',
+            'timestamp',
+        }
+
+        missing_keys = required_keys.difference(webhook.keys())
+        if missing_keys:
+            raise Exception(webhook)
+
+        # 1 rsa verify
+        sig = webhook.pop('sig')
+        need_sign_message = sort_request(webhook)
+        v = rsa_verify(platform_rsa_pk, need_sign_message, sig)
+        if not v:
+            raise Exception("rsa verify: false")
+
+        # 2 get aes key and iv
+        key = webhook.pop('key')
+        aes_data = rsa_decrypt(api_user_rsa_sk, key)
+        aes_key = aes_data[0:32]
+        aes_iv = aes_data[32:48]
+
+        # 3 aes decrypt data, get response data
+        r = aes_decrypt(aes_key, aes_iv, b64decode(webhook['bizContent']))
+        # response_dict['bizContent'] = json.loads(r.decode())
+
+        return json.loads(r.decode())

{safeheron_api_sdk_python-1.0.5 → safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: safeheron_api_sdk_python
-Version: 1.0.5
+Version: 1.0.6
 Summary: Python for Safeheron API
 Home-page: https://github.com/Safeheron/safeheron-api-sdk-python
 Author: safeheron

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+README.rst
+setup.py
+safeheron_api_sdk_python/client.py
+safeheron_api_sdk_python/tools.py
+safeheron_api_sdk_python.egg-info/PKG-INFO
+safeheron_api_sdk_python.egg-info/SOURCES.txt
+safeheron_api_sdk_python.egg-info/dependency_links.txt
+safeheron_api_sdk_python.egg-info/top_level.txt
+safeheron_api_sdk_python/api/account_api.py
+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/cosigner/co_signer_converter.py
+safeheron_api_sdk_python/webhook/webhook_converter.py

safeheron_api_sdk_python-1.0.6/safeheron_api_sdk_python.egg-info/top_level.txt

@@ -0,0 +1 @@
+safeheron_api_sdk_python

{safeheron_api_sdk_python-1.0.5 → safeheron_api_sdk_python-1.0.6}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages
 with open("README.rst", "r") as f:
     long_description = f.read()
 setup(name='safeheron_api_sdk_python',
-      version='1.0.5',
+      version='1.0.6',
       description='Python for Safeheron API',
       long_description=long_description,
       author='safeheron',
@@ -11,7 +11,7 @@ setup(name='safeheron_api_sdk_python',
       url='https://github.com/Safeheron/safeheron-api-sdk-python',
       install_requires=[],
       license='MIT License',
-      packages=find_packages(include=['safeheron_api_sdk_python', 'safeheron_api_sdk_python.*']),
+      packages=['safeheron_api_sdk_python','safeheron_api_sdk_python.api','safeheron_api_sdk_python.cosigner','safeheron_api_sdk_python.webhook'],
       platforms=["all"],
       classifiers=[
           'Operating System :: OS Independent',

safeheron_api_sdk_python-1.0.5/safeheron_api_sdk_python.egg-info/SOURCES.txt

@@ -1,10 +0,0 @@
-LICENSE
-README.md
-README.rst
-setup.py
-safeheron_api_sdk_python/client.py
-safeheron_api_sdk_python/tools.py
-safeheron_api_sdk_python.egg-info/PKG-INFO
-safeheron_api_sdk_python.egg-info/SOURCES.txt
-safeheron_api_sdk_python.egg-info/dependency_links.txt
-safeheron_api_sdk_python.egg-info/top_level.txt

safeheron_api_sdk_python-1.0.5/safeheron_api_sdk_python.egg-info/top_level.txt

@@ -1 +0,0 @@
-