Copyright	No rights reserved
License	MIT
Maintainer	[email protected]
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Haskoin.Transaction.Partial

Contents

Partially-Signed Transactions
- Signing

Description

Code related to PSBT parsing and serialization.

Synopsis

data PSBT = PSBT {
- unsignedTransaction :: Tx
- globalUnknown :: UnknownMap
- inputs :: [Input]
- outputs :: [Output]
}
getPSBT :: MonadGet m => Ctx -> m PSBT
putPSBT :: MonadPut m => Ctx -> PSBT -> m ()
data Input = Input {
- 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
}
getInput :: MonadGet m => Ctx -> m Input
putInput :: MonadPut m => Ctx -> Input -> m ()
data Output = Output {
- outputRedeemScript :: Maybe Script
- outputWitnessScript :: Maybe Script
- outputHDKeypaths :: HashMap PublicKey (Fingerprint, [KeyIndex])
- outputUnknown :: UnknownMap
}
getOutput :: MonadGet m => Ctx -> m Output
putOutput :: MonadPut m => Ctx -> Output -> m ()
newtype UnknownMap = UnknownMap {
- unknownMap :: HashMap Key ByteString
}
data Key = Key {
- keyType :: Word8
- key :: ByteString
}
merge :: PSBT -> PSBT -> Maybe PSBT
mergeMany :: [PSBT] -> Maybe PSBT
mergeInput :: Input -> Input -> Input
mergeOutput :: Output -> Output -> Output
complete :: Ctx -> PSBT -> PSBT
finalTransaction :: PSBT -> Tx
emptyPSBT :: Tx -> PSBT
emptyInput :: Input
emptyOutput :: Output
data PSBTSigner
getSignerKey :: PSBTSigner -> PublicKey -> Maybe (Fingerprint, DerivPath) -> Maybe SecKey
secKeySigner :: Ctx -> SecKey -> PSBTSigner
xPrvSigner :: Ctx -> XPrvKey -> Maybe (Fingerprint, DerivPath) -> PSBTSigner
signPSBT :: Network -> Ctx -> PSBTSigner -> PSBT -> PSBT

Partially-Signed Transactions

data PSBT Source #

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

Instances details

NFData PSBT Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

rnf :: PSBT -> () #

Generic PSBT Source #

Instance details

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep PSBT

Instance details

Defined in Haskoin.Transaction.Partial

type Rep PSBT = D1 ('MetaData "PSBT" "Haskoin.Transaction.Partial" "haskoin-core-1.2.2-7BgSuBjmW70D9Dx36RFkXY" '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]))))

Methods

from :: PSBT -> Rep PSBT x #

to :: Rep PSBT x -> PSBT #

Read PSBT Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS PSBT #

readList :: ReadS [PSBT] #

readPrec :: ReadPrec PSBT #

readListPrec :: ReadPrec [PSBT] #

Show PSBT Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> PSBT -> ShowS #

show :: PSBT -> String #

showList :: [PSBT] -> ShowS #

Eq PSBT Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

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

type Rep PSBT Source #

Instance details

Defined in Haskoin.Transaction.Partial

type Rep PSBT = D1 ('MetaData "PSBT" "Haskoin.Transaction.Partial" "haskoin-core-1.2.2-7BgSuBjmW70D9Dx36RFkXY" '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 Source #

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

data Input Source #

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

Instances details

NFData Input Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Input -> () #

Generic Input Source #

Instance details

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep Input

Instance details

Defined in Haskoin.Transaction.Partial

Methods

from :: Input -> Rep Input x #

to :: Rep Input x -> Input #

Read Input Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS Input #

readList :: ReadS [Input] #

readPrec :: ReadPrec Input #

readListPrec :: ReadPrec [Input] #

Show Input Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Input -> ShowS #

show :: Input -> String #

showList :: [Input] -> ShowS #

Eq Input Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

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

type Rep Input Source #

Instance details

Defined in Haskoin.Transaction.Partial

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

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

data Output Source #

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

Instances details

NFData Output Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Output -> () #

Generic Output Source #

Instance details

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep Output

Instance details

Defined in Haskoin.Transaction.Partial

type Rep Output = D1 ('MetaData "Output" "Haskoin.Transaction.Partial" "haskoin-core-1.2.2-7BgSuBjmW70D9Dx36RFkXY" '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))))

Methods

from :: Output -> Rep Output x #

to :: Rep Output x -> Output #

Read Output Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS Output #

readList :: ReadS [Output] #

readPrec :: ReadPrec Output #

readListPrec :: ReadPrec [Output] #

Show Output Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Output -> ShowS #

show :: Output -> String #

showList :: [Output] -> ShowS #

Eq Output Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

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

type Rep Output Source #

Instance details

Defined in Haskoin.Transaction.Partial

type Rep Output = D1 ('MetaData "Output" "Haskoin.Transaction.Partial" "haskoin-core-1.2.2-7BgSuBjmW70D9Dx36RFkXY" '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 Source #

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

newtype UnknownMap Source #

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

Instances details

Serial UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

deserialize :: MonadGet m => m UnknownMap #

NFData UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

rnf :: UnknownMap -> () #

Monoid UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

mempty :: UnknownMap #

mappend :: UnknownMap -> UnknownMap -> UnknownMap #

mconcat :: [UnknownMap] -> UnknownMap #

Semigroup UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

sconcat :: NonEmpty UnknownMap -> UnknownMap #

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

Generic UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep UnknownMap
Instance details Defined in Haskoin.Transaction.Partial type Rep UnknownMap = D1 ('MetaData "UnknownMap" "Haskoin.Transaction.Partial" "haskoin-core-1.2.2-7BgSuBjmW70D9Dx36RFkXY" 'True) (C1 ('MetaCons "UnknownMap" 'PrefixI 'True) (S1 ('MetaSel ('Just "unknownMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Key ByteString))))

Methods

from :: UnknownMap -> Rep UnknownMap x #

to :: Rep UnknownMap x -> UnknownMap #

Read UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS UnknownMap #

readList :: ReadS [UnknownMap] #

readPrec :: ReadPrec UnknownMap #

readListPrec :: ReadPrec [UnknownMap] #

Show UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> UnknownMap -> ShowS #

show :: UnknownMap -> String #

showList :: [UnknownMap] -> ShowS #

Eq UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

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

type Rep UnknownMap Source #

Instance details

Defined in Haskoin.Transaction.Partial

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

data Key Source #

Raw keys for the map type used in PSBTs.

Constructors

Key
Fields keyType :: Word8 key :: ByteString

Instances

Instances details

Binary Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

put :: Key -> Put #

get :: Get Key #

putList :: [Key] -> Put #

Serial Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

deserialize :: MonadGet m => m Key #

Serialize Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

put :: Putter Key #

get :: Get Key #

NFData Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

rnf :: Key -> () #

Generic Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Associated Types

type Rep Key

Instance details

Defined in Haskoin.Transaction.Partial

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

Methods

from :: Key -> Rep Key x #

to :: Rep Key x -> Key #

Read Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

readsPrec :: Int -> ReadS Key #

readList :: ReadS [Key] #

readPrec :: ReadPrec Key #

readListPrec :: ReadPrec [Key] #

Show Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

showsPrec :: Int -> Key -> ShowS #

show :: Key -> String #

showList :: [Key] -> ShowS #

Eq Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

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

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

Hashable Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

Methods

hashWithSalt :: Int -> Key -> Int #

hash :: Key -> Int #

type Rep Key Source #

Instance details

Defined in Haskoin.Transaction.Partial

type Rep Key = D1 ('MetaData "Key" "Haskoin.Transaction.Partial" "haskoin-core-1.2.2-7BgSuBjmW70D9Dx36RFkXY" '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 Source #

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

mergeMany :: [PSBT] -> Maybe PSBT Source #

A version of merge for a collection of PSBTs.

Since: 0.21.0

mergeInput :: Input -> Input -> Input Source #

mergeOutput :: Output -> Output -> Output Source #

complete :: Ctx -> PSBT -> PSBT Source #

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

finalTransaction :: PSBT -> Tx Source #

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 Source #

Take an unsigned transaction and produce an empty PSBT

emptyInput :: Input Source #

emptyOutput :: Output Source #

Signing

data PSBTSigner Source #

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

Instances details

Monoid PSBTSigner Source #
Instance details Defined in Haskoin.Transaction.Partial Methods mempty :: PSBTSigner # mappend :: PSBTSigner -> PSBTSigner -> PSBTSigner # mconcat :: [PSBTSigner] -> PSBTSigner #
Semigroup PSBTSigner Source #
Instance details 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 Source #

Fetch the secret key for the given PublicKey if possible.

since 0.21

secKeySigner :: Ctx -> SecKey -> PSBTSigner Source #

This signer can sign for one key.

since 0.21

xPrvSigner Source #

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 Source #

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

since 0.21