dummyfossilizer

Documentation

Overview

Package dummyfossilizer implements a fossilizer that can be used for testing.

It doesn't do much -- it just adds a timestamp.

Index

• Constants
• type Config
• type DummyFossilizer
  • func New(config *Config) *DummyFossilizer
  • func (a *DummyFossilizer) AddFossilizerEventChan(fossilizerEventChan chan *fossilizer.Event)
  • func (a *DummyFossilizer) Fossilize(ctx context.Context, data []byte, meta []byte) error
  • func (a *DummyFossilizer) GetInfo(ctx context.Context) (interface{}, error)
• type DummyProof
  • func (p *DummyProof) FullProof() []byte
  • func (p *DummyProof) Time() uint64
  • func (p *DummyProof) Verify(interface{}) bool
• type Info

Constants

const (
	// Name is the name set in the fossilizer's information.
	Name = "dummy"

	// Description is the description set in the fossilizer's information.
	Description = "Indigo's Dummy Fossilizer"
)

Types

type Config

type Config struct {
	// A version string that will be set in the store's information.
	Version string

	// A git commit hash that will be set in the store's information.
	Commit string
}

Config contains configuration options for the store.

type DummyFossilizer

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

DummyFossilizer is the type that implements github.com/stratumn/go-indigocore/fossilizer.Adapter.

func New

func New(config *Config) *DummyFossilizer

New creates an instance of a DummyFossilizer.

func (*DummyFossilizer) AddFossilizerEventChan

func (a *DummyFossilizer) AddFossilizerEventChan(fossilizerEventChan chan *fossilizer.Event)

AddFossilizerEventChan implements github.com/stratumn/go-indigocore/fossilizer.Adapter.AddFossilizerEventChan.

func (*DummyFossilizer) Fossilize

func (a *DummyFossilizer) Fossilize(ctx context.Context, data []byte, meta []byte) error

Fossilize implements github.com/stratumn/go-indigocore/fossilizer.Adapter.Fossilize.

func (*DummyFossilizer) GetInfo

func (a *DummyFossilizer) GetInfo(ctx context.Context) (interface{}, error)

GetInfo implements github.com/stratumn/go-indigocore/fossilizer.Adapter.GetInfo.

type DummyProof

type DummyProof struct {
	Timestamp uint64 `json:"timestamp"`
}

DummyProof implements the cs.Proof interface

func (*DummyProof) FullProof

func (p *DummyProof) FullProof() []byte

FullProof returns a JSON formatted proof

func (*DummyProof) Time

func (p *DummyProof) Time() uint64

Time returns the timestamp from the block header

func (*DummyProof) Verify

func (p *DummyProof) Verify(interface{}) bool

Verify returns true if the proof of a given linkHash is correct

type Info

type Info struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Version     string `json:"version"`
	Commit      string `json:"commit"`
}

Info is the info returned by GetInfo.