storage

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 20, 2023 License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// DIFFICULTY is the difficulty prefix
	DIFFICULTY = []byte("d")

	// HEADER is the header prefix
	HEADER = []byte("h")

	// HEAD is the chain head prefix
	HEAD = []byte("o")

	// FORK is the entry to store forks
	FORK = []byte("f")

	// CANONICAL is the prefix for the canonical chain numbers
	CANONICAL = []byte("c")

	// BODY is the prefix for bodies
	BODY = []byte("b")

	// RECEIPTS is the prefix for receipts
	RECEIPTS = []byte("r")

	// SNAPSHOTS is the prefix for snapshots
	SNAPSHOTS = []byte("s")

	// TX_LOOKUP_PREFIX is the prefix for transaction lookups
	TX_LOOKUP_PREFIX = []byte("l")
)

Prefixes for the key-value store

View Source 
var (
	HASH   = []byte("hash")
	NUMBER = []byte("number")
	EMPTY  = []byte("empty")
)

Sub-prefixes

View Source 
var ErrNotFound = fmt.Errorf("not found")

Functions

func TestStorage 

func TestStorage(t *testing.T, m PlaceholderStorage)

TestStorage tests a set of tests on a storage

Types

type Factory 

type Factory func(config map[string]interface{}, logger hclog.Logger) (Storage, error)

Factory is a factory method to create a blockchain storage

type Forks 

type Forks []types.Hash

func (*Forks) MarshalRLPTo 

func (f *Forks) MarshalRLPTo(dst []byte) []byte

MarshalRLPTo is a wrapper function for calling the type marshal implementation

func (*Forks) MarshalRLPWith 

func (f *Forks) MarshalRLPWith(ar *fastrlp.Arena) *fastrlp.Value

MarshalRLPWith is the actual RLP marshal implementation for the type

func (*Forks) UnmarshalRLP 

func (f *Forks) UnmarshalRLP(input []byte) error

UnmarshalRLP is a wrapper function for calling the type unmarshal implementation

func (*Forks) UnmarshalRLPFrom 

func (f *Forks) UnmarshalRLPFrom(p *fastrlp.Parser, v *fastrlp.Value) error

UnmarshalRLPFrom is the actual RLP unmarshal implementation for the type

type KV 

type KV interface {
	Close() error
	Set(p []byte, v []byte) error
	Get(p []byte) ([]byte, bool, error)
}

KV is a key value storage interface.

KV = Key-Value

type KeyValueStorage 

type KeyValueStorage struct {
	Db KV
	// contains filtered or unexported fields
}

KeyValueStorage is a generic storage for kv databases

func (*KeyValueStorage) Close 

func (s *KeyValueStorage) Close() error

Close closes the connection with the db

func (*KeyValueStorage) ReadBody 

func (s *KeyValueStorage) ReadBody(hash types.Hash) (*types.Body, error)

ReadBody reads the body

func (*KeyValueStorage) ReadCanonicalHash 

func (s *KeyValueStorage) ReadCanonicalHash(n uint64) (types.Hash, bool)

ReadCanonicalHash gets the hash from the number of the canonical chain

func (*KeyValueStorage) ReadForks 

func (s *KeyValueStorage) ReadForks() ([]types.Hash, error)

ReadForks read the current forks

func (*KeyValueStorage) ReadHeadHash 

func (s *KeyValueStorage) ReadHeadHash() (types.Hash, bool)

ReadHeadHash returns the hash of the head

func (*KeyValueStorage) ReadHeadNumber 

func (s *KeyValueStorage) ReadHeadNumber() (uint64, bool)

ReadHeadNumber returns the number of the head

func (*KeyValueStorage) ReadHeader 

func (s *KeyValueStorage) ReadHeader(hash types.Hash) (*types.Header, error)

ReadHeader reads the header

func (*KeyValueStorage) ReadReceipts 

func (s *KeyValueStorage) ReadReceipts(hash types.Hash) ([]*types.Receipt, error)

ReadReceipts reads the receipts

func (*KeyValueStorage) ReadTotalDifficulty 

func (s *KeyValueStorage) ReadTotalDifficulty(hash types.Hash) (*big.Int, bool)

ReadTotalDifficulty reads the difficulty

func (*KeyValueStorage) ReadTxLookup 

func (s *KeyValueStorage) ReadTxLookup(hash types.Hash) (types.Hash, bool)

ReadTxLookup reads the block hash using the transaction hash

func (*KeyValueStorage) WriteBody 

func (s *KeyValueStorage) WriteBody(hash types.Hash, body *types.Body) error

WriteBody writes the body

func (*KeyValueStorage) WriteCanonicalHash 

func (s *KeyValueStorage) WriteCanonicalHash(n uint64, hash types.Hash) error

WriteCanonicalHash writes a hash for a number block in the canonical chain

func (*KeyValueStorage) WriteCanonicalHeader 

func (s *KeyValueStorage) WriteCanonicalHeader(h *types.Header, diff *big.Int) error

WriteCanonicalHeader implements the storage interface

func (*KeyValueStorage) WriteForks 

func (s *KeyValueStorage) WriteForks(forks []types.Hash) error

WriteForks writes the current forks

func (*KeyValueStorage) WriteHeadHash 

func (s *KeyValueStorage) WriteHeadHash(h types.Hash) error

WriteHeadHash writes the hash of the head

func (*KeyValueStorage) WriteHeadNumber 

func (s *KeyValueStorage) WriteHeadNumber(n uint64) error

WriteHeadNumber writes the number of the head

func (*KeyValueStorage) WriteHeader 

func (s *KeyValueStorage) WriteHeader(h *types.Header) error

WriteHeader writes the header

func (*KeyValueStorage) WriteReceipts 

func (s *KeyValueStorage) WriteReceipts(hash types.Hash, receipts []*types.Receipt) error

WriteReceipts writes the receipts

func (*KeyValueStorage) WriteTotalDifficulty 

func (s *KeyValueStorage) WriteTotalDifficulty(hash types.Hash, diff *big.Int) error

WriteTotalDifficulty writes the difficulty

func (*KeyValueStorage) WriteTxLookup 

func (s *KeyValueStorage) WriteTxLookup(hash types.Hash, blockHash types.Hash) error

WriteTxLookup maps the transaction hash to the block hash

type MockStorage 

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

func NewMockStorage added in v0.4.1 

func NewMockStorage() *MockStorage

func (*MockStorage) Close added in v0.4.1 

func (m *MockStorage) Close() error

func (*MockStorage) HookClose added in v0.4.1 

func (m *MockStorage) HookClose(fn closeDelegate)

func (*MockStorage) HookReadBody added in v0.4.1 

func (m *MockStorage) HookReadBody(fn readBodyDelegate)

func (*MockStorage) HookReadCanonicalHash added in v0.4.1 

func (m *MockStorage) HookReadCanonicalHash(fn readCanonicalHashDelegate)

func (*MockStorage) HookReadForks added in v0.4.1 

func (m *MockStorage) HookReadForks(fn readForksDelegate)

func (*MockStorage) HookReadHeadHash added in v0.4.1 

func (m *MockStorage) HookReadHeadHash(fn readHeadHashDelegate)

func (*MockStorage) HookReadHeadNumber added in v0.4.1 

func (m *MockStorage) HookReadHeadNumber(fn readHeadNumberDelegate)

func (*MockStorage) HookReadHeader added in v0.4.1 

func (m *MockStorage) HookReadHeader(fn readHeaderDelegate)

func (*MockStorage) HookReadReceipts added in v0.4.1 

func (m *MockStorage) HookReadReceipts(fn readReceiptsDelegate)

func (*MockStorage) HookReadTotalDifficulty added in v0.4.1 

func (m *MockStorage) HookReadTotalDifficulty(fn readTotalDifficultyDelegate)

func (*MockStorage) HookReadTxLookup added in v0.4.1 

func (m *MockStorage) HookReadTxLookup(fn readTxLookupDelegate)

func (*MockStorage) HookWriteBody added in v0.4.1 

func (m *MockStorage) HookWriteBody(fn writeBodyDelegate)

func (*MockStorage) HookWriteCanonicalHash added in v0.4.1 

func (m *MockStorage) HookWriteCanonicalHash(fn writeCanonicalHashDelegate)

func (*MockStorage) HookWriteCanonicalHeader added in v0.4.1 

func (m *MockStorage) HookWriteCanonicalHeader(fn writeCanonicalHeaderDelegate)

func (*MockStorage) HookWriteForks added in v0.4.1 

func (m *MockStorage) HookWriteForks(fn writeForksDelegate)

func (*MockStorage) HookWriteHeadHash added in v0.4.1 

func (m *MockStorage) HookWriteHeadHash(fn writeHeadHashDelegate)

func (*MockStorage) HookWriteHeadNumber added in v0.4.1 

func (m *MockStorage) HookWriteHeadNumber(fn writeHeadNumberDelegate)

func (*MockStorage) HookWriteHeader added in v0.4.1 

func (m *MockStorage) HookWriteHeader(fn writeHeaderDelegate)

func (*MockStorage) HookWriteReceipts added in v0.4.1 

func (m *MockStorage) HookWriteReceipts(fn writeReceiptsDelegate)

func (*MockStorage) HookWriteTotalDifficulty added in v0.4.1 

func (m *MockStorage) HookWriteTotalDifficulty(fn writeTotalDifficultyDelegate)

func (*MockStorage) HookWriteTxLookup added in v0.4.1 

func (m *MockStorage) HookWriteTxLookup(fn writeTxLookupDelegate)

func (*MockStorage) ReadBody added in v0.4.1 

func (m *MockStorage) ReadBody(hash types.Hash) (*types.Body, error)

func (*MockStorage) ReadCanonicalHash added in v0.4.1 

func (m *MockStorage) ReadCanonicalHash(n uint64) (types.Hash, bool)

func (*MockStorage) ReadForks added in v0.4.1 

func (m *MockStorage) ReadForks() ([]types.Hash, error)

func (*MockStorage) ReadHeadHash added in v0.4.1 

func (m *MockStorage) ReadHeadHash() (types.Hash, bool)

func (*MockStorage) ReadHeadNumber added in v0.4.1 

func (m *MockStorage) ReadHeadNumber() (uint64, bool)

func (*MockStorage) ReadHeader added in v0.4.1 

func (m *MockStorage) ReadHeader(hash types.Hash) (*types.Header, error)

func (*MockStorage) ReadReceipts added in v0.4.1 

func (m *MockStorage) ReadReceipts(hash types.Hash) ([]*types.Receipt, error)

func (*MockStorage) ReadTotalDifficulty added in v0.4.1 

func (m *MockStorage) ReadTotalDifficulty(hash types.Hash) (*big.Int, bool)

func (*MockStorage) ReadTxLookup added in v0.4.1 

func (m *MockStorage) ReadTxLookup(hash types.Hash) (types.Hash, bool)

func (*MockStorage) WriteBody added in v0.4.1 

func (m *MockStorage) WriteBody(hash types.Hash, body *types.Body) error

func (*MockStorage) WriteCanonicalHash added in v0.4.1 

func (m *MockStorage) WriteCanonicalHash(n uint64, hash types.Hash) error

func (*MockStorage) WriteCanonicalHeader added in v0.4.1 

func (m *MockStorage) WriteCanonicalHeader(h *types.Header, diff *big.Int) error

func (*MockStorage) WriteForks added in v0.4.1 

func (m *MockStorage) WriteForks(forks []types.Hash) error

func (*MockStorage) WriteHeadHash added in v0.4.1 

func (m *MockStorage) WriteHeadHash(h types.Hash) error

func (*MockStorage) WriteHeadNumber added in v0.4.1 

func (m *MockStorage) WriteHeadNumber(n uint64) error

func (*MockStorage) WriteHeader added in v0.4.1 

func (m *MockStorage) WriteHeader(h *types.Header) error

func (*MockStorage) WriteReceipts added in v0.4.1 

func (m *MockStorage) WriteReceipts(hash types.Hash, receipts []*types.Receipt) error

func (*MockStorage) WriteTotalDifficulty added in v0.4.1 

func (m *MockStorage) WriteTotalDifficulty(hash types.Hash, diff *big.Int) error

func (*MockStorage) WriteTxLookup added in v0.4.1 

func (m *MockStorage) WriteTxLookup(hash types.Hash, blockHash types.Hash) error

type PlaceholderStorage added in v0.4.1 

type PlaceholderStorage func(t *testing.T) (Storage, func())

type Storage 

type Storage interface {
	ReadCanonicalHash(n uint64) (types.Hash, bool)
	WriteCanonicalHash(n uint64, hash types.Hash) error

	ReadHeadHash() (types.Hash, bool)
	ReadHeadNumber() (uint64, bool)
	WriteHeadHash(h types.Hash) error
	WriteHeadNumber(uint64) error

	WriteForks(forks []types.Hash) error
	ReadForks() ([]types.Hash, error)

	WriteTotalDifficulty(hash types.Hash, diff *big.Int) error
	ReadTotalDifficulty(hash types.Hash) (*big.Int, bool)

	WriteHeader(h *types.Header) error
	ReadHeader(hash types.Hash) (*types.Header, error)

	WriteCanonicalHeader(h *types.Header, diff *big.Int) error

	WriteBody(hash types.Hash, body *types.Body) error
	ReadBody(hash types.Hash) (*types.Body, error)

	WriteReceipts(hash types.Hash, receipts []*types.Receipt) error
	ReadReceipts(hash types.Hash) ([]*types.Receipt, error)

	WriteTxLookup(hash types.Hash, blockHash types.Hash) error
	ReadTxLookup(hash types.Hash) (types.Hash, bool)

	Close() error
}

Storage is a generic blockchain storage

func NewKeyValueStorage 

func NewKeyValueStorage(logger hclog.Logger, db KV) Storage

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.