Network.Bitcoin.Types

Contains the common types used through bitcoin RPC calls, that aren't specific to a single submodule.

Documentation

type Client = ByteString -> IO ByteString

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

data BitcoinException

A BitcoinException is thrown when 'callApi encounters an error. The API error code is represented as an Int, the message as a String.

It may also be thrown when the value returned by the bitcoin API wasn't what we expected.

WARNING: Any of the functions in this module's public API may throw this exception. You should plan on handling it.

Constructors

BitcoinApiError Int Text

A BitcoinApiError has an error code error message, as returned by bitcoind's JSON-RPC response.

BitcoinResultTypeError ByteString

The raw JSON returned, if we can't figure out what actually went wrong.

Instances

Eq BitcoinException

Ord BitcoinException

Read BitcoinException

Show BitcoinException

Exception BitcoinException

Typeable * BitcoinException

type HexString = Text

A string returned by the bitcoind API, representing data as hex.

What that data represents depends on the API call, but should be dcumented accordingly.

type TransactionID = HexString

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

This integer is a unique transaction identifier.

data Satoshi

A satoshi is the smallest subdivision of bitcoins. For the resolution, use resolution from Fixed.

Constructors

Satoshi

Instances

HasResolution Satoshi

type BTC = Fixed Satoshi

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

type Account = Text

An account on the wallet is just a label to easily specify private keys.

The default account is an empty string.

type Address = HexString

An address for sending or receiving money.