ledger

package

Go to main page

Versions in this module

v0

v0.9.3

Jul 19, 2022

v0.9.2

Jul 14, 2022

Changes in this version

+ type EpochDiff struct

+ func NewEpochDiff(spent []*OutputWithMetadata, created []*OutputWithMetadata) (new *EpochDiff)

+ func (e *EpochDiff) Created() []*OutputWithMetadata

+ func (e *EpochDiff) Spent() []*OutputWithMetadata

type Events

+ TransactionAccepted *event.Event[*TransactionAcceptedEvent]

+ TransactionConflictIDUpdated *event.Event[*TransactionConflictIDUpdatedEvent]

type OutputMetadata

+ func (o *OutputMetadata) AccessManaPledgeID() (id identity.ID)

+ func (o *OutputMetadata) ConfirmationState() (confirmationState confirmation.State)

+ func (o *OutputMetadata) ConfirmationStateTime() (confirmationState time.Time)

+ func (o *OutputMetadata) ConflictIDs() (conflictIDs *set.AdvancedSet[utxo.TransactionID])

+ func (o *OutputMetadata) SetAccessManaPledgeID(id identity.ID) (updated bool)

+ func (o *OutputMetadata) SetConfirmationState(confirmationState confirmation.State) (modified bool)

+ func (o *OutputMetadata) SetConflictIDs(conflictIDs *set.AdvancedSet[utxo.TransactionID]) (modified bool)

+ type OutputWithMetadata struct

+ func NewOutputWithMetadata(outputID utxo.OutputID, output utxo.Output, creationTime time.Time, ...) (new *OutputWithMetadata)

+ func (o *OutputWithMetadata) AccessManaPledgeID() (consensuPledgeID identity.ID)

+ func (o *OutputWithMetadata) ConsensusManaPledgeID() (consensuPledgeID identity.ID)

+ func (o *OutputWithMetadata) CreationTime() (creationTime time.Time)

+ func (o *OutputWithMetadata) FromBytes(data []byte) error

+ func (o *OutputWithMetadata) FromObjectStorage(key, value []byte) error

+ func (o *OutputWithMetadata) Output() (output utxo.Output)

+ func (o *OutputWithMetadata) SetAccessManaPledgeID(accessPledgeID identity.ID)

+ func (o *OutputWithMetadata) SetConsensusManaPledgeID(consensusPledgeID identity.ID)

+ func (o *OutputWithMetadata) SetCreationTime(creationTime time.Time)

+ func (o *OutputWithMetadata) SetOutput(output utxo.Output)

+ func (o *OutputWithMetadata) String() string

type OutputsMetadata

+ func (o *OutputsMetadata) ConflictIDs() (conflictIDs *set.AdvancedSet[utxo.TransactionID])

type Snapshot

+ DiffEpochIndex epoch.Index

+ EpochDiffs map[epoch.Index]*EpochDiff

+ FullEpochIndex epoch.Index

+ LatestECRecord *epoch.ECRecord

+ OutputsWithMetadata []*OutputWithMetadata

type TestFramework

+ func (t *TestFramework) AssertConflictIDs(expectedConflicts map[string][]string)

+ func (t *TestFramework) ConflictIDs(txAliases ...string) (conflictIDs *set.AdvancedSet[utxo.TransactionID])

+ func (t *TestFramework) ConsumeConflict(conflictID utxo.TransactionID, ...)

+ type TransactionAcceptedEvent struct

+ TransactionID utxo.TransactionID

+ type TransactionConflictIDUpdatedEvent struct

+ AddedConflictID utxo.TransactionID

+ Context context.Context

+ RemovedConflictIDs *set.AdvancedSet[utxo.TransactionID]

+ TransactionID utxo.TransactionID

type TransactionMetadata

+ func (t *TransactionMetadata) ConfirmationState() (confirmationState confirmation.State)

+ func (t *TransactionMetadata) ConfirmationStateTime() (confirmationStateTime time.Time)

+ func (t *TransactionMetadata) ConflictIDs() (conflictIDs *set.AdvancedSet[utxo.TransactionID])

+ func (t *TransactionMetadata) SetConfirmationState(confirmationState confirmation.State) (modified bool)

+ func (t *TransactionMetadata) SetConflictIDs(conflictIDs *set.AdvancedSet[utxo.TransactionID]) (modified bool)

type Utils

+ func (u *Utils) ConflictIDsInFutureCone(conflictIDs utxo.TransactionIDs) (conflictIDsInFutureCone utxo.TransactionIDs)

+ func (u *Utils) OutputConfirmationState(outputID utxo.OutputID) (confirmationState confirmation.State)

+ func (u *Utils) TransactionConfirmationState(txID utxo.TransactionID) (confirmationState confirmation.State)

+ func (u *Utils) TransactionConflictIDs(txID utxo.TransactionID) (conflictIDs *set.AdvancedSet[utxo.TransactionID], err error)

v0.9.1

Jun 22, 2022

v0.9.0

Jun 16, 2022

Changes in this version

+ const PrefixConsumerStorage

+ const PrefixOutputMetadataStorage

+ const PrefixOutputStorage

+ const PrefixTransactionMetadataStorage

+ const PrefixTransactionStorage

+ var ErrTransactionInvalid = errors.New("transaction invalid")

+ var ErrTransactionUnsolid = errors.New("transaction unsolid")

+ type Consumer struct

+ func NewConsumer(consumedInput utxo.OutputID, transactionID utxo.TransactionID) (new *Consumer)

+ func (c *Consumer) ConsumedInput() (outputID utxo.OutputID)

+ func (c *Consumer) IsBooked() (processed bool)

+ func (c *Consumer) SetBooked() (updated bool)

+ func (c *Consumer) TransactionID() (spendingTransaction utxo.TransactionID)

+ type Events struct

+ Error *event.Event[error]

+ TransactionBooked *event.Event[*TransactionBookedEvent]

+ TransactionBranchIDUpdated *event.Event[*TransactionBranchIDUpdatedEvent]

+ TransactionConfirmed *event.Event[*TransactionConfirmedEvent]

+ TransactionForked *event.Event[*TransactionForkedEvent]

+ TransactionInclusionUpdated *event.Event[*TransactionInclusionUpdatedEvent]

+ TransactionInvalid *event.Event[*TransactionInvalidEvent]

+ TransactionRejected *event.Event[*TransactionRejectedEvent]

+ TransactionStored *event.Event[*TransactionStoredEvent]

+ type Ledger struct

+ ConflictDAG *conflictdag.ConflictDAG[utxo.TransactionID, utxo.OutputID]

+ Events *Events

+ Storage *Storage

+ Utils *Utils

+ func New(options ...Option) (ledger *Ledger)

+ func (l *Ledger) CheckTransaction(ctx context.Context, tx utxo.Transaction) (err error)

+ func (l *Ledger) LoadSnapshot(snapshot *Snapshot)

+ func (l *Ledger) PruneTransaction(txID utxo.TransactionID, pruneFutureCone bool)

+ func (l *Ledger) SetTransactionInclusionTime(txID utxo.TransactionID, inclusionTime time.Time)

+ func (l *Ledger) Shutdown()

+ func (l *Ledger) StoreAndProcessTransaction(ctx context.Context, tx utxo.Transaction) (err error)

+ func (l *Ledger) TakeSnapshot() (snapshot *Snapshot)

+ type MockedInput struct

+ OutputID utxo.OutputID

+ func NewMockedInput(outputID utxo.OutputID) (new *MockedInput)

+ func (m *MockedInput) String() (humanReadable string)

+ type MockedOutput struct

+ func NewMockedOutput(txID utxo.TransactionID, index uint16) (out *MockedOutput)

+ type MockedTransaction struct

+ func NewMockedTransaction(inputs []*MockedInput, outputCount uint16) (tx *MockedTransaction)

+ func (m *MockedTransaction) Inputs() (inputs []utxo.Input)

+ type MockedVM struct

+ func NewMockedVM() *MockedVM

+ func (m *MockedVM) ExecuteTransaction(transaction utxo.Transaction, _ *utxo.Outputs, _ ...uint64) (outputs []utxo.Output, err error)

+ func (m *MockedVM) ParseOutput(outputBytes []byte) (output utxo.Output, err error)

+ func (m *MockedVM) ParseTransaction(transactionBytes []byte) (transaction utxo.Transaction, err error)

+ func (m *MockedVM) ResolveInput(input utxo.Input) (outputID utxo.OutputID)

+ type Option func(*options)

+ func WithCacheTimeProvider(cacheTimeProvider *database.CacheTimeProvider) (option Option)

+ func WithConflictDAGOptions(branchDAGOptions ...conflictdag.Option) (option Option)

+ func WithConsumerCacheTime(consumerCacheTime time.Duration) (option Option)

+ func WithOutputCacheTime(outputCacheTime time.Duration) (option Option)

+ func WithOutputMetadataCacheTime(outputMetadataCacheTime time.Duration) (option Option)

+ func WithStore(store kvstore.KVStore) (option Option)

+ func WithTransactionCacheTime(transactionCacheTime time.Duration) (option Option)

+ func WithTransactionMetadataCacheTime(transactionMetadataCacheTime time.Duration) (option Option)

+ func WithVM(vm vm.VM) (option Option)

+ type OutputMetadata struct

+ func NewOutputMetadata(outputID utxo.OutputID) (new *OutputMetadata)

+ func (o *OutputMetadata) BranchIDs() (branchIDs *set.AdvancedSet[utxo.TransactionID])

+ func (o *OutputMetadata) ConsensusManaPledgeID() (id identity.ID)

+ func (o *OutputMetadata) CreationTime() (creationTime time.Time)

+ func (o *OutputMetadata) FirstConsumer() (firstConsumer utxo.TransactionID)

+ func (o *OutputMetadata) GradeOfFinality() (gradeOfFinality gof.GradeOfFinality)

+ func (o *OutputMetadata) GradeOfFinalityTime() (gradeOfFinality time.Time)

+ func (o *OutputMetadata) IsSpent() (isSpent bool)

+ func (o *OutputMetadata) RegisterBookedConsumer(consumer utxo.TransactionID) (isConflicting bool, consumerToFork utxo.TransactionID)

+ func (o *OutputMetadata) SetBranchIDs(branchIDs *set.AdvancedSet[utxo.TransactionID]) (modified bool)

+ func (o *OutputMetadata) SetConsensusManaPledgeID(id identity.ID) (updated bool)

+ func (o *OutputMetadata) SetCreationTime(creationTime time.Time) (updated bool)

+ func (o *OutputMetadata) SetGradeOfFinality(gradeOfFinality gof.GradeOfFinality) (modified bool)

+ type OutputsMetadata struct

+ func NewOutputsMetadata(outputsMetadata ...*OutputMetadata) (new *OutputsMetadata)

+ func (o *OutputsMetadata) Add(output *OutputMetadata) (added bool)

+ func (o *OutputsMetadata) BranchIDs() (branchIDs *set.AdvancedSet[utxo.TransactionID])

+ func (o *OutputsMetadata) Filter(predicate func(outputMetadata *OutputMetadata) bool) (filtered *OutputsMetadata)

+ func (o *OutputsMetadata) ForEach(callback func(outputMetadata *OutputMetadata) error) (err error)

+ func (o *OutputsMetadata) Get(id utxo.OutputID) (outputMetadata *OutputMetadata, exists bool)

+ func (o *OutputsMetadata) IDs() (ids utxo.OutputIDs)

+ func (o *OutputsMetadata) String() (humanReadable string)

+ type Snapshot struct

+ Outputs *utxo.Outputs

+ OutputsMetadata *OutputsMetadata

+ func NewSnapshot(outputs *utxo.Outputs, outputsMetadata *OutputsMetadata) (new *Snapshot)

+ func (s *Snapshot) String() (humanReadable string)

+ type Storage struct

+ func (s *Storage) CachedConsumer(outputID utxo.OutputID, txID utxo.TransactionID, ...) (cachedConsumer *objectstorage.CachedObject[*Consumer])

+ func (s *Storage) CachedConsumers(outputID utxo.OutputID) (cachedConsumers objectstorage.CachedObjects[*Consumer])

+ func (s *Storage) CachedOutput(outputID utxo.OutputID, ...) (cachedOutput *objectstorage.CachedObject[utxo.Output])

+ func (s *Storage) CachedOutputMetadata(outputID utxo.OutputID, ...) (cachedOutputMetadata *objectstorage.CachedObject[*OutputMetadata])

+ func (s *Storage) CachedOutputs(outputIDs utxo.OutputIDs) (cachedOutputs objectstorage.CachedObjects[utxo.Output])

+ func (s *Storage) CachedOutputsMetadata(outputIDs utxo.OutputIDs) (cachedOutputsMetadata objectstorage.CachedObjects[*OutputMetadata])

+ func (s *Storage) CachedTransaction(transactionID utxo.TransactionID, ...) (cachedTransaction *objectstorage.CachedObject[utxo.Transaction])

+ func (s *Storage) CachedTransactionMetadata(transactionID utxo.TransactionID, ...) (cachedTransactionMetadata *objectstorage.CachedObject[*TransactionMetadata])

+ func (s *Storage) Prune() (err error)

+ func (s *Storage) Shutdown()

+ type TestFramework struct

+ func NewTestFramework(t *testing.T, options ...Option) (new *TestFramework)

+ func (t *TestFramework) AllBooked(txAliases ...string) (allBooked bool)

+ func (t *TestFramework) AssertBooked(expectedBookedMap map[string]bool)

+ func (t *TestFramework) AssertBranchIDs(expectedBranches map[string][]string)

+ func (t *TestFramework) AssertConflictDAG(expectedParents map[string][]string)

+ func (t *TestFramework) AssertConflicts(expectedConflictsAliases map[string][]string)

+ func (t *TestFramework) BranchIDs(txAliases ...string) (branchIDs *set.AdvancedSet[utxo.TransactionID])

+ func (t *TestFramework) ConsumeBranch(branchID utxo.TransactionID, ...)

+ func (t *TestFramework) ConsumeOutput(outputID utxo.OutputID, consumer func(output utxo.Output))

+ func (t *TestFramework) ConsumeOutputMetadata(outputID utxo.OutputID, consumer func(outputMetadata *OutputMetadata))

+ func (t *TestFramework) ConsumeTransactionMetadata(txID utxo.TransactionID, consumer func(txMetadata *TransactionMetadata))

+ func (t *TestFramework) ConsumeTransactionOutputs(mockTx *MockedTransaction, consumer func(outputMetadata *OutputMetadata))

+ func (t *TestFramework) CreateTransaction(txAlias string, outputCount uint16, inputAliases ...string)

+ func (t *TestFramework) IssueTransaction(txAlias string) (err error)

+ func (t *TestFramework) MockOutputFromTx(tx *MockedTransaction, outputIndex uint16) (mockedOutputID utxo.OutputID)

+ func (t *TestFramework) OutputID(alias string) (outputID utxo.OutputID)

+ func (t *TestFramework) Transaction(txAlias string) (tx *MockedTransaction)

+ func (t *TestFramework) TransactionIDs(txAliases ...string) (txIDs utxo.TransactionIDs)

+ func (t *TestFramework) WaitUntilAllTasksProcessed() (self *TestFramework)

+ type TransactionBookedEvent struct

+ Context context.Context

+ Outputs *utxo.Outputs

+ TransactionID utxo.TransactionID

+ type TransactionBranchIDUpdatedEvent struct

+ AddedBranchID utxo.TransactionID

+ Context context.Context

+ RemovedBranchIDs *set.AdvancedSet[utxo.TransactionID]

+ TransactionID utxo.TransactionID

+ type TransactionConfirmedEvent struct

+ TransactionID utxo.TransactionID

+ type TransactionForkedEvent struct

+ Context context.Context

+ ParentConflicts *set.AdvancedSet[utxo.TransactionID]

+ TransactionID utxo.TransactionID

+ type TransactionInclusionUpdatedEvent struct

+ InclusionTime time.Time

+ PreviousInclusionTime time.Time

+ TransactionID utxo.TransactionID

+ type TransactionInvalidEvent struct

+ Context context.Context

+ Reason error

+ TransactionID utxo.TransactionID

+ type TransactionMetadata struct

+ func NewTransactionMetadata(txID utxo.TransactionID) (new *TransactionMetadata)

+ func (t *TransactionMetadata) BookingTime() (bookingTime time.Time)

+ func (t *TransactionMetadata) BranchIDs() (branchIDs *set.AdvancedSet[utxo.TransactionID])

+ func (t *TransactionMetadata) GradeOfFinality() (gradeOfFinality gof.GradeOfFinality)

+ func (t *TransactionMetadata) GradeOfFinalityTime() (gradeOfFinalityTime time.Time)

+ func (t *TransactionMetadata) InclusionTime() (inclusionTime time.Time)

+ func (t *TransactionMetadata) IsBooked() (booked bool)

+ func (t *TransactionMetadata) IsConflicting() (isConflicting bool)

+ func (t *TransactionMetadata) OutputIDs() (outputIDs utxo.OutputIDs)

+ func (t *TransactionMetadata) SetBooked(booked bool) (modified bool)

+ func (t *TransactionMetadata) SetBranchIDs(branchIDs *set.AdvancedSet[utxo.TransactionID]) (modified bool)

+ func (t *TransactionMetadata) SetGradeOfFinality(gradeOfFinality gof.GradeOfFinality) (modified bool)

+ func (t *TransactionMetadata) SetInclusionTime(inclusionTime time.Time) (updated bool, previousInclusionTime time.Time)

+ func (t *TransactionMetadata) SetOutputIDs(outputIDs utxo.OutputIDs) (modified bool)

+ type TransactionRejectedEvent struct

+ TransactionID utxo.TransactionID

+ type TransactionStoredEvent struct

+ TransactionID utxo.TransactionID

+ type Utils struct

+ func (u *Utils) BranchGradeOfFinality(branchID utxo.TransactionID) (gradeOfFinality gof.GradeOfFinality, err error)

+ func (u *Utils) BranchIDsInFutureCone(branchIDs utxo.TransactionIDs) (branchIDsInFutureCone utxo.TransactionIDs)

+ func (u *Utils) ConflictingTransactions(transactionID utxo.TransactionID) (conflictingTransactions utxo.TransactionIDs)

+ func (u *Utils) ReferencedTransactions(tx utxo.Transaction) (transactionIDs utxo.TransactionIDs)

+ func (u *Utils) ResolveInputs(inputs []utxo.Input) (outputIDs utxo.OutputIDs)

+ func (u *Utils) TransactionBranchIDs(txID utxo.TransactionID) (branchIDs *set.AdvancedSet[utxo.TransactionID], err error)

+ func (u *Utils) TransactionGradeOfFinality(txID utxo.TransactionID) (gradeOfFinality gof.GradeOfFinality, err error)

+ func (u *Utils) UnprocessedConsumingTransactions(outputIDs utxo.OutputIDs) (consumingTransactions utxo.TransactionIDs)

+ func (u *Utils) WalkConsumingTransactionID(entryPoints utxo.OutputIDs, ...)

+ func (u *Utils) WalkConsumingTransactionMetadata(entryPoints utxo.OutputIDs, ...)

+ func (u *Utils) WithTransactionAndMetadata(txID utxo.TransactionID, ...)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL