baseapp

Documentation

Overview

Package baseapp contains data structures that provide basic data storage functionality and act as a bridge between the ABCI interface and the SDK abstractions.

BaseApp has no state except the CommitMultiStore you provide upon init.

See examples/basecoin/app/* for usage.

Index

• func NewRouter() *router
• func RunForever(app abci.Application)
• type BaseApp
  • func NewBaseApp(name string, cdc *wire.Codec, logger log.Logger, db dbm.DB) *BaseApp
  • func (app *BaseApp) BeginBlock(req abci.RequestBeginBlock) (res abci.ResponseBeginBlock)
  • func (app *BaseApp) Check(tx sdk.Tx) (result sdk.Result)
  • func (app *BaseApp) CheckTx(txBytes []byte) (res abci.ResponseCheckTx)
  • func (app *BaseApp) Commit() (res abci.ResponseCommit)
  • func (app *BaseApp) Deliver(tx sdk.Tx) (result sdk.Result)
  • func (app *BaseApp) DeliverTx(txBytes []byte) (res abci.ResponseDeliverTx)
  • func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBlock)
  • func (app *BaseApp) Info(req abci.RequestInfo) abci.ResponseInfo
  • func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitChain)
  • func (app *BaseApp) LastBlockHeight() int64
  • func (app *BaseApp) LastCommitID() sdk.CommitID
  • func (app *BaseApp) LoadLatestVersion(mainKey sdk.StoreKey) error
  • func (app *BaseApp) LoadVersion(version int64, mainKey sdk.StoreKey) error
  • func (app *BaseApp) MountStore(key sdk.StoreKey, typ sdk.StoreType)
  • func (app *BaseApp) MountStoreWithDB(key sdk.StoreKey, typ sdk.StoreType, db dbm.DB)
  • func (app *BaseApp) MountStoresIAVL(keys ...*sdk.KVStoreKey)
  • func (app *BaseApp) Name() string
  • func (app *BaseApp) NewContext(isCheckTx bool, header abci.Header) sdk.Context
  • func (app *BaseApp) Query(req abci.RequestQuery) (res abci.ResponseQuery)
  • func (app *BaseApp) RegisterCodespace(codespace sdk.CodespaceType) sdk.CodespaceType
  • func (app *BaseApp) Router() Router
  • func (app *BaseApp) SetAnteHandler(ah sdk.AnteHandler)
  • func (app *BaseApp) SetBeginBlocker(beginBlocker sdk.BeginBlocker)
  • func (app *BaseApp) SetEndBlocker(endBlocker sdk.EndBlocker)
  • func (app *BaseApp) SetInitChainer(initChainer sdk.InitChainer)
  • func (app *BaseApp) SetOption(req abci.RequestSetOption) (res abci.ResponseSetOption)
  • func (app *BaseApp) SetTxDecoder(txDecoder sdk.TxDecoder)
• type Router

Functions

func NewRouter

func NewRouter() *router

nolint NewRouter - create new router TODO either make Function unexported or make return type (router) Exported

func RunForever

func RunForever(app abci.Application)

RunForever - BasecoinApp execution and cleanup

Types

type BaseApp

type BaseApp struct {
	// initialized on creation
	Logger log.Logger
	// contains filtered or unexported fields
}

The ABCI application

func NewBaseApp

func NewBaseApp(name string, cdc *wire.Codec, logger log.Logger, db dbm.DB) *BaseApp

Create and name new BaseApp NOTE: The db is used to store the version number for now.

func (*BaseApp) BeginBlock

func (app *BaseApp) BeginBlock(req abci.RequestBeginBlock) (res abci.ResponseBeginBlock)

Implements ABCI

func (*BaseApp) Check

func (app *BaseApp) Check(tx sdk.Tx) (result sdk.Result)

nolint- Mostly for testing

func (*BaseApp) CheckTx

func (app *BaseApp) CheckTx(txBytes []byte) (res abci.ResponseCheckTx)

Implements ABCI

func (*BaseApp) Commit

func (app *BaseApp) Commit() (res abci.ResponseCommit)

Implements ABCI

func (*BaseApp) Deliver

func (app *BaseApp) Deliver(tx sdk.Tx) (result sdk.Result)

func (*BaseApp) DeliverTx

func (app *BaseApp) DeliverTx(txBytes []byte) (res abci.ResponseDeliverTx)

Implements ABCI

func (*BaseApp) EndBlock

func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBlock)

Implements ABCI

func (*BaseApp) Info

func (app *BaseApp) Info(req abci.RequestInfo) abci.ResponseInfo

Implements ABCI

func (*BaseApp) InitChain

func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitChain)

Implements ABCI InitChain runs the initialization logic directly on the CommitMultiStore and commits it.

func (*BaseApp) LastBlockHeight

func (app *BaseApp) LastBlockHeight() int64

the last commited block height

func (*BaseApp) LastCommitID

func (app *BaseApp) LastCommitID() sdk.CommitID

the last CommitID of the multistore

func (*BaseApp) LoadLatestVersion

func (app *BaseApp) LoadLatestVersion(mainKey sdk.StoreKey) error

load latest application version

func (*BaseApp) LoadVersion

func (app *BaseApp) LoadVersion(version int64, mainKey sdk.StoreKey) error

load application version

func (*BaseApp) MountStore

func (app *BaseApp) MountStore(key sdk.StoreKey, typ sdk.StoreType)

Mount a store to the provided key in the BaseApp multistore, using the default DB

func (*BaseApp) MountStoreWithDB

func (app *BaseApp) MountStoreWithDB(key sdk.StoreKey, typ sdk.StoreType, db dbm.DB)

Mount a store to the provided key in the BaseApp multistore, using a specified DB

func (*BaseApp) MountStoresIAVL

func (app *BaseApp) MountStoresIAVL(keys ...*sdk.KVStoreKey)

Mount a store to the provided key in the BaseApp multistore

func (*BaseApp) Name

func (app *BaseApp) Name() string

BaseApp Name

func (*BaseApp) NewContext

func (app *BaseApp) NewContext(isCheckTx bool, header abci.Header) sdk.Context

NewContext returns a new Context with the correct store, the given header, and nil txBytes.

func (*BaseApp) Query

func (app *BaseApp) Query(req abci.RequestQuery) (res abci.ResponseQuery)

Implements ABCI. Delegates to CommitMultiStore if it implements Queryable

func (*BaseApp) RegisterCodespace

func (app *BaseApp) RegisterCodespace(codespace sdk.CodespaceType) sdk.CodespaceType

Register the next available codespace through the baseapp's codespacer, starting from a default

func (*BaseApp) Router

func (app *BaseApp) Router() Router

func (*BaseApp) SetAnteHandler

func (app *BaseApp) SetAnteHandler(ah sdk.AnteHandler)

func (*BaseApp) SetBeginBlocker

func (app *BaseApp) SetBeginBlocker(beginBlocker sdk.BeginBlocker)

func (*BaseApp) SetEndBlocker

func (app *BaseApp) SetEndBlocker(endBlocker sdk.EndBlocker)

func (*BaseApp) SetInitChainer

func (app *BaseApp) SetInitChainer(initChainer sdk.InitChainer)

nolint - Set functions

func (*BaseApp) SetOption

func (app *BaseApp) SetOption(req abci.RequestSetOption) (res abci.ResponseSetOption)

Implements ABCI

func (*BaseApp) SetTxDecoder

func (app *BaseApp) SetTxDecoder(txDecoder sdk.TxDecoder)

Set the txDecoder function

type Router

type Router interface {
	AddRoute(r string, h sdk.Handler) (rtr Router)
	Route(path string) (h sdk.Handler)
}

Router provides handlers for each transaction type.