[ { "type": "get", "url": "/api.php", "title": "01. Basic Information", "name": "Info", "group": "API", "description": "

Each API call will return the result in JSON format. There are 2 objects, "status" and "data".

The "status" object returns "ok" when the transaction is successful and "error" on failure.

The "data" object returns the requested data, as sub-objects.

The parameters must be sent either as POST['data'], json encoded array or independently as GET.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "status", "description": "

"ok"

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "data", "description": "

The data provided by the api will be under this object.

" } ] }, "examples": [ { "title": "Success-Response:", "content": "{\n \"status\":\"ok\",\n \"data\":{\n \"obj1\":\"val1\",\n \"obj2\":\"val2\",\n \"obj3\":{\n \"obj4\":\"val4\",\n \"obj5\":\"val5\"\n }\n }\n}", "type": "json" } ] }, "error": { "fields": { "Error 4xx": [ { "group": "Error 4xx", "type": "String", "optional": false, "field": "status", "description": "

"error"

" }, { "group": "Error 4xx", "type": "String", "optional": false, "field": "result", "description": "

Information regarding the error

" } ] }, "examples": [ { "title": "Error-Response:", "content": "{\n \"status\": \"error\",\n \"data\": \"The requested action could not be completed.\"\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=base58", "title": "03. base58", "name": "base58", "group": "API", "description": "

Converts a string to base58.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "data", "description": "

Input string

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

Output string

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=checkAddress", "title": "22. checkAddress", "name": "checkAddress", "group": "API", "description": "

Checks the validity of an address.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "account", "description": "

Account id / address

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "public_key", "description": "

Public key

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "boolean", "optional": false, "field": "data", "description": "

True if the address is valid, false otherwise.

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=checkSignature", "title": "17. checkSignature", "name": "checkSignature", "group": "API", "description": "

Checks a signature against a public key

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": true, "field": "public_key", "description": "

Public key

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "data", "description": "

signed data

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "boolean", "optional": false, "field": "data", "description": "

true or false

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=currentBlock", "title": "10. currentBlock", "name": "currentBlock", "group": "API", "description": "

Returns the current block.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "id", "description": "

Blocks id

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "generator", "description": "

Block Generator

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "height", "description": "

Height

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "date", "description": "

Block's date in UNIX TIMESTAMP format

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "nonce", "description": "

Mining nonce

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "signature", "description": "

Signature signed by the generator

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "difficulty", "description": "

The base target / difficulty

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "argon", "description": "

Mining argon hash

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=generateAccount", "title": "09. generateAccount", "name": "generateAccount", "group": "API", "description": "

Generates a new account. This function should only be used when the node is on the same host or over a really secure network.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "address", "description": "

Account address

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "public_key", "description": "

Public key

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "private_key", "description": "

Private key

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getAddress", "title": "02. getAddress", "name": "getAddress", "group": "API", "description": "

Converts the public key to an ARO address.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "public_key", "description": "

The public key

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

Contains the address

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getAlias", "title": "19. getAlias", "name": "getAlias", "group": "API", "description": "

Returns the alias of an account

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": true, "field": "public_key", "description": "

Public key

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "account", "description": "

Account id / address

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

alias

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getBalance", "title": "04. getBalance", "name": "getBalance", "group": "API", "description": "

Returns the balance of a specific account or public key.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": true, "field": "public_key", "description": "

Public key

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "account", "description": "

Account id / address

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "alias", "description": "

alias

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

The ARO balance

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getBlock", "title": "11. getBlock", "name": "getBlock", "group": "API", "description": "

Returns the block.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "numeric", "optional": false, "field": "height", "description": "

Block Height

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "id", "description": "

Block id

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "generator", "description": "

Block Generator

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "height", "description": "

Height

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "date", "description": "

Block's date in UNIX TIMESTAMP format

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "nonce", "description": "

Mining nonce

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "signature", "description": "

Signature signed by the generator

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "difficulty", "description": "

The base target / difficulty

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "argon", "description": "

Mining argon hash

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getBlockTransactions", "title": "12. getBlockTransactions", "name": "getBlockTransactions", "group": "API", "description": "

Returns the transactions of a specific block.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "numeric", "optional": true, "field": "height", "description": "

Block Height

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "block", "description": "

Block id

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "block", "description": "

Block ID

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "confirmations", "description": "

Number of confirmations

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "date", "description": "

Transaction's date in UNIX TIMESTAMP format

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "dst", "description": "

Transaction destination

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "fee", "description": "

The transaction's fee

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "height", "description": "

Block height

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "id", "description": "

Transaction ID/HASH

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "message", "description": "

Transaction's message

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "signature", "description": "

Transaction's signature

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "public_key", "description": "

Account's public_key

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "src", "description": "

Sender's address

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "type", "description": "

"debit", "credit" or "mempool"

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "val", "description": "

Transaction value

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "version", "description": "

Transaction version

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getPendingBalance", "title": "05. getPendingBalance", "name": "getPendingBalance", "group": "API", "description": "

Returns the pending balance, which includes pending transactions, of a specific account or public key.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": true, "field": "public_key", "description": "

Public key

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "account", "description": "

Account id / address

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

The ARO balance

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getPublicKey", "title": "08. getPublicKey", "name": "getPublicKey", "group": "API", "description": "

Returns the public key of a specific account.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "account", "description": "

Account id / address

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

The public key

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getTransaction", "title": "07. getTransaction", "name": "getTransaction", "group": "API", "description": "

Returns one transaction.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": false, "field": "transaction", "description": "

Transaction ID

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "block", "description": "

Block ID

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "confirmation", "description": "

Number of confirmations

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "date", "description": "

Transaction's date in UNIX TIMESTAMP format

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "dst", "description": "

Transaction destination

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "fee", "description": "

The transaction's fee

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "height", "description": "

Block height

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "id", "description": "

Transaction ID/HASH

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "message", "description": "

Transaction's message

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "signature", "description": "

Transaction's signature

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "public_key", "description": "

Account's public_key

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "src", "description": "

Sender's address

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "type", "description": "

"debit", "credit" or "mempool"

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "val", "description": "

Transaction value

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "version", "description": "

Transaction version

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=getTransactions", "title": "06. getTransactions", "name": "getTransactions", "group": "API", "description": "

Returns the latest transactions of an account.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "string", "optional": true, "field": "public_key", "description": "

Public key

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "account", "description": "

Account id / address

" }, { "group": "Parameter", "type": "numeric", "optional": true, "field": "limit", "description": "

Number of confirmed transactions, max 1000, min 1

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "block", "description": "

Block ID

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "confirmation", "description": "

Number of confirmations

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "date", "description": "

Transaction's date in UNIX TIMESTAMP format

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "dst", "description": "

Transaction destination

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "fee", "description": "

The transaction's fee

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "height", "description": "

Block height

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "id", "description": "

Transaction ID/HASH

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "message", "description": "

Transaction's message

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "signature", "description": "

Transaction's signature

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "public_key", "description": "

Account's public_key

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "src", "description": "

Sender's address

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "type", "description": "

"debit", "credit" or "mempool"

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "val", "description": "

Transaction value

" }, { "group": "Success 200", "type": "numeric", "optional": false, "field": "version", "description": "

Transaction version

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=masternodes", "title": "18. masternodes", "name": "masternodes", "group": "API", "description": "

Returns all the masternode data

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "boolean", "optional": false, "field": "data", "description": "

masternode date

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=mempoolSize", "title": "15. mempoolSize", "name": "mempoolSize", "group": "API", "description": "

Returns the number of transactions in mempool.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "numeric", "optional": false, "field": "data", "description": "

Number of mempool transactions

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=node-info", "title": "21. node-info", "name": "node_info", "group": "API", "description": "

Returns details about the node.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "data", "description": "

A collection of data about the node.

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "data.hostname", "description": "

The hostname of the node.

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "data.version", "description": "

The current version of the node.

" }, { "group": "Success 200", "type": "string", "optional": false, "field": "data.dbversion", "description": "

The database schema version for the node.

" }, { "group": "Success 200", "type": "number", "optional": false, "field": "data.accounts", "description": "

The number of accounts known by the node.

" }, { "group": "Success 200", "type": "number", "optional": false, "field": "data.transactions", "description": "

The number of transactions known by the node.

" }, { "group": "Success 200", "type": "number", "optional": false, "field": "data.mempool", "description": "

The number of transactions in the mempool.

" }, { "group": "Success 200", "type": "number", "optional": false, "field": "data.masternodes", "description": "

The number of masternodes known by the node.

" }, { "group": "Success 200", "type": "number", "optional": false, "field": "data.peers", "description": "

The number of valid peers.

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=randomNumber", "title": "16. randomNumber", "name": "randomNumber", "group": "API", "description": "

Returns a random number based on an ARO block id.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "numeric", "optional": false, "field": "height", "description": "

The height of the block on which the random number will be based on (should be a future block when starting)

" }, { "group": "Parameter", "type": "numeric", "optional": false, "field": "min", "description": "

Minimum number (default 1)

" }, { "group": "Parameter", "type": "numeric", "optional": false, "field": "max", "description": "

Maximum number

" }, { "group": "Parameter", "type": "string", "optional": false, "field": "seed", "description": "

A seed to generate different numbers for each use cases.

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "numeric", "optional": false, "field": "data", "description": "

The random number

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=sanity", "title": "20. sanity", "name": "sanity", "group": "API", "description": "

Returns details about the node's sanity process.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "object", "optional": false, "field": "data", "description": "

A collection of data about the sanity process.

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "data.sanity_running", "description": "

Whether the sanity process is currently running.

" }, { "group": "Success 200", "type": "number", "optional": false, "field": "data.last_sanity", "description": "

The timestamp for the last time the sanity process was run.

" }, { "group": "Success 200", "type": "boolean", "optional": false, "field": "data.sanity_sync", "description": "

Whether the sanity process is currently synchronising.

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=send", "title": "14. send", "name": "send", "group": "API", "description": "

Sends a transaction.

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "numeric", "optional": false, "field": "val", "description": "

Transaction value (without fees)

" }, { "group": "Parameter", "type": "string", "optional": false, "field": "dst", "description": "

Destination address

" }, { "group": "Parameter", "type": "string", "optional": false, "field": "public_key", "description": "

Sender's public key

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "signature", "description": "

Transaction signature. It's recommended that the transaction is signed before being sent to the node to avoid sending your private key to the node.

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "private_key", "description": "

Sender's private key. Only to be used when the transaction is not signed locally.

" }, { "group": "Parameter", "type": "numeric", "optional": true, "field": "date", "description": "

Transaction's date in UNIX TIMESTAMP format. Requried when the transaction is pre-signed.

" }, { "group": "Parameter", "type": "string", "optional": true, "field": "message", "description": "

A message to be included with the transaction. Maximum 128 chars.

" }, { "group": "Parameter", "type": "numeric", "optional": true, "field": "version", "description": "

The version of the transaction. 1 to send coins.

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

Transaction id

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "get", "url": "/api.php?q=version", "title": "13. version", "name": "version", "group": "API", "description": "

Returns the node's version.

", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "string", "optional": false, "field": "data", "description": "

Version

" } ] } }, "version": "0.0.0", "filename": "./api.php", "groupTitle": "API" }, { "type": "php util.php", "url": "balance", "title": "Balance", "name": "balance", "group": "UTIL", "description": "

Prints the balance of an address or a public key

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "text", "optional": false, "field": "arg2", "description": "

address or public_key

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php balance 5WuRMXGM7Pf8NqEArVz1NxgSBptkimSpvuSaYC79g1yo3RDQc8TjVtGH5chQWQV7CHbJEuq9DmW5fbmCEW4AghQr", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "Balance: 2,487", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "block", "title": "Block", "name": "block", "group": "UTIL", "description": "

Returns a specific block

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "text", "optional": false, "field": "arg2", "description": "

block id

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php block 4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "array(9) {\n [\"id\"]=>\n string(88) \"4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR\"\n [\"generator\"]=>\n string(88) \"5ADfrJUnLefPsaYjMTR4KmvQ79eHo2rYWnKBRCXConYKYJVAw2adtzb38oUG5EnsXEbTct3p7GagT2VVZ9hfVTVn\"\n [\"height\"]=>\n int(16833)\n [\"date\"]=>\n int(1519312385)\n [\"nonce\"]=>\n string(41) \"EwtJ1EigKrLurlXROuuiozrR6ICervJDF2KFl4qEY\"\n [\"signature\"]=>\n string(97) \"AN1rKpqit8UYv6uvf79GnbjyihCPE1UZu4CGRx7saZ68g396yjHFmzkzuBV69Hcr7TF2egTsEwVsRA3CETiqXVqet58MCM6tu\"\n [\"difficulty\"]=>\n string(8) \"61982809\"\n [\"argon\"]=>\n string(68) \"$SfghIBNSHoOJDlMthVcUtg$WTJMrQWHHqDA6FowzaZJ+O9JC8DPZTjTxNE4Pj/ggwg\"\n [\"transactions\"]=>\n int(0)\n}", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "block-time", "title": "Block-time", "name": "block_time", "group": "UTIL", "description": "

Shows the block time of the last 100 blocks

", "examples": [ { "title": "Example usage:", "content": "php util.php block-time", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "16830 -> 323\n...\n16731 -> 302\nAverage block time: 217 seconds", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "blocks", "title": "Blocks", "name": "blocks", "group": "UTIL", "description": "

Prints the id and the height of the blocks >=arg2, max 100 or arg3

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "number", "optional": false, "field": "arg2", "description": "

Starting height

" }, { "group": "Parameter", "type": "number", "optional": true, "field": "arg3", "description": "

Block Limit

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php blocks 10800 5", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "10801 2yAHaZ3ghNnThaNK6BJcup2zq7EXuFsruMb5qqXaHP9M6JfBfstAag1n1PX7SMKGcuYGZddMzU7hW87S5ZSayeKX\n10802 wNa4mRvRPCMHzsgLdseMdJCvmeBaCNibRJCDhsuTeznJh8C1aSpGuXRDPYMbqKiVtmGAaYYb9Ze2NJdmK1HY9zM\n10803 3eW3B8jCFBauw8EoKN4SXgrn33UBPw7n8kvDDpyQBw1uQcmJQEzecAvwBk5sVfQxUqgzv31JdNHK45JxUFcupVot\n10804 4mWK1f8ch2Ji3D6aw1BsCJavLNBhQgpUHBCHihnrLDuh8Bjwsou5bQDj7D7nV4RsEPmP2ZbjUUMZwqywpRc8r6dR\n10805 5RBeWXo2c9NZ7UF2ubztk53PZpiA4tsk3bhXNXbcBk89cNqorNj771Qu4kthQN5hXLtu1hzUnv7nkH33hDxBM34m", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "check-address", "title": "Check-Address", "name": "check_address", "group": "UTIL", "description": "

Checks a specific address for validity

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "text", "optional": false, "field": "arg2", "description": "

block id

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php check-address 4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "The address is valid", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "clean", "title": "Clean", "name": "clean", "group": "UTIL", "description": "

Cleans the entire database

", "examples": [ { "title": "Example usage:", "content": "php util.php clean", "type": "cli" } ], "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "clean-blacklist", "title": "Clean-Blacklist", "name": "clean_blacklist", "group": "UTIL", "description": "

Removes all the peers from blacklist

", "examples": [ { "title": "Example usage:", "content": "php util.php clean-blacklist", "type": "cli" } ], "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "current", "title": "Current", "name": "current", "group": "UTIL", "description": "

Prints the current block in var_dump

", "examples": [ { "title": "Example usage:", "content": "php util.php current", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "array(9) {\n [\"id\"]=>\n string(88) \"4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR\"\n [\"generator\"]=>\n string(88) \"5ADfrJUnLefPsaYjMTR4KmvQ79eHo2rYWnKBRCXConYKYJVAw2adtzb38oUG5EnsXEbTct3p7GagT2VVZ9hfVTVn\"\n [\"height\"]=>\n int(16833)\n [\"date\"]=>\n int(1519312385)\n [\"nonce\"]=>\n string(41) \"EwtJ1EigKrLurlXROuuiozrR6ICervJDF2KFl4qEY\"\n [\"signature\"]=>\n string(97) \"AN1rKpqit8UYv6uvf79GnbjyihCPE1UZu4CGRx7saZ68g396yjHFmzkzuBV69Hcr7TF2egTsEwVsRA3CETiqXVqet58MCM6tu\"\n [\"difficulty\"]=>\n string(8) \"61982809\"\n [\"argon\"]=>\n string(68) \"$SfghIBNSHoOJDlMthVcUtg$WTJMrQWHHqDA6FowzaZJ+O9JC8DPZTjTxNE4Pj/ggwg\"\n [\"transactions\"]=>\n int(0)\n}", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "delete-peer", "title": "Delete-peer", "name": "delete_peer", "group": "UTIL", "description": "

Removes a peer from the peerlist

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "text", "optional": false, "field": "arg2", "description": "

Peer's hostname

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php delete-peer http://peer1.arionum.com", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "Peer removed", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "get-address", "title": "Get-Address", "name": "get_address", "group": "UTIL", "description": "

Converts a public key into an address

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "text", "optional": false, "field": "arg2", "description": "

public key

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php get-address PZ8Tyr4Nx8MHsRAGMpZmZ6TWY63dXWSCwQr8cE5s6APWAE1SWAmH6NM1nJTryBURULEsifA2hLVuW5GXFD1XU6s6REG1iPK7qGaRDkGpQwJjDhQKVoSVkSNp", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "5WuRMXGM7Pf8NqEArVz1NxgSBptkimSpvuSaYC79g1yo3RDQc8TjVtGH5chQWQV7CHbJEuq9DmW5fbmCEW4AghQr", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "mempool", "title": "Mempool", "name": "mempool", "group": "UTIL", "description": "

Prints the number of transactions in mempool

", "examples": [ { "title": "Example usage:", "content": "php util.php mempool", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "Mempool size: 12", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "peer", "title": "Peer", "name": "peer", "group": "UTIL", "description": "

Creates a peering session with another node

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "text", "optional": false, "field": "arg2", "description": "

The Hostname of the other node

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php peer http://peer1.arionum.com", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "Peering OK", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "peers", "title": "Peers", "name": "peers", "group": "UTIL", "description": "

Prints all the peers and their status

", "examples": [ { "title": "Example usage:", "content": "php util.php peers", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "http://35.190.160.142 active\n...\nhttp://aro.master.hashpi.com active", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "peers-block", "title": "Peers-Block", "name": "peers_block", "group": "UTIL", "description": "

Prints the current height of all the peers

", "examples": [ { "title": "Example usage:", "content": "php util.php peers-block", "type": "cli" } ], "success": { "examples": [ { "title": "Success-Response:", "content": "http://peer5.arionum.com 16849\n...\nhttp://peer10.arionum.com 16849", "type": "text" } ] }, "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "pop", "title": "Pop", "name": "pop", "group": "UTIL", "description": "

Cleans the entire database

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": false, "field": "arg2", "description": "

Number of blocks to delete

" } ] } }, "examples": [ { "title": "Example usage:", "content": "php util.php pop 1", "type": "cli" } ], "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "type": "php util.php", "url": "recheck-blocks", "title": "Recheck-Blocks", "name": "recheck_blocks", "group": "UTIL", "description": "

Recheck all the blocks to make sure the blockchain is correct

", "examples": [ { "title": "Example usage:", "content": "php util.php recheck-blocks", "type": "cli" } ], "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" }, { "success": { "fields": { "Success 200": [ { "group": "Success 200", "optional": false, "field": "varname1", "description": "

No type.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "varname2", "description": "

With type.

" } ] } }, "type": "", "url": "", "version": "0.0.0", "filename": "./doc/main.js", "group": "_github_node_doc_main_js", "groupTitle": "_github_node_doc_main_js", "name": "" } ]