proofs

Documentation

Index

• Constants
• func ParseHexKey(str string) ([]byte, error)
• func ValidateBlock(meta *types.Block, check lc.Checkpoint) error
• func ValidateBlockMeta(meta *types.BlockMeta, check lc.Checkpoint) error
• func ValidateHeader(head *types.Header, check lc.Checkpoint) error
• type AppProof
  • func (p AppProof) BlockHeight() uint64
  • func (p AppProof) Data() []byte
  • func (p AppProof) Marshal() ([]byte, error)
  • func (p AppProof) Validate(check lc.Checkpoint) error
• type AppProver
  • func NewAppProver(node client.Client) AppProver
  • func (a AppProver) Get(key []byte, h uint64) (lc.Proof, error)
  • func (a AppProver) Unmarshal(data []byte) (lc.Proof, error)
• type KeyMaker
  • func (k KeyMaker) MakeKey(str string) ([]byte, error)
• type Presenter
• type Presenters
  • func NewPresenters() Presenters
  • func (p Presenters) BruteForce(raw []byte) (interface{}, error)
  • func (p Presenters) Lookup(app string) (Presenter, error)
  • func (p Presenters) Register(app string, pres Presenter)
• type RawPresenter
  • func (p RawPresenter) ParseData(raw []byte) (interface{}, error)
• type TxProof
  • func (p TxProof) BlockHeight() uint64
  • func (p TxProof) Data() []byte
  • func (p TxProof) Marshal() ([]byte, error)
  • func (p TxProof) Validate(check lc.Checkpoint) error
• type TxProver
  • func NewTxProver(node client.Client) TxProver
  • func (t TxProver) Get(key []byte, h uint64) (lc.Proof, error)
  • func (t TxProver) Unmarshal(data []byte) (pr lc.Proof, err error)

Constants

const Raw = "raw"

Functions

func ParseHexKey

func ParseHexKey(str string) ([]byte, error)

func ValidateBlock

func ValidateBlock(meta *types.Block, check lc.Checkpoint) error

func ValidateBlockMeta

func ValidateBlockMeta(meta *types.BlockMeta, check lc.Checkpoint) error

func ValidateHeader

func ValidateHeader(head *types.Header, check lc.Checkpoint) error

Types

type AppProof

type AppProof struct {
	Height uint64
	Key    data.Bytes
	Value  data.Bytes
	Proof  data.Bytes
}

AppProof containts a key-value pair at a given height. It also contains the merkle proof from that key-value pair to the root hash, which can be verified against a signed header.

func (AppProof) BlockHeight

func (p AppProof) BlockHeight() uint64

func (AppProof) Data

func (p AppProof) Data() []byte

func (AppProof) Marshal

func (p AppProof) Marshal() ([]byte, error)

func (AppProof) Validate

func (p AppProof) Validate(check lc.Checkpoint) error

type AppProver

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

AppProver provides positive proofs of key-value pairs in the abciapp.

TODO: also support negative proofs (this key is not set)

func NewAppProver

func NewAppProver(node client.Client) AppProver

func (AppProver) Get

func (a AppProver) Get(key []byte, h uint64) (lc.Proof, error)

Get tries to download a merkle hash for app state on this key from the tendermint node.

func (AppProver) Unmarshal

func (a AppProver) Unmarshal(data []byte) (lc.Proof, error)

type KeyMaker

type KeyMaker struct {
	Prefix []byte
}

KeyMaker can be embedded for a basic and flexible key encoder

func (KeyMaker) MakeKey

func (k KeyMaker) MakeKey(str string) ([]byte, error)

type Presenter

type Presenter interface {
	MakeKey(string) ([]byte, error)
	ParseData([]byte) (interface{}, error)
}

Presenter allows us to encode queries and parse results in an app-specific way

type Presenters

type Presenters map[string]Presenter

func NewPresenters

func NewPresenters() Presenters

NewPresenters gives you a default raw presenter

func (Presenters) BruteForce

func (p Presenters) BruteForce(raw []byte) (interface{}, error)

BruteForce will try all regitered parsers in random order, before calling RawPresenter. Use if we have no idea how to interpret the data (eg. decoding all tx in a block)

func (Presenters) Lookup

func (p Presenters) Lookup(app string) (Presenter, error)

Lookup tries to find a registered presenter, or the raw presenter

func (Presenters) Register

func (p Presenters) Register(app string, pres Presenter)

Register adds this app to the lookup table to parse it

type RawPresenter

type RawPresenter struct {
	KeyMaker
}

RawPresenter just hex-encodes/decodes text. Useful as default, or to embed in other structs for the MakeKey implementation

If you set a prefix, it will be prepended to all your data after hex-decoding them

func (RawPresenter) ParseData

func (p RawPresenter) ParseData(raw []byte) (interface{}, error)

ParseData on the raw-presenter, just provides a hex-encoding of the bytes

type TxProof

type TxProof struct {
	Height uint64
	Proof  types.TxProof
}

TxProof checks ALL txs for one block... we need a better way!

func (TxProof) BlockHeight

func (p TxProof) BlockHeight() uint64

func (TxProof) Data

func (p TxProof) Data() []byte

func (TxProof) Marshal

func (p TxProof) Marshal() ([]byte, error)

func (TxProof) Validate

func (p TxProof) Validate(check lc.Checkpoint) error

type TxProver

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

TxProver provides positive proofs of key-value pairs in the abciapp.

TODO: also support negative proofs (this key is not set)

func NewTxProver

func NewTxProver(node client.Client) TxProver

func (TxProver) Get

func (t TxProver) Get(key []byte, h uint64) (lc.Proof, error)

Get tries to download a merkle hash for app state on this key from the tendermint node.

Important: key must be Tx.Hash() Height is completely ignored for now :(

func (TxProver) Unmarshal

func (t TxProver) Unmarshal(data []byte) (pr lc.Proof, err error)