0.3.3 • Published 5 years ago

htmlcoin-mobile-api-server v0.3.3

Weekly downloads
6
License
-
Repository
-
Last release
5 years ago

Table of Contents

API

Contracts / Call

POST

/contracts/{addressContract}/call

Request

{
	"hashes": [String, String, ...],
	"from": ?String
}

Response

{
    "outputs": [
          {
             "hash": String,
             "output": String,
             "gas_used": Integer
             "excepted": String
           },
           ...
     ]
}

Contracts / Encoder

POST

/contracts/encoder

Request

{
	"contract": String
}

Response

{
    ":MyToken": {
        bytecode: String,
        interface: [
            {
              "constant": true,
              "inputs": [],
              "name": "name",
              "outputs": [
                {
                  "name": "",
                  "type": "string"
                }
              ],
              "payable": false,
              "type": "function"
            },
            ...
        ]
    },
    ":tokenRecipient": {
        bytecode: String,
        interface: [
            ...
        ]
    },
    ...
}

Contracts / Generate token bytecode

POST

/contracts/generate-token-bytecode

request

{
	"initialSupply": Uint256,
	"tokenName": String
	"decimalUnits": Uint8
	"tokenSymbol": String
}

response

{
	"bytecode": String
}

Contracts / Params

GET

/contracts/{address_contract}/params?keys=symbol,decimals,name,totalSupply

response: Object | null

{
	"symbol": String,
	"decimals": String,
	"name": String,
	"totalSupply": String
}

Send Raw Transaction

POST

/send-raw-transaction

request parameters

{
	"data": "raw transaction" // string,
	"allowHighFee": 1 // 1 or 0
}

Get Transaction

GET

/transactions/{tx_hash}

response: Object | null

{
    "block_time": 1491219489|null,
    "block_height": 31111|-1,
    "block_hash": "b0589be37f4e24bffea77bfc87f5bbd6f9a90c629306f7c3340c7c52a982e592"|null,
    "tx_hash": "25fb98d4849f837d71f331eec74f71e9286e6a0b85d27218f7236dc69d8c990f",
    "amount": 5, //htmlcoin,
    "contract_has_been_created": true, //optional
    "contract_has_been_deleted": true, //optional
    "vout": [
        {
            "value": "2.00000000", //htmlcoin
            "address": "mopkoZaJGQE32h8WME5F2oBk8hvD1CVdP7"
            
        },
        {
            "value": "2.99995400", //htmlcoin
            "address": "mk5aX8HDEpSWF2P2dtdSN9aiAC7AHdzHEa"
        }
    ],
    "vin": [
        {
            value: "5", //htmlcoin
            address: "mopkoZaJGQE32h8WME5F2oBk8hvD1CVdP7"
        }
    ]
}

Get Transaction Receipt

GET

/transactions/:txhash/receipt

response: Array

[
    {
        "blockHash": "0916253e64ca802cbe29329144a10d73179fd84f118b0ef5c68e4e43276e1827",
        "blockNumber": 6964,
        "transactionHash": "073edd4537fda626fb351b25324e1ad69446cf7d489ebfdb6161f86df1f77aec",
        "transactionIndex": 2,
        "from": "d9826270f3bee3b792455ff5d1d1cd4432e6a5fa",
        "to": "588573c01ddcca8844aed7f762ab36b35cc6084e",
        "cumulativeGasUsed": 51805,
        "gasUsed": 51805,
        "contractAddress": "588573c01ddcca8844aed7f762ab36b35cc6084e",
        "log": [
            {
                "address": "588573c01ddcca8844aed7f762ab36b35cc6084e",
                "topics": [
                    "ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                    "000000000000000000000000d9826270f3bee3b792455ff5d1d1cd4432e6a5fa",
                    "00000000000000000000000004b13b89eae779f791d298a306a763230d283337"
                ],
                "data": "00000000000000000000000000000000000000000000000000000000000001f4"
            }
        ]
    }
]

Get History

GET

/history/{address}/{limit}/{offset}

MAX_LIMIT = 50;

response

{
    "totalItems": 2,
    "items": [
         {
             "block_time": 1490705700|null,
             "block_height": 23701|-1,
             "block_hash": "ea22d5650f6edf352790372c27edba05c4b3870f181ad245a2f9b63cfef39589"|null,
             "tx_hash": "79d78d6f54037045cd091c7ae1a3a84c07cd7a9c02190b26092e62b77feaea80",
             "amount": 1.875, //htmlcoin
             "contract_has_been_created": true,
             "vout": [
                 {
                     "value": "1", //htmlcoin
                     "address": "mr8Mezn8p7CmHvPBbfieSxfeNtHiG7AwfQ"
                 },
                 {
                     "value": "0.874", //htmlcoin
                     "address": "mvYtoXgd5NCWNfPmyH8AYDyzY6kqmZ5Jt3"
                 }
             ],
             "vin": [
                 {
                     value: "1.875", //htmlcoin
                     address: "mvYtoXgd5NCWNfPmyH8AYDyzY6kqmZ5Jt3"
                 }
             ]
         },
         ...
    ]
}

Get History for several addresses

GET

/history/{limit}/{offset}?addresses[]={:address}&addresses[]={:address2}

MAX_LIMIT = 50;

response

{
    "totalItems": 2,
    "items": [
         {
             "block_time": 1490705700|null,
             "block_height": 23701|-1,
             "block_hash": "ea22d5650f6edf352790372c27edba05c4b3870f181ad245a2f9b63cfef39589"|null,
             "tx_hash": "79d78d6f54037045cd091c7ae1a3a84c07cd7a9c02190b26092e62b77feaea80",
             "amount": 1.875, //htmlcoin
             "contract_has_been_created": true,
             "vout": [
                 {
                     "value": "1", //htmlcoin
                     "address": "mr8Mezn8p7CmHvPBbfieSxfeNtHiG7AwfQ"
                 },
                 {
                     "value": "0.874", //htmlcoin
                     "address": "mvYtoXgd5NCWNfPmyH8AYDyzY6kqmZ5Jt3"
                 }
             ],
             "vin": [
                 {
                     value: "1.875", //htmlcoin
                     address: "mvYtoXgd5NCWNfPmyH8AYDyzY6kqmZ5Jt3"
                 }
             ]
         },
         ...
    ]
}

Get unspent outputs

GET

/outputs/unspent/{address}

response

[{
    address: "mxDkwrDixgLNhNW9HHq73d1VpLcwYUtyja",
    tx_hash: "c038b71aaa6fa6a1fab239fa880483ecf36d664553456ad3985b522b1612f7e5",
    vout: 1,
    txout_scriptPubKey: "76a914b739980629d47e0de6e3fac7513cff7fe36e6fff88ac",
    amount: 1, //htmlcoin
    block_height: 100000000|-1,
    pubkey_hash: String,
    is_stake: Boolean,
    confirmations: Int
}]

Get unspent outputs for several addresses

GET

/outputs/unspent?addresses[]={:address}&addresses[]={:address2}

response

[{
    address: "mxDkwrDixgLNhNW9HHq73d1VpLcwYUtyja",
    tx_hash: "c038b71aaa6fa6a1fab239fa880483ecf36d664553456ad3985b522b1612f7e5",
    vout: 1,
    txout_scriptPubKey: "76a914b739980629d47e0de6e3fac7513cff7fe36e6fff88ac",
    amount: 1, //htmlcoin
    block_height: 100000000|-1,
    pubkey_hash: String,
    is_stake: Boolean,
    confirmations: Int
}]

Get news

GET

/news/{lang}

response

[{
	"id": 287,
	"date": "2017-07-18T09:36:13.717Z",
	"link": "https://htmlcoin.com/blog/",
	"title": "Htmlcoin Blog",
	"body": "These questions were asked in Slack Channel...",
	"short": "These questions were asked in Htmlcoin...",
	"image": "https://htmlcoin.com/images/test.png"
}]

Get blockchain info

GET

/blockchain/info

response

{
	"version": 130000,
	"protocolversion": 70014,
	"walletversion": 130000,
	"balance": 144668.2987138,
	"blocks": 5274,
	"timeoffset": 0,
	"connections": 3,
	"proxy": "",
	"difficulty": 52537.66724975229,
	"testnet": true,
	"keypoololdest": 1485441915,
	"keypoolsize": 100,
	"paytxfee": 0,
	"relayfee": 0.00001,
	"errors": ""
}

Get dgp info

GET

/blockchain/dgpinfo

response

{
    maxblocksize: 2000000,
    blockgaslimit: 40,
    mingasprice: 40000000
}

Estimate Fee Per Kb

GET

/estimate-fee-per-kb?nBlocks=2

Response: 

   {
       fee_per_kb: 0.00001
   }

HRC20 Transfers

GET

/hrc20/{:hrc20ContractAddress}/transfers?limit=20&offset=0&addresses[]=HMo91KVCAW9BMAeHRDYz5ib94N7pGTMmQd

Response:

{
    "limit": 20,
    "offset": 0,
    "count": 2,
    "items": [
        {
            "contract_address": "9d3d4cc1986d81f9109f2b091b7732e7d9bcf63b",
            "from": "HcoAQPP93jDAYnfvUxabQvGNR8x6Hn6tKC",
            "to": "HMo91KVCAW9BMAeHRDYz5ib94N7pGTMmQd",
            "amount": "1000000",
            "tx_hash": "b6101753060d6e7dd40a23e84305dd6c9f25d3f1b8a9cd45edc69cddb8d7f75a",
            "tx_time": 1511486352
        },
        {
            "contract_address": "9d3d4cc1986d81f9109f2b091b7732e7d9bcf63b",
            "from": "HQoU895WJ1NfCzHp6dEN8HEi9b8iuRvzQy",
            "to": "HMo91KVCAW9BMAeHRDYz5ib94N7pGTMmQd",
            "amount": "1000000",
            "tx_hash": "79a958c1c323ac249e6b56862bf7a836df23cc7532ea4c4551f5d11694d9533d",
            "tx_time": 1511065856
        }
    ]
}

Does Contract exist?

GET

/contracts/{:contractAddress}/exists

Response:

    {
        "exists": Boolean
    }

Web Socket API

The web socket API is served using socket.io.

Event token_balance_change

Subscribe:

    socket.emit('subscribe', 'token_balance_change', {
            contract_address: '804ca5244b5ba927565398f861adcc17363d617e', 
            addresses: ["mg2zzpBoWQJsfmGgcytS6eVzW8sgZpDcak", "mzXrAjgbFca8yGo8wxkzLuZJAsAhMvHfJx"]
        }, {
          notificationToken: ?NotificationToken<String>, 
          prevToken: ?PreviousNotificationToken<String>,
          language: ?'en'
      })

After subscribe will emit token_balance_change

Unsubscribe:

    socket.emit('unsubscribe', 'token_balance_change', {
            contract_address: '804ca5244b5ba927565398f861adcc17363d617e', 
            addresses: ["mg2zzpBoWQJsfmGgcytS6eVzW8sgZpDcak"]
        }, {
           notificationToken: ?NotificationToken<String> 
      });

or

    socket.emit('unsubscribe', 'token_balance_change', {
            contract_address: '804ca5244b5ba927565398f861adcc17363d617e'
        }, {
           notificationToken: ?NotificationToken<String> 
       })

or

    socket.emit('unsubscribe', 'token_balance_change', null, {
             notificationToken: ?NotificationToken<String> 
        });

Event token_balance_change

Listen:

    socket.on('token_balance_change', function(data) {
         // Sample output
    });

Sample output:

{
    "contract_address": "804ca5244b5ba927565398f861adcc17363d617e",
    "balances": [
        {
            "address": "mg2zzpBoWQJsfmGgcytS6eVzW8sgZpDcak"
            "balance": 123456
        },
        ...
    ]
}

Event balance_subscribe

Subscribe:

    socket.emit('subscribe', 'balance_subscribe', ["mt8WVPpaThMykC6cMrParAbykRBYWLDkPR"], {
        notificationToken: ?NotificationToken<String>, 
        prevToken: ?PreviousNotificationToken<String>,
        language: ?'en'
    });

After subscribe will emit balance_changed

Unsubscribe:

    socket.emit('unsubscribe', 'balance_subscribe', ["mt8WVPpaThMykC6cMrParAbykRBYWLDkPR"], {
        notificationToken: ?NotificationToken<String> 
    });

or

    socket.emit('unsubscribe', 'balance_subscribe', null, {
        notificationToken: ?NotificationToken<String> 
    });

Event balance_changed

Listen:

    socket.on('balance_changed', function(data) {
         console.log("New data received: " + data.balance); //satoshis
         console.log("New data received: " + data.unconfirmedBalance); //satoshis
    });

Sample output:

{
    "balance": 1400000000,
    "unconfirmedBalance": 7900000000
}

Event new_transaction

Listen:

    socket.on('new_transaction', function(data) {
         console.log(data) // Sample output
    });

Sample output:

{
    "block_time": 1490705700|null,
    "block_height": 23701|-1,
    "block_hash": "ea22d5650f6edf352790372c27edba05c4b3870f181ad245a2f9b63cfef39589"|null,
    "tx_hash": "79d78d6f54037045cd091c7ae1a3a84c07cd7a9c02190b26092e62b77feaea80",
    "amount": 1.875, //htmlcoin
    "contract_has_been_created": true, //optional
    "contract_has_been_deleted": true, //optional
    "vout": [
        {
            "value": "1", //htmlcoin
            "address": "mr8Mezn8p7CmHvPBbfieSxfeNtHiG7AwfQ"
        },
        {
            "value": "0.874", //htmlcoin
            "address": "mvYtoXgd5NCWNfPmyH8AYDyzY6kqmZ5Jt3"
        }
    ],
    "vin": [
        {
            value: "1.875", //htmlcoin
            address: "mvYtoXgd5NCWNfPmyH8AYDyzY6kqmZ5Jt3"
        }
    ]
}

Example Usage

html

<html>
<body>
  <script src="http://<insight-server>:<port>/socket.io/socket.io.js"></script>
  <script>
    
    var eventToListenTo = 'balance_subscribe',
        socket = io("http://<insight-server>:<port>/");
    
    socket.on('connect', function() {
      socket.emit('subscribe', eventToListenTo, ["mt8WVPpaThMykC6cMrParAbykRBYWLDkPR"]);
    });
    
    socket.on(eventToListenTo, function(data) {
      console.log("New data received: " + data.txid)
    });
  </script>
</body>
</html>

HStore API

Trending now

GET

/contracts/trending-now

Response: 

[{
    "id": "8a9d8f98as989s8dfak9a9k",
    "name": "Contract name",
    "type": "Crowdsale", // HRC20 Token || Crowdsale || Smart Contract
    "price": "4.3432344", // cost in Htmlcoin
    "count_buy": 3,
    "count_downloads": 323,
    "created_at": "2017-07-18T09:36:13.717Z"
}, ...]

Last added

GET

/contracts/last-added

Response: 

[{
    "id": "8a9d8f98as989s8dfak9a9k",
    "name": "Contract name",
    "type": "Crowdsale", // HRC20 Token || Crowdsale || Smart Contract
    "price": "4.3432344", // cost in Htmlcoin
    "count_buy": 3,
    "count_downloads": 323,
    "created_at": "2017-07-18T09:37:06.193Z"
}, ...]

Contract search

GET

/contracts/{count}/{offset}?type={type_name}&tags[]={tag}&name={name}

Response: 

[{
    "id": "8a9d8f98as989s8dfak9a9k",
    "name": "Contract name",
    "type": "Crowdsale", // HRC20 Token || Crowdsale || Smart Contract
    "price": "4.3432344", // cost in htmlcoin
    "count_buy": 3,
    "count_downloads": 323,
    "created_at": "2017-07-18T09:37:06.193Z",
    "tags": [
        "tag3",
        "tag4"
     ]
}, ...]

Contract

GET

/contracts/{contract_id}

Response: 

{
    "id": "8a9d8f98as989s8dfak9a9k",
    "name": "Contract name",
    "description": "Contract description",
    "tags": ["crowdsale", "contract", "some_token"]
    "size": 14.3, // size in bytes
    "completed_on": "1.0.5",
    "with_sourse_code": true,
    "publisher_address": "1Hz96kJKF2HLPGY15JWLB5m9qGNxvt8tHJ",    
    "type": "Crowdsale", // HRC20 Token || Crowdsale || Smart Contract
    "price": "4.3432344", // cost in htmlcoin
    "count_buy": 3,
    "count_downloads": 323,
    "created_at": "2017-07-18T09:37:06.193Z"
}

Contract ABI

GET

/contracts/{contract_id}/abi

Response: 

{
    ":test": {
        "test": "test"
    }
}

Buy Request

POST

/contracts/{contract_id}/buy-request

Response: 

{
    "address": "1Hz96kJKF2HLPGY15JWLB5m9qGNxvt8tHJ",
    "amount": "3.33",
    "access_token": "a989as0dfhfhshwwr37fh56sdfsi909kja0f9kas0dfas0ja0djfas9ias09k3414auyjjh09aks-a=sdfasdf-@",
    "request_id": "5976f5c7cfa1624c2909ab4d"
}

Is Paid

GET

/contracts/{contract_id}/is-paid/by-request-id?request_id={request_id}

GET

/contracts/{contract_id}/is-paid/by-address?addresses[]={check_address}

Response: 

{
    "contract_id": "8a9d8f98as989s8dfak9a9k",
    "request_id": "5976f5c7cfa1624c2909ab4d",
    "amount": "3.33",
    "payed_at": "2017-07-25T08:00:16.000Z",
    "created_at": "2017-07-25T08:00:16.000Z",
    "from_addresses": [
        "1Hz96kJKF2HLPGY15JWLB5m9qGNxvt8tHJ"
    ]
}

Source code

POST

/contracts/{contract_id}/source-code

Request: 

{
    "request_id": "5976f5c7cfa1624c2909ab4d",
    "access_token": "a989as0dfhfhshwwr37fh56sdfsi909kja0f9kas0dfas0ja0djfas9ias09k3414auyjjh09aks-a=sdfasdf-@"
}

Response: 

    {
        "bytecode": String
    }

Bytecode

POST

/contracts/{contract_id}/bytecode

Request: 

{
    "buyer_addresses": [
        "1Hz96kJKF2HLPGY15JWLB5m9qGNxvt8tHJ"
    ],
    "nonce": 1498736970,
    "signs": [
        "0320390741d655389f20904a41d655389e2540ff092f4542312f4144362f2f4254432e544f502f4e59412ffabe6d6d82d4592133163f9a904a326a4d57dfa19748074f0b7a69fd0c164593481e60a3010000000000000009392bffdb25924800000000"
    ]
}

Response: 

    {
        "source_code": String
    }

Types (Categories)

GET

/contracts/types

Response: 

[
    {
        _id: "Crowdsale",
        type: "Crowdsale",
        count: 1
    },
    ...
]

Web Socket HStore API

Event contract_purchase

Subscribe:

    socket.emit('subscribe', 'contract_purchase', requestId<String>);

Unsubscribe:

    socket.emit('unsubscribe', 'contract_purchase', requestId<String>);

or 

    socket.emit('unsubscribe', 'contract_purchase');

Listen:

    socket.on('contract_purchase', function(data) {
         //Sample output
    });

Sample output:

{
    "contract_id": "8a9d8f98as989s8dfak9a9k",
    "request_id": "5976f5c7cfa1624c2909ab4d",
    "amount": "3.33",
    "payed_at": "2017-07-25T08:00:16.000Z",
    "created_at": "2017-07-25T08:00:16.000Z",
    "from_addresses": [
        "1Hz96kJKF2HLPGY15JWLB5m9qGNxvt8tHJ"
    ]
}
asyncbignumber.jsbitcoinbitcoinjs-libbluebirdbody-parserbs58corscryptoexecexpressextendi18ninstalljsrsasignlodashlog4jsmomentmongoosemorganmultermustachemysqlnode-cronnode-dirnode-gcmnpmhtmlcoin-libquery-stringravenrequestsequelizesocket.iosocket.io-clientsolcweb3
@infinitebrahmanuniverse/nolb-htmlc@everything-registry/sub-chunk-1869
0.3.3

5 years ago

0.3.2

6 years ago