Safe Haskell	None
Language	Haskell98

Network.Bitcoin.Net

Description

An interface to bitcoind's available network-related RPC calls. The implementation of these functions can be found at https://github.com/bitcoin/bitcoin/blob/master/src/rpcnet.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
getClient :: String -> ByteString -> ByteString -> IO Client
getConnectionCount :: Client -> IO Integer
data PeerInfo = PeerInfo {
- addressName :: Text
- services :: Text
- lastSend :: Integer
- lastRecv :: Integer
- bytesSent :: Integer
- bytesRecv :: Integer
- connectionTime :: Integer
- peerVersion :: Integer
- peerSubversion :: Text
- inbound :: Bool
- startingHeight :: Integer
- banScore :: Integer
}
getPeerInfo :: Client -> IO [PeerInfo]

Documentation

type Client = ByteString -> IO ByteString Source #

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

getClient :: String -> ByteString -> ByteString -> IO Client Source #

getClient takes a url, rpc username, and rpc password and returns a Client that can be used to make API calls. Each Client encloses a Manager (from http-client) that re-uses connections for requests, so long as the same Client is is used for each call.

getConnectionCount :: Client -> IO Integer Source #

Returns the number of connections to other nodes.

data PeerInfo Source #

Information about a peer node of the Bitcoin network.

The documentation for this data structure is incomplete, as I honestly don't know what some of these fields are for. Patches are welcome!

Constructors

PeerInfo

Fields

addressName :: Text
The IP:port of this peer, as a string.
services :: Text
lastSend :: Integer
Relative to the first time we conected with this peer (and in milliseconds), the last time we sent this peer any data.
lastRecv :: Integer
Relative to the first time we connected with this peer (and in milliseconds), the last time we sent this peer any data.
bytesSent :: Integer
bytesRecv :: Integer
connectionTime :: Integer
How long have we been connected to this peer (in milliseconds).
peerVersion :: Integer
The version of the Bitcion client the peer is running.
peerSubversion :: Text
The sub-version of the Bitcoin client the peer is running.
inbound :: Bool
startingHeight :: Integer
banScore :: Integer
How many times has this peer behaved badly?

Instances

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

getPeerInfo :: Client -> IO [PeerInfo] Source #

Returns data about all connected peer nodes.