Liking cljdoc? Tell your friends :D

clj-btc.core


addmultisigaddressclj

(addmultisigaddress & {:keys [config nrequired keys account]})

Add a nrequired-to-sign multisignature address to the wallet. Each key is a bitcoin address or hex-encoded public key. If [account] is specified, assign address to [account].

Add a nrequired-to-sign multisignature address to the wallet. Each key is
a bitcoin address or hex-encoded public key. If [account] is specified,
assign address to [account].
raw docstring

addnodeclj

(addnode & {:keys [config node add-remove-onetry]})

(version 0.8) Attempts add or remove <node> from the addnode list or try a connection to <node> once.

(version 0.8) Attempts add or remove <node> from the addnode list or try a
connection to <node> once.
raw docstring

backupwalletclj

(backupwallet & {:keys [config destination]})

Safely copies wallet.dat to destination, which can be a directory or a path with filename.

Safely copies wallet.dat to destination, which can be a directory or a path
with filename.
raw docstring

createmultisigclj

(createmultisig & {:keys [config nrequired keys]})

Creates a multi-signature address and returns a json object

Creates a multi-signature address and returns a json object
raw docstring

createrawtransactionclj

(createrawtransaction & {:keys [config txids-map addrs-amounts-map]})

(version 0.7) Creates a raw transaction spending given inputs: [{"txid": txid "vout": n}...] {address:amount...}.

(version 0.7) Creates a raw transaction spending given inputs:
[{"txid": txid "vout": n}...] {address:amount...}.
raw docstring

decoderawtransactionclj

(decoderawtransaction & {:keys [config hex-string]})

(version 0.7) Produces a human-readable JSON object for a raw transaction.

(version 0.7) Produces a human-readable JSON object for a raw transaction.
raw docstring

dumpprivkeyclj

(dumpprivkey & {:keys [config bitcoinaddress]})

Reveals the private key corresponding to <bitcoinaddress>

Reveals the private key corresponding to <bitcoinaddress>
raw docstring

encryptwalletclj

(encryptwallet & {:keys [config passphrase]})

Encrypts the wallet with <passphrase>.

Encrypts the wallet with <passphrase>.
raw docstring

estimatefeeclj

(estimatefee & {:keys [config blocks]})

<blocks> is an int specifying how many blocks you're willing to wait before confirmation

<blocks> is an int specifying how many blocks you're willing
to wait before confirmation
raw docstring

getaccountclj

(getaccount & {:keys [config bitcoinaddress]})

Returns the account associated with the given address.

Returns the account associated with the given address.
raw docstring

getaccountaddressclj

(getaccountaddress & {:keys [config account]})

Returns the current bitcoin address for receiving payments to this account.

Returns the current bitcoin address for receiving payments to this account.
raw docstring

getaddednodeinfoclj

(getaddednodeinfo & {:keys [config dns node]})

(version 0.8) Returns information about the given added node, or all added nodes.(note that onetry addnodes are not listed here) If dns is false, only a list of added nodes will be provided, otherwise connected information will also be available.

(version 0.8) Returns information about the given added node, or all added
nodes.(note that onetry addnodes are not listed here) If dns is false, only
a list of added nodes will be provided, otherwise connected information will
also be available.
raw docstring

getaddressesbyaccountclj

(getaddressesbyaccount & {:keys [config account]})

Returns the list of addresses for the given account.

Returns the list of addresses for the given account.
raw docstring

getbalanceclj

(getbalance & {:keys [config account minconf]})

If [account] is not specified, returns the server's total available balance. If [account] is specified, returns the balance in the account.

If [account] is not specified, returns the server's total available balance.
If [account] is specified, returns the balance in the account.
raw docstring

getblockclj

(getblock & {:keys [config hash]})

Returns information about the block with the given hash.

Returns information about the block with the given hash.
raw docstring

getblockcountclj

(getblockcount & {:keys [config]})

Returns the number of blocks in the longest block chain.

Returns the number of blocks in the longest block chain.
raw docstring

getblockhashclj

(getblockhash & {:keys [config index]})

Returns hash of block in best-block-chain at <index>; index 0 is the genesis block.

Returns hash of block in best-block-chain at <index>; index 0 is the genesis
block.
raw docstring

getblocktemplateclj

(getblocktemplate & {:keys [config params]})

Returns data needed to construct a block to work on

Returns data needed to construct a block to work on
raw docstring

getconnectioncountclj

(getconnectioncount & {:keys [config]})

Returns the number of connections to other nodes.

Returns the number of connections to other nodes.
raw docstring

getdifficultyclj

(getdifficulty & {:keys [config]})

Returns the proof-of-work difficulty as a multiple of the minimum difficulty.

Returns the proof-of-work difficulty as a multiple of the minimum
difficulty.
raw docstring

getgenerateclj

(getgenerate & {:keys [config]})

Returns true or false whether bitcoind is currently generating hashes

Returns true or false whether bitcoind is currently generating hashes
raw docstring

getinfoclj

(getinfo & {:keys [config]})

Returns an object containing various state info.

Returns an object containing various state info.
raw docstring

getmemorypoolclj

(getmemorypool & {:keys [config data]})

Replaced in v0.7.0 with getblocktemplate, submitblock, getrawmempool```

Replaced in v0.7.0 with getblocktemplate, submitblock, getrawmempool```
raw docstring

getmininginfoclj

(getmininginfo & {:keys [config]})

Returns an object containing mining-related information: blocks, currentblocksize, currentblocktx, difficulty, errors, generate, genproclimit, hashespersec, pooledtx, testnet

Returns an object containing mining-related information: blocks,
currentblocksize, currentblocktx, difficulty, errors, generate, genproclimit,
hashespersec, pooledtx, testnet
raw docstring

getnewaddressclj

(getnewaddress & {:keys [config account]})

Returns a new bitcoin address for receiving payments. If [account] is specified (recommended), it is added to the address book so payments received with the address will be credited to [account].

Returns a new bitcoin address for receiving payments. If [account] is
specified (recommended), it is added to the address book so payments received
with the address will be credited to [account].
raw docstring

getpeerinfoclj

(getpeerinfo & {:keys [config]})

(version 0.7) Returns data about each connected node.

(version 0.7) Returns data about each connected node.
raw docstring

getrawmempoolclj

(getrawmempool & {:keys [config]})

(version 0.7) Returns all transaction ids in memory pool

(version 0.7) Returns all transaction ids in memory pool
raw docstring

getrawtransactionclj

(getrawtransaction & {:keys [config txid verbose]})

(version 0.7) Returns raw transaction representation for given transaction id.

(version 0.7) Returns raw transaction representation for given
transaction id.
raw docstring

getreceivedbyaccountclj

(getreceivedbyaccount & {:keys [config account minconf]})

Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24)

Returns the total amount received by addresses with [account] in transactions
with at least [minconf] confirmations. If [account] not provided return will
include all transactions to all accounts. (version 0.3.24)
raw docstring

getreceivedbyaddressclj

(getreceivedbyaddress & {:keys [config bitcoinaddress minconf]})

Returns the total amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations. While some might consider this obvious, value reported by this only considers receiving transactions. It does not check payments that have been made from this address. In other words, this is not "getaddressbalance". Works only for addresses in the local wallet, external addresses will always show 0.

Returns the total amount received by <bitcoinaddress> in transactions with at
least [minconf] confirmations. While some might consider this obvious, value
reported by this only considers *receiving* transactions. It does not check
payments that have been made *from* this address. In other words, this is not
"getaddressbalance". Works only for addresses in the local wallet, external
addresses will always show 0.
raw docstring

gettransactionclj

(gettransaction & {:keys [config txid]})

Returns an object about the given transaction containing: "amount": total amount of the transaction, "confirmations": number of confirmations of the transaction, "txid": the transaction ID, "time": time associated with the transaction., "details" - An array of objects containing: "account", "address", "category", "amount", "fee"

Returns an object about the given transaction containing:
"amount": total amount of the transaction,
"confirmations": number of confirmations of the transaction,
"txid": the transaction ID,
"time": time associated with the transaction.,
"details" - An array of objects containing: "account", "address",
     "category", "amount", "fee"
raw docstring

gettxoutclj

(gettxout & {:keys [config txid n includemempool]})

Returns details about an unspent transaction output (UTXO)

Returns details about an unspent transaction output (UTXO)
raw docstring

gettxoutsetinfoclj

(gettxoutsetinfo & {:keys [config]})

Returns statistics about the unspent transaction output (UTXO) set

Returns statistics about the unspent transaction output (UTXO) set
raw docstring

helpclj

(help & {:keys [config command]})

List commands, or get help for a command.

List commands, or get help for a command.
raw docstring

id-numclj


importprivkeyclj

(importprivkey & {:keys [config bitcoinprivkey label rescan]})

Adds a private key (as returned by dumpprivkey) to your wallet. This may take a while, as a rescan is done, looking for existing transactions. Optional [rescan] parameter added in 0.8.0.

Adds a private key (as returned by dumpprivkey) to your wallet. This
 may take a while, as a rescan is done, looking for existing
transactions. Optional [rescan] parameter added in 0.8.0.
raw docstring

keypoolrefillclj

(keypoolrefill & {:keys [config]})

Fills the keypool, requires wallet passphrase to be set.

Fills the keypool, requires wallet passphrase to be set.
raw docstring

listaccountsclj

(listaccounts & {:keys [config minconf]})

Returns Object that has account names as keys, account balances as values.

Returns Object that has account names as keys, account balances as
values.
raw docstring

listaddressgroupingsclj

(listaddressgroupings & {:keys [config]})

(version 0.7) Returns all addresses in the wallet and info used for coincontrol.

(version 0.7) Returns all addresses in the wallet and info used for
coincontrol.
raw docstring

listlockunspentclj

(listlockunspent & {:keys [config]})

(version 0.8) Returns list of temporarily unspendable outputs

(version 0.8) Returns list of temporarily unspendable outputs
raw docstring

listreceivedbyaccountclj

(listreceivedbyaccount & {:keys [config minconf includeempty]})

Returns an array of objects containing:, "account": the account of the receiving addresses, "amount": total amount received by addresses with this account, "confirmations": number of confirmations of the most recent transaction included

Returns an array of objects containing:, "account": the account
of the receiving addresses, "amount": total amount received by
addresses with this account, "confirmations": number of
confirmations of the most recent transaction included
raw docstring

listreceivedbyaddressclj

(listreceivedbyaddress & {:keys [config minconf includeempty]})

Returns an array of objects containing:, "address": receiving address, "account": the account of the receiving address, "amount": total amount received by the address, "confirmations": number of confirmations of the most recent transaction included, To get a list of accounts on the system, execute bitcoind listreceivedbyaddress 0 true

Returns an array of objects containing:, "address": receiving
address, "account": the account of the receiving address,
"amount": total amount received by the address, "confirmations":
number of confirmations of the most recent transaction included, To
get a list of accounts on the system, execute bitcoind
listreceivedbyaddress 0 true
raw docstring

listsinceblockclj

(listsinceblock & {:keys [config blockhash target-confirmations]})

Get all transactions in blocks since block [blockhash], or all transactions if omitted.

Get all transactions in blocks since block [blockhash], or all
transactions if omitted.
raw docstring

listtransactionsclj

(listtransactions & {:keys [config account count from]})

Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided will return recent transaction from all accounts.

Returns up to [count] most recent transactions skipping the first
[from] transactions for account [account]. If [account] not provided
will return recent transaction from all accounts.
raw docstring

listunspentclj

(listunspent & {:keys [config minconf maxconf]})

(version 0.7) Returns array of unspent transaction inputs in the wallet.

(version 0.7) Returns array of unspent transaction inputs in the wallet.
raw docstring

lockunspentclj

(lockunspent & {:keys [config unlock? array-of-objects]})

(version 0.8) Updates list of temporarily unspendable outputs

(version 0.8) Updates list of temporarily unspendable outputs
raw docstring

moveclj

(move & {:keys [config fromaccount toaccount amount minconf comment]})

Move from one account in your wallet to another

Move from one account in your wallet to another
raw docstring

not-nil?clj


sendfromclj

(sendfrom &
          {:keys [config fromaccount tobitcoinaddress amount minconf comment
                  comment-to]})

<amount> is a real and is rounded to 8 decimal places. Will send the given amount to the given address, ensuring the account has a valid balance using [minconf] confirmations. Returns the transaction ID if successful (not in JSON object).

<amount> is a real and is rounded to 8 decimal places. Will send
the given amount to the given address, ensuring the account has a
valid balance using [minconf] confirmations. Returns the transaction
ID if successful (not in JSON object).
raw docstring

sendmanyclj

(sendmany & {:keys [config fromaccount address-amount-maps minconf comment]})

amounts are double-precision floating point numbers. example usage: (sendmany :fromaccount "my-account" :address-amount-maps {"payee1" "amount1" ...} :minconf 6 :comment "Keep the change")

amounts are double-precision floating point numbers.
example usage:
(sendmany :fromaccount "my-account"
          :address-amount-maps {"payee1" "amount1" ...}
          :minconf 6 :comment "Keep the change")
raw docstring

sendrawtransactionclj

(sendrawtransaction & {:keys [config hexstring]})

(version 0.7) Submits raw transaction (serialized, hex-encoded) to local node and network.

(version 0.7) Submits raw transaction (serialized, hex-encoded) to
local node and network.
raw docstring

sendtoaddressclj

(sendtoaddress & {:keys [config bitcoinaddress amount comment comment-to]})

<amount> is a real and is rounded to 8 decimal places. Returns the transaction ID <txid> if successful.

<amount> is a real and is rounded to 8 decimal places. Returns the
transaction ID <txid> if successful.
raw docstring

setaccountclj

(setaccount & {:keys [config bitcoinaddress account]})

Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account.

Sets the account associated with the given address. Assigning
address that is already assigned to the same account will create a new
address associated with that account.
raw docstring

setgenerateclj

(setgenerate & {:keys [config generate genproclimit]})

<generate> is true or false to turn generation on or off. Generation is limited to [genproclimit] processors, -1 is unlimited.

<generate> is true or false to turn generation on or
off. Generation is limited to [genproclimit] processors, -1 is
unlimited.
raw docstring

settxfeeclj

(settxfee & {:keys [config amount]})

<amount> is a real and is rounded to the nearest 0.00000001

<amount> is a real and is rounded to the nearest 0.00000001
raw docstring

signmessageclj

(signmessage & {:keys [config bitcoinaddress message]})

Sign a message with the private key of an address.

Sign a message with the private key of an address.
raw docstring

signrawtransactionclj

(signrawtransaction & {:keys [config hexstring txinfo privatekeys]})

(version 0.7) Adds signatures to a raw transaction and returns the resulting raw transaction. txinfo is of the form [{:txid "txid", :vout n, :scriptPubKey "hex"}]. Exact case is important, pay attention to scriptPubKey.

(version 0.7) Adds signatures to a raw transaction and returns the
resulting raw transaction.
txinfo is of the form [{:txid "txid", :vout n,
                        :scriptPubKey "hex"}].
Exact case is important, pay attention to scriptPubKey.
raw docstring

stopclj

(stop & {:keys [config]})

Stop bitcoin server.

Stop bitcoin server.
raw docstring

submitblockclj

(submitblock & {:keys [config hex data optional-params-obj]})

Attempts to submit new block to network.

Attempts to submit new block to network.
raw docstring

validateaddressclj

(validateaddress & {:keys [config bitcoinaddress]})

Return information about <bitcoinaddress>.

Return information about <bitcoinaddress>.
raw docstring

verifymessageclj

(verifymessage & {:keys [config bitcoinaddress signature message]})

Verify a signed message.

Verify a signed message.
raw docstring

walletlockclj

(walletlock & {:keys [config]})

Removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call walletpassphrase again before being able to call any methods which require the wallet to be unlocked.

Removes the wallet encryption key from memory, locking the
wallet. After calling this method, you will need to call
walletpassphrase again before being able to call any methods which
require the wallet to be unlocked.
raw docstring

walletpassphraseclj

(walletpassphrase & {:keys [config passphrase timeout]})

Stores the wallet decryption key in memory for <timeout> seconds.

Stores the wallet decryption key in memory for <timeout> seconds.
raw docstring

walletpassphrasechangeclj

(walletpassphrasechange & {:keys [config oldpassphrase newpassphrase]})

Changes the wallet passphrase from <oldpassphrase> to <newpassphrase>.

Changes the wallet passphrase from <oldpassphrase> to <newpassphrase>.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close