ouroboros-consensus-0.25.0.0: Consensus layer for the Ouroboros blockchain protocol

Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Mock.Ledger

Synopsis

module Ouroboros.Consensus.Mock.Ledger.Address
module Ouroboros.Consensus.Mock.Ledger.Block
module Ouroboros.Consensus.Mock.Ledger.Block.BFT
module Ouroboros.Consensus.Mock.Ledger.Block.PBFT
module Ouroboros.Consensus.Mock.Ledger.Block.Praos
module Ouroboros.Consensus.Mock.Ledger.Block.PraosRule
module Ouroboros.Consensus.Mock.Ledger.Forge
module Ouroboros.Consensus.Mock.Ledger.Stake
module Ouroboros.Consensus.Mock.Ledger.State
type Ix = Word
type TxOut = (Addr, Amount)
type TxIn = (TxId, Ix)
data Tx where
- pattern Tx ∷ Expiry → Set TxIn → [TxOut] → Tx
genesisUtxo ∷ AddrDist → Utxo
type Amount = Word
data Expiry
- = DoNotExpire
- | ExpireAtOnsetOf !SlotNo
type Utxo = Map TxIn TxOut
class HasMockTxs a where
- getMockTxs ∷ a → [Tx]
data UtxoError
- = MissingInput TxIn
- | InputOutputMismatch Amount Amount
confirmed ∷ HasMockTxs a ⇒ a → Set TxId
txIns ∷ HasMockTxs a ⇒ a → Set TxIn
txOuts ∷ HasMockTxs a ⇒ a → Utxo
updateUtxo ∷ HasMockTxs a ⇒ a → Utxo → Except UtxoError Utxo
genesisTx ∷ AddrDist → Tx

Documentation

module Ouroboros.Consensus.Mock.Ledger.Address

module Ouroboros.Consensus.Mock.Ledger.Block

module Ouroboros.Consensus.Mock.Ledger.Block.BFT

module Ouroboros.Consensus.Mock.Ledger.Block.PBFT

module Ouroboros.Consensus.Mock.Ledger.Block.Praos

module Ouroboros.Consensus.Mock.Ledger.Block.PraosRule

module Ouroboros.Consensus.Mock.Ledger.Forge

module Ouroboros.Consensus.Mock.Ledger.Stake

module Ouroboros.Consensus.Mock.Ledger.State

type Ix = Word Source #

type TxOut = (Addr, Amount) Source #

type TxIn = (TxId, Ix) Source #

data Tx where Source #

Bundled Patterns

pattern Tx ∷ Expiry → Set TxIn → [TxOut] → Tx

Instances

Instances details

ToCBOR Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

toCBOR ∷ Tx → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Tx → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Tx] → Size Source #

NFData Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

rnf ∷ Tx → () #

Generic Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Associated Types

type Rep Tx

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

type Rep Tx = D1 ('MetaData "Tx" "Ouroboros.Consensus.Mock.Ledger.UTxO" "ouroboros-consensus-0.25.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "UnsafeTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Expiry) :*: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set TxIn)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TxOut]))))

Methods

from ∷ Tx → Rep Tx x #

to ∷ Rep Tx x → Tx #

Show Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

showsPrec ∷ Int → Tx → ShowS #

show ∷ Tx → String #

showList ∷ [Tx] → ShowS #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

(==) ∷ Tx → Tx → Bool #

(/=) ∷ Tx → Tx → Bool #

Ord Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

compare ∷ Tx → Tx → Ordering #

(<) ∷ Tx → Tx → Bool #

(<=) ∷ Tx → Tx → Bool #

(>) ∷ Tx → Tx → Bool #

(>=) ∷ Tx → Tx → Bool #

max ∷ Tx → Tx → Tx #

min ∷ Tx → Tx → Tx #

NoThunks Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

noThunks ∷ Context → Tx → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Tx → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy Tx → String Source #

Condense Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

condense ∷ Tx → String Source #

HasMockTxs Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

getMockTxs ∷ Tx → [Tx] Source #

Serialise Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

encode ∷ Tx → Encoding Source #

decode ∷ Decoder s Tx Source #

encodeList ∷ [Tx] → Encoding Source #

decodeList ∷ Decoder s [Tx] Source #

type Rep Tx Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

type Rep Tx = D1 ('MetaData "Tx" "Ouroboros.Consensus.Mock.Ledger.UTxO" "ouroboros-consensus-0.25.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "UnsafeTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Expiry) :*: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set TxIn)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TxOut]))))

genesisUtxo ∷ AddrDist → Utxo Source #

type Amount = Word Source #

data Expiry Source #

Constructors

DoNotExpire
ExpireAtOnsetOf !SlotNo

Instances

Instances details

NFData Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

rnf ∷ Expiry → () #

Generic Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Associated Types

type Rep Expiry

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

type Rep Expiry = D1 ('MetaData "Expiry" "Ouroboros.Consensus.Mock.Ledger.UTxO" "ouroboros-consensus-0.25.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "DoNotExpire" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ExpireAtOnsetOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo)))

Methods

from ∷ Expiry → Rep Expiry x #

to ∷ Rep Expiry x → Expiry #

Show Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

showsPrec ∷ Int → Expiry → ShowS #

show ∷ Expiry → String #

showList ∷ [Expiry] → ShowS #

Eq Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

(==) ∷ Expiry → Expiry → Bool #

(/=) ∷ Expiry → Expiry → Bool #

Ord Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

compare ∷ Expiry → Expiry → Ordering #

(<) ∷ Expiry → Expiry → Bool #

(<=) ∷ Expiry → Expiry → Bool #

(>) ∷ Expiry → Expiry → Bool #

(>=) ∷ Expiry → Expiry → Bool #

max ∷ Expiry → Expiry → Expiry #

min ∷ Expiry → Expiry → Expiry #

NoThunks Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

noThunks ∷ Context → Expiry → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Expiry → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy Expiry → String Source #

Condense Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

condense ∷ Expiry → String Source #

Serialise Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

encode ∷ Expiry → Encoding Source #

decode ∷ Decoder s Expiry Source #

encodeList ∷ [Expiry] → Encoding Source #

decodeList ∷ Decoder s [Expiry] Source #

type Rep Expiry Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

type Rep Expiry = D1 ('MetaData "Expiry" "Ouroboros.Consensus.Mock.Ledger.UTxO" "ouroboros-consensus-0.25.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "DoNotExpire" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "ExpireAtOnsetOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo)))

type Utxo = Map TxIn TxOut Source #

class HasMockTxs a where Source #

Methods

getMockTxs ∷ a → [Tx] Source #

The transactions in the order they are to be applied

Instances

Instances details

HasMockTxs SimpleBody Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods getMockTxs ∷ SimpleBody → [Tx] Source #
HasMockTxs Tx Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.UTxO Methods getMockTxs ∷ Tx → [Tx] Source #
HasMockTxs (GenTx (SimpleBlock p c)) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods getMockTxs ∷ GenTx (SimpleBlock p c) → [Tx] Source #
HasMockTxs a ⇒ HasMockTxs (Chain a) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.UTxO Methods getMockTxs ∷ Chain a → [Tx] Source #
HasMockTxs a ⇒ HasMockTxs [a] Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.UTxO Methods getMockTxs ∷ [a] → [Tx] Source #
HasMockTxs (SimpleBlock' c ext ext') Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods getMockTxs ∷ SimpleBlock' c ext ext' → [Tx] Source #

data UtxoError Source #

Constructors

MissingInput TxIn
InputOutputMismatch
Fields Amount Input Amount Output

Instances

Instances details

Generic UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Associated Types

type Rep UtxoError

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

type Rep UtxoError = D1 ('MetaData "UtxoError" "Ouroboros.Consensus.Mock.Ledger.UTxO" "ouroboros-consensus-0.25.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "MissingInput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIn)) :+: C1 ('MetaCons "InputOutputMismatch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Amount) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Amount)))

Methods

from ∷ UtxoError → Rep UtxoError x #

to ∷ Rep UtxoError x → UtxoError #

Show UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

showsPrec ∷ Int → UtxoError → ShowS #

show ∷ UtxoError → String #

showList ∷ [UtxoError] → ShowS #

Eq UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

(==) ∷ UtxoError → UtxoError → Bool #

(/=) ∷ UtxoError → UtxoError → Bool #

NoThunks UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

noThunks ∷ Context → UtxoError → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → UtxoError → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy UtxoError → String Source #

Condense UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

condense ∷ UtxoError → String Source #

Serialise UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

Methods

encode ∷ UtxoError → Encoding Source #

decode ∷ Decoder s UtxoError Source #

encodeList ∷ [UtxoError] → Encoding Source #

decodeList ∷ Decoder s [UtxoError] Source #

type Rep UtxoError Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.UTxO

type Rep UtxoError = D1 ('MetaData "UtxoError" "Ouroboros.Consensus.Mock.Ledger.UTxO" "ouroboros-consensus-0.25.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "MissingInput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIn)) :+: C1 ('MetaCons "InputOutputMismatch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Amount) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Amount)))

confirmed ∷ HasMockTxs a ⇒ a → Set TxId Source #

confirmed stands for all the transaction hashes present in the given collection.

txIns ∷ HasMockTxs a ⇒ a → Set TxIn Source #

txOuts ∷ HasMockTxs a ⇒ a → Utxo Source #

updateUtxo ∷ HasMockTxs a ⇒ a → Utxo → Except UtxoError Utxo Source #

Update the Utxo with the transactions from the given a, by removing the inputs and adding the outputs.

genesisTx ∷ AddrDist → Tx Source #

Transaction giving initial stake to the nodes