eyes

Documentation

Index

• Constants
• func ErrMissingData() errors.TMError
• func IsMissingDataErr(err error) bool
• func NewRemoveTx(key []byte) sdk.Tx
• func NewSetTx(key, value []byte) sdk.Tx
• type Data
  • func NewData(value []byte, setAt int64) Data
• type Handler
  • func NewHandler() Handler
  • func (h Handler) CheckTx(ctx sdk.Context, store state.SimpleDB, tx sdk.Tx) (res sdk.CheckResult, err error)
  • func (h Handler) DeliverTx(ctx sdk.Context, store state.SimpleDB, tx sdk.Tx) (res sdk.DeliverResult, err error)
  • func (h Handler) InitState(l log.Logger, store state.SimpleDB, module, key, value string) (log string, err error)
  • func (Handler) Name() string
• type RemoveTx
  • func (t RemoveTx) ValidateBasic() error
  • func (t RemoveTx) Wrap() sdk.Tx
• type SetTx
  • func (t SetTx) ValidateBasic() error
  • func (t SetTx) Wrap() sdk.Tx

Constants

const (
	// Name of the module for registering it
	Name = "eyes"

	// CostSet is the gas needed for the set operation
	CostSet int64 = 10
	// CostRemove is the gas needed for the remove operation
	CostRemove = 10
)

const (
	TypeSet    = Name + "/set"
	TypeRemove = Name + "/remove"

	ByteSet    = 0xF4
	ByteRemove = 0xF5
)

nolint

Functions

func ErrMissingData

func ErrMissingData() errors.TMError

nolint

func IsMissingDataErr

func IsMissingDataErr(err error) bool

func NewRemoveTx

func NewRemoveTx(key []byte) sdk.Tx

func NewSetTx

func NewSetTx(key, value []byte) sdk.Tx

Types

type Data

type Data struct {
	// SetAt is the block height this was set at
	SetAt int64 `json:"set_at"`
	// Value is the data that was stored.
	// data.Bytes is like []byte but json encodes as hex not base64
	Value data.Bytes `json:"value"`
}

Data is the struct we use to store in the merkle tree

func NewData

func NewData(value []byte, setAt int64) Data

NewData creates a new Data item

type Handler

type Handler struct {
	sdk.NopInitValidate
}

Handler allows us to set and remove data

func NewHandler

func NewHandler() Handler

NewHandler makes a role handler to modify data

func (Handler) CheckTx

func (h Handler) CheckTx(ctx sdk.Context, store state.SimpleDB, tx sdk.Tx) (res sdk.CheckResult, err error)

CheckTx verifies if the transaction is properly formated

func (Handler) DeliverTx

func (h Handler) DeliverTx(ctx sdk.Context, store state.SimpleDB, tx sdk.Tx) (res sdk.DeliverResult, err error)

DeliverTx tries to create a new role.

Returns an error if the role already exists

func (Handler) InitState

func (h Handler) InitState(l log.Logger, store state.SimpleDB,
	module, key, value string) (log string, err error)

InitState - sets the genesis state

func (Handler) Name

func (Handler) Name() string

Name - return name space

type RemoveTx

type RemoveTx struct {
	Key data.Bytes `json:"key"`
}

RemoveTx deletes the value at this key, returns old value

func (RemoveTx) ValidateBasic

func (t RemoveTx) ValidateBasic() error

ValidateBasic makes sure it is valid

func (RemoveTx) Wrap

func (t RemoveTx) Wrap() sdk.Tx

Wrap - fulfills TxInner interface

type SetTx

type SetTx struct {
	Key   data.Bytes `json:"key"`
	Value data.Bytes `json:"value"`
}

SetTx sets a key-value pair

func (SetTx) ValidateBasic

func (t SetTx) ValidateBasic() error

ValidateBasic makes sure it is valid

func (SetTx) Wrap

func (t SetTx) Wrap() sdk.Tx

Wrap - fulfills TxInner interface