Network.Bitcoin.BlockChain

An interface to bitcoind's available block-chain-related RPC calls. The implementation of these functions can be found at https://github.com/bitcoin/bitcoin/blob/master/src/rpcblockchain.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.

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

type TransactionID = HexString

A hexadecimal string representation of a 256-bit unsigned integer.

This integer is a unique transaction identifier.

type BTC = Fixed Satoshi

The type of bitcoin money, represented with a fixed-point number.

data ScriptSig

I don't know what this is. A signature of some sort? If you know, please submit a patch documenting this properly!

Constructors

ScriptSig

Fields

sigAsm :: HexString

sigHex :: HexString

Instances

Eq ScriptSig

Ord ScriptSig

Read ScriptSig

Show ScriptSig

FromJSON ScriptSig

getBlockCount :: Auth -> IO Integer

Returns the number of blocks in the longest block chain.

getDifficulty :: Auth -> IO Integer

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

setTransactionFee :: Auth -> BTC -> IO ()

Sets the transaction fee will will pay to the network. Values of 0 are rejected.

getRawMemoryPool :: Auth -> IO (Vector TransactionID)

Returns all transaction identifiers in the memory pool.

type BlockHash = HexString

The hash of a given block.

getBlockHash

Arguments

:: Auth

-> Integer

Block index.

-> IO BlockHash

Returns the hash of the block in best-block-chain at the given index.

data Block

Information about a given block in the block chain.

Constructors

Block

Fields

blockHash :: BlockHash

blkConfirmations :: Integer

The number of confirmations the block has.

blkSize :: Integer

The size of the block.

blkHeight :: Integer

The height of the block. TODO: Clarify this.

blkVersion :: Integer

The version of the block.

merkleRoot :: BlockHash

The hash of the block at the root of the merkle tree which this block belongs to.

subTransactions :: Vector TransactionID

Should this be a transaction, or transaction id?

blkTime :: Integer

The time it was mined.

blkNonce :: Integer

The block's nonce.

blkBits :: HexString

blkDifficulty :: Integer

How hard was this block to mine?

nextBlock :: Maybe BlockHash

A pointer to the next block in the chain.

prevBlock :: Maybe BlockHash

A pointer to the previous block in the chain.

Instances

Eq Block

Ord Block

Read Block

Show Block

FromJSON Block

getBlock :: Auth -> BlockHash -> IO Block

Returns details of a block with given block-hash.

data OutputSetInfo

Information on the unspent transaction in the output set.

Constructors

OutputSetInfo

Fields

osiBestBlock :: BlockHash

numTransactions :: Integer

The number of transactions in the output set.

transactionOutputs :: Integer

The number of outputs for the transactions.

serializedSize :: Integer

The serialized size of the output set.

Instances

Eq OutputSetInfo

Ord OutputSetInfo

Read OutputSetInfo

Show OutputSetInfo

FromJSON OutputSetInfo

getOutputSetInfo :: Auth -> IO OutputSetInfo

Returns statistics about the unspent transaction output set.

data OutputInfo

Details about an unspent transaction output.

Constructors

OutputInfo

Fields

oiBestBlock :: BlockHash

oiConfirmations :: Integer

The number of times this transaction has been confirmed.

oiAmount :: BTC

The amount transferred.

oiScriptPubKey :: ScriptSig

The public key of the sender.

oiVersion :: Integer

The version of this transaction.

oiCoinBase :: Bool

Is this transaction part of the coin base?

Instances

Eq OutputInfo

Ord OutputInfo

Read OutputInfo

Show OutputInfo

FromJSON OutputInfo

getOutputInfo

Arguments

:: Auth

-> TransactionID

-> Integer

The index we're looking at.

-> IO OutputInfo

Returns details about an unspent transaction output.