Network.Bitcoin.Mining

An interface to bitcoind's available mining RPC calls. The implementation of these functions can be found at https://github.com/bitcoin/bitcoin/blob/master/src/rpcmining.cpp.

If any APIs are missing, patches are always welcome. If you look at the source of this module, you'll see that the interface code is trivial.

Note that it is highly discouraged to use bitcoind for actual bitcoin mining. It uses the CPU for mining, which is much, much less power efficient than GPU mining. If you're paying for power, you will not come out ahead.

Instead, consider using a GPU miner listed at https://en.bitcoin.it/wiki/Software#Mining_apps.

Documentation

data Auth

Auth describes authentication credentials for making API requests to the Bitcoin daemon.

Constructors

Auth

Fields

rpcUrl :: Text

URL, with port, where bitcoind listens

rpcUser :: Text

same as bitcoind's rpcuser config

rpcPassword :: Text

same as bitcoind's rpcpassword config

Instances

Eq Auth

Ord Auth

Read Auth

Show Auth

getGenerate

Arguments

:: Auth

bitcoind RPC authorization

-> IO Bool

Returns whether or not bitcoind is generating bitcoins.

setGenerate

Arguments

:: Auth

bitcoind RPC authorization

-> Bool

Turn it on, or turn it off?

-> Maybe Int

Generation is limited to this number of processors. Set it to Nothing to keep the value at what it was before, Just -1 to use all available cores, and any other value to limit it.

-> IO ()

Controls whether or not bitcoind is generating bitcoins.

getHashesPerSec :: Auth -> IO Integer

Returns a recent hashes per second performance measurement while generating.

data MiningInfo

Information related to the current bitcoind mining operation.

If a field is undocumented here, it's because I don't know what it means. If you DO know what it means, I'd love it if you would submit a patch to help complete this documentation.

Constructors

MiningInfo

Fields

nBlocks :: Integer

The number of blocks in our block-chain.

currentBlockSize :: Integer

The size of the current block we're mining.

currentBlockTransaction :: Integer

difficulty :: Double

How difficult mining currently is.

miningErrors :: Text

Any mining errors that may have come up.

isGenerating :: Bool

Are we currently generating bitcoins?

generationProcessorLimit :: Integer

How many processors have we limited bitcoin mining to?

hashesPerSecond :: Integer

How fast is the mining going?

pooledTransactions :: Integer

miningOnTestNetwork :: Bool

Are we on the bitcoin test network (as opposed to the real thing)?

Instances

Eq MiningInfo

Ord MiningInfo

Read MiningInfo

Show MiningInfo

FromJSON MiningInfo

getMiningInfo :: Auth -> IO MiningInfo

Returns an object containing mining-related information.

data HashData

The hash data returned from getWork.

Constructors

HashData

Fields

blockData :: HexString

hdTarget :: HexString

Little-endian hash target, formatted as a hexadecimal string.

hash1 :: HexString

midstate :: HexString

Instances

Eq HashData

Ord HashData

Read HashData

Show HashData

ToJSON HashData

FromJSON HashData

getWork :: Auth -> IO HashData

Returns formatted hash data to work on.

solveBlock :: Auth -> HexString -> IO Bool

Tries to solve the given block, and returns true if it was successful.

data Transaction

A transaction to be included in the next block.

Constructors

Transaction

Fields

txnData :: HexString

txnHash :: HexString

depends :: Vector Integer

txnFee :: Maybe Integer

sigOps :: Integer

Instances

Eq Transaction

Ord Transaction

Read Transaction

Show Transaction

FromJSON Transaction

data CoinBaseAux

Constructors

CoinBaseAux

Fields

cbFlags :: HexString

Instances

Eq CoinBaseAux

Ord CoinBaseAux

Read CoinBaseAux

Show CoinBaseAux

FromJSON CoinBaseAux

data BlockTemplate

A template for constructing a block to work on.

See https://en.bitcoin.it/wiki/BIP_0022 for the full specification.

Constructors

BlockTemplate

Fields

blockVersion :: Integer

previousBlockHash :: HexString

Hash of current highest block.

transactionsToInclude :: Vector Transaction

Contents of non-coinbase transactions that should be included in the next block.

coinBaseAux :: CoinBaseAux

Data that should be included in coinbase.

coinBaseValue :: Integer

Maximum allowable input to coinbase transaction, including the generation award and transaction fees.

btTarget :: HexString

Hash target.

minTime :: Integer

Minimum timestamp appropriate for next block.

nonceRange :: HexString

Range of valid nonces.

sigopLimit :: Integer

Limit of sigops in blocks.

sizeLimit :: Integer

Limit of block size.

curTime :: Integer

Current timestamp.

btBits :: HexString

Compressed target of the next block.

btHeight :: Integer

Height of the next block.

Instances

Eq BlockTemplate

Ord BlockTemplate

Read BlockTemplate

Show BlockTemplate

FromJSON BlockTemplate

getBlockTemplate :: Auth -> IO BlockTemplate

Returns data needed to construct a block to work on.

submitBlock

Arguments

:: Auth

-> HexString

The block to submit.

-> IO Bool

Was the block accepted by the network?

Attempts to submit a new block to the network.