Haskoin.Transaction.Partial

Code related to PSBT parsing and serialization.

Partially-Signed Transactions

data PartiallySignedTransaction

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 PartiallySignedTransaction line up by index with the inputs and outputs in the unsigned transaction.

Constructors

PartiallySignedTransaction

Fields

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

Instances

Eq PartiallySignedTransaction

Defined in Haskoin.Transaction.Partial

Methods

(==) :: PartiallySignedTransaction -> PartiallySignedTransaction -> Bool

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

Show PartiallySignedTransaction

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> PartiallySignedTransaction -> ShowS

show :: PartiallySignedTransaction -> String

showList :: [PartiallySignedTransaction] -> ShowS

Generic PartiallySignedTransaction

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep PartiallySignedTransaction :: Type -> Type

Methods

from :: PartiallySignedTransaction -> Rep PartiallySignedTransaction x

to :: Rep PartiallySignedTransaction x -> PartiallySignedTransaction

Serialize PartiallySignedTransaction

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter PartiallySignedTransaction

get :: Get PartiallySignedTransaction

NFData PartiallySignedTransaction

Defined in Haskoin.Transaction.Partial

Methods

rnf :: PartiallySignedTransaction -> ()

type Rep PartiallySignedTransaction

Defined in Haskoin.Transaction.Partial

type Rep PartiallySignedTransaction = D1 ('MetaData "PartiallySignedTransaction" "Haskoin.Transaction.Partial" "haskoin-core-0.21.2-inplace" 'False) (C1 ('MetaCons "PartiallySignedTransaction" '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]))))

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 PubKeyI ByteString
• sigHashType :: Maybe SigHash
• inputRedeemScript :: Maybe Script
• inputWitnessScript :: Maybe Script
• inputHDKeypaths :: HashMap PubKeyI (Fingerprint, [KeyIndex])
• finalScriptSig :: Maybe Script
• finalScriptWitness :: Maybe WitnessStack
• inputUnknown :: UnknownMap

Instances

Eq Input

Defined in Haskoin.Transaction.Partial

Methods

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

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

Show Input

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Input -> ShowS

show :: Input -> String

showList :: [Input] -> ShowS

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

Serialize Input

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter Input

get :: Get Input

NFData Input

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Input -> ()

type Rep Input

Defined in Haskoin.Transaction.Partial

type Rep Input = D1 ('MetaData "Input" "Haskoin.Transaction.Partial" "haskoin-core-0.21.2-inplace" '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 PubKeyI 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 PubKeyI (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))))))

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 PubKeyI (Fingerprint, [KeyIndex])
• outputUnknown :: UnknownMap

Instances

Eq Output

Defined in Haskoin.Transaction.Partial

Methods

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

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

Show Output

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

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

Serialize Output

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter Output

get :: Get Output

NFData Output

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Output -> ()

type Rep Output

Defined in Haskoin.Transaction.Partial

type Rep Output = D1 ('MetaData "Output" "Haskoin.Transaction.Partial" "haskoin-core-0.21.2-inplace" '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 PubKeyI (Fingerprint, [KeyIndex]))) :*: S1 ('MetaSel ('Just "outputUnknown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnknownMap))))

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

Eq UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

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

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

Show UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> UnknownMap -> ShowS

show :: UnknownMap -> String

showList :: [UnknownMap] -> ShowS

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

Semigroup UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

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

sconcat :: NonEmpty UnknownMap -> UnknownMap

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

Monoid UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

mempty :: UnknownMap

mappend :: UnknownMap -> UnknownMap -> UnknownMap

mconcat :: [UnknownMap] -> UnknownMap

Serialize UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter UnknownMap

get :: Get UnknownMap

NFData UnknownMap

Defined in Haskoin.Transaction.Partial

Methods

rnf :: UnknownMap -> ()

type Rep UnknownMap

Defined in Haskoin.Transaction.Partial

type Rep UnknownMap = D1 ('MetaData "UnknownMap" "Haskoin.Transaction.Partial" "haskoin-core-0.21.2-inplace" '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

Eq Key

Defined in Haskoin.Transaction.Partial

Methods

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

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

Show Key

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

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

Hashable Key

Defined in Haskoin.Transaction.Partial

Methods

hashWithSalt :: Int -> Key -> Int

hash :: Key -> Int

Serialize Key

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter Key

get :: Get Key

NFData Key

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Key -> ()

type Rep Key

Defined in Haskoin.Transaction.Partial

type Rep Key = D1 ('MetaData "Key" "Haskoin.Transaction.Partial" "haskoin-core-0.21.2-inplace" '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 :: PartiallySignedTransaction -> PartiallySignedTransaction -> Maybe PartiallySignedTransaction

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

mergeMany :: [PartiallySignedTransaction] -> Maybe PartiallySignedTransaction

A version of merge for a collection of PSBTs.

Since: 0.21.0

mergeInput :: Input -> Input -> Input

mergeOutput :: Output -> Output -> Output

complete :: PartiallySignedTransaction -> PartiallySignedTransaction

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

finalTransaction :: PartiallySignedTransaction -> Tx

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

emptyPSBT :: Tx -> PartiallySignedTransaction

Take an unsigned transaction and produce an empty PartiallySignedTransaction

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

Semigroup PsbtSigner

Defined in Haskoin.Transaction.Partial

Methods

(<>) :: PsbtSigner -> PsbtSigner -> PsbtSigner

sconcat :: NonEmpty PsbtSigner -> PsbtSigner

stimes :: Integral b => b -> PsbtSigner -> PsbtSigner

Monoid PsbtSigner

Defined in Haskoin.Transaction.Partial

Methods

mempty :: PsbtSigner

mappend :: PsbtSigner -> PsbtSigner -> PsbtSigner

mconcat :: [PsbtSigner] -> PsbtSigner

getSignerKey :: PsbtSigner -> PubKeyI -> Maybe (Fingerprint, DerivPath) -> Maybe SecKey

Fetch the secret key for the given PubKeyI if possible.

since 0.21

secKeySigner :: SecKey -> PsbtSigner

This signer can sign for one key.

since 0.21

xPrvSigner

Arguments

:: 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 -> PsbtSigner -> PartiallySignedTransaction -> PartiallySignedTransaction

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

since 0.21