database

Documentation

Index

• Constants
• Variables
• type Conflict
• type Database
  • func New(ctx context.Context, log *logger.Logger, tangleDatabasePath string, ...) (*Database, error)
  • func (db *Database) ChildrenMessageIDs(messageID hornet.MessageID, maxResults int) (hornet.MessageIDs, error)
  • func (db *Database) CloseDatabases() error
  • func (db *Database) ConflictingTransactionsMessageIDs(address iotago.Address, maxResults ...int) (hornet.MessageIDs, error)
  • func (db *Database) IndexMessageIDs(index []byte, maxResults int) (hornet.MessageIDs, error)
  • func (db *Database) LatestSyncState() *SyncState
  • func (db *Database) MessageMetadataOrNil(messageID hornet.MessageID) *MessageMetadata
  • func (db *Database) MessageOrNil(messageID hornet.MessageID) *Message
  • func (db *Database) MilestoneOrNil(milestoneIndex milestone.Index) *Milestone
  • func (db *Database) MilestoneTimestampUnixByIndex(milestoneIndex milestone.Index) (int64, error)
  • func (db *Database) PrintSnapshotInfo()
  • func (db *Database) UTXOManager() *utxo.Manager
• type Message
  • func (msg *Message) Data() []byte
  • func (msg *Message) Message() *iotago.Message
  • func (msg *Message) Milestone() *iotago.Milestone
  • func (msg *Message) Transaction() *iotago.Transaction
  • func (msg *Message) TransactionEssence() *iotago.TransactionEssence
• type MessageMetadata
  • func (m *MessageMetadata) Conflict() Conflict
  • func (m *MessageMetadata) IsConflictingTx() bool
  • func (m *MessageMetadata) IsIncludedTxInLedger() bool
  • func (m *MessageMetadata) IsMilestone() bool
  • func (m *MessageMetadata) IsNoTransaction() bool
  • func (m *MessageMetadata) IsReferenced() bool
  • func (m *MessageMetadata) IsSolid() bool
  • func (m *MessageMetadata) MessageID() hornet.MessageID
  • func (m *MessageMetadata) Metadata() byte
  • func (m *MessageMetadata) Parents() hornet.MessageIDs
  • func (m *MessageMetadata) ReferencedWithIndex() (bool, milestone.Index)
• type Milestone
• type SnapshotInfo
• type SyncState

Constants

const (
	StorePrefixMessages             byte = 1
	StorePrefixMessageMetadata      byte = 2
	StorePrefixMilestones           byte = 3
	StorePrefixChildren             byte = 4
	StorePrefixSnapshot             byte = 5
	StorePrefixUnreferencedMessages byte = 6
	StorePrefixIndexation           byte = 7
	//nolint:godot,gocritic
	//StorePrefixUTXODeprecated          byte = 8
	StorePrefixConflictingTransactions byte = 9
	StorePrefixHealth                  byte = 255
)

const (
	MessageMetadataSolid         = 0
	MessageMetadataReferenced    = 1
	MessageMetadataNoTx          = 2
	MessageMetadataConflictingTx = 3
	MessageMetadataMilestone     = 4
)

const (
	// ConflictNone the message has no conflict.
	ConflictNone Conflict = iota

	// ConflictInputUTXOAlreadySpent the referenced UTXO was already spent.
	ConflictInputUTXOAlreadySpent = 1

	// ConflictInputUTXOAlreadySpentInThisMilestone the referenced UTXO was already spent while confirming this milestone.
	ConflictInputUTXOAlreadySpentInThisMilestone = 2

	// ConflictInputUTXONotFound the referenced UTXO cannot be found.
	ConflictInputUTXONotFound = 3

	// ConflictInputOutputSumMismatch the sum of the inputs and output values does not match.
	ConflictInputOutputSumMismatch = 4

	// ConflictInvalidSignature the unlock block signature is invalid.
	ConflictInvalidSignature = 5

	// ConflictInvalidDustAllowance the dust allowance for the address is invalid.
	ConflictInvalidDustAllowance = 6

	// ConflictSemanticValidationFailed the semantic validation failed.
	ConflictSemanticValidationFailed = 255
)

const (
	DBVersion = 1
)

const (
	IndexationIndexLength = 64
)

Variables

var (
	ErrMilestoneNotFound = errors.New("milestone not found")
)

var (
	// ErrOperationAborted is returned when the operation was aborted e.g. by a shutdown signal.
	ErrOperationAborted = errors.New("operation was aborted")
)

var (
	ErrParseSnapshotInfoFailed = errors.New("Parsing of snapshot info failed")
)

Types

type Conflict

type Conflict uint8

Conflict defines the reason why a message is marked as conflicting.

type Database

type Database struct {
	*logger.WrappedLogger
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, log *logger.Logger, tangleDatabasePath string, utxoDatabasePath string, networkID uint64, skipHealthCheck bool) (*Database, error)

func (*Database) ChildrenMessageIDs

func (db *Database) ChildrenMessageIDs(messageID hornet.MessageID, maxResults int) (hornet.MessageIDs, error)

ChildrenMessageIDs returns the message IDs of the children of the given message.

func (*Database) CloseDatabases

func (db *Database) CloseDatabases() error

func (*Database) ConflictingTransactionsMessageIDs

func (db *Database) ConflictingTransactionsMessageIDs(address iotago.Address, maxResults ...int) (hornet.MessageIDs, error)

ConflictingTransactionsMessageIDs returns the message IDs of conflicting transactions of the given address.

func (*Database) IndexMessageIDs

func (db *Database) IndexMessageIDs(index []byte, maxResults int) (hornet.MessageIDs, error)

IndexMessageIDs returns all known message IDs for the given index.

func (*Database) LatestSyncState

func (db *Database) LatestSyncState() *SyncState

func (*Database) MessageMetadataOrNil

func (db *Database) MessageMetadataOrNil(messageID hornet.MessageID) *MessageMetadata

MessageMetadataOrNil returns a metadata object.

func (*Database) MessageOrNil

func (db *Database) MessageOrNil(messageID hornet.MessageID) *Message

MessageOrNil returns a message object.

func (*Database) MilestoneOrNil

func (db *Database) MilestoneOrNil(milestoneIndex milestone.Index) *Milestone

MilestoneOrNil returns a milestone object.

func (*Database) MilestoneTimestampUnixByIndex

func (db *Database) MilestoneTimestampUnixByIndex(milestoneIndex milestone.Index) (int64, error)

MilestoneTimestampUnixByIndex returns the unix timestamp of a milestone.

func (*Database) PrintSnapshotInfo

func (db *Database) PrintSnapshotInfo()

func (*Database) UTXOManager

func (db *Database) UTXOManager() *utxo.Manager

type Message

type Message struct {
	objectstorage.StorableObjectFlags
	// contains filtered or unexported fields
}

func (*Message) Data

func (msg *Message) Data() []byte

func (*Message) Message

func (msg *Message) Message() *iotago.Message

func (*Message) Milestone

func (msg *Message) Milestone() *iotago.Milestone

func (*Message) Transaction

func (msg *Message) Transaction() *iotago.Transaction

func (*Message) TransactionEssence

func (msg *Message) TransactionEssence() *iotago.TransactionEssence

type MessageMetadata

type MessageMetadata struct {
	// contains filtered or unexported fields
}

func (*MessageMetadata) Conflict

func (m *MessageMetadata) Conflict() Conflict

func (*MessageMetadata) IsConflictingTx

func (m *MessageMetadata) IsConflictingTx() bool

func (*MessageMetadata) IsIncludedTxInLedger

func (m *MessageMetadata) IsIncludedTxInLedger() bool

func (*MessageMetadata) IsMilestone

func (m *MessageMetadata) IsMilestone() bool

func (*MessageMetadata) IsNoTransaction

func (m *MessageMetadata) IsNoTransaction() bool

func (*MessageMetadata) IsReferenced

func (m *MessageMetadata) IsReferenced() bool

func (*MessageMetadata) IsSolid

func (m *MessageMetadata) IsSolid() bool

func (*MessageMetadata) MessageID

func (m *MessageMetadata) MessageID() hornet.MessageID

func (*MessageMetadata) Metadata

func (m *MessageMetadata) Metadata() byte

func (*MessageMetadata) Parents

func (m *MessageMetadata) Parents() hornet.MessageIDs

func (*MessageMetadata) ReferencedWithIndex

func (m *MessageMetadata) ReferencedWithIndex() (bool, milestone.Index)

type Milestone

type Milestone struct {
	Index     milestone.Index
	MessageID hornet.MessageID
	Timestamp time.Time
}

type SnapshotInfo

type SnapshotInfo struct {
	NetworkID       uint64
	SnapshotIndex   milestone.Index
	EntryPointIndex milestone.Index
	PruningIndex    milestone.Index
	Timestamp       time.Time
	Metadata        bitmask.BitMask
}

type SyncState

type SyncState struct {
	LatestMilestoneIndex     milestone.Index
	LatestMilestoneTimestamp int64
	ConfirmedMilestoneIndex  milestone.Index
	PruningIndex             milestone.Index
}