core

Documentation

Index

• func CalculateDataHash(txx []Transaction) (hash types.Hash, err error)
• type Block
  • func NewBlock(h *Header, tsc []Transaction) (*Block, error)
  • func NewBlockFromHeader(prevHeader *Header, txx []Transaction) (*Block, error)
  • func (b *Block) AddTransaction(tx *Transaction)
  • func (b *Block) Decode(dec Decoder[*Block]) error
  • func (b *Block) Encode(enc Encoder[*Block]) error
  • func (b *Block) Hash(hasher Hasher[*Header]) types.Hash
  • func (b *Block) Sign(privKey crypto.PrivateKey) error
  • func (b *Block) Verify() error
• type BlockChain
  • func NewBlockChain(genesis *Block) (*BlockChain, error)
  • func (bc *BlockChain) AddBlock(b *Block) error
  • func (bc *BlockChain) GetHeader(height uint32) (*Header, error)
  • func (bc *BlockChain) HasBlock(heigh uint32) bool
  • func (bc *BlockChain) Height() uint32
  • func (bc *BlockChain) SetValidator(v Validator)
• type BlockHasher
  • func (BlockHasher) Hash(b *Header) types.Hash
• type BlockValidator
  • func NewBlockValidator(bc *BlockChain) *BlockValidator
  • func (v *BlockValidator) ValidateBlock(b *Block) error
• type Decoder
• type Encoder
• type GobTxDecoder
  • func NewGobDecoder(r io.Reader) *GobTxDecoder
  • func (d *GobTxDecoder) Decode(tx *Transaction) error
• type GobTxEncoder
  • func NewGobEncoder(w io.Writer) *GobTxEncoder
  • func (e *GobTxEncoder) Encode(tx *Transaction) error
• type Hasher
• type Header
  • func (h *Header) Bytes() []byte
• type MemoryStore
  • func NewMemStore() *MemoryStore
  • func (ms *MemoryStore) Put(b *Block) error
• type Storage
• type Transaction
  • func NewTransaction(data []byte) *Transaction
  • func (tx *Transaction) Decode(dec Decoder[*Transaction]) error
  • func (tx *Transaction) Encode(enc Encoder[*Transaction]) error
  • func (tx *Transaction) GetFirstSeen() int64
  • func (tx *Transaction) Hash(h Hasher[*Transaction]) types.Hash
  • func (tx *Transaction) SetFirstSeen(t int64)
  • func (tx *Transaction) Sign(privKey crypto.PrivateKey) error
  • func (tx *Transaction) Verify() error
• type TxHasher
  • func (TxHasher) Hash(tx *Transaction) types.Hash
• type Validator

Functions

func CalculateDataHash

func CalculateDataHash(txx []Transaction) (hash types.Hash, err error)

Types

type Block

type Block struct {
	*Header
	Transactions []Transaction
	Validator    crypto.PublicKey
	Signature    *crypto.Signature
	// contains filtered or unexported fields
}

Hold the transactions and the header information

func NewBlock

func NewBlock(h *Header, tsc []Transaction) (*Block, error)

func NewBlockFromHeader

func NewBlockFromHeader(prevHeader *Header, txx []Transaction) (*Block, error)

func (*Block) AddTransaction

func (b *Block) AddTransaction(tx *Transaction)

func (*Block) Decode

func (b *Block) Decode(dec Decoder[*Block]) error

func (*Block) Encode

func (b *Block) Encode(enc Encoder[*Block]) error

func (*Block) Hash

func (b *Block) Hash(hasher Hasher[*Header]) types.Hash

func (*Block) Sign

func (b *Block) Sign(privKey crypto.PrivateKey) error

func (*Block) Verify

func (b *Block) Verify() error

type BlockChain

type BlockChain struct {
	Store     Storage
	Lock      sync.RWMutex
	Headers   []*Header
	Validator Validator
}

func NewBlockChain

func NewBlockChain(genesis *Block) (*BlockChain, error)

func (*BlockChain) AddBlock

func (bc *BlockChain) AddBlock(b *Block) error

func (*BlockChain) GetHeader

func (bc *BlockChain) GetHeader(height uint32) (*Header, error)

func (*BlockChain) HasBlock

func (bc *BlockChain) HasBlock(heigh uint32) bool

func (*BlockChain) Height

func (bc *BlockChain) Height() uint32

[g, 1, 2, 3] = len 4 ; heigh = 3

func (*BlockChain) SetValidator

func (bc *BlockChain) SetValidator(v Validator)

type BlockHasher

type BlockHasher struct{}

func (BlockHasher) Hash

func (BlockHasher) Hash(b *Header) types.Hash

type BlockValidator

type BlockValidator struct {
	Bc *BlockChain
}

func NewBlockValidator

func NewBlockValidator(bc *BlockChain) *BlockValidator

func (*BlockValidator) ValidateBlock

func (v *BlockValidator) ValidateBlock(b *Block) error

type Decoder

type Decoder[T any] interface {
	Decode(T) error
}

type Encoder

type Encoder[T any] interface {
	Encode(T) error
}

type GobTxDecoder

type GobTxDecoder struct {
	R io.Reader
}

func NewGobDecoder

func NewGobDecoder(r io.Reader) *GobTxDecoder

func (*GobTxDecoder) Decode

func (d *GobTxDecoder) Decode(tx *Transaction) error

type GobTxEncoder

type GobTxEncoder struct {
	W io.Writer
}

func NewGobEncoder

func NewGobEncoder(w io.Writer) *GobTxEncoder

func (*GobTxEncoder) Encode

func (e *GobTxEncoder) Encode(tx *Transaction) error

type Hasher

type Hasher[T any] interface {
	Hash(T) types.Hash
}

type Header

type Header struct {
	Version       uint32
	PrevBlockHash types.Hash
	Timestamp     uint64
	Height        uint32
	DataHash      types.Hash
}

To save space we just hash the header

func (*Header) Bytes

func (h *Header) Bytes() []byte

type MemoryStore

type MemoryStore struct{}

func NewMemStore

func NewMemStore() *MemoryStore

func (*MemoryStore) Put

func (ms *MemoryStore) Put(b *Block) error

type Storage

type Storage interface {
	Put(*Block) error
}

type Transaction

type Transaction struct {
	Data []byte

	From      crypto.PublicKey
	Signature *crypto.Signature

	//cached version of tx data hash
	CacheHash types.Hash
	// firstSeen is the tmiestamp of when this tx is first seen localy
	FirstSeen int64
}

func NewTransaction

func NewTransaction(data []byte) *Transaction

func (*Transaction) Decode

func (tx *Transaction) Decode(dec Decoder[*Transaction]) error

func (*Transaction) Encode

func (tx *Transaction) Encode(enc Encoder[*Transaction]) error

func (*Transaction) GetFirstSeen

func (tx *Transaction) GetFirstSeen() int64

get firstSeen

func (*Transaction) Hash

func (tx *Transaction) Hash(h Hasher[*Transaction]) types.Hash

func (*Transaction) SetFirstSeen

func (tx *Transaction) SetFirstSeen(t int64)

set firstSeen

func (*Transaction) Sign

func (tx *Transaction) Sign(privKey crypto.PrivateKey) error

func (*Transaction) Verify

func (tx *Transaction) Verify() error

type TxHasher

type TxHasher struct {
}

func (TxHasher) Hash

func (TxHasher) Hash(tx *Transaction) types.Hash

type Validator

type Validator interface {
	ValidateBlock(*Block) error
}