Safe Haskell	None
Language	Haskell98

Network.Bitcoin.BlockChain

Description

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.

Synopsis

type Client = ByteString -> IO ByteString
type TransactionID = HexString
type BTC = Fixed Satoshi
getBlockCount :: Client -> IO BlockHeight
getDifficulty :: Client -> IO Integer
setTransactionFee :: Client -> BTC -> IO ()
getRawMemoryPool :: Client -> IO (Vector TransactionID)
type BlockHash = HexString
type BlockHeight = Integer
getBlockHash :: Client -> BlockHeight -> IO BlockHash
data Block = Block {
- blockHash :: BlockHash
- blkConfirmations :: Integer
- blkSize :: Integer
- blkHeight :: BlockHeight
- blkVersion :: Integer
- merkleRoot :: BlockHash
- subTransactions :: Vector TransactionID
- blkTime :: Integer
- blkNonce :: Integer
- blkBits :: HexString
- blkDifficulty :: Double
- nextBlock :: Maybe BlockHash
- prevBlock :: Maybe BlockHash
}
getBlock :: Client -> BlockHash -> IO Block
data OutputSetInfo = OutputSetInfo {
- osiBestBlock :: BlockHash
- osiHeight :: BlockHeight
- numTransactions :: Integer
- transactionOutputs :: Integer
- serializedSize :: Integer
}
getOutputSetInfo :: Client -> IO OutputSetInfo
data OutputInfo = OutputInfo {
- oiBestBlock :: BlockHash
- oiConfirmations :: Integer
- oiAmount :: BTC
- oiScriptPubKey :: ScriptPubKey
- oiVersion :: Maybe Integer
- oiCoinBase :: Bool
}
getOutputInfo :: Client -> TransactionID -> Integer -> IO (Maybe OutputInfo)

Documentation

type Client = ByteString -> IO ByteString Source #

Client describes authentication credentials and host info for making API requests to the Bitcoin daemon.

type TransactionID = HexString Source #

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

This integer is a unique transaction identifier.

type BTC = Fixed Satoshi Source #

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

getBlockCount :: Client -> IO BlockHeight Source #

Returns the number of blocks in the longest block chain.

getDifficulty :: Client -> IO Integer Source #

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

setTransactionFee :: Client -> BTC -> IO () Source #

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

getRawMemoryPool :: Client -> IO (Vector TransactionID) Source #

Returns all transaction identifiers in the memory pool.

type BlockHash = HexString Source #

The hash of a given block.

type BlockHeight = Integer Source #

getBlockHash Source #

Arguments

:: Client
-> BlockHeight	Block index.
-> IO BlockHash

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

data Block Source #

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 :: BlockHeight
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 :: Double
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 Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods (==) :: Block -> Block -> Bool # (/=) :: Block -> Block -> Bool #
Ord Block Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods compare :: Block -> Block -> Ordering # (<) :: Block -> Block -> Bool # (<=) :: Block -> Block -> Bool # (>) :: Block -> Block -> Bool # (>=) :: Block -> Block -> Bool # max :: Block -> Block -> Block # min :: Block -> Block -> Block #
Read Block Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods readsPrec :: Int -> ReadS Block # readList :: ReadS [Block] # readPrec :: ReadPrec Block # readListPrec :: ReadPrec [Block] #
Show Block Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods showsPrec :: Int -> Block -> ShowS # show :: Block -> String # showList :: [Block] -> ShowS #
FromJSON Block Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods parseJSON :: Value -> Parser Block # parseJSONList :: Value -> Parser [Block] #

getBlock :: Client -> BlockHash -> IO Block Source #

Returns details of a block with given block-hash.

data OutputSetInfo Source #

Information on the unspent transaction in the output set.

Constructors

OutputSetInfo
Fields osiBestBlock :: BlockHash osiHeight :: BlockHeight The height of the best block chain 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 Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods (==) :: OutputSetInfo -> OutputSetInfo -> Bool # (/=) :: OutputSetInfo -> OutputSetInfo -> Bool #
Ord OutputSetInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods compare :: OutputSetInfo -> OutputSetInfo -> Ordering # (<) :: OutputSetInfo -> OutputSetInfo -> Bool # (<=) :: OutputSetInfo -> OutputSetInfo -> Bool # (>) :: OutputSetInfo -> OutputSetInfo -> Bool # (>=) :: OutputSetInfo -> OutputSetInfo -> Bool # max :: OutputSetInfo -> OutputSetInfo -> OutputSetInfo # min :: OutputSetInfo -> OutputSetInfo -> OutputSetInfo #
Read OutputSetInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods readsPrec :: Int -> ReadS OutputSetInfo # readList :: ReadS [OutputSetInfo] # readPrec :: ReadPrec OutputSetInfo # readListPrec :: ReadPrec [OutputSetInfo] #
Show OutputSetInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods showsPrec :: Int -> OutputSetInfo -> ShowS # show :: OutputSetInfo -> String # showList :: [OutputSetInfo] -> ShowS #
FromJSON OutputSetInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods parseJSON :: Value -> Parser OutputSetInfo # parseJSONList :: Value -> Parser [OutputSetInfo] #

getOutputSetInfo :: Client -> IO OutputSetInfo Source #

Returns statistics about the unspent transaction output set.

data OutputInfo Source #

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 :: ScriptPubKey The public key of the sender. oiVersion :: Maybe Integer The version of this transaction. oiCoinBase :: Bool Is this transaction part of the coin base?

Instances

Eq OutputInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods (==) :: OutputInfo -> OutputInfo -> Bool # (/=) :: OutputInfo -> OutputInfo -> Bool #
Ord OutputInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods compare :: OutputInfo -> OutputInfo -> Ordering # (<) :: OutputInfo -> OutputInfo -> Bool # (<=) :: OutputInfo -> OutputInfo -> Bool # (>) :: OutputInfo -> OutputInfo -> Bool # (>=) :: OutputInfo -> OutputInfo -> Bool # max :: OutputInfo -> OutputInfo -> OutputInfo # min :: OutputInfo -> OutputInfo -> OutputInfo #
Read OutputInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods readsPrec :: Int -> ReadS OutputInfo # readList :: ReadS [OutputInfo] # readPrec :: ReadPrec OutputInfo # readListPrec :: ReadPrec [OutputInfo] #
Show OutputInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods showsPrec :: Int -> OutputInfo -> ShowS # show :: OutputInfo -> String # showList :: [OutputInfo] -> ShowS #
FromJSON OutputInfo Source #
Instance details Defined in Network.Bitcoin.BlockChain Methods parseJSON :: Value -> Parser OutputInfo # parseJSONList :: Value -> Parser [OutputInfo] #

getOutputInfo Source #

Arguments

:: Client
-> TransactionID
-> Integer	The index we're looking at.
-> IO (Maybe OutputInfo)

Returns details about an unspent transaction output.