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

ToJSON OutputFormat

Methods

toJSON :: OutputFormat -> Value

toEncoding :: OutputFormat -> Encoding

toJSONList :: [OutputFormat] -> Value

toEncodingList :: [OutputFormat] -> Encoding

FromJSON OutputFormat

Methods

parseJSON :: Value -> Parser OutputFormat

parseJSONList :: Value -> Parser [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

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

Default Config

Methods

def :: Config

Server

runSPVServer :: Config -> IO ()

stopSPVServer :: Config -> IO ()

data SPVMode

Constructors

SPVOnline

SPVOffline

Instances

Eq SPVMode

Methods

(==) :: SPVMode -> SPVMode -> Bool

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

Read SPVMode

Methods

readsPrec :: Int -> ReadS SPVMode

readList :: ReadS [SPVMode]

readPrec :: ReadPrec SPVMode

readListPrec :: ReadPrec [SPVMode]

Show SPVMode

Methods

showsPrec :: Int -> SPVMode -> ShowS

show :: SPVMode -> String

showList :: [SPVMode] -> ShowS

ToJSON SPVMode

Methods

toJSON :: SPVMode -> Value

toEncoding :: SPVMode -> Encoding

toJSONList :: [SPVMode] -> Value

toEncodingList :: [SPVMode] -> Encoding

FromJSON SPVMode

Methods

parseJSON :: Value -> Parser SPVMode

parseJSONList :: Value -> Parser [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

Methods

(==) :: JsonAccount -> JsonAccount -> Bool

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

Read JsonAccount

Methods

readsPrec :: Int -> ReadS JsonAccount

readList :: ReadS [JsonAccount]

readPrec :: ReadPrec JsonAccount

readListPrec :: ReadPrec [JsonAccount]

Show JsonAccount

Methods

showsPrec :: Int -> JsonAccount -> ShowS

show :: JsonAccount -> String

showList :: [JsonAccount] -> ShowS

ToJSON JsonAccount

Methods

toJSON :: JsonAccount -> Value

toEncoding :: JsonAccount -> Encoding

toJSONList :: [JsonAccount] -> Value

toEncodingList :: [JsonAccount] -> Encoding

FromJSON JsonAccount

Methods

parseJSON :: Value -> Parser JsonAccount

parseJSONList :: Value -> Parser [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

Methods

(==) :: JsonAddr -> JsonAddr -> Bool

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

Read JsonAddr

Methods

readsPrec :: Int -> ReadS JsonAddr

readList :: ReadS [JsonAddr]

readPrec :: ReadPrec JsonAddr

readListPrec :: ReadPrec [JsonAddr]

Show JsonAddr

Methods

showsPrec :: Int -> JsonAddr -> ShowS

show :: JsonAddr -> String

showList :: [JsonAddr] -> ShowS

ToJSON JsonAddr

Methods

toJSON :: JsonAddr -> Value

toEncoding :: JsonAddr -> Encoding

toJSONList :: [JsonAddr] -> Value

toEncodingList :: [JsonAddr] -> Encoding

FromJSON JsonAddr

Methods

parseJSON :: Value -> Parser JsonAddr

parseJSONList :: Value -> Parser [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

Methods

(==) :: JsonCoin -> JsonCoin -> Bool

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

Read JsonCoin

Methods

readsPrec :: Int -> ReadS JsonCoin

readList :: ReadS [JsonCoin]

readPrec :: ReadPrec JsonCoin

readListPrec :: ReadPrec [JsonCoin]

Show JsonCoin

Methods

showsPrec :: Int -> JsonCoin -> ShowS

show :: JsonCoin -> String

showList :: [JsonCoin] -> ShowS

ToJSON JsonCoin

Methods

toJSON :: JsonCoin -> Value

toEncoding :: JsonCoin -> Encoding

toJSONList :: [JsonCoin] -> Value

toEncodingList :: [JsonCoin] -> Encoding

FromJSON JsonCoin

Methods

parseJSON :: Value -> Parser JsonCoin

parseJSONList :: Value -> Parser [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

Methods

(==) :: JsonTx -> JsonTx -> Bool

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

Read JsonTx

Methods

readsPrec :: Int -> ReadS JsonTx

readList :: ReadS [JsonTx]

readPrec :: ReadPrec JsonTx

readListPrec :: ReadPrec [JsonTx]

Show JsonTx

Methods

showsPrec :: Int -> JsonTx -> ShowS

show :: JsonTx -> String

showList :: [JsonTx] -> ShowS

ToJSON JsonTx

Methods

toJSON :: JsonTx -> Value

toEncoding :: JsonTx -> Encoding

toJSONList :: [JsonTx] -> Value

toEncodingList :: [JsonTx] -> Encoding

FromJSON JsonTx

Methods

parseJSON :: Value -> Parser JsonTx

parseJSONList :: Value -> Parser [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

GetIndexR !AccountName !PubKeyC !AddressType

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

GetBlockInfoR ![BlockHash]

StopServerR

Instances

Eq WalletRequest

Methods

(==) :: WalletRequest -> WalletRequest -> Bool

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

Show WalletRequest

Methods

showsPrec :: Int -> WalletRequest -> ShowS

show :: WalletRequest -> String

showList :: [WalletRequest] -> ShowS

ToJSON WalletRequest

Methods

toJSON :: WalletRequest -> Value

toEncoding :: WalletRequest -> Encoding

toJSONList :: [WalletRequest] -> Value

toEncodingList :: [WalletRequest] -> Encoding

FromJSON WalletRequest

Methods

parseJSON :: Value -> Parser WalletRequest

parseJSONList :: Value -> Parser [WalletRequest]

data ListRequest

Constructors

ListRequest

Fields

• listOffset :: !Word32
• listLimit :: !Word32
• listReverse :: !Bool

Instances

Eq ListRequest

Methods

(==) :: ListRequest -> ListRequest -> Bool

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

Read ListRequest

Methods

readsPrec :: Int -> ReadS ListRequest

readList :: ReadS [ListRequest]

readPrec :: ReadPrec ListRequest

readListPrec :: ReadPrec [ListRequest]

Show ListRequest

Methods

showsPrec :: Int -> ListRequest -> ShowS

show :: ListRequest -> String

showList :: [ListRequest] -> ShowS

ToJSON ListRequest

Methods

toJSON :: ListRequest -> Value

toEncoding :: ListRequest -> Encoding

toJSONList :: [ListRequest] -> Value

toEncodingList :: [ListRequest] -> Encoding

FromJSON ListRequest

Methods

parseJSON :: Value -> Parser ListRequest

parseJSONList :: Value -> Parser [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

Methods

(==) :: NewAccount -> NewAccount -> Bool

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

Read NewAccount

Methods

readsPrec :: Int -> ReadS NewAccount

readList :: ReadS [NewAccount]

readPrec :: ReadPrec NewAccount

readListPrec :: ReadPrec [NewAccount]

Show NewAccount

Methods

showsPrec :: Int -> NewAccount -> ShowS

show :: NewAccount -> String

showList :: [NewAccount] -> ShowS

ToJSON NewAccount

Methods

toJSON :: NewAccount -> Value

toEncoding :: NewAccount -> Encoding

toJSONList :: [NewAccount] -> Value

toEncodingList :: [NewAccount] -> Encoding

FromJSON NewAccount

Methods

parseJSON :: Value -> Parser NewAccount

parseJSONList :: Value -> Parser [NewAccount]

data SetAccountGap

Constructors

SetAccountGap

Fields

• getAccountGap :: !Word32

Instances

Eq SetAccountGap

Methods

(==) :: SetAccountGap -> SetAccountGap -> Bool

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

Read SetAccountGap

Methods

readsPrec :: Int -> ReadS SetAccountGap

readList :: ReadS [SetAccountGap]

readPrec :: ReadPrec SetAccountGap

readListPrec :: ReadPrec [SetAccountGap]

Show SetAccountGap

Methods

showsPrec :: Int -> SetAccountGap -> ShowS

show :: SetAccountGap -> String

showList :: [SetAccountGap] -> ShowS

ToJSON SetAccountGap

Methods

toJSON :: SetAccountGap -> Value

toEncoding :: SetAccountGap -> Encoding

toJSONList :: [SetAccountGap] -> Value

toEncodingList :: [SetAccountGap] -> Encoding

FromJSON SetAccountGap

Methods

parseJSON :: Value -> Parser SetAccountGap

parseJSONList :: Value -> Parser [SetAccountGap]

data OfflineTxData

Constructors

OfflineTxData

Fields

• offlineTxDataTx :: !Tx
• offlineTxDataCoinData :: ![CoinSignData]

Instances

ToJSON OfflineTxData

Methods

toJSON :: OfflineTxData -> Value

toEncoding :: OfflineTxData -> Encoding

toJSONList :: [OfflineTxData] -> Value

toEncodingList :: [OfflineTxData] -> Encoding

FromJSON OfflineTxData

Methods

parseJSON :: Value -> Parser OfflineTxData

parseJSONList :: Value -> Parser [OfflineTxData]

data CoinSignData

Constructors

CoinSignData

Fields

• coinSignOutPoint :: !OutPoint
• coinSignScriptOutput :: !ScriptOutput
• coinSignDeriv :: !SoftPath

Instances

Eq CoinSignData

Methods

(==) :: CoinSignData -> CoinSignData -> Bool

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

Show CoinSignData

Methods

showsPrec :: Int -> CoinSignData -> ShowS

show :: CoinSignData -> String

showList :: [CoinSignData] -> ShowS

ToJSON CoinSignData

Methods

toJSON :: CoinSignData -> Value

toEncoding :: CoinSignData -> Encoding

toJSONList :: [CoinSignData] -> Value

toEncodingList :: [CoinSignData] -> Encoding

FromJSON CoinSignData

Methods

parseJSON :: Value -> Parser CoinSignData

parseJSONList :: Value -> Parser [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

Methods

(==) :: TxAction -> TxAction -> Bool

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

Show TxAction

Methods

showsPrec :: Int -> TxAction -> ShowS

show :: TxAction -> String

showList :: [TxAction] -> ShowS

ToJSON TxAction

Methods

toJSON :: TxAction -> Value

toEncoding :: TxAction -> Encoding

toJSONList :: [TxAction] -> Value

toEncodingList :: [TxAction] -> Encoding

FromJSON TxAction

Methods

parseJSON :: Value -> Parser TxAction

parseJSONList :: Value -> Parser [TxAction]

data AddressLabel

Constructors

AddressLabel

Fields

• addressLabelLabel :: !Text

Instances

Eq AddressLabel

Methods

(==) :: AddressLabel -> AddressLabel -> Bool

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

Read AddressLabel

Methods

readsPrec :: Int -> ReadS AddressLabel

readList :: ReadS [AddressLabel]

readPrec :: ReadPrec AddressLabel

readListPrec :: ReadPrec [AddressLabel]

Show AddressLabel

Methods

showsPrec :: Int -> AddressLabel -> ShowS

show :: AddressLabel -> String

showList :: [AddressLabel] -> ShowS

ToJSON AddressLabel

Methods

toJSON :: AddressLabel -> Value

toEncoding :: AddressLabel -> Encoding

toJSONList :: [AddressLabel] -> Value

toEncodingList :: [AddressLabel] -> Encoding

FromJSON AddressLabel

Methods

parseJSON :: Value -> Parser AddressLabel

parseJSONList :: Value -> Parser [AddressLabel]

data NodeAction

Constructors

NodeActionRescan

Fields

• nodeActionTimestamp :: !(Maybe Word32)

NodeActionStatus

Instances

Eq NodeAction

Methods

(==) :: NodeAction -> NodeAction -> Bool

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

Read NodeAction

Methods

readsPrec :: Int -> ReadS NodeAction

readList :: ReadS [NodeAction]

readPrec :: ReadPrec NodeAction

readListPrec :: ReadPrec [NodeAction]

Show NodeAction

Methods

showsPrec :: Int -> NodeAction -> ShowS

show :: NodeAction -> String

showList :: [NodeAction] -> ShowS

ToJSON NodeAction

Methods

toJSON :: NodeAction -> Value

toEncoding :: NodeAction -> Encoding

toJSONList :: [NodeAction] -> Value

toEncodingList :: [NodeAction] -> Encoding

FromJSON NodeAction

Methods

parseJSON :: Value -> Parser NodeAction

parseJSONList :: Value -> Parser [NodeAction]

data AccountType

Constructors

AccountRegular

AccountMultisig

Fields

• accountTypeRequiredSigs :: !Int
• accountTypeTotalKeys :: !Int

Instances

Eq AccountType

Methods

(==) :: AccountType -> AccountType -> Bool

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

Read AccountType

Methods

readsPrec :: Int -> ReadS AccountType

readList :: ReadS [AccountType]

readPrec :: ReadPrec AccountType

readListPrec :: ReadPrec [AccountType]

Show AccountType

Methods

showsPrec :: Int -> AccountType -> ShowS

show :: AccountType -> String

showList :: [AccountType] -> ShowS

NFData AccountType

Methods

rnf :: AccountType -> ()

ToJSON AccountType

Methods

toJSON :: AccountType -> Value

toEncoding :: AccountType -> Encoding

toJSONList :: [AccountType] -> Value

toEncodingList :: [AccountType] -> Encoding

FromJSON AccountType

Methods

parseJSON :: Value -> Parser AccountType

parseJSONList :: Value -> Parser [AccountType]

PersistField AccountType

Methods

toPersistValue :: AccountType -> PersistValue

fromPersistValue :: PersistValue -> Either Text AccountType

PersistFieldSql AccountType

Methods

sqlType :: Proxy * AccountType -> SqlType

data AddressType

Constructors

AddressInternal

AddressExternal

Instances

Eq AddressType

Methods

(==) :: AddressType -> AddressType -> Bool

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

Read AddressType

Methods

readsPrec :: Int -> ReadS AddressType

readList :: ReadS [AddressType]

readPrec :: ReadPrec AddressType

readListPrec :: ReadPrec [AddressType]

Show AddressType

Methods

showsPrec :: Int -> AddressType -> ShowS

show :: AddressType -> String

showList :: [AddressType] -> ShowS

NFData AddressType

Methods

rnf :: AddressType -> ()

ToJSON AddressType

Methods

toJSON :: AddressType -> Value

toEncoding :: AddressType -> Encoding

toJSONList :: [AddressType] -> Value

toEncodingList :: [AddressType] -> Encoding

FromJSON AddressType

Methods

parseJSON :: Value -> Parser AddressType

parseJSONList :: Value -> Parser [AddressType]

PersistField AddressType

Methods

toPersistValue :: AddressType -> PersistValue

fromPersistValue :: PersistValue -> Either Text AddressType

PersistFieldSql AddressType

Methods

sqlType :: Proxy * AddressType -> SqlType

addrTypeIndex :: AddressType -> KeyIndex

data TxType

Constructors

TxIncoming

TxOutgoing

TxSelf

Instances

Eq TxType

Methods

(==) :: TxType -> TxType -> Bool

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

Read TxType

Methods

readsPrec :: Int -> ReadS TxType

readList :: ReadS [TxType]

readPrec :: ReadPrec TxType

readListPrec :: ReadPrec [TxType]

Show TxType

Methods

showsPrec :: Int -> TxType -> ShowS

show :: TxType -> String

showList :: [TxType] -> ShowS

NFData TxType

Methods

rnf :: TxType -> ()

ToJSON TxType

Methods

toJSON :: TxType -> Value

toEncoding :: TxType -> Encoding

toJSONList :: [TxType] -> Value

toEncodingList :: [TxType] -> Encoding

FromJSON TxType

Methods

parseJSON :: Value -> Parser TxType

parseJSONList :: Value -> Parser [TxType]

PersistField TxType

Methods

toPersistValue :: TxType -> PersistValue

fromPersistValue :: PersistValue -> Either Text TxType

PersistFieldSql TxType

Methods

sqlType :: Proxy * TxType -> SqlType

data TxConfidence

Constructors

TxOffline

TxDead

TxPending

TxBuilding

Instances

Eq TxConfidence

Methods

(==) :: TxConfidence -> TxConfidence -> Bool

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

Read TxConfidence

Methods

readsPrec :: Int -> ReadS TxConfidence

readList :: ReadS [TxConfidence]

readPrec :: ReadPrec TxConfidence

readListPrec :: ReadPrec [TxConfidence]

Show TxConfidence

Methods

showsPrec :: Int -> TxConfidence -> ShowS

show :: TxConfidence -> String

showList :: [TxConfidence] -> ShowS

NFData TxConfidence

Methods

rnf :: TxConfidence -> ()

ToJSON TxConfidence

Methods

toJSON :: TxConfidence -> Value

toEncoding :: TxConfidence -> Encoding

toJSONList :: [TxConfidence] -> Value

toEncodingList :: [TxConfidence] -> Encoding

FromJSON TxConfidence

Methods

parseJSON :: Value -> Parser TxConfidence

parseJSONList :: Value -> Parser [TxConfidence]

PersistField TxConfidence

Methods

toPersistValue :: TxConfidence -> PersistValue

fromPersistValue :: PersistValue -> Either Text TxConfidence

PersistFieldSql TxConfidence

Methods

sqlType :: Proxy * TxConfidence -> SqlType

data AddressInfo

Constructors

AddressInfo

Fields

• addressInfoAddress :: !Address
• addressInfoValue :: !(Maybe Word64)
• addressInfoIsLocal :: !Bool

Instances

Eq AddressInfo

Methods

(==) :: AddressInfo -> AddressInfo -> Bool

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

Read AddressInfo

Methods

readsPrec :: Int -> ReadS AddressInfo

readList :: ReadS [AddressInfo]

readPrec :: ReadPrec AddressInfo

readListPrec :: ReadPrec [AddressInfo]

Show AddressInfo

Methods

showsPrec :: Int -> AddressInfo -> ShowS

show :: AddressInfo -> String

showList :: [AddressInfo] -> ShowS

Generic AddressInfo

Associated Types

type Rep AddressInfo :: * -> *

Methods

from :: AddressInfo -> Rep AddressInfo x

to :: Rep AddressInfo x -> AddressInfo

NFData AddressInfo

Methods

rnf :: AddressInfo -> ()

ToJSON AddressInfo

Methods

toJSON :: AddressInfo -> Value

toEncoding :: AddressInfo -> Encoding

toJSONList :: [AddressInfo] -> Value

toEncodingList :: [AddressInfo] -> Encoding

FromJSON AddressInfo

Methods

parseJSON :: Value -> Parser AddressInfo

parseJSONList :: Value -> Parser [AddressInfo]

Serialize AddressInfo

Methods

put :: Putter AddressInfo

get :: Get AddressInfo

PersistField [AddressInfo]

Methods

toPersistValue :: [AddressInfo] -> PersistValue

fromPersistValue :: PersistValue -> Either Text [AddressInfo]

PersistFieldSql [AddressInfo]

Methods

sqlType :: Proxy * [AddressInfo] -> SqlType

type Rep AddressInfo

type Rep AddressInfo = D1 (MetaData "AddressInfo" "Network.Haskoin.Wallet.Types" "haskoin-wallet-0.4.2-GGNJxNbZENWKcZl6t1mkyY" False) (C1 (MetaCons "AddressInfo" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "addressInfoAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Address)) ((:*:) (S1 (MetaSel (Just Symbol "addressInfoValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Word64))) (S1 (MetaSel (Just Symbol "addressInfoIsLocal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

data BalanceInfo

Constructors

BalanceInfo

Fields

• balanceInfoInBalance :: !Word64
• balanceInfoOutBalance :: !Word64
• balanceInfoCoins :: !Int
• balanceInfoSpentCoins :: !Int

Instances

Eq BalanceInfo

Methods

(==) :: BalanceInfo -> BalanceInfo -> Bool

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

Read BalanceInfo

Methods

readsPrec :: Int -> ReadS BalanceInfo

readList :: ReadS [BalanceInfo]

readPrec :: ReadPrec BalanceInfo

readListPrec :: ReadPrec [BalanceInfo]

Show BalanceInfo

Methods

showsPrec :: Int -> BalanceInfo -> ShowS

show :: BalanceInfo -> String

showList :: [BalanceInfo] -> ShowS

NFData BalanceInfo

Methods

rnf :: BalanceInfo -> ()

ToJSON BalanceInfo

Methods

toJSON :: BalanceInfo -> Value

toEncoding :: BalanceInfo -> Encoding

toJSONList :: [BalanceInfo] -> Value

toEncodingList :: [BalanceInfo] -> Encoding

FromJSON BalanceInfo

Methods

parseJSON :: Value -> Parser BalanceInfo

parseJSONList :: Value -> Parser [BalanceInfo]

API Response Types

data WalletResponse a

Constructors

ResponseError

Fields

• responseError :: !Text

ResponseValid

Fields

• responseResult :: !(Maybe a)

Instances

Eq a => Eq (WalletResponse a)

Methods

(==) :: WalletResponse a -> WalletResponse a -> Bool

(/=) :: WalletResponse a -> WalletResponse a -> Bool

Show a => Show (WalletResponse a)

Methods

showsPrec :: Int -> WalletResponse a -> ShowS

show :: WalletResponse a -> String

showList :: [WalletResponse a] -> ShowS

ToJSON a0 => ToJSON (WalletResponse a0)

Methods

toJSON :: WalletResponse a0 -> Value

toEncoding :: WalletResponse a0 -> Encoding

toJSONList :: [WalletResponse a0] -> Value

toEncodingList :: [WalletResponse a0] -> Encoding

FromJSON a0 => FromJSON (WalletResponse a0)

Methods

parseJSON :: Value -> Parser (WalletResponse a0)

parseJSONList :: Value -> Parser [WalletResponse a0]

data TxCompleteRes

Constructors

TxCompleteRes

Fields

• txCompleteTx :: !Tx
• txCompleteComplete :: !Bool

Instances

Eq TxCompleteRes

Methods

(==) :: TxCompleteRes -> TxCompleteRes -> Bool

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

Read TxCompleteRes

Methods

readsPrec :: Int -> ReadS TxCompleteRes

readList :: ReadS [TxCompleteRes]

readPrec :: ReadPrec TxCompleteRes

readListPrec :: ReadPrec [TxCompleteRes]

Show TxCompleteRes

Methods

showsPrec :: Int -> TxCompleteRes -> ShowS

show :: TxCompleteRes -> String

showList :: [TxCompleteRes] -> ShowS

ToJSON TxCompleteRes

Methods

toJSON :: TxCompleteRes -> Value

toEncoding :: TxCompleteRes -> Encoding

toJSONList :: [TxCompleteRes] -> Value

toEncodingList :: [TxCompleteRes] -> Encoding

FromJSON TxCompleteRes

Methods

parseJSON :: Value -> Parser TxCompleteRes

parseJSONList :: Value -> Parser [TxCompleteRes]

data ListResult a

Constructors

ListResult

Fields

• listResultItems :: ![a]
• listResultTotal :: !Word32

Instances

ToJSON a0 => ToJSON (ListResult a0)

Methods

toJSON :: ListResult a0 -> Value

toEncoding :: ListResult a0 -> Encoding

toJSONList :: [ListResult a0] -> Value

toEncodingList :: [ListResult a0] -> Encoding

FromJSON a0 => FromJSON (ListResult a0)

Methods

parseJSON :: Value -> Parser (ListResult a0)

parseJSONList :: Value -> Parser [ListResult a0]

data RescanRes

Constructors

RescanRes

Fields

• rescanTimestamp :: !Word32

Instances

Eq RescanRes

Methods

(==) :: RescanRes -> RescanRes -> Bool

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

Read RescanRes

Methods

readsPrec :: Int -> ReadS RescanRes

readList :: ReadS [RescanRes]

readPrec :: ReadPrec RescanRes

readListPrec :: ReadPrec [RescanRes]

Show RescanRes

Methods

showsPrec :: Int -> RescanRes -> ShowS

show :: RescanRes -> String

showList :: [RescanRes] -> ShowS

ToJSON RescanRes

Methods

toJSON :: RescanRes -> Value

toEncoding :: RescanRes -> Encoding

toJSONList :: [RescanRes] -> Value

toEncodingList :: [RescanRes] -> Encoding

FromJSON RescanRes

Methods

parseJSON :: Value -> Parser RescanRes

parseJSONList :: Value -> Parser [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])

createWalletTx

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 ()