tmpop

Documentation

Index

• Constants
• func BuildQueryBinary(args interface{}) (argsBytes []byte, err error)
• func ComputeAppHash(previous *types.Bytes32, validator *types.Bytes32, root *types.Bytes32) (*types.Bytes32, error)
• func Run(a store.Adapter, kv store.KeyValueStore, config *Config)
• type ABCIError
  • func (e *ABCIError) Error() string
  • func (e *ABCIError) IsOK() bool
• type Block
• type Config
• type Info
• type LastBlock
  • func ReadLastBlock(kv store.KeyValueReader) (*LastBlock, error)
• type State
  • func NewState(a store.Adapter) (*State, error)
  • func (s *State) Check(link *cs.Link) *ABCIError
  • func (s *State) Commit() (*types.Bytes32, []*cs.Link, error)
  • func (s *State) Deliver(link *cs.Link) *ABCIError
• type TMPop
  • func New(a store.Adapter, kv store.KeyValueStore, config *Config) (*TMPop, error)
  • func (t *TMPop) BeginBlock(req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (t *TMPop) CheckTx(tx []byte) abci.ResponseCheckTx
  • func (t *TMPop) Commit() abci.ResponseCommit
  • func (t *TMPop) ConnectTendermint(tmClient TendermintClient)
  • func (t *TMPop) DeliverTx(tx []byte) abci.ResponseDeliverTx
  • func (t *TMPop) GetCurrentHeader() *abci.Header
  • func (t *TMPop) Info(req abci.RequestInfo) abci.ResponseInfo
  • func (t *TMPop) Query(reqQuery abci.RequestQuery) (resQuery abci.ResponseQuery)
  • func (t *TMPop) SetOption(req abci.RequestSetOption) abci.ResponseSetOption
• type TendermintClient
• type TendermintClientWrapper
  • func NewTendermintClient(tmClient client.Client) *TendermintClientWrapper
  • func (c *TendermintClientWrapper) Block(height int) *Block
• type Tx
• type TxType

Constants

const (
	// CodeTypeValidation is the ABCI error code for a validation error.
	CodeTypeValidation uint32 = 400

	// CodeTypeInternalError is the ABCI error code for an internal error.
	CodeTypeInternalError uint32 = 500

	// CodeTypeNotImplemented is the ABCI error code for a feature not yet implemented.
	CodeTypeNotImplemented uint32 = 501
)

const (
	AddEvidence   = "AddEvidence"
	FindSegments  = "FindSegments"
	GetEvidences  = "GetEvidences"
	GetInfo       = "GetInfo"
	GetMapIDs     = "GetMapIDs"
	GetSegment    = "GetSegment"
	PendingEvents = "PendingEvents"
)

Query types.

const (
	// Name of the Tendermint Application.
	Name = "TMPop"

	// Description of this Tendermint Application.
	Description = "Agent Store in a Blockchain"
)

Functions

func BuildQueryBinary

func BuildQueryBinary(args interface{}) (argsBytes []byte, err error)

BuildQueryBinary outputs the marshalled Query.

func ComputeAppHash

func ComputeAppHash(previous *types.Bytes32, validator *types.Bytes32, root *types.Bytes32) (*types.Bytes32, error)

ComputeAppHash computes the app hash from its required parts If one of the parts is nil or empty, we'll pad with 0s so that we always hash a 96-bytes array

func Run

func Run(a store.Adapter, kv store.KeyValueStore, config *Config)

Run launches a TMPop Tendermint App

Types

type ABCIError

type ABCIError struct {
	Code uint32
	Log  string
}

ABCIError is a structured error used inside TMPoP. The error codes are close to standard http status codes.

func (*ABCIError) Error

func (e *ABCIError) Error() string

func (*ABCIError) IsOK

func (e *ABCIError) IsOK() bool

IsOK returns true if no error occurred.

type Block

type Block struct {
	Header *abci.Header
	Txs    []*Tx
}

Block contains the parts of a Tendermint block that TMPoP is interested in.

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

	// JSON schema rules definition
	ValidatorFilename string
}

Config contains configuration options for the App.

type Info

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

Info is the info returned by GetInfo.

type LastBlock

type LastBlock struct {
	AppHash    *types.Bytes32
	Height     int64
	LastHeader *abci.Header
}

LastBlock saves the information of the last block committed for Core/App Handshake on crash/restart.

func ReadLastBlock

func ReadLastBlock(kv store.KeyValueReader) (*LastBlock, error)

ReadLastBlock returns the last block committed by TMPop

type State

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

State represents the app states, separating the committed state (for queries) from the working state (for CheckTx and DeliverTx).

func NewState

func NewState(a store.Adapter) (*State, error)

NewState creates a new State.

func (*State) Check

func (s *State) Check(link *cs.Link) *ABCIError

Check checks if creating this link is a valid operation

func (*State) Commit

func (s *State) Commit() (*types.Bytes32, []*cs.Link, error)

Commit commits the delivered links, resets delivered and checked state, and returns the hash for the commit and the list of committed links.

func (*State) Deliver

func (s *State) Deliver(link *cs.Link) *ABCIError

Deliver adds a link to the list of links to be committed

type TMPop

type TMPop struct {
	abci.BaseApplication
	// contains filtered or unexported fields
}

TMPop is the type of the application that implements github.com/tendermint/abci/types.Application, the tendermint socket protocol (ABCI).

func New

func New(a store.Adapter, kv store.KeyValueStore, config *Config) (*TMPop, error)

New creates a new instance of a TMPop.

func (*TMPop) BeginBlock

func (t *TMPop) BeginBlock(req abci.RequestBeginBlock) abci.ResponseBeginBlock

BeginBlock implements github.com/tendermint/abci/types.Application.BeginBlock.

func (*TMPop) CheckTx

func (t *TMPop) CheckTx(tx []byte) abci.ResponseCheckTx

CheckTx implements github.com/tendermint/abci/types.Application.CheckTx.

func (*TMPop) Commit

func (t *TMPop) Commit() abci.ResponseCommit

Commit implements github.com/tendermint/abci/types.Application.Commit. It actually commits the current state in the Store.

func (*TMPop) ConnectTendermint

func (t *TMPop) ConnectTendermint(tmClient TendermintClient)

ConnectTendermint connects TMPoP to a Tendermint node

func (*TMPop) DeliverTx

func (t *TMPop) DeliverTx(tx []byte) abci.ResponseDeliverTx

DeliverTx implements github.com/tendermint/abci/types.Application.DeliverTx.

func (*TMPop) GetCurrentHeader

func (t *TMPop) GetCurrentHeader() *abci.Header

GetCurrentHeader returns the current block header

func (*TMPop) Info

func (t *TMPop) Info(req abci.RequestInfo) abci.ResponseInfo

Info implements github.com/tendermint/abci/types.Application.Info.

func (*TMPop) Query

func (t *TMPop) Query(reqQuery abci.RequestQuery) (resQuery abci.ResponseQuery)

Query implements github.com/tendermint/abci/types.Application.Query.

func (*TMPop) SetOption

func (t *TMPop) SetOption(req abci.RequestSetOption) abci.ResponseSetOption

SetOption implements github.com/tendermint/abci/types.Application.SetOption.

type TendermintClient

type TendermintClient interface {
	Block(height int) *Block
}

TendermintClient is a light interface to query Tendermint Core

type TendermintClientWrapper

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

TendermintClientWrapper implements TendermintClient

func NewTendermintClient

func NewTendermintClient(tmClient client.Client) *TendermintClientWrapper

NewTendermintClient creates a new TendermintClient

func (*TendermintClientWrapper) Block

func (c *TendermintClientWrapper) Block(height int) *Block

Block queries for a block at a specific height

type Tx

type Tx struct {
	TxType   TxType         `json:"type"`
	Link     *cs.Link       `json:"link"`
	LinkHash *types.Bytes32 `json:"linkhash"`
}

Tx represents a TMPoP transaction

type TxType

type TxType byte

TxType represents the type of a Transaction

const (
	// CreateLink characterizes a transaction that creates a new link
	CreateLink TxType = iota
)