db

Documentation

Index

• Variables
• type AddLeafStatus
• type Client
  • func NewMemoryDb() Client
• type MemoryDb
  • func (db *MemoryDb) AddLeaf(_ context.Context, leaf *types.Leaf, treeSize uint64) (AddLeafStatus, error)
  • func (db *MemoryDb) AddSequencedLeaves(_ context.Context, leaves []types.Leaf, index int64) error
  • func (db *MemoryDb) GetConsistencyProof(_ context.Context, req *requests.ConsistencyProof) (types.ConsistencyProof, error)
  • func (db *MemoryDb) GetInclusionProof(_ context.Context, req *requests.InclusionProof) (types.InclusionProof, error)
  • func (db *MemoryDb) GetLeaves(_ context.Context, req *requests.Leaves) ([]types.Leaf, error)
  • func (db *MemoryDb) GetTreeHead(_ context.Context) (types.TreeHead, error)
• type TreeType
• type TrillianClient
  • func DialTrillian(target string, timeout time.Duration, treeType TreeType, treeIdFile string) (*TrillianClient, error)
  • func (c *TrillianClient) AddLeaf(ctx context.Context, leaf *types.Leaf, treeSize uint64) (AddLeafStatus, error)
  • func (c *TrillianClient) AddSequencedLeaves(ctx context.Context, leaves []types.Leaf, index int64) error
  • func (c *TrillianClient) GetConsistencyProof(ctx context.Context, req *requests.ConsistencyProof) (types.ConsistencyProof, error)
  • func (c *TrillianClient) GetInclusionProof(ctx context.Context, req *requests.InclusionProof) (types.InclusionProof, error)
  • func (c *TrillianClient) GetLeaves(ctx context.Context, req *requests.Leaves) ([]types.Leaf, error)
  • func (c *TrillianClient) GetTreeHead(ctx context.Context) (types.TreeHead, error)

Variables

var ErrNotIncluded = errors.New("not included")

Types

type AddLeafStatus

type AddLeafStatus struct {
	AlreadyExists bool
	IsSequenced   bool
}

type Client

type Client interface {
	AddLeaf(context.Context, *types.Leaf, uint64) (AddLeafStatus, error)
	AddSequencedLeaves(ctx context.Context, leaves []types.Leaf, index int64) error
	GetTreeHead(context.Context) (types.TreeHead, error)
	GetConsistencyProof(context.Context, *requests.ConsistencyProof) (types.ConsistencyProof, error)
	GetInclusionProof(context.Context, *requests.InclusionProof) (types.InclusionProof, error)
	GetLeaves(context.Context, *requests.Leaves) ([]types.Leaf, error)
}

Client is an interface that interacts with a log's database backend

func NewMemoryDb

func NewMemoryDb() Client

type MemoryDb

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

func (*MemoryDb) AddLeaf

func (db *MemoryDb) AddLeaf(_ context.Context, leaf *types.Leaf, treeSize uint64) (AddLeafStatus, error)

func (*MemoryDb) AddSequencedLeaves

func (db *MemoryDb) AddSequencedLeaves(_ context.Context, leaves []types.Leaf, index int64) error

func (*MemoryDb) GetConsistencyProof

func (db *MemoryDb) GetConsistencyProof(_ context.Context, req *requests.ConsistencyProof) (types.ConsistencyProof, error)

func (*MemoryDb) GetInclusionProof

func (db *MemoryDb) GetInclusionProof(_ context.Context, req *requests.InclusionProof) (types.InclusionProof, error)

func (*MemoryDb) GetLeaves

func (db *MemoryDb) GetLeaves(_ context.Context, req *requests.Leaves) ([]types.Leaf, error)

func (*MemoryDb) GetTreeHead

func (db *MemoryDb) GetTreeHead(_ context.Context) (types.TreeHead, error)

type TreeType

type TreeType int

const (
	PrimaryTree TreeType = iota
	SecondaryTree
)

type TrillianClient

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

TrillianClient implements the Client interface for Trillian's gRPC backend

func DialTrillian

func DialTrillian(target string, timeout time.Duration, treeType TreeType, treeIdFile string) (*TrillianClient, error)

func (*TrillianClient) AddLeaf

func (c *TrillianClient) AddLeaf(ctx context.Context, leaf *types.Leaf, treeSize uint64) (AddLeafStatus, error)

AddLeaf adds a leaf to the tree and returns true if the leaf has been sequenced into the tree of size treeSize.

func (*TrillianClient) AddSequencedLeaves

func (c *TrillianClient) AddSequencedLeaves(ctx context.Context, leaves []types.Leaf, index int64) error

AddSequencedLeaves adds a set of already sequenced leaves to the tree.

func (*TrillianClient) GetConsistencyProof

func (c *TrillianClient) GetConsistencyProof(ctx context.Context, req *requests.ConsistencyProof) (types.ConsistencyProof, error)

func (*TrillianClient) GetInclusionProof

func (c *TrillianClient) GetInclusionProof(ctx context.Context, req *requests.InclusionProof) (types.InclusionProof, error)

func (*TrillianClient) GetLeaves

func (c *TrillianClient) GetLeaves(ctx context.Context, req *requests.Leaves) ([]types.Leaf, error)

func (*TrillianClient) GetTreeHead

func (c *TrillianClient) GetTreeHead(ctx context.Context) (types.TreeHead, error)