Network.Haskoin.Wallet

This package provides a command line application called hw (haskoin wallet). It is a lightweight bitcoin wallet featuring BIP32 key management, deterministic signatures (RFC-6979) and first order support for multisignature transactions. A library API for hw is also exposed.

Client

clientMain :: IO ()

data OutputFormat

Constructors

OutputNormal

OutputJSON

OutputYAML

Instances

FromJSON OutputFormat

ToJSON OutputFormat

data Config

Constructors

Config

Fields

configCount :: !Word32

Output size of commands

configMinConf :: !Word32

Minimum number of confirmations

configSignTx :: !Bool

Sign transactions

configFee :: !Word64

Fee to pay per 1000 bytes when creating new transactions

configRcptFee :: !Bool

Recipient pays fee (dangerous, no config file setting)

configAddrType :: !AddressType

Return internal instead of external addresses

configOffline :: !Bool

Display the balance including offline transactions

configReversePaging :: !Bool

Use reverse paging for displaying addresses and transactions

configPath :: !(Maybe HardPath)

Derivation path when creating account

configFormat :: !OutputFormat

How to format the command-line results

configConnect :: !String

ZeroMQ socket to connect to (location of the server)

configConnectNotif :: !String

ZeroMQ socket to connect for notifications

configDetach :: !Bool

Detach server when launched from command-line

configFile :: !FilePath

Configuration file

configTestnet :: !Bool

Use Testnet3 network

configDir :: !FilePath

Working directory

configBind :: !String

Bind address for the ZeroMQ socket

configBindNotif :: !String

Bind address for ZeroMQ notifications

configBTCNodes :: !(HashMap Text [BTCNode])

Trusted Bitcoin full nodes to connect to

configMode :: !SPVMode

Operation mode of the SPV node.

configBloomFP :: !Double

False positive rate for the bloom filter.

configDatabase :: !(HashMap Text DatabaseConfType)

Database configuration

configLogFile :: !FilePath

Log file

configPidFile :: !FilePath

PID File

configLogLevel :: !LogLevel

Log level

configVerbose :: !Bool

Verbose

configServerKey :: !(Maybe (Restricted Div5 ByteString))

Server key for authentication and encryption (server config)

configServerKeyPub :: !(Maybe (Restricted Div5 ByteString))

Server public key for authentication and encryption (client config)

configClientKey :: !(Maybe (Restricted Div5 ByteString))

Client key for authentication and encryption (client config)

configClientKeyPub :: !(Maybe (Restricted Div5 ByteString))

Client public key for authentication and encryption (client + server config)

Instances

FromJSON Config

Default Config

Server

runSPVServer :: Config -> IO ()

stopSPVServer :: Config -> IO ()

data SPVMode

Constructors

SPVOnline

SPVOffline

Instances

Eq SPVMode

Read SPVMode

Show SPVMode

FromJSON SPVMode

ToJSON SPVMode

API JSON Types

data JsonAccount

Constructors

JsonAccount

Fields

jsonAccountName :: !Text

jsonAccountType :: !AccountType

jsonAccountMaster :: !(Maybe XPrvKey)

jsonAccountMnemonic :: !(Maybe Text)

jsonAccountDerivation :: !(Maybe HardPath)

jsonAccountKeys :: ![XPubKey]

jsonAccountGap :: !Word32

jsonAccountCreated :: !UTCTime

Instances

Eq JsonAccount

Read JsonAccount

Show JsonAccount

FromJSON JsonAccount

ToJSON JsonAccount

data JsonAddr

Constructors

JsonAddr

Fields

jsonAddrAddress :: !Address

jsonAddrIndex :: !KeyIndex

jsonAddrType :: !AddressType

jsonAddrLabel :: !Text

jsonAddrRedeem :: !(Maybe ScriptOutput)

jsonAddrKey :: !(Maybe PubKeyC)

jsonAddrCreated :: !UTCTime

jsonAddrBalance :: !(Maybe BalanceInfo)

Instances

Eq JsonAddr

Read JsonAddr

Show JsonAddr

FromJSON JsonAddr

ToJSON JsonAddr

data JsonCoin

Constructors

JsonCoin

Fields

jsonCoinHash :: !TxHash

jsonCoinPos :: !Word32

jsonCoinValue :: !Word64

jsonCoinScript :: !ScriptOutput

jsonCoinCreated :: !UTCTime

jsonCoinTx :: !(Maybe JsonTx)

jsonCoinAddress :: !(Maybe JsonAddr)

jsonCoinSpendingTx :: !(Maybe JsonTx)

Instances

Eq JsonCoin

Read JsonCoin

Show JsonCoin

FromJSON JsonCoin

ToJSON JsonCoin

data JsonTx

Constructors

JsonTx

Fields

jsonTxHash :: !TxHash

jsonTxNosigHash :: !TxHash

jsonTxType :: !TxType

jsonTxInValue :: !Word64

jsonTxOutValue :: !Word64

jsonTxValue :: !Int64

jsonTxInputs :: ![AddressInfo]

jsonTxOutputs :: ![AddressInfo]

jsonTxChange :: ![AddressInfo]

jsonTxTx :: !Tx

jsonTxIsCoinbase :: !Bool

jsonTxConfidence :: !TxConfidence

jsonTxConfirmedBy :: !(Maybe BlockHash)

jsonTxConfirmedHeight :: !(Maybe Word32)

jsonTxConfirmedDate :: !(Maybe Word32)

jsonTxCreated :: !UTCTime

jsonTxAccount :: !AccountName

jsonTxConfirmations :: !(Maybe Word32)

jsonTxBestBlock :: !(Maybe BlockHash)

jsonTxBestBlockHeight :: !(Maybe BlockHeight)

Instances

Eq JsonTx

Read JsonTx

Show JsonTx

FromJSON JsonTx

ToJSON JsonTx

API Request Types

data WalletRequest

Constructors

GetAccountsR !ListRequest

PostAccountsR !NewAccount

PostAccountRenameR !AccountName !AccountName

GetAccountR !AccountName

PostAccountKeysR !AccountName ![XPubKey]

PostAccountGapR !AccountName !SetAccountGap

GetAddressesR !AccountName !AddressType !Word32 !Bool !ListRequest

GetAddressesUnusedR !AccountName !AddressType !ListRequest

GetAddressR !AccountName !KeyIndex !AddressType !Word32 !Bool

PutAddressR !AccountName !KeyIndex !AddressType !AddressLabel

PostAddressesR !AccountName !KeyIndex !AddressType

GetTxsR !AccountName !ListRequest

GetAddrTxsR !AccountName !KeyIndex !AddressType !ListRequest

PostTxsR !AccountName !(Maybe XPrvKey) !TxAction

GetTxR !AccountName !TxHash

GetOfflineTxR !AccountName !TxHash

PostOfflineTxR !AccountName !(Maybe XPrvKey) !Tx ![CoinSignData]

GetBalanceR !AccountName !Word32 !Bool

PostNodeR !NodeAction

DeleteTxIdR !TxHash

GetSyncR !AccountName !BlockHash !ListRequest

GetSyncHeightR !AccountName !BlockHeight !ListRequest

GetPendingR !AccountName !ListRequest

GetDeadR !AccountName !ListRequest

Instances

FromJSON WalletRequest

ToJSON WalletRequest

data ListRequest

Constructors

ListRequest

Fields

listOffset :: !Word32

listLimit :: !Word32

listReverse :: !Bool

Instances

Eq ListRequest

Read ListRequest

Show ListRequest

FromJSON ListRequest

ToJSON ListRequest

data NewAccount

Constructors

NewAccount

Fields

newAccountName :: !AccountName

newAccountType :: !AccountType

newAccountMnemonic :: !(Maybe Text)

newAccountMaster :: !(Maybe XPrvKey)

newAccountDeriv :: !(Maybe HardPath)

newAccountKeys :: ![XPubKey]

newAccountReadOnly :: !Bool

Instances

Eq NewAccount

Read NewAccount

Show NewAccount

FromJSON NewAccount

ToJSON NewAccount

data SetAccountGap

Constructors

SetAccountGap

Fields

getAccountGap :: !Word32

Instances

Eq SetAccountGap

Read SetAccountGap

Show SetAccountGap

FromJSON SetAccountGap

ToJSON SetAccountGap

data OfflineTxData

Constructors

OfflineTxData

Fields

offlineTxDataTx :: !Tx

offlineTxDataCoinData :: ![CoinSignData]

Instances

FromJSON OfflineTxData

ToJSON OfflineTxData

data CoinSignData

Constructors

CoinSignData

Fields

coinSignOutPoint :: !OutPoint

coinSignScriptOutput :: !ScriptOutput

coinSignDeriv :: !SoftPath

Instances

Eq CoinSignData

Show CoinSignData

FromJSON CoinSignData

ToJSON CoinSignData

data TxAction

Constructors

CreateTx

Fields

accTxActionRecipients :: ![(Address, Word64)]

accTxActionFee :: !Word64

accTxActionMinConf :: !Word32

accTxActionRcptFee :: !Bool

accTxActionSign :: !Bool

ImportTx

Fields

accTxActionTx :: !Tx

SignTx

Fields

accTxActionHash :: !TxHash

Instances

Eq TxAction

Show TxAction

FromJSON TxAction

ToJSON TxAction

data AddressLabel

Constructors

AddressLabel

Fields

addressLabelLabel :: !Text

Instances

Eq AddressLabel

Read AddressLabel

Show AddressLabel

FromJSON AddressLabel

ToJSON AddressLabel

data NodeAction

Constructors

NodeActionRescan

Fields

nodeActionTimestamp :: !(Maybe Word32)

NodeActionStatus

Instances

Eq NodeAction

Read NodeAction

Show NodeAction

FromJSON NodeAction

ToJSON NodeAction

data AccountType

Constructors

AccountRegular

AccountMultisig

Fields

accountTypeRequiredSigs :: !Int

accountTypeTotalKeys :: !Int

Instances

Eq AccountType

Read AccountType

Show AccountType

NFData AccountType

PersistFieldSql AccountType

PersistField AccountType

FromJSON AccountType

ToJSON AccountType

data AddressType

Constructors

AddressInternal

AddressExternal

Instances

Eq AddressType

Read AddressType

Show AddressType

NFData AddressType

PersistFieldSql AddressType

PersistField AddressType

FromJSON AddressType

ToJSON AddressType

addrTypeIndex :: AddressType -> KeyIndex

data TxType

Constructors

TxIncoming

TxOutgoing

TxSelf

Instances

Eq TxType

Read TxType

Show TxType

NFData TxType

PersistFieldSql TxType

PersistField TxType

FromJSON TxType

ToJSON TxType

data TxConfidence

Constructors

TxOffline

TxDead

TxPending

TxBuilding

Instances

Eq TxConfidence

Read TxConfidence

Show TxConfidence

NFData TxConfidence

PersistFieldSql TxConfidence

PersistField TxConfidence

FromJSON TxConfidence

ToJSON TxConfidence

data AddressInfo

Constructors

AddressInfo

Fields

addressInfoAddress :: !Address

addressInfoValue :: !(Maybe Word64)

addressInfoIsLocal :: !Bool

Instances

Eq AddressInfo

Read AddressInfo

Show AddressInfo

Generic AddressInfo

Binary AddressInfo

NFData AddressInfo

FromJSON AddressInfo

ToJSON AddressInfo

PersistFieldSql [AddressInfo]

PersistField [AddressInfo]

type Rep AddressInfo

data BalanceInfo

Constructors

BalanceInfo

Fields

balanceInfoInBalance :: !Word64

balanceInfoOutBalance :: !Word64

balanceInfoCoins :: !Int

balanceInfoSpentCoins :: !Int

Instances

Eq BalanceInfo

Read BalanceInfo

Show BalanceInfo

NFData BalanceInfo

FromJSON BalanceInfo

ToJSON BalanceInfo

API Response Types

data WalletResponse a

Constructors

ResponseError

Fields

responseError :: !Text

ResponseValid

Fields

responseResult :: !(Maybe a)

Instances

Eq a => Eq (WalletResponse a)

Show a => Show (WalletResponse a)

FromJSON a0 => FromJSON (WalletResponse a)

ToJSON a0 => ToJSON (WalletResponse a)

data TxCompleteRes

Constructors

TxCompleteRes

Fields

txCompleteTx :: !Tx

txCompleteComplete :: !Bool

Instances

Eq TxCompleteRes

Read TxCompleteRes

Show TxCompleteRes

FromJSON TxCompleteRes

ToJSON TxCompleteRes

data ListResult a

Constructors

ListResult

Fields

listResultItems :: ![a]

listResultTotal :: !Word32

Instances

FromJSON a0 => FromJSON (ListResult a)

ToJSON a0 => ToJSON (ListResult a)

data RescanRes

Constructors

RescanRes

Fields

rescanTimestamp :: !Word32

Instances

Eq RescanRes

Read RescanRes

Show RescanRes

FromJSON RescanRes

ToJSON RescanRes

Database Accounts

initWallet :: MonadIO m => Double -> SqlPersistT m ()

accounts :: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m) => ListRequest -> SqlPersistT m ([Account], Word32)

Fetch all accounts

newAccount :: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m) => NewAccount -> SqlPersistT m (Entity Account, Maybe Mnemonic)

Create a new account

addAccountKeys

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> Entity Account

Account Entity

-> [XPubKey]

Thirdparty public keys to add

-> SqlPersistT m Account

Account information

Add new thirdparty keys to a multisignature account. This function can fail if the multisignature account already has all required keys.

getAccount :: (MonadIO m, MonadThrow m) => AccountName -> SqlPersistT m (Entity Account)

isMultisigAccount :: Account -> Bool

isReadAccount :: Account -> Bool

isCompleteAccount :: Account -> Bool

Database Addresses

getAddress

Arguments

:: (MonadIO m, MonadThrow m)

=> Entity Account

Account Entity

-> AddressType

Address type

-> KeyIndex

Derivation index (key)

-> SqlPersistT m (Entity WalletAddr)

Address

Get an address if it exists, or throw an exception otherwise. Fetching addresses in the hidden gap will also throw an exception.

addressesAll :: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m) => SqlPersistT m [WalletAddr]

All addresses in the wallet, including hidden gap addresses. This is useful for building a bloom filter.

addresses

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> Entity Account

Account Entity

-> AddressType

Address Type

-> SqlPersistT m [WalletAddr]

Addresses

All addresses in one account excluding hidden gap.

addressList

Arguments

:: MonadIO m

=> Entity Account

Account Entity

-> AddressType

Address type

-> ListRequest

List request

-> SqlPersistT m ([WalletAddr], Word32)

List result

Get address list.

unusedAddresses

Arguments

:: MonadIO m

=> Entity Account

Account ID

-> AddressType

Address type

-> ListRequest

-> SqlPersistT m ([WalletAddr], Word32)

Unused addresses

Get a list of all unused addresses.

addressCount

Arguments

:: MonadIO m

=> Entity Account

Account Entity

-> AddressType

Address type

-> SqlPersistT m Word32

Address Count

Get a count of all the addresses in an account

setAddrLabel

Arguments

:: (MonadIO m, MonadThrow m)

=> Entity Account

Account ID

-> KeyIndex

Derivation index

-> AddressType

Address type

-> Text

New label

-> SqlPersistT m WalletAddr

Add a label to an address.

addressPrvKey

Arguments

:: (MonadIO m, MonadThrow m)

=> Entity Account

Account Entity

-> Maybe XPrvKey

If not in account

-> KeyIndex

Derivation index of the address

-> AddressType

Address type

-> SqlPersistT m PrvKeyC

Private key

Returns the private key of an address.

useAddress :: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m) => WalletAddr -> SqlPersistT m [WalletAddr]

Use an address and make sure we have enough gap addresses after it. Returns the new addresses that have been created.

setAccountGap

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> Entity Account

Account Entity

-> Word32

New gap value

-> SqlPersistT m (Entity Account)

Set the address gap of an account to a new value. This will create new internal and external addresses as required. The gap can only be increased, not decreased in size.

firstAddrTime :: MonadIO m => SqlPersistT m (Maybe Timestamp)

getPathRedeem :: Account -> SoftPath -> RedeemScript

getPathPubKey :: Account -> SoftPath -> PubKeyC

Database Bloom Filter

getBloomFilter :: (MonadIO m, MonadThrow m) => SqlPersistT m (BloomFilter, Int, Double)

Returns a bloom filter containing all the addresses in this wallet. This includes internal and external addresses. The bloom filter can be set on a peer connection to filter the transactions received by that peer.

Database transactions

txs

Arguments

:: MonadIO m

=> Maybe TxConfidence

-> AccountId

Account ID

-> ListRequest

List request

-> SqlPersistT m ([WalletTx], Word32)

List result

Get transactions.

addrTxs

Arguments

:: MonadIO m

=> Entity Account

Account entity

-> Entity WalletAddr

Address entity

-> ListRequest

List request

-> SqlPersistT m ([WalletTx], Word32)

getTx :: MonadIO m => TxHash -> SqlPersistT m (Maybe Tx)

getAccountTx :: MonadIO m => AccountId -> TxHash -> SqlPersistT m WalletTx

importTx

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> Tx

Transaction to import

-> Maybe (TBMChan Notif)

-> AccountId

Account ID

-> SqlPersistT m ([WalletTx], [WalletAddr])

New transactions and addresses created

Import a transaction into the wallet from an unknown source. If the transaction is standard, valid, all inputs are known and all inputs can be spent, then the transaction will be imported as a network transaction. Otherwise, the transaction will be imported into the local account as an offline transaction.

importNetTx

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> Tx

-> Maybe (TBMChan Notif)

-> SqlPersistT m ([WalletTx], [WalletAddr])

Returns the new transactions and addresses created

Import a transaction from the network into the wallet. This function assumes transactions are imported in-order (parents first). It also assumes that the confirmations always arrive after the transaction imports. This function is idempotent.

When re-importing an existing transaction, this function will recompute the inputs, outputs and transaction details for each account. A non-dead transaction could be set to dead due to new inputs being double spent. However, we do not allow dead transactions to be revived by reimporting them. Transactions can only be revived if they make it into the main chain.

This function returns the network confidence of the imported transaction.

signAccountTx :: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m) => Entity Account -> Maybe (TBMChan Notif) -> Maybe XPrvKey -> TxHash -> SqlPersistT m ([WalletTx], [WalletAddr])

createTx

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> Entity Account

Account Entity

-> Maybe (TBMChan Notif)

Notification channel

-> Maybe XPrvKey

Key if not provided by account

-> [(Address, Word64)]

List of recipient addresses and amounts

-> Word64

Fee per 1000 bytes

-> Word32

Minimum confirmations

-> Bool

Should fee be paid by recipient

-> Bool

Should the transaction be signed

-> SqlPersistT m (WalletTx, [WalletAddr])

(New transaction hash, Completed flag)

Create a transaction sending some coins to a list of recipient addresses.

signOfflineTx

Arguments

:: Account

Account used for signing

-> Maybe XPrvKey

Key if not provided in account

-> Tx

Transaction to sign

-> [CoinSignData]

Input signing data

-> Tx

getOfflineTxData :: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m) => AccountId -> TxHash -> SqlPersistT m (OfflineTxData, [InCoinData])

Database blocks

importMerkles :: MonadIO m => BlockChainAction -> [MerkleTxs] -> Maybe (TBMChan Notif) -> SqlPersistT m ()

walletBestBlock :: MonadIO m => SqlPersistT m (BlockHash, Word32)

Database coins and balances

spendableCoins

Arguments

:: (MonadIO m, MonadThrow m, MonadBase IO m, MonadResource m)

=> AccountId

Account key

-> Word32

Minimum confirmations

-> (SqlExpr (Entity WalletCoin) -> SqlExpr (Entity WalletTx) -> [SqlExpr OrderBy])

Coin ordering policy

-> SqlPersistT m [InCoinData]

Spendable coins

accountBalance :: MonadIO m => AccountId -> Word32 -> Bool -> SqlPersistT m Word64

addressBalances :: MonadIO m => Entity Account -> KeyIndex -> KeyIndex -> AddressType -> Word32 -> Bool -> SqlPersistT m [(KeyIndex, BalanceInfo)]

Rescan

resetRescan :: MonadIO m => SqlPersistT m ()