About BLUEHELIX BAAS

Overview

BLUEHELIX BAAS provides a REST API (HTTPS + JSON) to facilitate Bluehelix Cloud customers' for self-service access to third-party public chains.

Before requesting for an API socket, users need to apply for an APIKEY by using ED25519 algorithm to generate the Public & Private Keys(see client demos). Users are required to save the Public & Private Keys. Submit the application for coin listing and attach the Public Keys accordingly. The APIKEY will then be issued to the applicant.

How to apply?

Submit a Ticket Request

Information Required For Coin Listing

Parameter	Value
Digital Asset Symbol	ABC
Explorer	ABC
Decimals	8
Total Supply	10 billion
Address check regexp	^0x[0-9a-fA-F]{50}$
Memo required	Y/N
Memo check regexp	^[0-9]{6-12}$
IP address	100.100.100.100 (used as IP whitelist restriction, please use a elastic IP)

Client Sample

Developer can code using any one of the following programming languages (Python, Golang, Java) https://github.com/bhexopen/baas.

API Signature Authentication

The data needs to be signed as the following: HTTP_METHOD + | + HTTP_REQUEST_PATH + | + TIMESTAMP + | + PARAMS

The API signature should sign data with ED25519 signature after connection and sign the bytes with hex encoding.

Domain name

Prod env：https://baas.bluehelix.com

HTTPMethods

GET POST

TIMESTAMP

When accessing API, the UNIX EPOCH timestamp(ms), expires in 120000ms.

Complete Sample

POST Request

METHOD	URL	TIMESTAMP
POST	https://baas.bluehelix.com/api/v1/test	1580887996488

The request data shown on the right:：

{
  "side": 1,
  "amount": "100.0543",
  "token_id": "ABC",
  "tx_hash":"0x1234567890",
  "block_height": 1000000
}

Before signing in, you need to sort the request parameters according to the first letter of the key to obtain the following data POST|/api/v1/test/|1580887996488|amount=100.0543&block_height=1000000&side=1&token_id=ABC&tx_hash=0x1234567890

Use your locally generated private_key to sign off the data with ED25519. Then Hex-encode the binary result to obtain the final signature.

In the HTTP request, enter the header to bypass the verification:

BWAAS-API-KEY
BWAAS-API-SIGNATURE
BWAAS-API-TIMESTAMP

GET Request

METHOD	URL	TIMESTAMP
GET	https://baas.bluehelix.com/api/v1/test?chain=ABC	1580887996488

Before signing in, you need to sort the request parameters according to the first letter of the key to obtain the following data GET|/api/v1/test?chain=ABC|1580887996488

Use your locally generated private_key to sign off the data with ED25519. Then Hex-encode the binary result to obtain the final signature.

In the HTTP request, enter the header to bypass the verification:

BWAAS-API-KEY
BWAAS-API-SIGNATURE
BWAAS-API-TIMESTAMP

API List

Count the number of unused address

Count the number of unused address

curl
  -X GET
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  https://baas.bluehelix.com/api/v1/address/unused/count/
?chain=ABC

Reponse：

{
    "code": 10000,
    "msg": "success",
    "data": 1000
}

HTTP Request：

GET /api/v1/address/unused/count?chain=ABC

Request parameters：

Parameter	Type	Mandatory	Description
chain	string	yes	The chain,use mainnet token

Response：

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed
data	int	Number of unused address

Add deposit address

Add deposit address

curl
  -X POST
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  -- data '
    {
      "chain":"ABC",
      "addr_list":[
        "addr_111",
        "addr_222"
      ]
    }
  '
  https://baas.bluehelix.com/api/v1/address/add

Reponse：

{
    "code": 10000,
    "msg": "success",
}

HTTP Request：

POST /api/v1/address/add

Request parameters：

Parameter	Type	Mandatory	Description
chain	string	yes	The chain,use mainne token
addr_list	[]string	yes	list of address

Response:

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed

Deposit Notify

Deposit Notify

curl
  -X POST
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  -- data '
    {
        "token_id": "ABC",
        "from": "addr1",
        "to": "addr2",
        "memo":"1234",
        "amount": "124.23",
        "tx_hash": "1234",
        "index": "1",
        "block_height": "1234",
        "block_time": "1234"
    }
  '
  https://baas.bluehelix.com/api/v1/notify/deposit

Reponse：

{
    "code": 10000,
    "msg": "success",
}

HTTP Request：

POST /api/v1/notify/deposit

Request parameters:

Parameter	Type	Mandatory	Description
token_id	string	yes	digital asset symbol
from	string	yes	from which address
to	string	yes	to which address
memo	string	optional	memo not null
amount	string	yes	deposit amount
tx_hash	string	yes	transaction hash
index	string	yes	he location of the deposit made
block_height	string	yes	block height
block_time	string	yes	block time (seconds)

Response：

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed

Generate pending withdrawal orders

Generate pending withdrawal orders

curl
  -X GET
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  https://baas.bluehelix.com/api/v1/withdrawal/orders?chain=ABC

Reponse：

{
    "code": 10000,
    "msg": "success",
    "data"::[
        {
            "order_id": "1234",
            "token_id":"ABC",
            "to": "bhexaddr1",
            "memo": "bhexmemo",
            "amount": "12.34"
        },
        {
            "order_id": "2345",
            "token_id":"ABC",
            "to": "bhexaddr1",
            "memo": "bhexmemo",
            "amount": "12.34"
        }
    ]
}

HTTP Request：

GET /api/v1/withdrawal/orders?chain=ABC

Request parameters:

Parameter	Type	Mandatory	Description
chain	string	yes	The chain,use mainnet token

Response：

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed
data	[]order	List of pending withdrawal orders

orderinfo：

Parameter	Type	Description
order_id	string	order id
token_id	string	withdrawal currency
to	string	withdrawal address
memo	string	memo
amount	string	withdrawal amount

Successful withdrawal notify

Successful withdrawal notify

curl
  -X POST
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  --data '
  {
    "order_id": "1234",
    "token_id": "ABC",
    "to": "bhexaddr1",
    "memo": "bhexmemo",
    "amount": "12.34",
    "tx_hash": "0x5f99810a4154379e5b7951419a77250f020be54b78acb9a8747ff8b0ec75769d",
    "block_height": "6581548",
    "block_time": "1540480255"
  }
  '
  https://baas.bluehelix.com/api/v1/notify/withdrawal

Reponse：

{
    "code": 10000,
    "msg": "success",
}

HTTP Request：

POST /api/v1/notify/withdrawal

Request parameters:

Parameter	Type	Mandatory	Description
order_id	string	yes	order id
token_id	string	yes	withdrawal currency
to	string	yes	to wihich address
memo	string	optional	memo
amount	string	yes	withdrawal amount
tx_hash	string	yes	transaction hash
block_height	string	yes	block height
block_time	string	yes	block time (seconds)

Response：

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed

Failed withdrawal notify

Failed withdrawal notify

curl
  -X POST
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  --data '
  {
    "order_id": "1234",
    "token_id": "ABC",
    "reason": "invalid address"
  }
  '
  https://baas.bluehelix.com/api/v1/notify/failed

Reponse：

{
    "code": 10000,
    "msg": "success",
}

HTTP Request：

POST /api/v1/notify/failed

Request parameters:

Parameter	Type	Mandatory	Description
order_id	string	yes	order id
token_id	string	yes	withdrawal currency
reason	string	yes	failed reason

Response：

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed

Asset verification

Asset verification

curl
  -X POST
  -H "BWAAS-API-KEY: 123"
  -H "BWAAS-API-TIMESTAMP: 1580887996488"
  -H "BWAAS-API-SIGNATURE: f321da3"
  --data '
  {
    "token_id": "ABC",
    "total_deposit_amount": "100000.567",
    "total_withdrawal_amount": "10000",
    "last_block_height": "100000"
  }
  '
  https://baas.bluehelix.com/api/v1/asset/verify

Reponse：

{
    "code": 10000,
    "msg": "success",
}

HTTP Request：

POST /api/v1/asset/verify

Request parameters:

Parameter	Type	Mandatory	Description
token_id	string	yes	withdrawal currency
total_deposit_amount	string	yes	total deposit amount
total_withdrawal_amount	string	yes	total withdrawal amount
last_block_height	string	yes	verification of highest block height

Response：

Parameter	Type	Description
code	int	Please see the retruen code list
msg	string	Returned content; error message if failed

Return code list

Code	Type	Description
10000	SUCCESS	successful
10001	INVALID_SIGN	invalid signature
10002	INVALID_APIKEY	invalid api_key
10003	INVALID_CHAIN	invalid chain
10004	INVALID_TOKEN_ID	invalid token_id
10005	INVALID_PARAMS	invalid paramter
10006	INVALID_TO_ADDRESS	invalid deposit address
10007	INVALID_ORDER_ID	invalid order id
10008	INVALID_AMOUNT	invalid amount
10009	INVALID_DECIMALS	invalid decimals
10010	INVALID_BLOCK_HEIGHT	invalid block height
10011	INVALID_BLOCK_TIME	invalid block time
10012	INVALID_TXHASH	invalid tx hash
10013	INVALID_INDEX	invalid tx index
10014	NETWORK_ERROR	network error
10015	REPEAT_DEPOSIT	repeat deposit
10016	ASSET_VERIFY_FAILED	asset verification failed
10017	DEPOSIT_SUSPENDED	deposit suspended
10018	WITHDRAWAL_SUSPENDED	withdrawal suspended
10019	TIMESTAMP_EXPIRED	timestamp expired
10020	MEMO_REQUIRED	memo required
10021	NEED_WAIT	need to wait queue when notify failed withdrawal
10022	INVALID_FROM_ADDRESS	invalid from address
10023	ADDRESS_ENOUGH	added addresses enough
10024	NEED_RETRY	retry required
10025	INVALID_MEMO	invalid memo
10026	ADDRESS_TOO_LONG	address too long, max 512