phore-rpc

1.0.0 • Public • Published

Installation

Using npm:

npm install phore-rpc --save
 

In Node.js:

const phorerpc = require('phore-rpc');
 
phorerpc.estimateFee(numberofblocks).then(console.log) // input a number (e.g. 5) of blocks within which the transaction needs to be included - returns an estimate of the fee per kilobyte for the transaction
 
phorerpc.estimatePriority(numberofblocks).then(console.log) //input a number (e.g. 5) of blocks the transaction may wait before being included as a free high-priority transaction - returns an estimate of the priority that a transaction needs
 
phorerpc.getBestBlockHash().then(console.log) // no parameter - returns a hash from the tip of the best block chain
 
phorerpc.getBlock(blockhash).then(function(d){
    console.log(d) // input the hash of a block - returns block details
})
 
phorerpc.getBlockHash(index).then(console.log) // input a number that represents the block height index of the block to get back its hash - an index of 0 returns the genesis block, which has a hash of '2b1a0f66712aad59ad283662d5b919415a25921ce89511d73019107e380485bf'
 
phorerpc.getBlockChainInfo().then(console.log) // no parameter - returns an object with network info such as blocks, headers, bestblockhash
 
phorerpc.getBlockCount().then(console.log) // no parameter - returns current blocks height (i.e. # of blocks)
 
phorerpc.getBlockHeader(blockhash).then(console.log) // input a block hash - returns just the header info for that block
 
phorerpc.getChainTips().then(console.log) // no parameter - returns an array of blocks with their height, hash, branchlen and status
 
phorerpc.getConnectionCount().then(console.log) // no parameter - returns the number of connections to other nodes
 
phorerpc.getDifficulty().then(console.log) // no parameter - returns a difficulty score as multiple of the minimum difficulty
 
phorerpc.getInfo().then(console.log) // no parameter - returns information about the node and the network
 
phorerpc.getMemPoolInfo().then(console.log) // no parameter - returns information about the current state of the mempool
 
phorerpc.getMiningInfo().then(console.log) // no parameter - returns info about the network
 
phorerpc.getNetworkHashPs().then(console.log) // no parameter - returns the estimated current or historical network hashes per second based on the last n blocks
 
phorerpc.getRawMemPool().then(console.log) // no parameter - returns an array of info about what is in the Mem Pool or an empty array if nothing is in the Mem Pool
 
phorerpc.getRawTransaction(txId).then(console.log) // input a txId (transaction id) - returns details of that transaction
 
phorerpc.getTxOut(txId).then(console.log) // input a txId (transaction id) - returns the value of any unspent UTXO's
 
phorerpc.getTxOutsetInfo().then(console.log) // no parameter - returns statistics about the unspent transaction output (UTXO) set
 
phorerpc.ping().then(console.log) // no parameter - returns null
 
phorerpc.submitBlock(blockhex).then(console.log) // input the new block in a serialized hex format and this submits it to the network and returns result
 
 
phorerpc.masterNodeList().then(console.log) // no parameter - returns a list of master nodes
 
phorerpc.sendRawTransaction(txHex).then(console.log) // input the txHex obtained from creating a transaction using bitcoinjs-phore - broadcasts the transaction to the network and returns result
 

Readme

Keywords

Package Sidebar

Install

npm i phore-rpc

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

19.5 kB

Total Files

4

Last publish

Collaborators

  • marleymarl