resource-bitcoin

bitcoin

for managing bitcoins

best API documentation

API

properties

• id

• server

methods

• connect (options, callback)

• connectId (options, callback)

• addMultiSigAddress ()

• addNode ()

• backupWallet ()

• createMultiSig ()

• createRawTransaction ()

• decodeRawTransaction ()

• dumpPrivKey ()

• encryptWallet ()

• getAccount ()

• getAccountAddress ()

• getAddedNodeInfo ()

• getAddressesByAccount ()

• getBalance ()

• getBlock ()

• getBlockCount ()

• getBlockHash ()

• getBlockTemplate ()

• getConnectionCount ()

• getDifficulty ()

• getGenerate ()

• getHashesPerSecond ()

• getHashesPerSec ()

• getInfo ()

• getMiningInfo ()

• getNewAddress ()

• getPeerInfo ()

• getRawMemPool ()

• getRawTransaction ()

• getReceivedByAccount ()

• getReceivedByAddress ()

• getTransaction ()

• getTxOut ()

• getTxOutSetInfo ()

• getWork ()

• help ()

• importPrivKey ()

• keypoolRefill ()

• keyPoolRefill ()

• listAccounts ()

• listAddressGroupings ()

• listLockUnspent ()

• listReceivedByAccount ()

• listReceivedByAddress ()

• listSinceBlock ()

• listTransactions ()

• listUnspent ()

• lockUnspent ()

• move ()

• sendFrom ()

• sendMany ()

• sendRawTransaction ()

• sendToAddress ()

• setAccount ()

• setGenerate ()

• setTxFee ()

• signMessage ()

• signRawTransaction ()

• stop ()

• submitBlock ()

• validateAddress ()

• verifyMessage ()

• walletLock ()

• walletPassphrase ()

• walletPassphraseChange ()

• start ()

properties

for managing bitcoins

• id

  • type : any

• server

  • description : a bitcoin server

  • properties

    • host

      • description : the hostname of the bitcoin server

      • type : string

      • default : localhost

    • port

      • description : the port of the bitcoin server

      • type : number

      • default : 8332

    • user

      • description : the user of the bitcoin server

      • type : string

      • default : rpcuser

    • pass

      • description : the password of the bitcoin server

      • type : string

      • default : rpcpassword

    • ssl

      • description : whether to enable ssl on bitcoin server

      • type : boolean

      • default : false

methods

bitcoin.connect(options, callback)

connects to a bitcoin server

• options

  • type : object

  • properties

    • host

      • description : the hostname of the bitcoin server

      • type : string

      • default : localhost

    • port

      • description : the port of the bitcoin server

      • type : number

      • default : 8332

    • user

      • description : the user of the bitcoin server

      • type : string

      • default : rpcuser

    • pass

      • description : the password of the bitcoin server

      • type : string

      • default : rpcpassword

    • ssl

      • description : whether to enable ssl on bitcoin server

      • type : boolean

      • default : false

• callback

  • type : function

bitcoin.connectId(options)

converts connect info to connectId

• options

  • type : object

  • properties

    • host

      • description : the hostname of the bitcoin server

      • type : string

      • default : localhost

    • port

      • description : the port of the bitcoin server

      • type : number

      • default : 8332

    • user

      • description : the user of the bitcoin server

      • type : string

      • default : rpcuser

• callback

  • type : function

bitcoin.start()

bitcoin.addMultiSigAddress()

bitcoin.addNode()

bitcoin.backupWallet()

bitcoin.createMultiSig()

bitcoin.createRawTransaction()

bitcoin.decodeRawTransaction()

bitcoin.dumpPrivKey()

bitcoin.encryptWallet()

bitcoin.getAccount()

bitcoin.getAccountAddress()

bitcoin.getAddedNodeInfo()

bitcoin.getAddressesByAccount()

bitcoin.getBalance()

bitcoin.getBlock()

bitcoin.getBlockCount()

bitcoin.getBlockHash()

bitcoin.getBlockTemplate()

bitcoin.getConnectionCount()

bitcoin.getDifficulty()

bitcoin.getGenerate()

bitcoin.getHashesPerSecond()

bitcoin.getHashesPerSec()

bitcoin.getInfo()

bitcoin.getMiningInfo()

bitcoin.getNewAddress()

bitcoin.getPeerInfo()

bitcoin.getRawMemPool()

bitcoin.getRawTransaction()

bitcoin.getReceivedByAccount()

bitcoin.getReceivedByAddress()

bitcoin.getTransaction()

bitcoin.getTxOut()

bitcoin.getTxOutSetInfo()

bitcoin.getWork()

bitcoin.help()

bitcoin.importPrivKey()

bitcoin.keypoolRefill()

bitcoin.keyPoolRefill()

bitcoin.listAccounts()

bitcoin.listAddressGroupings()

bitcoin.listLockUnspent()

bitcoin.listReceivedByAccount()

bitcoin.listReceivedByAddress()

bitcoin.listSinceBlock()

bitcoin.listTransactions()

bitcoin.listUnspent()

bitcoin.lockUnspent()

bitcoin.move()

bitcoin.sendFrom()

bitcoin.sendMany()

bitcoin.sendRawTransaction()

bitcoin.sendToAddress()

bitcoin.setAccount()

bitcoin.setGenerate()

bitcoin.setTxFee()

bitcoin.signMessage()

bitcoin.signRawTransaction()

bitcoin.stop()

bitcoin.submitBlock()

bitcoin.validateAddress()

bitcoin.verifyMessage()

bitcoin.walletLock()

bitcoin.walletPassphrase()

bitcoin.walletPassphraseChange()

README auto-generated with docs