Haskoin.Transaction.Partial

Code related to PSBT parsing and serialization.

Partially-Signed Transactions

data PSBT

PSBT data type as specified in BIP-174. This contains an unsigned transaction, inputs and outputs, and unspecified extra data. There is one input per input in the unsigned transaction, and one output per output in the unsigned transaction. The inputs and outputs in the PSBT line up by index with the inputs and outputs in the unsigned transaction.

Constructors

PSBT

Fields

• unsignedTransaction :: Tx
• globalUnknown :: UnknownMap
• inputs :: [Input]
• outputs :: [Output]

Instances

Generic PSBT

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep PSBT :: Type -> Type

Methods

from :: PSBT -> Rep PSBT x

to :: Rep PSBT x -> PSBT

Read PSBT

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS PSBT

readList :: ReadS [PSBT]

readPrec :: ReadPrec PSBT

readListPrec :: ReadPrec [PSBT]

Show PSBT

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> PSBT -> ShowS

show :: PSBT -> String

showList :: [PSBT] -> ShowS

NFData PSBT

Defined in Haskoin.Transaction.Partial

Methods

rnf :: PSBT -> ()

Eq PSBT

Defined in Haskoin.Transaction.Partial

Methods

(==) :: PSBT -> PSBT -> Bool

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

type Rep PSBT

Defined in Haskoin.Transaction.Partial

type Rep PSBT = D1 ('MetaData "PSBT" "Haskoin.Transaction.Partial" "haskoin-core-1.1.0-EPeWWz60EKPlWai44F9WC" 'False) (C1 ('MetaCons "PSBT" 'PrefixI 'True) ((S1 ('MetaSel ('Just "unsignedTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tx) :*: S1 ('MetaSel ('Just "globalUnknown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnknownMap)) :*: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Input]) :*: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Output]))))

getPSBT :: MonadGet m => Ctx -> m PSBT

putPSBT :: MonadPut m => Ctx -> PSBT -> m ()

data Input

Inputs contain all of the data needed to sign a transaction and all of the resulting signature data after signing.

Constructors

Input

Fields

• nonWitnessUtxo :: Maybe Tx
• witnessUtxo :: Maybe TxOut
• partialSigs :: HashMap PublicKey ByteString
• sigHashType :: Maybe SigHash
• inputRedeemScript :: Maybe Script
• inputWitnessScript :: Maybe Script
• inputHDKeypaths :: HashMap PublicKey (Fingerprint, [KeyIndex])
• finalScriptSig :: Maybe Script
• finalScriptWitness :: Maybe WitnessStack
• inputUnknown :: UnknownMap

Instances

Generic Input

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep Input :: Type -> Type

Methods

from :: Input -> Rep Input x

to :: Rep Input x -> Input

Read Input

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS Input

readList :: ReadS [Input]

readPrec :: ReadPrec Input

readListPrec :: ReadPrec [Input]

Show Input

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Input -> ShowS

show :: Input -> String

showList :: [Input] -> ShowS

NFData Input

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Input -> ()

Eq Input

Defined in Haskoin.Transaction.Partial

Methods

(==) :: Input -> Input -> Bool

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

type Rep Input

Defined in Haskoin.Transaction.Partial

type Rep Input = D1 ('MetaData "Input" "Haskoin.Transaction.Partial" "haskoin-core-1.1.0-EPeWWz60EKPlWai44F9WC" 'False) (C1 ('MetaCons "Input" 'PrefixI 'True) (((S1 ('MetaSel ('Just "nonWitnessUtxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Tx)) :*: S1 ('MetaSel ('Just "witnessUtxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TxOut))) :*: (S1 ('MetaSel ('Just "partialSigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap PublicKey ByteString)) :*: (S1 ('MetaSel ('Just "sigHashType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SigHash)) :*: S1 ('MetaSel ('Just "inputRedeemScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Script))))) :*: ((S1 ('MetaSel ('Just "inputWitnessScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Script)) :*: S1 ('MetaSel ('Just "inputHDKeypaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap PublicKey (Fingerprint, [KeyIndex])))) :*: (S1 ('MetaSel ('Just "finalScriptSig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Script)) :*: (S1 ('MetaSel ('Just "finalScriptWitness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WitnessStack)) :*: S1 ('MetaSel ('Just "inputUnknown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnknownMap))))))

getInput :: MonadGet m => Ctx -> m Input

putInput :: MonadPut m => Ctx -> Input -> m ()

data Output

Outputs can contain information needed to spend the output at a later date.

Constructors

Output

Fields

• outputRedeemScript :: Maybe Script
• outputWitnessScript :: Maybe Script
• outputHDKeypaths :: HashMap PublicKey (Fingerprint, [KeyIndex])
• outputUnknown :: UnknownMap

Instances

Generic Output

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep Output :: Type -> Type

Methods

from :: Output -> Rep Output x

to :: Rep Output x -> Output

Read Output

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS Output

readList :: ReadS [Output]

readPrec :: ReadPrec Output

readListPrec :: ReadPrec [Output]

Show Output

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

NFData Output

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Output -> ()

Eq Output

Defined in Haskoin.Transaction.Partial

Methods

(==) :: Output -> Output -> Bool

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

type Rep Output

Defined in Haskoin.Transaction.Partial

type Rep Output = D1 ('MetaData "Output" "Haskoin.Transaction.Partial" "haskoin-core-1.1.0-EPeWWz60EKPlWai44F9WC" 'False) (C1 ('MetaCons "Output" 'PrefixI 'True) ((S1 ('MetaSel ('Just "outputRedeemScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Script)) :*: S1 ('MetaSel ('Just "outputWitnessScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Script))) :*: (S1 ('MetaSel ('Just "outputHDKeypaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap PublicKey (Fingerprint, [KeyIndex]))) :*: S1 ('MetaSel ('Just "outputUnknown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnknownMap))))

getOutput :: MonadGet m => Ctx -> m Output

putOutput :: MonadPut m => Ctx -> Output -> m ()

newtype UnknownMap

A map of raw PSBT keys to byte strings for extra data. The keyType field cannot overlap with any of the reserved keyType fields specified in the PSBT specification.

Constructors

UnknownMap

Fields

• unknownMap :: HashMap Key ByteString

Instances

Monoid UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

mempty :: UnknownMap

mappend :: UnknownMap -> UnknownMap -> UnknownMap

mconcat :: [UnknownMap] -> UnknownMap

Semigroup UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

(<>) :: UnknownMap -> UnknownMap -> UnknownMap

sconcat :: NonEmpty UnknownMap -> UnknownMap

stimes :: Integral b => b -> UnknownMap -> UnknownMap

Generic UnknownMap

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep UnknownMap :: Type -> Type

Methods

from :: UnknownMap -> Rep UnknownMap x

to :: Rep UnknownMap x -> UnknownMap

Read UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS UnknownMap

readList :: ReadS [UnknownMap]

readPrec :: ReadPrec UnknownMap

readListPrec :: ReadPrec [UnknownMap]

Show UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> UnknownMap -> ShowS

show :: UnknownMap -> String

showList :: [UnknownMap] -> ShowS

Serial UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

serialize :: MonadPut m => UnknownMap -> m ()

deserialize :: MonadGet m => m UnknownMap

NFData UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

rnf :: UnknownMap -> ()

Eq UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

(==) :: UnknownMap -> UnknownMap -> Bool

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

type Rep UnknownMap

Defined in Haskoin.Transaction.Partial

type Rep UnknownMap = D1 ('MetaData "UnknownMap" "Haskoin.Transaction.Partial" "haskoin-core-1.1.0-EPeWWz60EKPlWai44F9WC" 'True) (C1 ('MetaCons "UnknownMap" 'PrefixI 'True) (S1 ('MetaSel ('Just "unknownMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Key ByteString))))

data Key

Raw keys for the map type used in PSBTs.

Constructors

Key

Fields

• keyType :: Word8
• key :: ByteString

Instances

Generic Key

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep Key :: Type -> Type

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

Read Key

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS Key

readList :: ReadS [Key]

readPrec :: ReadPrec Key

readListPrec :: ReadPrec [Key]

Show Key

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Binary Key

Defined in Haskoin.Transaction.Partial

Methods

put :: Key -> Put

get :: Get Key

putList :: [Key] -> Put

Serial Key

Defined in Haskoin.Transaction.Partial

Methods

serialize :: MonadPut m => Key -> m ()

deserialize :: MonadGet m => m Key

Serialize Key

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter Key

get :: Get Key

NFData Key

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Key -> ()

Eq Key

Defined in Haskoin.Transaction.Partial

Methods

(==) :: Key -> Key -> Bool

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

Hashable Key

Defined in Haskoin.Transaction.Partial

Methods

hashWithSalt :: Int -> Key -> Int

hash :: Key -> Int

type Rep Key

Defined in Haskoin.Transaction.Partial

type Rep Key = D1 ('MetaData "Key" "Haskoin.Transaction.Partial" "haskoin-core-1.1.0-EPeWWz60EKPlWai44F9WC" 'False) (C1 ('MetaCons "Key" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

merge :: PSBT -> PSBT -> Maybe PSBT

Take two PSBTs and merge them. The unsignedTransaction field in both must be the same.

mergeMany :: [PSBT] -> Maybe PSBT

A version of merge for a collection of PSBTs.

Since: 0.21.0

mergeInput :: Input -> Input -> Input

mergeOutput :: Output -> Output -> Output

complete :: Ctx -> PSBT -> PSBT

Take partial signatures from all of the Inputs and finalize the signature.

finalTransaction :: PSBT -> Tx

Take a finalized PSBT and produce the signed final transaction. You may need to call complete on the PSBT before producing the final transaction.

emptyPSBT :: Tx -> PSBT

Take an unsigned transaction and produce an empty PSBT

emptyInput :: Input

emptyOutput :: Output

Signing

data PSBTSigner

A abstraction which covers varying key configurations. Use the Semigroup instance to create signers for sets of keys: `signerA <> signerB` can sign anything for which signerA or signerB could sign.

since 0.21

Instances

Monoid PSBTSigner

Defined in Haskoin.Transaction.Partial

Methods

mempty :: PSBTSigner

mappend :: PSBTSigner -> PSBTSigner -> PSBTSigner

mconcat :: [PSBTSigner] -> PSBTSigner

Semigroup PSBTSigner

Defined in Haskoin.Transaction.Partial

Methods

(<>) :: PSBTSigner -> PSBTSigner -> PSBTSigner

sconcat :: NonEmpty PSBTSigner -> PSBTSigner

stimes :: Integral b => b -> PSBTSigner -> PSBTSigner

getSignerKey :: PSBTSigner -> PublicKey -> Maybe (Fingerprint, DerivPath) -> Maybe SecKey

Fetch the secret key for the given PublicKey if possible.

since 0.21

secKeySigner :: Ctx -> SecKey -> PSBTSigner

This signer can sign for one key.

since 0.21

xPrvSigner

Arguments

:: Ctx

-> XPrvKey

-> Maybe (Fingerprint, DerivPath)

Origin data, if the input key is explicitly a child key

-> PSBTSigner

This signer can sign with any child key, provided that derivation information is present.

since 0.21

signPSBT :: Network -> Ctx -> PSBTSigner -> PSBT -> PSBT

Update a PSBT with signatures when possible. This function uses inputHDKeypaths in order to calculate secret keys.

since 0.21