api

package

v0.0.0-...-cc9bb6a Latest Latest Go to latest Published: Apr 23, 2022 License: BSD-2-Clause Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sigsum.org/sigsum-tools-go

Links

Open Source Insights

Documentation ¶

Overview ¶

package api implements the Sigsum v0 API. See

https://git.sigsum.org/sigsum/tree/doc/api.md

for further details. No verification, retries, etc., is done here.

Index ¶

type API
type NetworkClient
- func NewNetworkClient(httpClient http.Client, logURL string) *NetworkClient

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API interface {
	GetToCosignTreeHead() (*types.SignedTreeHead, error)
	GetCosignedTreeHead() (*types.CosignedTreeHead, error)
	GetInclusionProof(treeSize uint64, leafHash *types.Hash) (*types.InclusionProof, error)
	GetConsistencyProof(oldSize, newSize uint64) (*types.ConsistencyProof, error)
	GetLeaves(startSize, endSize uint64) (*types.Leaves, error)

	AddLeaf(*requests.Leaf) error
	AddCosignature(*requests.Cosignature) error
}

type NetworkClient ¶

type NetworkClient struct {
	http.Client
	LogURL string
}

func NewNetworkClient ¶

func NewNetworkClient(httpClient http.Client, logURL string) *NetworkClient

func (*NetworkClient) AddCosignature ¶

func (c *NetworkClient) AddCosignature(*requests.Cosignature) error

func (*NetworkClient) AddLeaf ¶

func (c *NetworkClient) AddLeaf(leaf *requests.Leaf) error

func (*NetworkClient) GetConsistencyProof ¶

func (c *NetworkClient) GetConsistencyProof(oldSize, newSize uint64) (*types.ConsistencyProof, error)

func (*NetworkClient) GetCosignedTreeHead ¶

func (c *NetworkClient) GetCosignedTreeHead() (*types.CosignedTreeHead, error)

func (*NetworkClient) GetInclusionProof ¶

func (c *NetworkClient) GetInclusionProof(treeSize uint64, leafHash *types.Hash) (*types.InclusionProof, error)

func (*NetworkClient) GetLeaves ¶

func (c *NetworkClient) GetLeaves(startSize, endSize uint64) (*types.Leaves, error)

func (*NetworkClient) GetToCosignTreeHead ¶

func (c *NetworkClient) GetToCosignTreeHead() (*types.SignedTreeHead, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL