types

type BackfillHotPathStats ¶ added in v0.50.0

type BackfillHotPathStats struct {
	Blocks    uint64
	Txs       uint64
	Utxos     uint64
	InputRefs uint64

	BlobTxOffsetWrites   uint64
	BlobUtxoOffsetWrites uint64
	SkippedUtxoOffsets   uint64
	SkippedInputRecovery uint64

	AddressTxs      uint64
	Witnesses       uint64
	Scripts         uint64
	WitnessScripts  uint64
	PlutusData      uint64
	Redeemers       uint64
	UtxoSpends      uint64
	CollateralRets  uint64
	DeleteTxIDs     uint64
	Certificates    uint64
	MetadataLabels  uint64
	PParamUpdates   uint64
	RecoveredInputs uint64

	BlockReadDecode       time.Duration
	OffsetComputation     time.Duration
	BlobOffsetWrites      time.Duration
	SetTransactionBatched time.Duration
	ConsumedInputRecovery time.Duration
	UtxoAddressLookup     time.Duration
	AddressIndex          time.Duration
	FlushBatch            time.Duration
	CheckpointWrites      time.Duration
}

BackfillHotPathStats captures low-overhead interval counters for API-mode Mithril metadata backfill. Callers aggregate these per progress interval so dense and sparse historical ranges can be compared without pprof.

func (s *BackfillHotPathStats) Add(other BackfillHotPathStats)

func (s *BackfillHotPathStats) Reset()

type BlobItem ¶ added in v0.19.0

type BlobItem interface {
	Key() []byte
	ValueCopy(dst []byte) ([]byte, error)
}

BlobItem represents a value returned by an iterator

type BlobIterator ¶ added in v0.19.0

type BlobIterator interface {
	Rewind()
	Seek(prefix []byte)
	Valid() bool
	ValidForPrefix(prefix []byte) bool
	Next()
	Item() BlobItem
	Close()
	Err() error
}

BlobIterator provides key iteration over the blob store.

Important lifecycle constraint: items returned by `Item()` must only be accessed while the underlying transaction used to create the iterator is still active. Implementations may validate transaction state at access time (for example `ValueCopy` may fail if the transaction has been committed or rolled back). Typical usage iterates and accesses item values within the same transaction scope.

type BlobIteratorOptions ¶ added in v0.19.0

type BlobIteratorOptions struct {
	Prefix  []byte
	Reverse bool
}

BlobIteratorOptions configures blob iterator creation

type BlockMetadata ¶ added in v0.20.0

type BlockMetadata struct {
	cbor.StructAsArray
	ID       uint64
	Type     uint
	Height   uint64
	PrevHash []byte
}

BlockMetadata contains metadata for a block stored in blob. IMPORTANT: Field order must remain [ID, Type, Height, PrevHash] because cbor.StructAsArray encodes/decodes by position. Changing the order would break deserialization of existing stored data.

type BlockTombstonedError ¶ added in v0.39.1

type BlockTombstonedError = HistoryExpiredError

type HistoryExpiredError ¶ added in v0.52.0

type HistoryExpiredError struct {
	Slot uint64
	Hash []byte
}

HistoryExpiredError is the typed form of ErrHistoryExpired, returned by blob plugins when GetBlock or iterator ValueCopy observe an expired block. It carries the (slot, hash) so archive-proxy wrappers can resolve it without parsing blob keys — the wrapper extracts it via:

var h *types.HistoryExpiredError
if errors.As(err, &h) { fetchFromArchive(h.Slot, h.Hash) }

func (e *HistoryExpiredError) Error() string

func (e *HistoryExpiredError) Unwrap() error

type MetadataBatchAccumulator ¶ added in v0.45.0

type MetadataBatchAccumulator interface {
	Reset()
}

MetadataBatchAccumulator is an opaque plugin-owned accumulator used by metadata stores that support batched transaction ingestion.

type NodeSettings ¶ added in v0.31.0

type NodeSettings struct {
	StorageMode string
	Network     string
}

NodeSettings holds immutable node configuration that is persisted on first sync and enforced on every subsequent startup.

type NullableHash ¶ added in v0.58.0

type NullableHash []byte

NullableHash is a byte slice that serializes to SQL NULL when empty, rather than to an empty blob. It is used for nullable foreign-key columns that reference transaction(hash) (e.g. utxo.spent_at_tx_id) and are unset until the UTxO is spent/referenced.

Without a custom driver.Valuer, an empty/nil []byte can be bound by some GORM + SQLite driver versions as an empty blob instead of SQL NULL. SQLite enforces FK constraints against an empty blob (no transaction has an empty hash), so such a row fails with SQLITE_CONSTRAINT_FOREIGNKEY (787). This affects every UTxO not yet spent/referenced, including all genesis UTxOs. Returning a nil driver.Value guarantees SQL NULL on every driver version, so the FK is correctly skipped.

func (h *NullableHash) Scan(val any) error

func (h NullableHash) Value() (driver.Value, error)

type Rat ¶

type Rat struct {
	*big.Rat
}

func (r *Rat) Scan(val any) error

func (r Rat) Value() (driver.Value, error)

type SignedURL ¶ added in v0.22.0

type SignedURL struct {
	URL     url.URL
	Expires time.Time
}

SignedURL is a url that has been pre-signed and has an expiration time

type Txn ¶ added in v0.19.0

type Txn interface {
	Commit() error
	Rollback() error
}

Txn is a simple transaction handle for commit/rollback only. Database layer (Txn) coordinates metadata and blob operations separately.

type Uint64 ¶

type Uint64 uint64

func (u *Uint64) Scan(val any) error

func (u Uint64) Value() (driver.Value, error)

type UtxoKey ¶ added in v0.37.0

type UtxoKey struct {
	TxId      []byte
	OutputIdx uint32
}

UtxoKey identifies a UTxO row by its transaction id and output index. Used as a parameter type for batch UTxO operations across the metadata-store interface (e.g. MarkUtxosDeletedAtSlot). The fixed-size UtxoRef in database/cbor_cache.go is for in-memory map keys; this variable-length form matches the byte slices stored on the UTxO row directly.