Network.Haskoin.Transaction

This package provides functions for building and signing both simple transactions and multisignature transactions.

Transaction Types

data Tx

Data type representing a bitcoin transaction

Instances

Eq Tx

Methods

(==) :: Tx -> Tx -> Bool

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

Read Tx

Methods

readsPrec :: Int -> ReadS Tx

readList :: ReadS [Tx]

readPrec :: ReadPrec Tx

readListPrec :: ReadPrec [Tx]

Show Tx

Methods

showsPrec :: Int -> Tx -> ShowS

show :: Tx -> String

showList :: [Tx] -> ShowS

IsString Tx

Methods

fromString :: String -> Tx

ToJSON Tx

Methods

toJSON :: Tx -> Value

toEncoding :: Tx -> Encoding

toJSONList :: [Tx] -> Value

toEncodingList :: [Tx] -> Encoding

FromJSON Tx

Methods

parseJSON :: Value -> Parser Tx

parseJSONList :: Value -> Parser [Tx]

Serialize Tx

Methods

put :: Putter Tx

get :: Get Tx

NFData Tx

Methods

rnf :: Tx -> ()

createTx :: Word32 -> [TxIn] -> [TxOut] -> Word32 -> Tx

txVersion :: Tx -> Word32

txIn :: Tx -> [TxIn]

txOut :: Tx -> [TxOut]

txLockTime :: Tx -> Word32

txHash :: Tx -> TxHash

data TxIn

Data type representing a transaction input.

Constructors

TxIn

Fields

• prevOutput :: !OutPoint

  Reference the previous transaction output (hash + position)

• scriptInput :: !ByteString

  Script providing the requirements of the previous transaction output to spend those coins.

• txInSequence :: !Word32

  Transaction version as defined by the sender of the transaction. The intended use is for replacing transactions with new information before the transaction is included in a block.

Instances

Eq TxIn

Methods

(==) :: TxIn -> TxIn -> Bool

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

Read TxIn

Methods

readsPrec :: Int -> ReadS TxIn

readList :: ReadS [TxIn]

readPrec :: ReadPrec TxIn

readListPrec :: ReadPrec [TxIn]

Show TxIn

Methods

showsPrec :: Int -> TxIn -> ShowS

show :: TxIn -> String

showList :: [TxIn] -> ShowS

Serialize TxIn

Methods

put :: Putter TxIn

get :: Get TxIn

NFData TxIn

Methods

rnf :: TxIn -> ()

data TxOut

Data type representing a transaction output.

Constructors

TxOut

Fields

• outValue :: !Word64

  Transaction output value.

• scriptOutput :: !ByteString

  Script specifying the conditions to spend this output.

Instances

Eq TxOut

Methods

(==) :: TxOut -> TxOut -> Bool

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

Read TxOut

Methods

readsPrec :: Int -> ReadS TxOut

readList :: ReadS [TxOut]

readPrec :: ReadPrec TxOut

readListPrec :: ReadPrec [TxOut]

Show TxOut

Methods

showsPrec :: Int -> TxOut -> ShowS

show :: TxOut -> String

showList :: [TxOut] -> ShowS

Serialize TxOut

Methods

put :: Putter TxOut

get :: Get TxOut

NFData TxOut

Methods

rnf :: TxOut -> ()

data OutPoint

The OutPoint is used inside a transaction input to reference the previous transaction output that it is spending.

Constructors

OutPoint

Fields

• outPointHash :: !TxHash

  The hash of the referenced transaction.

• outPointIndex :: !Word32

  The position of the specific output in the transaction. The first output position is 0.

Instances

Eq OutPoint

Methods

(==) :: OutPoint -> OutPoint -> Bool

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

Read OutPoint

Methods

readsPrec :: Int -> ReadS OutPoint

readList :: ReadS [OutPoint]

readPrec :: ReadPrec OutPoint

readListPrec :: ReadPrec [OutPoint]

Show OutPoint

Methods

showsPrec :: Int -> OutPoint -> ShowS

show :: OutPoint -> String

showList :: [OutPoint] -> ShowS

ToJSON OutPoint

Methods

toJSON :: OutPoint -> Value

toEncoding :: OutPoint -> Encoding

toJSONList :: [OutPoint] -> Value

toEncodingList :: [OutPoint] -> Encoding

FromJSON OutPoint

Methods

parseJSON :: Value -> Parser OutPoint

parseJSONList :: Value -> Parser [OutPoint]

Serialize OutPoint

Methods

put :: Putter OutPoint

get :: Get OutPoint

NFData OutPoint

Methods

rnf :: OutPoint -> ()

newtype TxHash

Constructors

TxHash

Fields

• getTxHash :: Hash256

Instances

Eq TxHash

Methods

(==) :: TxHash -> TxHash -> Bool

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

Ord TxHash

Methods

compare :: TxHash -> TxHash -> Ordering

(<) :: TxHash -> TxHash -> Bool

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

(>) :: TxHash -> TxHash -> Bool

(>=) :: TxHash -> TxHash -> Bool

max :: TxHash -> TxHash -> TxHash

min :: TxHash -> TxHash -> TxHash

Read TxHash

Methods

readsPrec :: Int -> ReadS TxHash

readList :: ReadS [TxHash]

readPrec :: ReadPrec TxHash

readListPrec :: ReadPrec [TxHash]

Show TxHash

Methods

showsPrec :: Int -> TxHash -> ShowS

show :: TxHash -> String

showList :: [TxHash] -> ShowS

IsString TxHash

Methods

fromString :: String -> TxHash

ToJSON TxHash

Methods

toJSON :: TxHash -> Value

toEncoding :: TxHash -> Encoding

toJSONList :: [TxHash] -> Value

toEncodingList :: [TxHash] -> Encoding

FromJSON TxHash

Methods

parseJSON :: Value -> Parser TxHash

parseJSONList :: Value -> Parser [TxHash]

Serialize TxHash

Methods

put :: Putter TxHash

get :: Get TxHash

NFData TxHash

Methods

rnf :: TxHash -> ()

hexToTxHash :: ByteString -> Maybe TxHash

txHashToHex :: TxHash -> ByteString

nosigTxHash :: Tx -> TxHash

Build Transactions

buildTx :: [OutPoint] -> [(ScriptOutput, Word64)] -> Either String Tx

Build a transaction by providing a list of outpoints as inputs and a list of ScriptOutput and amounts as outputs.

buildAddrTx :: [OutPoint] -> [(ByteString, Word64)] -> Either String Tx

Build a transaction by providing a list of outpoints as inputs and a list of recipients addresses and amounts as outputs.

Sign Transactions

data SigInput

Data type used to specify the signing parameters of a transaction input. To sign an input, the previous output script, outpoint and sighash are required. When signing a pay to script hash output, an additional redeem script is required.

Constructors

SigInput

Fields

• sigDataOut :: !ScriptOutput

  Output script to spend.

• sigDataOP :: !OutPoint

  Spending tranasction OutPoint

• sigDataSH :: !SigHash

  Signature type.

• sigDataRedeem :: !(Maybe RedeemScript)

  Redeem script

Instances

Eq SigInput

Methods

(==) :: SigInput -> SigInput -> Bool

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

Read SigInput

Methods

readsPrec :: Int -> ReadS SigInput

readList :: ReadS [SigInput]

readPrec :: ReadPrec SigInput

readListPrec :: ReadPrec [SigInput]

Show SigInput

Methods

showsPrec :: Int -> SigInput -> ShowS

show :: SigInput -> String

showList :: [SigInput] -> ShowS

ToJSON SigInput

Methods

toJSON :: SigInput -> Value

toEncoding :: SigInput -> Encoding

toJSONList :: [SigInput] -> Value

toEncodingList :: [SigInput] -> Encoding

FromJSON SigInput

Methods

parseJSON :: Value -> Parser SigInput

parseJSONList :: Value -> Parser [SigInput]

NFData SigInput

Methods

rnf :: SigInput -> ()

signTx

Arguments

:: Tx

Transaction to sign

-> [SigInput]

SigInput signing parameters

-> [PrvKey]

List of private keys to use for signing

-> Either String Tx

Signed transaction

Sign a transaction by providing the SigInput signing paramters and a list of private keys. The signature is computed deterministically as defined in RFC-6979.

signInput :: Tx -> Int -> SigInput -> PrvKey -> Either String Tx

Sign a single input in a transaction deterministically (RFC-6979).

mergeTxs :: [Tx] -> [(ScriptOutput, OutPoint)] -> Either String Tx

verifyStdTx :: Tx -> [(ScriptOutput, OutPoint)] -> Bool

Verify if a transaction is valid and all of its inputs are standard.

verifyStdInput :: Tx -> Int -> ScriptOutput -> Bool

Verify if a transaction input is valid and standard.

Coin selection

class Coin c where

Any type can be used as a Coin if it can provide a value in Satoshi. The value is used in coin selection algorithms.

Minimal complete definition

coinValue

Methods

coinValue :: c -> Word64

Instances

Coin ArbitrarySatoshi

Methods

coinValue :: ArbitrarySatoshi -> Word64

chooseCoins

Arguments

:: Coin c

=> Word64

Target price to pay.

-> Word64

Fee price per 1000 bytes.

-> Bool

Try to find better solution when one is found

-> [c]

List of ordered coins to choose from.

-> Either String ([c], Word64)

Coin selection result and change amount.

Coin selection algorithm for normal (non-multisig) transactions. This function returns the selected coins together with the amount of change to send back to yourself, taking the fee into account.

chooseCoinsSink

Arguments

:: (Monad m, Coin c)

=> Word64

Target price to pay.

-> Word64

Fee price per 1000 bytes.

-> Bool

Try to find better solution when one is found

-> Sink c m (Either String ([c], Word64))

Coin selection result and change amount.

Coin selection algorithm for normal (non-multisig) transactions. This function returns the selected coins together with the amount of change to send back to yourself, taking the fee into account. This version uses a Sink if you need conduit-based coin selection.

chooseMSCoins

Arguments

:: Coin c

=> Word64

Target price to pay.

-> Word64

Fee price per 1000 bytes.

-> (Int, Int)

Multisig parameters m of n (m,n).

-> Bool

Try to find better solution when one is found

-> [c]

-> Either String ([c], Word64)

Coin selection result and change amount.

Coin selection algorithm for multisignature transactions. This function returns the selected coins together with the amount of change to send back to yourself, taking the fee into account. This function assumes all the coins are script hash outputs that send funds to a multisignature address.

chooseMSCoinsSink

Arguments

:: (Monad m, Coin c)

=> Word64

Target price to pay.

-> Word64

Fee price per 1000 bytes.

-> (Int, Int)

Multisig parameters m of n (m,n).

-> Bool

Try to find better solution when one is found

-> Sink c m (Either String ([c], Word64))

Coin selection result and change amount.

Coin selection algorithm for multisignature transactions. This function returns the selected coins together with the amount of change to send back to yourself, taking the fee into account. This function assumes all the coins are script hash outputs that send funds to a multisignature address. This version uses a Sink if you need conduit-based coin selection.

guessTxSize

Arguments

:: Int

Number of regular transaction inputs.

-> [(Int, Int)]

For every multisig input in the transaction, provide the multisig parameters m of n (m,n) for that input.

-> Int

Number of pay to public key hash outputs.

-> Int

Number of pay to script hash outputs.

-> Int

Upper bound on the transaction size.

Computes an upper bound on the size of a transaction based on some known properties of the transaction.

getFee :: Word64 -> Int -> Word64

getMSFee :: Word64 -> (Int, Int) -> Int -> Word64

buildInput :: Tx -> Int -> ScriptOutput -> Maybe RedeemScript -> TxSignature -> PubKey -> Either String ScriptInput