ChainUp MPC Wallet

ChainUp Custody ensures the overall implementation and application of MPC technology, providing the highest level of market security for your investment assets. User private keys are jointly managed by users and ChainUp Custody, granting you complete control over your assets without limitations of time and location. This technology facilitates easy backup and recovery of assets, eliminating single-point failures in private key management and enhancing the security of self-managed assets.

The nature of the MPC protocol allows users to know which private key shares participate in signing without requiring participants to disclose their identities externally. This ensures the confidentiality of each party's input. Additionally, MPC guarantees that the signature generation party remains private and invisible on the network, ensuring personal data privacy while maintaining the trustworthiness of multi-party cooperation and transactions.

ChainUp Custody MPC provides a simple and efficient integration component and API, enabling developers to quickly connect to the system. This allows you to automate the management of your wallet and transaction processes. Furthermore, we offer transaction message notifications to promptly alert you of events.

The API primarily offers the following functions:

• Manage sub-wallets and view assets
• Obtain estimated transaction fees required for initiating transactions
• Initiate transactions and receive notifications of the final transaction status
• Automatically sign transactions and generate addresses through the Co-Signer provided by ChainUp Custody
• Retrieve detailed records of all transactions

Please contact your dedicated Business Manager or email to custody@chainup.com for API information.

Integration Guide

Developers can quickly integrate the ChainUp Custody - MPC Wallet API according to the following process.

Open an Account

To use the ChainUp MPC Wallet, you need to open an account. Clients can complete the account opening process independently.

Download the App

Users can obtain the app through the following methods:

Method 1: Visit the official website (https://custody.chainup.com/download) using a mobile browser or scan the QR code with a mobile device.

Method 2: Download from the App Store

• For Android, search for "ChainUp Custody" on the Google Play Store. If access to the Google Play Store is restricted in your country or region, you can download and install it from the official website.

• For iOS, search for "ChainUp Custody" on the App Store. Due to policy reasons, the app may not be available in some countries or regions (e.g., mainland China), so you can obtain it through an Apple account from another country or region.

Register and Login

The system supports registration and login via email or mobile number. Registration and login are combined into one function. The first login will automatically complete the registration.

Create a Wallet

After logging in, switch to MPC and create a wallet for your team in the app. The wallet creation will generate one private key share locally in the app. It is crucial to promptly back up the private key share, as some functions will be unavailable without it.

Currently, there are two backup methods: "Manual Copy" and "Upload to Cloud Server."

Wallets include both a Main Wallet and Sub Wallets. A main wallet can create multiple sub-wallets.

Use Cases:

• The main wallet can be used for asset statistics for a specific business line, while sub-wallets are assigned to different users.
• The main wallet can be used for overall company asset statistics, with sub-wallets assigned to different business departments.

The Private Key Password is used for encrypting and decrypting private key shares and is crucial for your asset security. Please ensure timely backup. The backup methods and password are essential for the secure use of the MPC wallet.

• ChainUp Custody uses a 3-3 signature strategy, with two private key shares encrypted and stored on Microsoft and Amazon cloud services, and one private key share stored locally on the user's device.
• Users have 100% control over their assets: ChainUp Custody only assists users in managing assets and cannot access user assets without the user's private key share signature. Therefore, users need to promptly back up and securely store the local private key share.
• For user convenience, the private key share exists in the form of a recovery phrases.

If the wallet configuration does not meet your requirements, please contact your dedicated Business Manager or email to custody@chainup.com for support.

Preparation

Before system development, the wallet needs to complete the following preparations.

Create API

The wallet creator should log in to the ChainUp Console System and create an API on the API Management page.

About RSA Public Key

To ensure secure data transmission, ChainUp uses the RSA-2048 PKCS#8 key format for asymmetric encryption of API request and response data. The public key is used to decrypt request data and needs to be uploaded to ChainUp, while the private key is used to encrypt data and is configured by the client on the corresponding server and securely stored.

Explanation of RSA Public-Private Key Pairs

• First pair of RSA public-private keys: After creating the API, ChainUp Custody will generate a default pair. The RSA public key will be provided to the developer for decrypting response parameters.

• Second pair of RSA public-private keys: Generated by the developer, used for encrypting parameters before API requests from the client's business system. The RSA public key is configured in ChainUp Custody for decrypting request parameters.

• Third pair of RSA public-private keys: Generated by the developer, used by Co-Signer for encrypting parameters before API requests. The RSA public key is configured in ChainUp Custody for decrypting request parameters.

• Fourth pair of RSA public-private keys (optional): Generated by the developer, mainly used for verifying transaction signatures when Co-Signer does not configure callback notifications. This pair of public-private keys is generated and saved by the client, and ChainUp Custody does not retain it.

Callback Notifications

The system currently supports three types of callback services: Transaction Status Callback, Signature Callback, and Transaction Approval Callback.

• Transaction Status Callback: ChainUp will notify the client of the latest status of an order when processing is completed (e.g. receiving, transfer orders). The client configures this callback address on the ChainUp platform on the Create API page under Transaction Status Notification Address.

• Signature Callback: ChainUp will callback Co-Signer for signature operations when creating an address or generating private key shares for Co-Signer. The client configures this callback address on the ChainUp platform on the Create API page under Co-Signer Interface Address.

• Transaction Approval Callback Address: Please refer to the Co-Signer configuration.

Configure Co-Signer

Co-Signer is commonly used for automated signing of OpenAPI-initiated transactions and automatic consolidation of transactions.

Co-Signer Server Selection

Co-Signer supports deployment on a regular server or supports SGX server. For security reasons, it is recommended to use a server with SGX support, preferably from Microsoft cloud services. View Co-Signer Server Configuration Requirements

Co-Signer Configuration

Co-Signer provides a callback handler, which is an optional component:

• If configuring the callback handler (Security Level: High): Co-Signer will perform a secondary review of transaction requests initiated by OpenAPI to the business server. Signing operations will only proceed when the business server's review is successful. Transactions like creating addresses, assets consolidation, and refueling will not trigger callbacks.

• If not configuring the callback handler (Security Level: Higher): API Co-Signer will verify transaction signatures and sign all transaction requests initiated by OpenAPI.

• View Co-Signer Configuration Tutorial

Create Co-Signer Private Key Shares

After configuring API and Co-Signer programs, create private key shares for Co-Signer in the app.

The wallet creator can create Co-Signer private key shares on the MPC Wallet Security - Co-Signer page. The created Co-Signer private key shares will be encrypted and synchronized to the Co-Signer server using the Co-Signer RSA public key configured by the client on the ChainUp platform.

Enable Automatic Consolidation

To enhance assets security and utilization, some main chains need to be configured for consolidation and refueling functions. ChainUp provides a set of automated consolidation solutions for clients. The specific operation process is as follows:

Login to the ChainUp management platform and create it on the Co-Signer page;

• Wallet members (any role) set the assets consolidation to the receiving wallet and refueling wallet. Only sub-wallets displayed in the app can be selected. For efficient assets use, it is recommended to set the consolidation wallet and refueling wallet to different wallets (due to the nature of single-execution transfer for account-type main chains, if configured with the same wallet, the withdrawal transaction(transfer) will wait until the miner fee is supplemented when supplementing the miner fee for the address).

• The wallet creator approves the signature in the app. Encrypt the set wallets with the wallet's private key to ensure the correct address for assets consolidation.

• Wallet members (any role) configure sub-wallet consolidation, refueling application scope, coin consolidation, refueling rules, and other information.

Application Consolidation Scope

Configure the sub-wallets for which assets consolidation should be performed.

Consolidation Strategy

Configure the currencies for which assets consolidation should be performed, along with the consolidation threshold. Assets consolidation will be automatically triggered when the threshold is exceeded and the miner fee is set below the configured level. Users can customize the consolidation threshold and maximum miner fee through the Console or API.

Refueling Strategy

Configure the replenishment of miner fees for the consolidated currencies. Since token consolidation requires the use of the main coin as a miner fee, when the token in the address meets the consolidation strategy and the address does not have the main coin, replenishment of miner fees will be triggered from the refueling wallet to the address to be consolidated. The quantity of replenished miner fees can be customized, and it is essential to ensure that the replenished miner fee is lower than the consolidation threshold.

• Once the strategy is configured, the system runs automatically, and users can view asset changes in the set wallet.

It is recommended for clients to configure insufficient miner fee alerts to replenish in a timely manner and avoid affecting user transfers (withdrawals).

Integration Testing

To facilitate clients in quickly and conveniently integrating the system, ChainUp has outlined the core processes based on past client integration experiences, focusing on the integration solutions for [Get Receiving(Deposit) Address] , [User Receiving(Deposit)] and [User Transfer (Withdrawal]. The details are as follows:

Get Receiving Address

• Create a sub-wallet /api/mpc/sub_wallet/create

• Create a coin address for the sub-wallet /api/mpc/sub_wallet/create/address

• ChainUp callbacks Co-Signer for signing, and Co-Signer collaborates with ChainUp node to complete the signing

• Successfully signed, return the address created for the coin

Addresses support two types: system addresses and user addresses. The system address is used for assets consolidation or change, and cannot be assigned to users.

User Receiving (Deposit)

• Users complete registration within the client system.

• When users view the coin receiving address in the frontend, the client system assigns a coin address to the user.

• Users deposits assets to the assigned address.

• ChainUp monitors the blockchain address for incoming transactions. After detecting a deposit, ChainUp notifies the client's business system of the receiving notification (the client's system actively retrieves /api/mpc/billing/sync_deposit_list).

• The client obtains the current block height of the corresponding blockchain for the coin (/api/mpc/chain_height).

• The client system credits the user's account after confirming the required number of secure confirmations.

• User receives the coin (deposits successful).

User Transfer (Withdrawal)

• Users initiate a transfer in the client system.

• After the client system approves the Transfer, it initiates a Transfer request to the ChainUp system via API /api/mpc/billing/withdraw.

• Co-Signer periodically retrieves withdrawal transactions. If Co-Signer has configured a callback program, it confirms with the client's business system. If Co-Signer has configured signature verification, it verifies the signature and collaborates with the ChainUp node to sign.

• Once signed, ChainUp broadcasts the transaction to the blockchain and monitors its status.

If the transaction miner fee is too low, the transaction can be accelerated for quick confirmation. Users can perform this operation through the console or use the API /api/mpc/billing/withdraw_pending.

Supported blockchains for acceleration can be obtained through the API /api/mpc/wallet/open_coin.

• After blockchain confirmation, ChainUp notifies the client's business system of the transfer notification (the client's system actively retrieves /api/mpc/billing/sync_withdraw_list).

• The client system updates the order status.

• User transfer out successful.

API Interface

Overview

Domain and API Key

RSA Public-Private Key Format

RSA Public-Private Key Generator

Password Length: 2048

Key Format: PKCS#8

Interface Rules

Request Example:

POST /api/mpc/sub_wallet/assets

app_id=2128eb8de9e932a4376909f3d69424cc&data=SWYYr-LBVAmaS0eq8n-CUT_nHkM3OBxyWOsImMTe41UaqAoYI2ZghmaphXHov-7hsRsVmOhyPqC-JFuRGvonJKFd2Jirxv6Vn_8V40r_MMYTkhqcviQbZWYW5xX8Ai8CIpqas9fIWVDIYA_NKBl0UCJpwGxscxLNpjq5Z8-BTyIYDsVBquM9zEQGBCfcA7szD9n2fN_loSkoexlwqV8wg9HIZO5yQ6utZ_Kt0lNDQQb8zn8BwfAvsEsbJlOINUAqhxh1vV_AJ4bXn2uYx8TaYcBht-n_ZcBdxIDt975dbOFUiH-oCzIuDi1oLDtb4EylfCvhU5E4ozel_lQ-6cyIG0Dqiiyx0RFFOCJzPSXIoV031pvoa8pTCpkWklh8mRw1rylBgeZtqSxpnJO2_u2RIlXq6Hs8Yly9CmhIXaSrUgPir0h6xVxlf4VC6PFVCkiiTlp0kZ_H_UbKm0nUis3v3U2sflWJ2C449waSrikhuxVrFAQ6PQmrFVCAE6MYXNrFXJQuam2HAIQNSGbFQjspw8b_bXyfyZMGZ3K2oBC4I_v3eETTdPe0pfSNJb-5g37K0tOAr_UFbWK8pkC8yl56fSjn8tcR3yCRWwoi8jxTcUBiswTtvXZtzgG4dyzkaHXjsZjSGiywXSqP76VZWlyOmAx6IDSViLcPLPISdU3ruCI

Common Request Parameters

Common Response Parameters

Response Example:

{
    "data": "SWYYr-LBVAmaS0eq8n-CUT_nHkM3OBxyWOsImMTe41UaqAoYI2ZghmaphXHov
        -7hsRsVmOhyPqC-JFuRGvonJKFd2Jirxv6Vn_8V40r_MMYTkhqcviQbZWYW5xX8Ai8CIpqas9fIWVDIYA
        _NKBl0UCJpwGxscxLNpjq5Z8-BTyIYDsVBquM9zEQGBCfcA7szD9n2fN_loSkoexlwqV8wg9HIZO5yQ6utZ_
        Kt0lNDQQb8zn8BwfAvsEsbJlOINUAqhxh1vV_AJ4bXn2uYx8TaYcBht-n_ZcBdxIDt975dbOFUiH-
        oCzIuDi1oLDtb4EylfCvhU5E4ozel_lQ-6cyIG0Dqiiyx0RFFOCJzPSXIoV031pvoa8pTCpkWklh8mRw1rylBgeZtqSxpnJO2
        _u2RIlXq6Hs8Yly9CmhIXaSrUgPir0h6xVxlf4VC6PFVCkiiTlp0kZ
        _H_UbKm0nUis3v3U2sflWJ2C449waSrikhuxVrFAQ6PQmrFVCAE6MYXNrFXJQuam2HAIQNSGbFQjspw8b_
        bXyfyZMGZ3K2oBC4I_v3eETTdPe0pfSNJb-5g37K0tOAr_UFbWK8pkC8yl56fSjn8tcR3yCRWwoi8jxTcUBiswTtvXZtzgG4dyzka
        HXjsZjSGiywXSqP76VZWlyOmAx6IDSViLcPLPISdU3ruCI"
}

Decrypted Response Parameters

Encryption and Decryption

The values of the request parameter data and the response field data are both encrypted with RSA and then encrypted with base64urlsafe.

Wallet

Get Supported Main Chains

Get the supported MPC main chain coins and the MPC main chain coins opened in ChainUp Custody.

HTTP Request

GET /api/mpc/wallet/open_coin

Request Parameters

Response：

{
    "open_main_chain":[
        {
            "coin_net":"BTC",
            "symbol":"BTC",
            "symbol_alias":"BTC",
            "support_acceleration" : false
        },
        {
            "coin_net":"ETH",
            "symbol":"ETH",
            "symbol_alias":"ETH",
            "support_acceleration" : true
        }
    ],
    "support_main_chain":[
        {
            "coin_net":"BTC",
            "if_open_chain":true,
            "symbol":"BTC",
            "symbol_alias":"BTC",
            "support_acceleration" : false
        },
        {
            "coin_net":"ETH",
            "if_open_chain":false,
            "symbol":"ETH",
            "symbol_alias":"ETH",
            "support_acceleration" : true
        }
    ]
}

Response Data Parameters

Get MPC Coin Details

Get the details of MPC wallet main chain coins and tokens supported by ChainUp Custody

HTTP Request

GET /api/mpc/coin_list

Request Parameters

Response：

[
    {
        "address_regex":".*",
        "address_tag_regex":"",
        "base_symbol":"BSC",
        "coin_net":"BSC",
        "contract_address":"0xe9e7cea3dedca5984780bafc599bd69add087d56",
        "decimals":"18",
        "deposit_confirmation":"1",
        "address_link":"https://www.bscscan.com/address/",
        "tx_link":"https://www.bscscan.com/tx/",
        "icon":"",
        "if_open_chain":true,
        "name":"BUSD Token;BSC;BUSD",
        "real_symbol":"BUSD",
        "support_memo":"0",
        "support_token":"0",
        "symbol":"BUSD",
        "symbol_alias":"BUSD",
        "support_acceleration": true,
        "support_multi_addr" : true
    },
    {
        "address_regex":".*",
        "address_tag_regex":"",
        "base_symbol":"ETH",
        "coin_net":"ETH",
        "contract_address":"0xdac17f958d2ee523a2206206994597c13d831ec7",
        "decimals":"18",
        "deposit_confirmation":"1",
        "address_link":"https://etherscan.io/address/",
        "tx_link":"https://etherscan.io/tx/",
        "icon":"",
        "if_open_chain":false,
        "name":"USDTERC20;ETH;USDT",
        "real_symbol":"USDTERC20",
        "support_memo":"0",
        "support_token":"0",
        "symbol":"USDTERC20",
        "symbol_alias":"USDT",
        "support_acceleration": true,
        "support_multi_addr" : true
    }
]

Response Data Parameters

Get Latest Block Height

Get the latest block height of the specified main chain.

HTTP Request

GET /api/mpc/chain_height

Request Parameters

Response

{
    "height": 10023412
}

Response Data Parameters

Sub-wallet

Create a Sub-wallet

Pass in the specified sub-wallet name to create a new sub-wallet for the main wallet

HTTP Request

POST /api/mpc/sub_wallet/create

Decrypted Request Parameters

Response：

{
    "sub_wallet_id": 10234122
}

Response Data Parameters

Sub-wallet Address Creation

Create an address for a specified sub-wallet and coin; the same sub-wallet can have multiple addresses, and Memo types may create multiple memos.

HTTP Request

POST /api/mpc/sub_wallet/create/address

Request Parameters Data Structure

Response

{
    "address": "0xd5b688639ef10ac7fb8ad0156eb0ae025dd03b86",
    "addr_type": 1,
    "memo": ""
}

Response Data Parameters

Query Sub-Wallet Address

List of sub-wallet addresses

HTTP Request

POST /api/mpc/sub_wallet/get/address/list

Request Parameters

Response

[
    {
        "address":"12ZzzA48sYnE12fdkmKmaxkR3Rz5j7Gjac",
        "addr_type": 1,
        "memo": ""
    },
    {
        "address":"139cRprA9siBDbScbjtCZTcESUgZ1rm9fr",
        "addr_type": 2,
        "memo": ""
    }
]

Response Data Parameters

Get Sub-wallet Assets

Get the account assets under the specified sub-wallet and coin.

HTTP Request

GET /api/mpc/sub_wallet/assets

Decrypted Request Parameters

Response

{
    "collecting_balance":"3.23",
    "normal_balance":"1.23",
    "lock_balance":"0.77"
}

Response Data Parameters

Modify the Display Status

The display of the specified sub-wallet in the App and web portal is essential for initiating transactions. If it is not displayed, transactions cannot be initiated in the app.

HTTP Request

POST /api/mpc/sub_wallet/change_show_status

Decrypted Request Parameters

Response Data Parameters

None

Transfer (Withdrawal)

Initiate a Transfer

HTTP Request

POST /api/mpc/billing/withdraw

Decrypted Request Parameters

Response

{
    "withdraw_id": 12345
}

Response Data Parameters

Estimated Gas Fee

Obtain the estimated miner fee required for transfer.

HTTP Request

GET /api/mpc/billing/gas_estimate

Decrypted Request Parameters

Response

{
    "gas_limit":0,
    "fee_unit":"Gwei",
    "gas_price1":"0",
    "fee":"0.00159",
    "gas_price2":"0",
    "gas_price3":"0",
    "trans_fee":"0.00159"
}

Response Data Parameters

Speed Up Transfer

After the transfer signature is completed, if the transaction fee has not been process on the chain for a long time due to insufficient gas fee, you can re-specify a higher gas fee to speed up the process on the blockchain.

HTTP Request

POST /api/mpc/billing/withdraw_pending

Decrypted Request Parameters

Response Data Parameters

None

Get Transfer Records

Get all sub-wallet transfer records under the main wallet, and return up to 100 records

HTTP Request

GET /api/mpc/billing/withdraw_list

Decrypted Request Parameters

Response

[
    {
        "symbol":"ETH",
        "amount":"0.0000111",
        "real_fee":"0",
        "withdraw_source":2,
        "fee":"0.0002782353",
        "address_to":"0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
        "memo": "",
        "created_at":1672304978000,
        "txid":"0x8e6beba81b90835fc9fcd40a2bdca33243c7c3b81ac765c240837d4810874a55",
        "confirmations":0,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0x5EDc9177997Bf6B4db559A5C184051858B3B3704",
        "fee_symbol":"ETH",
        "updated_at":1672318660000,
        "base_symbol":"",
        "id":242,
        "request_id":"57fdc296-1e14-47fa-a99d-5e86f8e51008",
        "status":1200,
        "tx_height":3120013
    },
    {
        "symbol":"TRX",
        "amount":"0.001",
        "real_fee":"0",
        "withdraw_source":1,
        "fee":"27.4",
        "address_to":"TYQJcpoH2zeZ2pnpRokwBeRZ16yqyNZPR4",
        "memo": "",
        "created_at":1672304978000,
        "txid":"dee604ca778aee55ef0d17260ee4a96d69dfbc965228288598dce0cf9c829542",
        "confirmations":0,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"TC1rbTinyRyNC5sBJdxGcADbVXh9xcHwwQ",
        "fee_symbol":"TRX",
        "updated_at":1672318660000,
        "base_symbol":"",
        "id":242,
        "request_id":"57fdc296-1e14-47fa-a99d-5e86f8e51008",
        "status":2000,
        "tx_height":56207376
    }
]

Response Data Parameters

Synchronize Transfer Records

Get all sub-wallet transfer records under the main wallet, and return up to 100 records

HTTP Request

GET /api/mpc/billing/sync_withdraw_list

Decrypted Request Parameters

Response

[
    {
        "symbol":"ETH",
        "amount":"0.0000111",
        "real_fee":"0",
        "withdraw_source":2,
        "fee":"0.0002782353",
        "address_to":"0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
        "memo": "",
        "created_at":1672304978000,
        "txid":"0x8e6beba81b90835fc9fcd40a2bdca33243c7c3b81ac765c240837d4810874a55",
        "confirmations":0,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0x5EDc9177997Bf6B4db559A5C184051858B3B3704",
        "fee_symbol":"ETH",
        "updated_at":1672318660000,
        "base_symbol":"",
        "id":242,
        "request_id":"57fdc296-1e14-47fa-a99d-5e86f8e51008",
        "status":1200,
        "tx_height":3120013
    },
    {
        "symbol":"TRX",
        "amount":"0.001",
        "real_fee":"0",
        "withdraw_source":1,
        "fee":"27.4",
        "address_to":"TYQJcpoH2zeZ2pnpRokwBeRZ16yqyNZPR4",
        "memo": "",
        "created_at":1672304978000,
        "txid":"dee604ca778aee55ef0d17260ee4a96d69dfbc965228288598dce0cf9c829542",
        "confirmations":0,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"TC1rbTinyRyNC5sBJdxGcADbVXh9xcHwwQ",
        "fee_symbol":"TRX",
        "updated_at":1672318660000,
        "base_symbol":"",
        "id":242,
        "request_id":"57fdc296-1e14-47fa-a99d-5e86f8e51008",
        "status":2000,
        "tx_height":56207376
    }
]

Response Data Parameters

Receiving (Deposit)

Get Receiving records

Get all sub-wallet receiving records under the main wallet, and return up to 100 records

HTTP Request

GET /api/mpc/billing/deposit_list

Decrypted Request Parameters

Response

[
    {
        "symbol":"ETH",
        "amount":"1",
        "address_to":"0x33648fACAD6CECA85cf717841Ddd87c40B12438F",
        "memo": "",
        "created_at":1672107533000,
        "txid":"0xfd0b04024bd1d849ba69e301733194154cb42a05c1dd32065367d8c6336af711",
        "confirmations":20,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
        "updated_at":1672323030000,
        "base_symbol":"ETH",
        "id":43,
        "status":2000,
        "tx_height":3120013
    },
    {
        "symbol":"ETH",
        "amount":"1",
        "address_to":"0x525208dd0b56c27bd10703bd675fca0509a17154",
        "memo": "",
        "created_at":1672107533000,
        "txid":"0x97cccb68595182d8df439fe17d33376d4bb69abf49d56e08d46fa5f281e095fb",
        "confirmations":5,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0xe897Fd38f319cB343ffD03Ba2f7426BA99bb97c4",
        "updated_at":1672323030000,
        "base_symbol":"ETH",
        "id":45,
        "status":2000,
        "tx_height":13238654
    }
]

Response Data Parameters

Sync Receiving record

Get all sub-wallet receiving records under the main wallet, and return up to 100 records

HTTP Request

GET /api/mpc/billing/sync_deposit_list

Decrypted Request Parameters

Response

[
    {
        "symbol":"ETH",
        "amount":"1",
        "address_to":"0x33648fACAD6CECA85cf717841Ddd87c40B12438F",
        "memo": "",
        "created_at":1672107533000,
        "txid":"0xfd0b04024bd1d849ba69e301733194154cb42a05c1dd32065367d8c6336af711",
        "confirmations":20,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
        "updated_at":1672323030000,
        "base_symbol":"ETH",
        "id":43,
        "status":2000,
        "tx_height":3120013
    },
    {
        "symbol":"ETH",
        "amount":"1",
        "address_to":"0x525208dd0b56c27bd10703bd675fca0509a17154",
        "memo": "",
        "created_at":1672107533000,
        "txid":"0x97cccb68595182d8df439fe17d33376d4bb69abf49d56e08d46fa5f281e095fb",
        "confirmations":5,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0xe897Fd38f319cB343ffD03Ba2f7426BA99bb97c4",
        "updated_at":1672323030000,
        "base_symbol":"ETH",
        "id":45,
        "status":2000,
        "tx_height":13238654
    }
]

Response Data Parameters

Auto-Consolidation

Get Auto-Consolidation Sub-Wallets

Retrieve the auto-consolidation sub-wallet and refueling sub-wallet for a specific coin.

HTTP Request

GET /api/mpc/auto_collect/sub_wallets

Request Data Parameters

Response

{
    "collect_sub_wallet_id": 10241,
    "fueling_sub_wallet_id": 20482
}

Response Data Parameters

Configure Auto-Consolidation for Coin

Set the minimum auto-consolidation amount and the maximum miner fee for refueling.

HTTP Request

POST /api/mpc/auto_collect/symbol/set

Request Parameters

Response

{
    "symbol": "USDTERC20  "
}

Response Parameter

Sync Consolidation Records

Retrieve up to 100 consolidation records for all sub-wallets under a wallet.

HTTP Request

GET /api/mpc/billing/sync_auto_collect_list

Request Parameter Data Structure

Response

[
    {
        "symbol":"ETH",
        "amount":"0.0000111",
        "real_fee":"0",
        "trans_type":10,
        "fee":"0.0002782353",
        "address_to":"0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
        "memo": "",
        "created_at":1672304978000,
        "txid":"0x8e6beba81b90835fc9fcd40a2bdca33243c7c3b81ac765c240837d4810874a55",
        "confirmations":0,
        "contract_address":"",
        "sub_wallet_id":"123",
        "address_from":"0x5EDc9177997Bf6B4db559A5C184051858B3B3704",
        "fee_symbol":"ETH",
        "updated_at":1672318660000,
        "base_symbol":"",
        "id":242,
        "status":1200
    },
    {
        "symbol":"HECO",
        "amount":"0.0000111",
        "real_fee":"0",
        "trans_type":11,
        "fee":"0.0024040607337957",
        "address_to":"0x0AabA82E4ba9c2Fdf80B9F8E1AcE885f092B64F0",
        "memo": "",
        "created_at":1672304978000,
        "txid":"",
        "confirmations":0,
        "contract_address":"",
        "sub_wallet_id":"123975",
        "address_from":"0xE76a3d30dAc35C4b9A17E690cd250d8Bec649b65",
        "fee_symbol":"HECO",
        "updated_at":1672318660000,
        "base_symbol":"HECO",
        "id":315,
        "status":2400
    }
]

Response Parameter Data Structure

Web3 Transaction

Create Web3 Transaction

Create a Web3 transaction.

HTTP Request

POST /api/mpc/web3/trans/create

Request Parameters

Response

{
     "trans_id": 198012
}

Response Data Parameters

Web3 Transaction Acceleration

When a transfer is signed but has not been confirmed on the blockchain for a long time due to insufficient fees, it can be accelerated by specifying a higher fee.

HTTP Request

POST /api/mpc/web3/pending

Request Parameters

Response Data Parameters

None

Get Web3 Transaction Records

Get all Web3 transaction records under a wallet, maximum of 100 records.

HTTP Request

GET /api/mpc/web3/trans_list

Request Parameters

Response

[
    {
        "id":435,
        "request_id":"0000000003",
        "sub_wallet_id":1000895,
        "txid":"0xbc87e486d28df91fe715436415bab38cc1cf5e4b23fbb8497ff688b823c08ba7",
        "symbol":"",
        "main_chain_symbol":"HECO",
        "amount":"0",
        "fee_symbol":"HECO",
        "fee":"0.00018",
        "real_fee":"0.000107277",
        "created_at":1684220373000,
        "updated_at":1684222558000,
        "address_from":"0xd5c2d98BF2d205039F62ee40c9A7ab1B36125d6d",
        "address_to":"",
        "confirmations":4,
        "input_data":"0xca718c65",
        "interactive_contract":"0xe012F3957226894B1a2a44b3ef5070417a069dC2",
        "status":2400,
        "trans_source":2,
        "tx_height":3120013
    },
    {
        "id":436,
        "request_id":"0000000003",
        "sub_wallet_id":1000895,
        "txid":"0xeab40bf0072c25514bc61fe58e5e36cc082ea7f50ae33f33013dd365beba9438",
        "symbol":"",
        "main_chain_symbol":"HECO",
        "amount":"0",
        "fee_symbol":"HECO",
        "fee":"0.00018",
        "real_fee":"0.000107277",
        "created_at":1684220373000,
        "updated_at":1684222558000,
        "address_from":"0xBDeBecf1fEDc622Cc50dE2F2aD6925D1EE15fCf9",
        "address_to":"",
        "confirmations":4,
        "input_data":"0xca718c65",
        "interactive_contract":"0x0AabA82E4ba9c2Fdf80B9F8E1AcE885f092B64F0",
        "status":2400,
        "trans_source":2,
        "tx_height":3120113
    }
]

Response Data Parameters

Sync Web3 Transaction Records

Get all Web3 transaction records under a wallet, maximum of 100 records.

HTTP Request

GET /api/mpc/web3/sync_trans_list

Request Parameters

Response

[
    {
        "id":437,
        "request_id":"0000000003",
        "sub_wallet_id":1000895,
        "txid":"0xbc87e486d28df91fe715436415bab38cc1cf5e4b23fbb8497ff688b823c08ba7",
        "symbol":"",
        "main_chain_symbol":"HECO",
        "amount":"0",
        "fee_symbol":"HECO",
        "fee":"0.00018",
        "real_fee":"0.000107277",
        "created_at":1684220373000,
        "updated_at":1684222558000,
        "address_from":"0xd5c2d98BF2d205039F62ee40c9A7ab1B36125d6d",
        "address_to":"",
        "confirmations":4,
        "input_data":"0xca718c65",
        "interactive_contract":"0xe012F3957226894B1a2a44b3ef5070417a069dC2",
        "status":2400,
        "trans_source":2,
        "tx_height":3120013
    },
    {
        "id":438,
        "request_id":"0000000003",
        "sub_wallet_id":1000895,
        "txid":"0xeab40bf0072c25514bc61fe58e5e36cc082ea7f50ae33f33013dd365beba9438",
        "symbol":"",
        "main_chain_symbol":"HECO",
        "amount":"0",
        "fee_symbol":"HECO",
        "fee":"0.00018",
        "real_fee":"0.000107277",
        "created_at":1684220373000,
        "updated_at":1684222558000,
        "address_from":"0xBDeBecf1fEDc622Cc50dE2F2aD6925D1EE15fCf9",
        "address_to":"",
        "confirmations":4,
        "input_data":"0xca718c65",
        "interactive_contract":"0x0AabA82E4ba9c2Fdf80B9F8E1AcE885f092B64F0",
        "status":2400,
        "trans_source":2,
        "tx_height":3120113
    }
]

Response Data Parameters

NFT

Get NFT Information

Retrieve NFT data such as images and names.

HTTP Request

POST /api/nft/info

Request Data Parameter

Response

{
     "base_symbol": "bsc",
     "contract_address": "0xC2A19349D5f451071C3085B90f531D19F190FF21",
     "token_id": "75000000000000000281",
     "nft_name": "#75000000000000000281",
     "image": "https://ipfs.io/ipfs/QmXCaMVmRWviaFtRpEH7dJXrJav8dsJdGcsj7M8NpgAgPW",
     "image_type": ".svg",
     "is_video": false,
}

Response Parameter

Transaction Notification

Overview

POST /user callback notification address

Request Example

app_id=2128eb8de9e932a4376909f3d69424cc&data=SWYYr-LBVAmaS0eq8n-CUT_nHkM3OBxyWOsImMTe41UaqAoYI2ZghmaphXHov-7hsRsVmOhyPqC-JFuRGvonJKFd2Jirxv6Vn_8V40r_MMYTkhqcviQbZWYW5xX8Ai8CIpqas9fIWVDIYA_NKBl0UCJpwGxscxLNpjq5Z8-BTyIYDsVBquM9zEQGBCfcA7szD9n2fN_loSkoexlwqV8wg9HIZO5yQ6utZ_Kt0lNDQQb8zn8BwfAvsEsbJlOINUAqhxh1vV_AJ4bXn2uYx8TaYcBht-n_ZcBdxIDt975dbOFUiH-oCzIuDi1oLDtb4EylfCvhU5E4ozel_lQ-6cyIG0Dqiiyx0RFFOCJzPSXIoV031pvoa8pTCpkWklh8mRw1rylBgeZtqSxpnJO2_u2RIlXq6Hs8Yly9CmhIXaSrUgPir0h6xVxlf4VC6PFVCkiiTlp0kZ_H_UbKm0nUis3v3U2sflWJ2C449waSrikhuxVrFAQ6PQmrFVCAE6MYXNrFXJQuam2HAIQNSGbFQjspw8b_bXyfyZMGZ3K2oBC4I_v3eETTdPe0pfSNJb-5g37K0tOAr_UFbWK8pkC8yl56fSjn8tcR3yCRWwoi8jxTcUBiswTtvXZtzgG4dyzkaHXjsZjSGiywXSqP76VZWlyOmAx6IDSViLcPLPISdU3ruCI

Common Request Parameters

Common Response

Return string: SUCCESS means SUCCESS, FAILURE means FAILURE (note that the return parameter does not need to be encrypted here)

Transfer (Withdrawal)

Decrypted Request Parameters

Receiving (Deposit)

Decrypted Request Parameters

Web3 Transaction

Request Parameters

Co-Signer

Overview

Co-Signer can help you quickly integrate with the API and needs to be deployed separately on a server. Co-Signer needs to bind the shard private key of your wallet for creating addresses and signing transactions.

• Before signing a transaction, Co-Signer will callback to your business system. It can initiate the signature only after authorization is obtained; otherwise, the transaction cannot proceed.

• After the app-side signature authorization for the consolidation transaction, it will not callback to the Client system.

• View Co-Signer Deployment Documentation

Integration Process

Co-Signer mainly implements two functions: creating addresses and automatic signing. The calling relationship is as shown in the following diagram:

Creating an Address:

Automatic Signature (Callback Method):

Automatic Signature (Signature Sign Verification Method):

• Both callback and signature sign verification methods can coexist, but at least one verification method is required. Developers can choose the verification method according to their needs.

Co-Signer Callback

To ensure the security of transactions, you need to configure a callback address for the business system in Co-Signer and authorize it before transaction signing.

The authorized transaction data is transmitted in plaintext, and you need to ensure the communication security between the business system and Co-Signer in the application service.

Transfer(Withdrawal) Callback

HTTP Request

POST /{url}

Content-Type application/json;charset=UTF-8

Request

POST /callback/example

{
    "type":"sign_start",
    "transfer_id":321456,
    "request_id":"c70d1eebb7c687ec8d56bead73f104",
    "pending_round":false,
    "from":"0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
    "to":"0x5EDc9177997Bf6B4db559A5C184051858B3B3704",
    "memo": "123321",
    "amount":167230.4978,
    "symbol":"BTC"
}

Callback Request Parameters

Web3 Transaction Callback

HTTP Request

POST /{url}

Content-Type: application/json;charset=UTF-8

Callback Parameter Example

POST /callback/example

{
    "type": "sign_start",
    "trans_id": 432,
    "request_id": "0000000003",
    "pending_round": false,
    "from": "0xc70d1eebb7c687ec8d56bead73f104d41e6e0bda",
    "to": "0x5EDc9177997Bf6B4db559A5C184051858B3B3704",
    "amount": 0,
    "main_chain_symbol": "HECO",
    "input_data": "0xca718c65",
    "interactive_contract": "0xe012F3957226894B1a2a44b3ef5070417a069dC2",
    "txid": ""
}

Callback Parameter Format:

Common Response for Callback

Return string: SUCCESS means SUCCESS, FAILURE means FAILURE

Co-Signer Transaction Signature Verification

Co-Signer provides a more secure dual-verification feature for transactions.

In addition to the Co-Signer callback mechanism, Clients can simultaneously pass the sign field when initiating a transaction. Co-Signer will additionally verify whether the sign is legal.

Error Code