blockchain

Documentation

Index

• Constants
• Variables
• type Address
  • func AddressFromBytes(byteAddr []byte) (Address, error)
  • func AddressFromHex(hex string) (Address, error)
• type Hash
  • func HashFromBytes(b []byte) Hash
• type Header
• type HeadersCache
  • func NewHeadersCache(log *zap.Logger, db HeadersDB) *HeadersCache
  • func (headersCache *HeadersCache) Get(ctx context.Context, client *ethclient.Client, hash Hash) (Header, error)
• type HeadersDB

Constants

const AddrLength = 20

AddrLength is byte length of eth account address.

Variables

var ErrAddrLength = errs.Class(fmt.Sprintf("Address must be %v bytes in length", AddrLength))

ErrAddrLength represents the error that the address is the wrong length.

var (
	// ErrNoHeader is error thrown when there is no header in db.
	ErrNoHeader = errs.New("HeadersDB: header not found")
)

Types

type Address

type Address = common.Address

Address is wallet address on eth chain.

func AddressFromBytes

func AddressFromBytes(byteAddr []byte) (Address, error)

AddressFromBytes creates a new address from hex bytes.

func AddressFromHex

func AddressFromHex(hex string) (Address, error)

AddressFromHex creates new address from hex string.

type Hash

type Hash = common.Hash

Hash represent cryptographic hash.

func HashFromBytes

func HashFromBytes(b []byte) Hash

HashFromBytes creates hash from byte slice.

type Header

type Header struct {
	Hash      Hash
	Number    int64
	Timestamp time.Time
}

Header holds ethereum blockchain block header indexed data. No need to keep number as big.Int right now as block count on ethereum mainnet is far from overflowing int64 capacity.

type HeadersCache

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

HeadersCache cache for blockchain block headers.

func NewHeadersCache

func NewHeadersCache(log *zap.Logger, db HeadersDB) *HeadersCache

NewHeadersCache creates new headers cache.

func (*HeadersCache) Get

func (headersCache *HeadersCache) Get(ctx context.Context, client *ethclient.Client, hash Hash) (Header, error)

Get retrieves block header from cache storage or fetches header from client and caches it. TODO: remove direct dependency on go-eth client from public API.

type HeadersDB

type HeadersDB interface {
	// Insert inserts new header to cache db.
	Insert(ctx context.Context, hash Hash, number int64, timestamp time.Time) error
	// Delete deletes header from db by hash.
	Delete(ctx context.Context, hash Hash) error
	// DeleteBefore deletes headers before the given time.
	DeleteBefore(ctx context.Context, before time.Time) (err error)
	// Get retrieves header by hash.
	Get(ctx context.Context, hash Hash) (Header, error)
	// GetByNumber retrieves header by number.
	GetByNumber(ctx context.Context, number int64) (Header, error)
	// List retrieves all headers stored in cache db.
	List(ctx context.Context) ([]Header, error)
}

HeadersDB is ethereum blockchain block header indexed cache.

architecture: Database