insight-api-monoeci
v0.6.0
Published
A Monoeci blockchain REST and web socket API service for Bitcore Node.
Downloads
3
Maintainers
Readme
This is a backend-only service. If you're looking for the web frontend application, take a look at https://github.com/yoyae/insight-ui-monoeci.
Table of Content
- Getting Started
- API HTTP Endpoints
- Block
- Block Index
- Raw Block
- Block Summaries
- Transaction
- Address
- Address Properties
- Unspent Outputs
- Unspent Outputs for Multiple Addresses
- InstantSend Transactions
- Transactions by Block
- Transactions by Address
- Transactions for Multiple Addresses
- Transaction Broadcasting
- Sporks List
- Budget Proposal List
- Budget Proposal Detail
- Masternodes List
- Historic Blockchain Data Sync Status
- Live Network P2P Data Sync Status
- Status of the Bitcoin Network
- Utility Methods
- Web Socket Api
- Notes on Upgrading from v0.3
- Notes on Upgrading from v0.2
- Resources
- License
Getting Started
npm install -g bitcore-node-monoeci@latest
bitcore-node-monoeci create mynode
cd mynode
bitcore-node-monoeci install insight-api-monoeci
bitcore-node-monoeci start
The API endpoints will be available by default at: http://localhost:3001/insight-api-monoeci/
Prerequisites
Note: You can use an existing Monoeci data directory, however txindex
, addressindex
, timestampindex
and spentindex
needs to be set to true in monoeci.conf
, as well as a few other additional fields.
Query Rate Limit
To protect the server, insight-api has a built it query rate limiter. It can be configurable in bitcore-node.json
with:
"servicesConfig": {
"insight-api": {
"rateLimiterOptions": {
"whitelist": ["::ffff:127.0.0.1"]
}
}
}
With all the configuration options available: https://github.com/bitpay/insight-api/blob/master/lib/ratelimiter.js#L10-17
Or disabled entirely with:
"servicesConfig": {
"insight-api": {
"disableRateLimiter": true
}
}
API HTTP Endpoints
Block
/insight-api-monoeci/block/[:hash]
/insight-api-monoeci/block/0000000006e7b38e8ab2d351239019c01de9a148b5baef58cfe52dfd9917cedc
Block Index
Get block hash by height
/insight-api-monoeci/block-index/[:height]
/insight-api-monoeci/block-index/0
This would return:
{
"blockHash":"00000bafbc94add76cb75e2ec92894837288a481e5c005f6563d91623bf8bc2c"
}
which is the hash of the TestNet Genesis block (0 height)
Raw Block
/insight-api-monoeci/rawblock/[:blockHash]
This would return:
{
"rawblock":"blockhexstring..."
}
Block Summaries
Get block summaries by date:
/insight-api-monoeci/blocks?limit=3&blockDate=2017-04-22
Example response:
{
"blocks": [
{
"height": 188928,
"size": 312,
"hash": "00000000ee9a976cf459240c2add1147137ca6126b7906fa13ce3d80b5cadcc7",
"time": 1492905418,
"txlength": 1,
"poolInfo": {
"poolName": "BTCC Pool",
"url": "https://pool.btcc.com/"
}
},{...},{...}
],
"length": 3,
"pagination": {
"next":"2017-04-23",
"prev":"2017-04-21",
"currentTs":1492905599,
"current":"2017-04-22",
"isToday":false,
"more":true,
"moreTs":1492905600
}
}
Transaction
/insight-api-monoeci/tx/[:txid]
/insight-api-monoeci/tx/ebdca263fe1c75c8609ce8fe3d82a320a0b3ca840f4df995883f5dab1b9ff8d9
/insight-api-monoeci/rawtx/[:rawid]
/insight-api-monoeci/rawtx/ebdca263fe1c75c8609ce8fe3d82a320a0b3ca840f4df995883f5dab1b9ff8d9
Address
/insight-api-monoeci/addr/[:addr][?noTxList=1][&from=&to=]
/insight-api-monoeci/addr/ybi3gej7Ea1MysEYLR7UMs3rMuLJH5aVsW?noTxList=1
/insight-api-monoeci/addr/yPv7h2i8v3dJjfSH4L3x91JSJszjdbsJJA?from=1000&to=2000
Address Properties
/insight-api-monoeci/addr/[:addr]/balance
/insight-api-monoeci/addr/[:addr]/totalReceived
/insight-api-monoeci/addr/[:addr]/totalSent
/insight-api-monoeci/addr/[:addr]/unconfirmedBalance
The response contains the value in Satoshis.
Unspent Outputs
/insight-api-monoeci/addr/[:addr]/utxo
Sample return:
[
{
"address":"ygwNQgE5f15Ygopbs2KPRYMS4TcffqBpsz",
"txid":"05d70bc1c4cf1c3afefc3250480d733b5666b19cb1f629901ded82cb2d6263d1",
"vout":0,
"scriptPubKey":"76a914e22dc8acf5bb5624f4beef22fb2238f8479e183f88ac",
"amount":0.01194595,
"satoshis":1194595,
"height":142204,
"confirmations":124317
},{...}
]
Unspent Outputs for Multiple Addresses
GET method:
/insight-api-monoeci/addrs/[:addrs]/utxo
/insight-api-monoeci/addrs/ygwNQgE5f15Ygopbs2KPRYMS4TcffqBpsz,ygw5yCtVkx3hREke4L8qDqQtnNoAiPKTSx/utxo
POST method:
/insight-api-monoeci/addrs/utxo
POST params:
addrs: ygwNQgE5f15Ygopbs2KPRYMS4TcffqBpsz,ygw5yCtVkx3hREke4L8qDqQtnNoAiPKTSx
InstantSend Transactions
If a Transaction Lock has been observed by Insight API a 'txlock' value of true will be included in the Transaction Object.
Sample output:
{
"txid": "b7ef92d1dce458276f1189e06bf532eff78f9c504101d3d4c0dfdcd9ebbf3879",
"version": 1,
"locktime": 133366,
"vin": [{ ... }],
"vout": [{ ... }],
"blockhash": "0000001ab9a138339fe4505a299525ace8cda3b9bcb258a2e5d93ed7a320bf21",
"blockheight": 133367,
"confirmations": 37,
"time": 1483985187,
"blocktime": 1483985187,
"valueOut": 8.998,
"size": 226,
"valueIn": 8.999,
"fees": 0.001,
"txlock": true
}
Transactions by Block
/insight-api-monoeci/txs/?block=HASH
/insight-api-monoeci/txs/?block=000000000814dd7cf470bd835334ea6624ebf0291ea857a5ab37c65592726375
Transactions by Address
/insight-api-monoeci/txs/?address=ADDR
/insight-api-monoeci/txs/?address=yWFfdp9nLUjy1kJczFhRuBMUjtTkTTiyMv
Transactions for Multiple Addresses
GET method:
/insight-api-monoeci/addrs/[:addrs]/txs[?from=&to=]
/insight-api-monoeci/addrs/ygwNQgE5f15Ygopbs2KPRYMS4TcffqBpsz,ygw5yCtVkx3hREke4L8qDqQtnNoAiPKTSx/txs?from=0&to=20
POST method:
/insight-api-monoeci/addrs/txs
POST params:
addrs: ygwNQgE5f15Ygopbs2KPRYMS4TcffqBpsz,ygw5yCtVkx3hREke4L8qDqQtnNoAiPKTSx
from (optional): 0
to (optional): 20
noAsm (optional): 1 (will omit script asm from results)
noScriptSig (optional): 1 (will omit the scriptSig from all inputs)
noSpent (option): 1 (will omit spent information per output)
Sample output:
{ totalItems: 100,
from: 0,
to: 20,
items:
[ { txid: '3e81723d069b12983b2ef694c9782d32fca26cc978de744acbc32c3d3496e915',
version: 1,
locktime: 0,
vin: [Object],
vout: [Object],
blockhash: '00000000011a135e5277f5493c52c66829792392632b8b65429cf07ad3c47a6c',
confirmations: 109367,
time: 1393659685,
blocktime: 1393659685,
valueOut: 0.3453,
size: 225,
firstSeenTs: undefined,
valueIn: 0.3454,
fees: 0.0001,
txlock: false },
{ ... },
{ ... },
...
{ ... }
]
}
Note: if pagination params are not specified, the result is an array of transactions.
Transaction Broadcasting
Standard transaction
POST method:
/insight-api-monoeci/tx/send
POST params:
rawtx: "signed transaction as hex string"
eg
rawtx: 01000000017b1eabe0209b1fe794124575ef807057c77ada2138ae4fa8d6c4de0398a14f3f00000000494830450221008949f0cb400094ad2b5eb399d59d01c14d73d8fe6e96df1a7150deb388ab8935022079656090d7f6bac4c9a94e0aad311a4268e082a725f8aeae0573fb12ff866a5f01ffffffff01f0ca052a010000001976a914cbc20a7664f2f69e5355aa427045bc15e7c6c77288ac00000000
POST response:
{
txid: [:txid]
}
eg
{
txid: "c7736a0a0046d5a8cc61c8c3c2821d4d7517f5de2bc66a966011aaa79965ffba"
}
InstantSend transaction
Conditions :
- Every inputs should have 6 confirmations.
- Fee are 0.001 per input.
- Transaction value should be below SPORK_5_INSTANTSEND_MAX_VALUE (see spork route)
POST method:
/insight-api-monoeci/tx/sendix
POST params:
rawtx: "signed transaction as hex string"
POST response:
{
txid: [:txid]
}
Sporks List
GET method:
/insight-api-monoeci/sporks
Sample output:
{"sporks":
{
"SPORK_2_INSTANTSEND_ENABLED":0,
"SPORK_3_INSTANTSEND_BLOCK_FILTERING":0,
"SPORK_5_INSTANTSEND_MAX_VALUE":2000,
"SPORK_8_MASTERNODE_PAYMENT_ENFORCEMENT":0,
"SPORK_9_SUPERBLOCKS_ENABLED":0,
"SPORK_10_MASTERNODE_PAY_UPDATED_NODES":0,
"SPORK_12_RECONSIDER_BLOCKS":0,
"SPORK_13_OLD_SUPERBLOCK_FLAG":4070908800,
"SPORK_14_REQUIRE_SENTINEL_FLAG":4070908800
}
}
Budget Proposal List
GET method:
/insight-api-monoeci/gobject/list/proposal
Sample output:
[ { Hash: 'b6af3e70c686f660541a77bc035df2e5e46841020699ce3ec8fad786f7d1aa35',
DataObject: {
end_epoch: 1513555200,
name: 'flare03',
payment_address: 'yViyoK3NwfH5GXRo7e4DEYkzzhBjDNQaQG',
payment_amount: 5,
start_epoch: 1482105600,
type: 1,
url: 'https://www.monoeci.io'
},
AbsoluteYesCount: 40,
YesCount: 40,
NoCount: 0,
AbstainCount: 0 } ]
Budget Proposal Detail
GET method:
/insight-api-monoeci/gobject/get/[:hash]
/insight-api-monoeci/gobject/get/b6af3e70c686f660541a77bc035df2e5e46841020699ce3ec8fad786f7d1aa35
Sample output:
[ { Hash: 'b6af3e70c686f660541a77bc035df2e5e46841020699ce3ec8fad786f7d1aa35',
CollateralHash: '24a71d8f221659717560365d2914bc7a00f82ffb8f8c68e7fffce5f35aa23b90',
DataHex: '5b5b2270726f706f73616c222c7b22656e645f65706f6368223a313531333535353230302c226e616d65223a22666c6172653033222c227061796d656e745f61646472657373223a22795669796f4b334e776648354758526f3765344445596b7a7a68426a444e51615147222c227061796d656e745f616d6f756e74223a352c2273746172745f65706f6368223a313438323130353630302c2274797065223a312c2275726c223a2268747470733a2f2f64617368646f742e696f2f702f666c6172653033227d5d5d',
DataObject: {
end_epoch: 1513555200,
name: 'flare03',
payment_address: 'yViyoK3NwfH5GXRo7e4DEYkzzhBjDNQaQG',
payment_amount: 5,
start_epoch: 1482105600,
type: 1,
url: 'https://www.monoeci.io'
},
CreationTime: 1482223714,
FundingResult: {
AbsoluteYesCount: 40,
YesCount: 40,
NoCount: 0,
AbstainCount: 0
},
ValidResult: {
AbsoluteYesCount: 74,
YesCount: 74,
NoCount: 0,
AbstainCount: 0
},
DeleteResult: {
AbsoluteYesCount: 0,
YesCount: 0,
NoCount: 0,
AbstainCount: 0
},
EndorsedResult: {
AbsoluteYesCount: 0,
YesCount: 0,
NoCount: 0,
AbstainCount: 0
} } ]
Masternodes List
/insight-api-monoeci/masternodes/list
Validate Masternode
/insight-api-monoeci/masternodes/validate/[:payee]
/insight-api-monoeci/masternodes/validate/yRuALkPpeYpTgxdNn2L5YgGktASJYDYPAo
Sample valid output:
{
"valid":true,
"vin":"e3a6b7878a7e9413898bb379b323c521676f9d460db17ec3bf42d9ac0c9a432f-1",
"status":"ENABLED",
"rank":1,
"ip":"217.182.229.146:19999",
"protocol":70208,
"payee":"yRuALkPpeYpTgxdNn2L5YgGktASJYDYPAo",
"activeseconds":158149,
"lastseen":1507810068
}
Historic Blockchain Data Sync Status
/insight-api-monoeci/sync
Live Network P2P Data Sync Status
/insight-api-monoeci/peer
Status of the Bitcoin Network
/insight-api-monoeci/status?q=xxx
Where "xxx" can be:
- getInfo
- getDifficulty
- getBestBlockHash
- getLastBlockHash
Utility Methods
/insight-api-monoeci/utils/estimatefee[?nbBlocks=2]
Web Socket API
The web socket API is served using socket.io.
The following are the events published by insight:
tx
: new transaction received from network, txlock boolean is set true if a matching txlock event has been observed. This event is published in the 'inv' room. Data will be a app/models/Transaction object.
Sample output:
{
"txid":"00c1b1acb310b87085c7deaaeba478cef5dc9519fab87a4d943ecbb39bd5b053",
"txlock": false,
"processed":false
...
}
txlock
: InstantSend transaction received from network, this event is published alongside the 'tx' event when a transaction lock event occurs. Data will be a app/models/Transaction object.
Sample output:
{
"txid":"00c1b1acb310b87085c7deaaeba478cef5dc9519fab87a4d943ecbb39bd5b053",
"processed":false
...
}
block
: new block received from network. This event is published in the inv
room. Data will be a app/models/Block object.
Sample output:
{
"hash":"000000004a3d187c430cd6a5e988aca3b19e1f1d1727a50dead6c8ac26899b96",
"time":1389789343,
...
}
<bitcoinAddress>
: new transaction concerning received from network. This event is published in the <bitcoinAddress>
room.
status
: every 1% increment on the sync task, this event will be triggered. This event is published in the sync
room.
Sample output:
{
blocksToSync: 164141,
syncedBlocks: 475,
upToExisting: true,
scanningBackward: true,
isEndGenesis: true,
end: "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943",
isStartGenesis: false,
start: "000000009f929800556a8f3cfdbe57c187f2f679e351b12f7011bfc276c41b6d"
}
Example Usage
The following html page connects to the socket.io insight API and listens for new transactions.
html
<html>
<body>
<script src="http://<insight-server>:<port>/socket.io/socket.io.js"></script>
<script>
eventToListenTo = 'tx'
room = 'inv'
var socket = io("http://<insight-server>:<port>/");
socket.on('connect', function() {
// Join the room.
socket.emit('subscribe', room);
})
socket.on(eventToListenTo, function(data) {
if (data.txlock) {
console.log("New InstantSend transaction received: " + data.txid)
} else {
console.log("New transaction received: " + data.txid)
}
})
</script>
</body>
</html>
Notes on Upgrading from v0.3
The unspent outputs format now has satoshis
and height
:
[
{
"address":"mo9ncXisMeAoXwqcV5EWuyncbmCcQN4rVs",
"txid":"d5f8a96faccf79d4c087fa217627bb1120e83f8ea1a7d84b1de4277ead9bbac1",
"vout":0,
"scriptPubKey":"76a91453c0307d6851aa0ce7825ba883c6bd9ad242b48688ac",
"amount":0.000006,
"satoshis":600,
"confirmations":0,
"ts":1461349425
},
{
"address": "mo9ncXisMeAoXwqcV5EWuyncbmCcQN4rVs",
"txid": "bc9df3b92120feaee4edc80963d8ed59d6a78ea0defef3ec3cb374f2015bfc6e",
"vout": 1,
"scriptPubKey": "76a91453c0307d6851aa0ce7825ba883c6bd9ad242b48688ac",
"amount": 0.12345678,
"satoshis: 12345678,
"confirmations": 1,
"height": 300001
}
]
The timestamp
property will only be set for unconfirmed transactions and height
can be used for determining block order. The confirmationsFromCache
is nolonger set or necessary, confirmation count is only cached for the time between blocks.
There is a new GET
endpoint or raw blocks at /rawblock/<blockHash>
:
Response format:
{
"rawblock": "blockhexstring..."
}
There are a few changes to the GET
endpoint for /addr/[:address]
:
- The list of txids in an address summary does not include orphaned transactions
- The txids will be sorted in block order
- The list of txids will be limited at 1000 txids
- There are two new query options "from" and "to" for pagination of the txids (e.g.
/addr/[:address]?from=1000&to=2000
)
Some additional general notes:
- The transaction history for an address will be sorted in block order
- The response for the
/sync
endpoint does not includestartTs
andendTs
as the sync is no longer relevant as indexes are built in bitcoind. - The endpoint for
/peer
is no longer relevant connection to bitcoind is via ZMQ. /tx
endpoint results will now include block height, and spentTx related fields will be set tonull
if unspent./block
endpoint results does not includeconfirmations
and will includepoolInfo
.
Notes on Upgrading from v0.2
Some of the fields and methods are not supported:
The /tx/<txid>
endpoint JSON response will not include the following fields on the "vin"
object:
doubleSpentTxId
// double spends are not currently trackedisConfirmed
// confirmation of the previous outputconfirmations
// confirmations of the previous outputunconfirmedInput
The /tx/<txid>
endpoint JSON response will not include the following fields on the "vout"
object.
spentTs
The /status?q=getTxOutSetInfo
method has also been removed due to the query being very slow and locking bitcoind.
Plug-in support for Insight API is also no longer available, as well as the endpoints:
/email/retrieve
/rates/:code
Caching support has not yet been added in the v0.3 upgrade.