Haskoin.Store

Documentation

data Store

Store mailboxes.

Constructors

Store

Fields

• storeManager :: !Manager

  peer manager mailbox

• storeChain :: !Chain

  chain header process mailbox

• storeBlock :: !BlockStore

  block storage mailbox

• storePublisher :: !(Publisher StoreEvent)

  store event publisher mailbox

type BlockStore = Inbox BlockMessage

Mailbox for block store.

data Output

Output data.

Constructors

Output

Fields

• outputValue :: !Word64

  value of output in satoshi

• outBlock :: !(Maybe BlockRef)

  block infromation for output

• outScript :: !ByteString

  pubkey (output) script

• outSpender :: !(Maybe Spender)

  input spending this output

Instances

Eq Output

Defined in Network.Haskoin.Store.Types

Methods

(==) :: Output -> Output -> Bool

(/=) :: Output -> Output -> Bool

Ord Output

Defined in Network.Haskoin.Store.Types

Methods

compare :: Output -> Output -> Ordering

(<) :: Output -> Output -> Bool

(<=) :: Output -> Output -> Bool

(>) :: Output -> Output -> Bool

(>=) :: Output -> Output -> Bool

max :: Output -> Output -> Output

min :: Output -> Output -> Output

Show Output

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

Serialize Output

Defined in Network.Haskoin.Store.Types

Methods

put :: Putter Output

get :: Get Output

data Spender

Information about input spending output.

Constructors

Spender

Fields

• spenderHash :: !TxHash

  input transaction hash

• spenderIndex :: !Word32

  input position in transaction

• spenderBlock :: !(Maybe BlockRef)

  block information

Instances

Eq Spender

Defined in Network.Haskoin.Store.Types

Methods

(==) :: Spender -> Spender -> Bool

(/=) :: Spender -> Spender -> Bool

Ord Spender

Defined in Network.Haskoin.Store.Types

Methods

compare :: Spender -> Spender -> Ordering

(<) :: Spender -> Spender -> Bool

(<=) :: Spender -> Spender -> Bool

(>) :: Spender -> Spender -> Bool

(>=) :: Spender -> Spender -> Bool

max :: Spender -> Spender -> Spender

min :: Spender -> Spender -> Spender

Show Spender

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> Spender -> ShowS

show :: Spender -> String

showList :: [Spender] -> ShowS

ToJSON Spender

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: Spender -> Value

toEncoding :: Spender -> Encoding

toJSONList :: [Spender] -> Value

toEncodingList :: [Spender] -> Encoding

Serialize Spender

Defined in Network.Haskoin.Store.Types

Methods

put :: Putter Spender

get :: Get Spender

data BlockRef

Reference to a block where a transaction is stored.

Constructors

BlockRef

Fields

• blockRefHash :: !BlockHash

  block header hash

• blockRefHeight :: !BlockHeight

  block height in the chain

• blockRefPos :: !Word32

  position of transaction within the block

Instances

Eq BlockRef

Defined in Network.Haskoin.Store.Types

Methods

(==) :: BlockRef -> BlockRef -> Bool

(/=) :: BlockRef -> BlockRef -> Bool

Ord BlockRef

Defined in Network.Haskoin.Store.Types

Methods

compare :: BlockRef -> BlockRef -> Ordering

(<) :: BlockRef -> BlockRef -> Bool

(<=) :: BlockRef -> BlockRef -> Bool

(>) :: BlockRef -> BlockRef -> Bool

(>=) :: BlockRef -> BlockRef -> Bool

max :: BlockRef -> BlockRef -> BlockRef

min :: BlockRef -> BlockRef -> BlockRef

Show BlockRef

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> BlockRef -> ShowS

show :: BlockRef -> String

showList :: [BlockRef] -> ShowS

ToJSON BlockRef

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: BlockRef -> Value

toEncoding :: BlockRef -> Encoding

toJSONList :: [BlockRef] -> Value

toEncodingList :: [BlockRef] -> Encoding

Serialize BlockRef

Defined in Network.Haskoin.Store.Types

Methods

put :: Putter BlockRef

get :: Get BlockRef

data StoreConfig

Configuration for a Store.

Constructors

StoreConfig

Fields

• storeConfMaxPeers :: !Int

  max peers to connect to

• storeConfInitPeers :: ![HostPort]

  static set of peers to connect to

• storeConfDiscover :: !Bool

  discover new peers?

• storeConfDB :: !DB

  RocksDB database handler

• storeConfNetwork :: !Network

  network constants

data StoreEvent

Event that the store can generate.

Constructors

BestBlock !BlockHash

new best block

MempoolNew !TxHash

new mempool transaction

TxException !TxHash !TxException

published tx could not be imported

PeerConnected !Peer

new peer connected

PeerDisconnected !Peer

peer has disconnected

PeerPong !Peer !Word64

peer responded Ping

data BlockValue

Database value for a block entry.

Constructors

BlockValue

Fields

• blockValueHeight :: !BlockHeight

  height of the block in the chain

• blockValueWork :: !BlockWork

  accumulated work in that block

• blockValueHeader :: !BlockHeader

  block header

• blockValueSize :: !Word32

  size of the block including witnesses

• blockValueTxs :: ![TxHash]

  block transactions

Instances

Eq BlockValue

Defined in Network.Haskoin.Store.Types

Methods

(==) :: BlockValue -> BlockValue -> Bool

(/=) :: BlockValue -> BlockValue -> Bool

Ord BlockValue

Defined in Network.Haskoin.Store.Types

Methods

compare :: BlockValue -> BlockValue -> Ordering

(<) :: BlockValue -> BlockValue -> Bool

(<=) :: BlockValue -> BlockValue -> Bool

(>) :: BlockValue -> BlockValue -> Bool

(>=) :: BlockValue -> BlockValue -> Bool

max :: BlockValue -> BlockValue -> BlockValue

min :: BlockValue -> BlockValue -> BlockValue

Show BlockValue

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> BlockValue -> ShowS

show :: BlockValue -> String

showList :: [BlockValue] -> ShowS

ToJSON BlockValue

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: BlockValue -> Value

toEncoding :: BlockValue -> Encoding

toJSONList :: [BlockValue] -> Value

toEncodingList :: [BlockValue] -> Encoding

Serialize BlockValue

Defined in Network.Haskoin.Store.Types

Methods

put :: Putter BlockValue

get :: Get BlockValue

data DetailedTx

Detailed transaction information.

Constructors

DetailedTx

Fields

• detailedTxData :: !Tx

  Tx object

• detailedTxFee :: !Word64

  transaction fees paid to miners in satoshi

• detailedTxInputs :: ![DetailedInput]

  transaction inputs

• detailedTxOutputs :: ![DetailedOutput]

  transaction outputs

• detailedTxBlock :: !(Maybe BlockRef)

  block information for this transaction

Instances

Eq DetailedTx

Defined in Network.Haskoin.Store.Types

Methods

(==) :: DetailedTx -> DetailedTx -> Bool

(/=) :: DetailedTx -> DetailedTx -> Bool

Show DetailedTx

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> DetailedTx -> ShowS

show :: DetailedTx -> String

showList :: [DetailedTx] -> ShowS

ToJSON DetailedTx

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: DetailedTx -> Value

toEncoding :: DetailedTx -> Encoding

toJSONList :: [DetailedTx] -> Value

toEncodingList :: [DetailedTx] -> Encoding

data DetailedInput

Input information.

Constructors

DetailedCoinbase

coinbase input details

Fields

• detInOutPoint :: !OutPoint

  output being spent (should be zeroes)

• detInSequence :: !Word32

  sequence

• detInSigScript :: !ByteString

  input script data (not valid script)

• detInNetwork :: !Network

  network constants

DetailedInput

regular input details

Fields

• detInOutPoint :: !OutPoint

  output being spent (should be zeroes)

• detInSequence :: !Word32

  sequence

• detInSigScript :: !ByteString

  input script data (not valid script)

• detInPkScript :: !ByteString

  pubkey (output) script from previous tx

• detInValue :: !Word64

  amount in satoshi being spent spent

• detInBlock :: !(Maybe BlockRef)

  block where this input is found

• detInNetwork :: !Network

  network constants

Instances

Eq DetailedInput

Defined in Network.Haskoin.Store.Types

Methods

(==) :: DetailedInput -> DetailedInput -> Bool

(/=) :: DetailedInput -> DetailedInput -> Bool

Show DetailedInput

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> DetailedInput -> ShowS

show :: DetailedInput -> String

showList :: [DetailedInput] -> ShowS

ToJSON DetailedInput

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: DetailedInput -> Value

toEncoding :: DetailedInput -> Encoding

toJSONList :: [DetailedInput] -> Value

toEncodingList :: [DetailedInput] -> Encoding

data DetailedOutput

Output information.

Constructors

DetailedOutput

Fields

• detOutValue :: !Word64

  amount in satoshi

• detOutScript :: !ByteString

  pubkey (output) script

• detOutSpender :: !(Maybe Spender)

  input spending this transaction

• detOutNetwork :: !Network

  network constants

Instances

Eq DetailedOutput

Defined in Network.Haskoin.Store.Types

Methods

(==) :: DetailedOutput -> DetailedOutput -> Bool

(/=) :: DetailedOutput -> DetailedOutput -> Bool

Show DetailedOutput

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> DetailedOutput -> ShowS

show :: DetailedOutput -> String

showList :: [DetailedOutput] -> ShowS

ToJSON DetailedOutput

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: DetailedOutput -> Value

toEncoding :: DetailedOutput -> Encoding

toJSONList :: [DetailedOutput] -> Value

toEncodingList :: [DetailedOutput] -> Encoding

newtype NewTx

Wrapper for an transaction that can be deserialized from a JSON object.

Constructors

NewTx

Fields

• newTx :: Tx

Instances

Eq NewTx

Defined in Network.Haskoin.Store.Types

Methods

(==) :: NewTx -> NewTx -> Bool

(/=) :: NewTx -> NewTx -> Bool

Ord NewTx

Defined in Network.Haskoin.Store.Types

Methods

compare :: NewTx -> NewTx -> Ordering

(<) :: NewTx -> NewTx -> Bool

(<=) :: NewTx -> NewTx -> Bool

(>) :: NewTx -> NewTx -> Bool

(>=) :: NewTx -> NewTx -> Bool

max :: NewTx -> NewTx -> NewTx

min :: NewTx -> NewTx -> NewTx

Show NewTx

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> NewTx -> ShowS

show :: NewTx -> String

showList :: [NewTx] -> ShowS

FromJSON NewTx

Defined in Network.Haskoin.Store.Types

Methods

parseJSON :: Value -> Parser NewTx

parseJSONList :: Value -> Parser [NewTx]

data AddrOutput

Address output.

Constructors

AddrOutput

Fields

• addrOutputKey :: !AddrOutKey
• addrOutput :: !Output

Instances

Eq AddrOutput

Defined in Network.Haskoin.Store.Types

Methods

(==) :: AddrOutput -> AddrOutput -> Bool

(/=) :: AddrOutput -> AddrOutput -> Bool

Ord AddrOutput

Defined in Network.Haskoin.Store.Types

Methods

compare :: AddrOutput -> AddrOutput -> Ordering

(<) :: AddrOutput -> AddrOutput -> Bool

(<=) :: AddrOutput -> AddrOutput -> Bool

(>) :: AddrOutput -> AddrOutput -> Bool

(>=) :: AddrOutput -> AddrOutput -> Bool

max :: AddrOutput -> AddrOutput -> AddrOutput

min :: AddrOutput -> AddrOutput -> AddrOutput

Show AddrOutput

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> AddrOutput -> ShowS

show :: AddrOutput -> String

showList :: [AddrOutput] -> ShowS

ToJSON AddrOutput

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: AddrOutput -> Value

toEncoding :: AddrOutput -> Encoding

toJSONList :: [AddrOutput] -> Value

toEncodingList :: [AddrOutput] -> Encoding

data AddressBalance

Address balance information.

Constructors

AddressBalance

Fields

• addressBalAddress :: !Address

  address balance

• addressBalConfirmed :: !Word64

  confirmed balance

• addressBalUnconfirmed :: !Int64

  unconfirmed balance (can be negative)

• addressUtxoCount :: !Word64

  number of unspent outputs

Instances

Eq AddressBalance

Defined in Network.Haskoin.Store.Types

Methods

(==) :: AddressBalance -> AddressBalance -> Bool

(/=) :: AddressBalance -> AddressBalance -> Bool

Show AddressBalance

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> AddressBalance -> ShowS

show :: AddressBalance -> String

showList :: [AddressBalance] -> ShowS

ToJSON AddressBalance

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: AddressBalance -> Value

toEncoding :: AddressBalance -> Encoding

toJSONList :: [AddressBalance] -> Value

toEncodingList :: [AddressBalance] -> Encoding

data TxException

Reasons why a transaction may not get imported.

Constructors

DoubleSpend

outputs already spent by another transaction

OverSpend

outputs larger than inputs

OrphanTx

inputs unknown

NonStandard

non-standard transaction rejected by peer

LowFee

pony up

Dust

an output is too small

NoPeers

no peers to send the transaction to

InvalidTx

transaction is invalid in some other way

CouldNotImport

could not import for an unknown reason

PeerIsGone

the peer that got the transaction disconnected

AlreadyImported

the transaction is already in the database

PublishTimeout

some timeout was reached while publishing

PeerRejectOther

peer rejected transaction for unknown reason

NotAtHeight

this node is not yet synchronized

Instances

Eq TxException

Defined in Network.Haskoin.Store.Types

Methods

(==) :: TxException -> TxException -> Bool

(/=) :: TxException -> TxException -> Bool

Show TxException

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> TxException -> ShowS

show :: TxException -> String

showList :: [TxException] -> ShowS

Exception TxException

Defined in Network.Haskoin.Store.Types

Methods

toException :: TxException -> SomeException

fromException :: SomeException -> Maybe TxException

displayException :: TxException -> String

data PeerInformation

Constructors

PeerInformation

Fields

• userAgent :: !ByteString
• address :: !ByteString
• connected :: !Bool
• version :: !Word32
• services :: !Word64
• relay :: !Bool
• block :: !BlockHash
• height :: !BlockHeight
• nonceLocal :: !Word64
• nonceRemote :: !Word64

Instances

Eq PeerInformation

Defined in Network.Haskoin.Store.Types

Methods

(==) :: PeerInformation -> PeerInformation -> Bool

(/=) :: PeerInformation -> PeerInformation -> Bool

Show PeerInformation

Defined in Network.Haskoin.Store.Types

Methods

showsPrec :: Int -> PeerInformation -> ShowS

show :: PeerInformation -> String

showList :: [PeerInformation] -> ShowS

ToJSON PeerInformation

Defined in Network.Haskoin.Store.Types

Methods

toJSON :: PeerInformation -> Value

toEncoding :: PeerInformation -> Encoding

toJSONList :: [PeerInformation] -> Value

toEncodingList :: [PeerInformation] -> Encoding

withStore :: (MonadLoggerIO m, MonadUnliftIO m) => StoreConfig -> (Store -> m a) -> m a

Run a Haskoin Store instance. It will launch a network node, a BlockStore, connect to the network and start synchronizing blocks and transactions.

getBestBlock :: MonadIO m => DB -> Snapshot -> m BlockValue

Get best block.

getBlockAtHeight :: MonadIO m => BlockHeight -> DB -> Snapshot -> m (Maybe BlockValue)

Get one block at specified height.

getBlock :: MonadIO m => BlockHash -> DB -> Snapshot -> m (Maybe BlockValue)

Get a block.

getBlocks :: MonadIO m => [BlockHash] -> DB -> Snapshot -> m [BlockValue]

Get blocks for specific hashes.

getTx :: MonadUnliftIO m => Network -> TxHash -> DB -> Snapshot -> m (Maybe DetailedTx)

Get single transaction.

getAddrTxs :: (MonadResource m, MonadUnliftIO m) => Network -> Address -> Maybe BlockHeight -> DB -> Snapshot -> ConduitT () DetailedTx m ()

getUnspent :: (MonadResource m, MonadUnliftIO m) => Address -> Maybe BlockHeight -> DB -> Snapshot -> ConduitT () AddrOutput m ()

Get unspent outputs for an address.

getBalance :: MonadIO m => Address -> DB -> Snapshot -> m AddressBalance

Get balance for an address.

getMempool :: MonadUnliftIO m => DB -> Snapshot -> m [TxHash]

Get list of transactions in mempool.

getPeersInformation :: MonadIO m => Manager -> m [PeerInformation]

publishTx :: (MonadUnliftIO m, MonadLoggerIO m) => Network -> Store -> DB -> Tx -> m (Either TxException DetailedTx)

Publish a new transaction to the network.