protocol

Documentation

Index

• Constants
• Variables
• func NewQueryRouter() *queryrouter
• func NewRouter() *router
• type Protocol
• type ProtocolEngine
  • func NewProtocolEngine(protocolKeeper sdk.ProtocolKeeper) ProtocolEngine
  • func (pe *ProtocolEngine) Activate(version uint64, ctx sdk.Context) bool
  • func (pe *ProtocolEngine) Add(p Protocol) Protocol
  • func (pe *ProtocolEngine) GetByVersion(v uint64) (Protocol, bool)
  • func (pe *ProtocolEngine) GetCurrentProtocol() Protocol
  • func (pe *ProtocolEngine) GetCurrentVersion() uint64
  • func (pe *ProtocolEngine) GetKVStoreKeys() []*sdk.KVStoreKey
  • func (pe *ProtocolEngine) GetTransientStoreKeys() []*sdk.TransientStoreKey
  • func (pe *ProtocolEngine) LoadCurrentProtocol(kvStore sdk.KVStore) (bool, uint64)
  • func (pe *ProtocolEngine) LoadProtocol(version uint64)
• type QueryRouter
• type Router

Constants

const (
	// all store name
	AccountStore         = "acc"
	StakeStore           = "stake"
	StakeTransientStore  = "transient_stake"
	MintStore            = "mint"
	DistrStore           = "distr"
	DistrTransientStore  = "transient_distr"
	SlashingStore        = "slashing"
	GovStore             = "gov"
	FeeStore             = "fee"
	ParamsStore          = "params"
	ParamsTransientStore = "transient_params"
	ServiceStore         = "service"
	GuardianStore        = "guardian"
	UpgradeStore         = "upgrade"
	AssetStore           = "asset"
	RandStore            = "rand"
	SwapStore            = "coinswap"
	HtlcStore            = "htlc"

	// all route for query and handler
	BankRoute     = "bank"
	AccountRoute  = AccountStore
	StakeRoute    = StakeStore
	DistrRoute    = DistrStore
	SlashingRoute = SlashingStore
	GovRoute      = GovStore
	ParamsRoute   = ParamsStore
	ServiceRoute  = ServiceStore
	GuardianRoute = GuardianStore
	UpgradeRoute  = UpgradeStore
	AssetRoute    = AssetStore
	RandRoute     = RandStore
	SwapRoute     = SwapStore
	HtlcRoute     = HtlcStore
)

Variables

var (
	KeyMain     = sdk.NewKVStoreKey(sdk.MainStore)
	KeyAccount  = sdk.NewKVStoreKey(AccountStore)
	KeyStake    = sdk.NewKVStoreKey(StakeStore)
	TkeyStake   = sdk.NewTransientStoreKey(StakeTransientStore)
	KeyMint     = sdk.NewKVStoreKey(MintStore)
	KeyDistr    = sdk.NewKVStoreKey(DistrStore)
	TkeyDistr   = sdk.NewTransientStoreKey(DistrTransientStore)
	KeySlashing = sdk.NewKVStoreKey(SlashingStore)
	KeyGov      = sdk.NewKVStoreKey(GovStore)
	KeyFee      = sdk.NewKVStoreKey(FeeStore)
	KeyParams   = sdk.NewKVStoreKey(ParamsStore)
	TkeyParams  = sdk.NewTransientStoreKey(ParamsTransientStore)
	KeyService  = sdk.NewKVStoreKey(ServiceStore)
	KeyGuardian = sdk.NewKVStoreKey(GuardianStore)
	KeyUpgrade  = sdk.NewKVStoreKey(UpgradeStore)
	KeyAsset    = sdk.NewKVStoreKey(AssetStore)
	KeyRand     = sdk.NewKVStoreKey(RandStore)
	KeySwap     = sdk.NewKVStoreKey(SwapStore)
	KeyHtlc     = sdk.NewKVStoreKey(HtlcStore)
)

Functions

func NewQueryRouter

func NewQueryRouter() *queryrouter

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

func NewRouter

func NewRouter() *router

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

Types

type Protocol

type Protocol interface {
	GetVersion() uint64
	GetRouter() Router
	GetQueryRouter() QueryRouter
	GetAnteHandlers() []sdk.AnteHandler                // ante handlers for fee and auth
	GetFeeRefundHandler() sdk.FeeRefundHandler         // fee handler for fee refund
	GetFeePreprocessHandler() sdk.FeePreprocessHandler // fee handler for fee preprocessor
	ExportAppStateAndValidators(ctx sdk.Context, forZeroHeight bool) (appState json.RawMessage, validators []tmtypes.GenesisValidator, err error)
	ValidateTx(ctx sdk.Context, txBytes []byte, msgs []sdk.Msg) sdk.Error

	// may be nil
	GetInitChainer() sdk.InitChainer1  // initialize state with validators and state blob
	GetBeginBlocker() sdk.BeginBlocker // logic to run before any txs
	GetEndBlocker() sdk.EndBlocker     // logic to run after all txs, and to determine valset changes

	GetKVStoreKeyList() []*sdk.KVStoreKey
	Load()
	Init(ctx sdk.Context)
	GetCodec() *codec.Codec
	InitMetrics(store sdk.MultiStore) // init metrics
}

type ProtocolEngine

type ProtocolEngine struct {
	ProtocolKeeper sdk.ProtocolKeeper
	// contains filtered or unexported fields
}

func NewProtocolEngine

func NewProtocolEngine(protocolKeeper sdk.ProtocolKeeper) ProtocolEngine

func (*ProtocolEngine) Activate

func (pe *ProtocolEngine) Activate(version uint64, ctx sdk.Context) bool

To be used for Protocol with version > 0

func (*ProtocolEngine) Add

func (pe *ProtocolEngine) Add(p Protocol) Protocol

func (*ProtocolEngine) GetByVersion

func (pe *ProtocolEngine) GetByVersion(v uint64) (Protocol, bool)

func (*ProtocolEngine) GetCurrentProtocol

func (pe *ProtocolEngine) GetCurrentProtocol() Protocol

func (*ProtocolEngine) GetCurrentVersion

func (pe *ProtocolEngine) GetCurrentVersion() uint64

func (*ProtocolEngine) GetKVStoreKeys

func (pe *ProtocolEngine) GetKVStoreKeys() []*sdk.KVStoreKey

func (*ProtocolEngine) GetTransientStoreKeys

func (pe *ProtocolEngine) GetTransientStoreKeys() []*sdk.TransientStoreKey

func (*ProtocolEngine) LoadCurrentProtocol

func (pe *ProtocolEngine) LoadCurrentProtocol(kvStore sdk.KVStore) (bool, uint64)

func (*ProtocolEngine) LoadProtocol

func (pe *ProtocolEngine) LoadProtocol(version uint64)

type QueryRouter

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

QueryRouter provides queryables for each query path.

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.