module StartcoinClient::DSL

Public Instance Methods

account(bitcoinaddress)
Alias for: getaccount
account=(bitcoinaddress, account)
Alias for: setaccount
account_address(account)
Alias for: getaccountaddress
accounts(minconf = 1)
Alias for: listaccounts
addresses_by_account(account)
backupwallet(destination) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 64
def backupwallet(destination)
  bitcoin.backupwallet destination
end
balance(account = nil, minconf = 1)
Alias for: getbalance
bitcoin() click to toggle source
# File lib/startcoin_client/dsl.rb, line 2
def bitcoin
  if self.class.respond_to?(:bitcoin)
    @client ||= StartcoinClient::Client.new(self.class.bitcoin.user, self.class.bitcoin.pass, self.class.bitcoin.options)
  else
    @client ||= StartcoinClient::Client.new(nil, nil)
  end
end
block_by_count(height)
Alias for: getblockbycount
block_count()
Alias for: getblockcount
block_hash(index)
Alias for: getblockhash
block_number()
Alias for: getblocknumber
connection_count()
Alias for: getconnectioncount
difficulty()
Alias for: getdifficulty
generate=(generate, genproclimit = -1)
Alias for: setgenerate
generate?()
Alias for: getgenerate
get_work(data = nil)
Alias for: getwork
getaccount(bitcoinaddress) click to toggle source

Returns the account associated with the given address.

# File lib/startcoin_client/dsl.rb, line 69
def getaccount(bitcoinaddress)
  bitcoin.getaccount bitcoinaddress
end
Also aliased as: account
getaccountaddress(account) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 74
def getaccountaddress(account)
  bitcoin.getaccountaddress account
end
Also aliased as: account_address
getaddressesbyaccount(account) click to toggle source

Returns the list of addresses for the given account.

# File lib/startcoin_client/dsl.rb, line 79
def getaddressesbyaccount(account)
  bitcoin.getaddressesbyaccount account
end
Also aliased as: addresses_by_account
getbalance(account = nil, minconf = 1) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 85
def getbalance(account = nil, minconf = 1)
  bitcoin.getbalance account, minconf
end
Also aliased as: balance
getbestblockhash() click to toggle source

Returns the hash of the best (tip) block in the longest block chain.

# File lib/startcoin_client/dsl.rb, line 90
def getbestblockhash
  bitcoin.getbestblockhash
end
getblock(hash) click to toggle source

Dumps the block existing with specified hash.

# File lib/startcoin_client/dsl.rb, line 101
def getblock(hash)
  bitcoin.getblock hash
end
getblockbycount(height) click to toggle source

Dumps the block existing at specified height. Note: this is not available in the official release

# File lib/startcoin_client/dsl.rb, line 96
def getblockbycount(height)
  bitcoin.getblockbycount height
end
Also aliased as: block_by_count
getblockcount() click to toggle source

Returns the number of blocks in the longest block chain.

# File lib/startcoin_client/dsl.rb, line 106
def getblockcount
  bitcoin.getblockcount
end
Also aliased as: block_count
getblockhash(index) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 116
def getblockhash(index)
  bitcoin.getblockhash index
end
Also aliased as: block_hash
getblocknumber() click to toggle source

Returns the block number of the latest block in the longest block chain.

# File lib/startcoin_client/dsl.rb, line 111
def getblocknumber
  bitcoin.getblocknumber
end
Also aliased as: block_number
getconnectioncount() click to toggle source

Returns the number of connections to other nodes.

# File lib/startcoin_client/dsl.rb, line 121
def getconnectioncount
  bitcoin.getconnectioncount
end
Also aliased as: connection_count
getdifficulty() click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 126
def getdifficulty
  bitcoin.getdifficulty
end
Also aliased as: difficulty
getgenerate() click to toggle source

Returns true or false whether bitcoind is currently generating hashes

# File lib/startcoin_client/dsl.rb, line 131
def getgenerate
  bitcoin.getgenerate
end
Also aliased as: generate?
gethashespersec() click to toggle source

Returns a recent hashes per second performance measurement while generating.

# File lib/startcoin_client/dsl.rb, line 136
def gethashespersec
  bitcoin.gethashespersec
end
Also aliased as: hashes_per_sec
getinfo() click to toggle source

Returns an object containing various state info.

# File lib/startcoin_client/dsl.rb, line 141
def getinfo
  bitcoin.getinfo
end
Also aliased as: info
getmininginfo() click to toggle source

Returns an object containing various mining info.

# File lib/startcoin_client/dsl.rb, line 151
def getmininginfo
  bitcoin.getmininginfo
end
Also aliased as: mininginfo
getnewaddress(account = nil) click to toggle source

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.

# File lib/startcoin_client/dsl.rb, line 157
def getnewaddress(account = nil)
  bitcoin.getnewaddress account
end
Also aliased as: new_address
getpeerinfo() click to toggle source

Returns data about each connected network node.

# File lib/startcoin_client/dsl.rb, line 146
def getpeerinfo
  bitcoin.getpeerinfo
end
Also aliased as: peerinfo
getrawmempool() click to toggle source

Gets all mempool txs (pedning/waiting to be added in a block)

# File lib/startcoin_client/dsl.rb, line 185
def getrawmempool
  bitcoin.getrawmempool
end
Also aliased as: raw_mempool
getrawtransaction(txid, verbose = 0) click to toggle source

Get raw transaction bout txid. It outputs the whole transaction chain by default in HEX. If you want JSON, set verbose to 1. When in the bitcoind config is set txindex=1, after reindexing, you can ask about any transaction (not included in your wallet), with this command.

# File lib/startcoin_client/dsl.rb, line 180
def getrawtransaction(txid, verbose = 0)
  bitcoin.getrawtransaction txid verbose
end
Also aliased as: rawtransaction
getreceivedbyaccount(account, minconf = 1) click to toggle source

Returns the total amount received by addresses with account in transactions with at least minconf confirmations.

# File lib/startcoin_client/dsl.rb, line 163
def getreceivedbyaccount(account, minconf = 1)
  bitcoin.getreceivedbyaccount account, minconf
end
Also aliased as: received_by_account
getreceivedbyaddress(bitcoinaddress, minconf = 1) click to toggle source

Returns the total amount received by bitcoinaddress in transactions with at least minconf confirmations.

# File lib/startcoin_client/dsl.rb, line 168
def getreceivedbyaddress(bitcoinaddress, minconf = 1)
  bitcoin.getreceivedbyaddress bitcoinaddress, minconf
end
Also aliased as: received_by_address
gettransaction(txid) click to toggle source

Get detailed information about txid

# File lib/startcoin_client/dsl.rb, line 173
def gettransaction(txid)
  bitcoin.gettransaction txid
end
Also aliased as: transaction
getwork(data = nil) click to toggle source

If data is not specified, returns formatted hash data to work on:

:midstate => precomputed hash state after hashing the first half of the data
:data     => block data
:hash1    => formatted hash buffer for second hash
:target   => little endian hash target

If data is specified, tries to solve the block and returns true if it was successful.

# File lib/startcoin_client/dsl.rb, line 197
def getwork(data = nil)
  bitcoin.getwork data
end
Also aliased as: work, get_work
hashes_per_sec()
Alias for: gethashespersec
help(command = nil) click to toggle source

List commands, or get help for a command.

# File lib/startcoin_client/dsl.rb, line 202
def help(command = nil)
  bitcoin.help command
end
host(value = nil) click to toggle source
# File lib/startcoin_client/dsl.rb, line 42
def host(value = nil)
  value ? bitcoin.host = value : bitcoin.host
end
host=(value) click to toggle source
# File lib/startcoin_client/dsl.rb, line 18
def host=(value)
  bitcoin.host = value
end
info()
Alias for: getinfo
list_received_by_account(minconf = 1, includeempty = false)
list_received_by_address(minconf = 1, includeempty = false)
list_transactions(account = '', count = 10, from = 0)
Alias for: listtransactions
listaccounts(minconf = 1) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 207
def listaccounts(minconf = 1)
  bitcoin.listaccounts minconf
end
Also aliased as: accounts
listreceivedbyaccount(minconf = 1, includeempty = false) click to toggle source

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
# File lib/startcoin_client/dsl.rb, line 217
def listreceivedbyaccount(minconf = 1, includeempty = false)
  bitcoin.listreceivedbyaccount minconf, includeempty
end
Also aliased as: list_received_by_account
listreceivedbyaddress(minconf = 1, includeempty = false) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 229
def listreceivedbyaddress(minconf = 1, includeempty = false)
  bitcoin.listreceivedbyaddress minconf, includeempty
end
Also aliased as: list_received_by_address
listtransactions(account = '', count = 10, from = 0) click to toggle source

Returns up to count most recent transactions for account account.

# File lib/startcoin_client/dsl.rb, line 234
def listtransactions(account = '', count = 10, from = 0)
  bitcoin.listtransactions account, count, from
end
Also aliased as: transactions, list_transactions
mininginfo()
Alias for: getmininginfo
move(fromaccount, toaccount, amount, minconf = 1, comment = nil) click to toggle source

Move from one account in your wallet to another.

# File lib/startcoin_client/dsl.rb, line 239
def move(fromaccount, toaccount, amount, minconf = 1, comment = nil)
  bitcoin.move fromaccount, toaccount, amount, minconf, comment
end
new_address(account = nil)
Alias for: getnewaddress
password(value = nil) click to toggle source
# File lib/startcoin_client/dsl.rb, line 38
def password(value = nil)
  value ? bitcoin.pass = value : bitcoin.pass
end
password=(value) click to toggle source
# File lib/startcoin_client/dsl.rb, line 14
def password=(value)
  bitcoin.pass = value
end
peerinfo()
Alias for: getpeerinfo
port(value = nil) click to toggle source
# File lib/startcoin_client/dsl.rb, line 46
def port(value = nil)
  value ? bitcoin.port = value : bitcoin.port
end
port=(value) click to toggle source
# File lib/startcoin_client/dsl.rb, line 22
def port=(value)
  bitcoin.port = value
end
proxy(value = nil) click to toggle source
# File lib/startcoin_client/dsl.rb, line 54
def proxy(value = nil)
  value.nil? ? bitcoin.proxy : bitcoin.proxy = value
end
proxy=(value) click to toggle source
# File lib/startcoin_client/dsl.rb, line 30
def proxy=(value)
  bitcoin.proxy = value
end
raw_mempool()
Alias for: getrawmempool
rawtransaction(txid, verbose = 0)
Alias for: getrawtransaction
received_by_account(account, minconf = 1)
received_by_address(bitcoinaddress, minconf = 1)
search_raw_transactions(bitcoinaddress, verbose=1)
searchrawtransactions(bitcoinaddress, verbose=1) click to toggle source

Return count transactions with <address> present in their scriptSig, skipping skip at the beginning. The ordering is oldest transaction first; if skip is negative the order returned is newest transaction first and skip+1 transactions are skipped. If verbose=0 only txids are returned rather than the full transactions.

# File lib/startcoin_client/dsl.rb, line 244
def searchrawtransactions(bitcoinaddress, verbose=1)
  bitcoin.searchrawtransactions bitcoinaddress, verbose
end
Also aliased as: search_raw_transactions
send_from(fromaccount, tobitcoinaddress, amount, minconf = 1, comment = nil, comment_to = nil)
Alias for: sendfrom
send_to_address(bitcoinaddress, amount, comment = nil, comment_to = nil)
Alias for: sendtoaddress
sendfrom(fromaccount, tobitcoinaddress, amount, minconf = 1, comment = nil, comment_to = nil) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 249
def sendfrom(fromaccount, tobitcoinaddress, amount, minconf = 1, comment = nil, comment_to = nil)
  bitcoin.sendfrom fromaccount, tobitcoinaddress, amount, minconf, comment, comment_to
end
Also aliased as: send_from
sendtoaddress(bitcoinaddress, amount, comment = nil, comment_to = nil) click to toggle source

amount is a real and is rounded to 8 decimal places

# File lib/startcoin_client/dsl.rb, line 254
def sendtoaddress(bitcoinaddress, amount, comment = nil, comment_to = nil)
  bitcoin.sendtoaddress bitcoinaddress, amount, comment, comment_to
end
Also aliased as: send_to_address
set_account(bitcoinaddress, account)
Alias for: setaccount
set_generate(generate, genproclimit = -1)
Alias for: setgenerate
setaccount(bitcoinaddress, account) click to toggle source

Sets the account associated with the given address.

# File lib/startcoin_client/dsl.rb, line 259
def setaccount(bitcoinaddress, account)
  bitcoin.setaccount bitcoinaddress, account
end
Also aliased as: account=, set_account
setgenerate(generate, genproclimit = -1) click to toggle source

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

# File lib/startcoin_client/dsl.rb, line 265
def setgenerate(generate, genproclimit = -1)
  bitcoin.setgenerate generate, genproclimit
end
Also aliased as: generate=, set_generate
ssl(value = nil) click to toggle source
# File lib/startcoin_client/dsl.rb, line 50
def ssl(value = nil)
  value.nil? ? bitcoin.ssl : bitcoin.ssl = value
end
ssl=(value) click to toggle source
# File lib/startcoin_client/dsl.rb, line 26
def ssl=(value)
  bitcoin.ssl = value
end
ssl?() click to toggle source
# File lib/startcoin_client/dsl.rb, line 58
def ssl?
  bitcoin.ssl?
end
stop() click to toggle source

Stop bitcoin server.

# File lib/startcoin_client/dsl.rb, line 270
def stop
  bitcoin.stop
end
transaction(txid)
Alias for: gettransaction
transactions(account = '', count = 10, from = 0)
Alias for: listtransactions
username(value = nil) click to toggle source
# File lib/startcoin_client/dsl.rb, line 34
def username(value = nil)
  value ? bitcoin.user = value : bitcoin.user
end
username=(value) click to toggle source
# File lib/startcoin_client/dsl.rb, line 10
def username=(value)
  bitcoin.user = value
end
validate_address(bitcoinaddress)
Alias for: validateaddress
validateaddress(bitcoinaddress) click to toggle source

Return information about bitcoinaddress.

# File lib/startcoin_client/dsl.rb, line 275
def validateaddress(bitcoinaddress)
  bitcoin.validateaddress
end
Also aliased as: validate_address
work(data = nil)
Alias for: getwork