- client
Create an Axios Client with defaults
- request() ⇒
Promise
Custom
- getConfig() ⇒
Promise.<object>
Get current config
- getLatestConfirmed() ⇒
Promise.Array.<Registration>
Get all confirmed transactions
- getLatestUnconfirmed() ⇒
Promise.Array.<Registration>
Get all transactions pending confirmation
- register() ⇒
Promise.<Registration>
Register a new hash in the BTC blockchain
- getStatus() ⇒
Promise.<Registration>
Get current status of a registration
- updateStatus() ⇒
Promise.<Registration>
Update the current status of a registration
- docproofs() ⇒
Promise.Array.<Docproof>
Get current docproofs of the registration
- Registration :
Object
- Docproof :
Object
Create an Axios Client with defaults
Custom
Kind: global function
Returns: Promise
- a JS promise
Type | Description |
---|---|
object |
an object containing the method and the URL to fetch |
Get current config
Kind: global function
Returns: Promise.<object>
- the server config
getLatestConfirmed() ⇒ Promise.Array.<Registration>
Get all confirmed transactions
Kind: global function
Returns: Promise.Array.<Registration>
- an array of confirmed
getLatestUnconfirmed() ⇒ Promise.Array.<Registration>
Get all transactions pending confirmation
Kind: global function
Returns: Promise.Array.<Registration>
- an array of confirmed
register() ⇒ Promise.<Registration>
Register a new hash in the BTC blockchain
Kind: global function
Type | Description |
---|---|
string |
a valid Sha256 hash |
getStatus() ⇒ Promise.<Registration>
Get current status of a registration
Kind: global function
Type | Description |
---|---|
string |
a valid Sha256 hash |
updateStatus() ⇒ Promise.<Registration>
Update the current status of a registration
Kind: global function
Type | Description |
---|---|
string |
a valid Sha256 hash |
docproofs() ⇒ Promise.Array.<Docproof>
Get current docproofs of the registration
Kind: global function
Type | Description |
---|---|
string |
a valid Sha256 hash |
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
digest | string |
the sha256 hash |
payment_address | string |
the BTC address |
pending | boolean |
if the paiment has been received |
network | string |
BTC netwotk 'testnet' or 'mainnet' |
success | boolean |
if the transaction has been recorded successfully |
timestamp | string |
the registration timestamp |
tx | string |
the BTC transaction id |
txstamp | string |
the BTC transaction timestamp |
blockstamp | string |
the BTC block timestamp |
price | string |
the price paid for the registration |
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
blockchash | string |
the sha256 hash |
confirmations | number |
number of times it has been confirmed in the BTC blockchain |
txid | string |
the BTC transaction id |
txstamp | string |
the BTC transaction timestamp |
blockheight | string |
position of the block in the BTC blockchain |
blocktime | number |
the BTC block timestamp |
metadata | string |
the OP_RETURN data containing the sha256 and the protocol |