mock

README

This package is only intended to be used for testing core IBC. In order to maintain secure testing, we need to do message passing and execution which requires connecting an IBC application module that fulfills all the callbacks. We cannot connect to ibc-transfer which does not support all channel types so instead we create a mock application module which does nothing. It simply return nil in all cases so no error ever occurs. It is intended to be as minimal and lightweight as possible and should never import simapp.

Documentation

Overview

This package is only intended to be used for testing core IBC. In order to maintain secure testing, we need to do message passing and execution which requires connecting an IBC application module that fulfills all the callbacks. We cannot connect to ibc-transfer which does not support all channel types so instead we create a mock application module which does nothing. It simply return nil in all cases so no error ever occurs. It is intended to be as minimal and lightweight as possible and should never import simapp.

Index

• Constants
• Variables
• type AppModule
  • func NewAppModule(sk capabilitykeeper.ScopedKeeper) AppModule
  • func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)
  • func (am AppModule) EndBlock(ctx sdk.Context, req abci.RequestEndBlock) []abci.ValidatorUpdate
  • func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONMarshaler, data json.RawMessage) []abci.ValidatorUpdate
  • func (am AppModule) LegacyQuerierHandler(*codec.LegacyAmino) sdk.Querier
  • func (am AppModule) OnAcknowledgementPacket(sdk.Context, channeltypes.Packet, []byte) (*sdk.Result, error)
  • func (am AppModule) OnChanCloseConfirm(sdk.Context, string, string) error
  • func (am AppModule) OnChanCloseInit(sdk.Context, string, string) error
  • func (am AppModule) OnChanOpenAck(sdk.Context, string, string, string) error
  • func (am AppModule) OnChanOpenConfirm(sdk.Context, string, string) error
  • func (am AppModule) OnChanOpenInit(ctx sdk.Context, _ channeltypes.Order, _ []string, portID string, ...) error
  • func (am AppModule) OnChanOpenTry(ctx sdk.Context, _ channeltypes.Order, _ []string, portID string, ...) error
  • func (am AppModule) OnRecvPacket(sdk.Context, channeltypes.Packet) (*sdk.Result, []byte, error)
  • func (am AppModule) OnTimeoutPacket(sdk.Context, channeltypes.Packet) (*sdk.Result, error)
  • func (AppModule) QuerierRoute() string
  • func (AppModule) RegisterInvariants(ir sdk.InvariantRegistry)
  • func (am AppModule) RegisterServices(module.Configurator)
  • func (am AppModule) Route() sdk.Route
• type AppModuleBasic
  • func (AppModuleBasic) DefaultGenesis(cdc codec.JSONMarshaler) json.RawMessage
  • func (AppModuleBasic) GetQueryCmd() *cobra.Command
  • func (AppModuleBasic) GetTxCmd() *cobra.Command
  • func (AppModuleBasic) Name() string
  • func (a AppModuleBasic) RegisterGRPCGatewayRoutes(_ client.Context, _ *runtime.ServeMux)
  • func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry)
  • func (AppModuleBasic) RegisterLegacyAminoCodec(*codec.LegacyAmino)
  • func (AppModuleBasic) RegisterRESTRoutes(clientCtx client.Context, rtr *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(codec.JSONMarshaler, client.TxEncodingConfig, json.RawMessage) error
• type PV
  • func NewPV() PV
  • func (pv PV) GenerateVRFProof(message []byte) (crypto.Proof, error)
  • func (pv PV) GetPubKey() (crypto.PubKey, error)
  • func (pv PV) SignProposal(chainID string, proposal *ocproto.Proposal) error
  • func (pv PV) SignVote(chainID string, vote *ocproto.Vote) error

Constants

const (
	ModuleName = "mock"
)

Variables

var (
	MockAcknowledgement = []byte("mock acknowledgement")
	MockCommitment      = []byte("mock packet commitment")
)

Types

type AppModule

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

AppModule represents the AppModule for the mock module.

func NewAppModule

func NewAppModule(sk capabilitykeeper.ScopedKeeper) AppModule

NewAppModule returns a mock AppModule instance.

func (AppModule) BeginBlock

func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)

BeginBlock implements the AppModule interface

func (AppModule) EndBlock

func (am AppModule) EndBlock(ctx sdk.Context, req abci.RequestEndBlock) []abci.ValidatorUpdate

EndBlock implements the AppModule interface

func (AppModule) ExportGenesis

func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json.RawMessage

ExportGenesis implements the AppModule interface.

func (AppModule) InitGenesis

func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONMarshaler, data json.RawMessage) []abci.ValidatorUpdate

InitGenesis implements the AppModule interface.

func (AppModule) LegacyQuerierHandler

func (am AppModule) LegacyQuerierHandler(*codec.LegacyAmino) sdk.Querier

LegacyQuerierHandler implements the AppModule interface.

func (AppModule) OnAcknowledgementPacket

func (am AppModule) OnAcknowledgementPacket(sdk.Context, channeltypes.Packet, []byte) (*sdk.Result, error)

OnAcknowledgementPacket implements the IBCModule interface.

func (AppModule) OnChanCloseConfirm

func (am AppModule) OnChanCloseConfirm(sdk.Context, string, string) error

OnChanCloseConfirm implements the IBCModule interface.

func (AppModule) OnChanCloseInit

func (am AppModule) OnChanCloseInit(sdk.Context, string, string) error

OnChanCloseInit implements the IBCModule interface.

func (AppModule) OnChanOpenAck

func (am AppModule) OnChanOpenAck(sdk.Context, string, string, string) error

OnChanOpenAck implements the IBCModule interface.

func (AppModule) OnChanOpenConfirm

func (am AppModule) OnChanOpenConfirm(sdk.Context, string, string) error

OnChanOpenConfirm implements the IBCModule interface.

func (AppModule) OnChanOpenInit

func (am AppModule) OnChanOpenInit(
	ctx sdk.Context, _ channeltypes.Order, _ []string, portID string,
	channelID string, chanCap *capabilitytypes.Capability, _ channeltypes.Counterparty, _ string,
) error

OnChanOpenInit implements the IBCModule interface.

func (AppModule) OnChanOpenTry

func (am AppModule) OnChanOpenTry(
	ctx sdk.Context, _ channeltypes.Order, _ []string, portID string,
	channelID string, chanCap *capabilitytypes.Capability, _ channeltypes.Counterparty, _, _ string,
) error

OnChanOpenTry implements the IBCModule interface.

func (AppModule) OnRecvPacket

func (am AppModule) OnRecvPacket(sdk.Context, channeltypes.Packet) (*sdk.Result, []byte, error)

OnRecvPacket implements the IBCModule interface.

func (AppModule) OnTimeoutPacket

func (am AppModule) OnTimeoutPacket(sdk.Context, channeltypes.Packet) (*sdk.Result, error)

OnTimeoutPacket implements the IBCModule interface.

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

QuerierRoute implements the AppModule interface.

func (AppModule) RegisterInvariants

func (AppModule) RegisterInvariants(ir sdk.InvariantRegistry)

RegisterInvariants implements the AppModule interface.

func (AppModule) RegisterServices

func (am AppModule) RegisterServices(module.Configurator)

RegisterServices implements the AppModule interface.

func (AppModule) Route

func (am AppModule) Route() sdk.Route

Route implements the AppModule interface.

type AppModuleBasic

type AppModuleBasic struct{}

AppModuleBasic is the mock AppModuleBasic.

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis(cdc codec.JSONMarshaler) json.RawMessage

DefaultGenesis implements AppModuleBasic interface.

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd() *cobra.Command

GetQueryCmd implements AppModuleBasic interface.

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd() *cobra.Command

GetTxCmd implements AppModuleBasic interface.

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

Name implements AppModuleBasic interface.

func (AppModuleBasic) RegisterGRPCGatewayRoutes

func (a AppModuleBasic) RegisterGRPCGatewayRoutes(_ client.Context, _ *runtime.ServeMux)

RegisterGRPCGatewayRoutes implements AppModuleBasic interface.

func (AppModuleBasic) RegisterInterfaces

func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry)

RegisterInterfaces implements AppModuleBasic interface.

func (AppModuleBasic) RegisterLegacyAminoCodec

func (AppModuleBasic) RegisterLegacyAminoCodec(*codec.LegacyAmino)

RegisterLegacyAminoCodec implements AppModuleBasic interface.

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(clientCtx client.Context, rtr *mux.Router)

RegisterRESTRoutes implements AppModuleBasic interface.

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(codec.JSONMarshaler, client.TxEncodingConfig, json.RawMessage) error

ValidateGenesis implements the AppModuleBasic interface.

type PV

type PV struct {
	PrivKey cryptotypes.PrivKey
}

MockPV implements PrivValidator without any safety or persistence. Only use it for testing.

func NewPV

func NewPV() PV

func (PV) GenerateVRFProof

func (pv PV) GenerateVRFProof(message []byte) (crypto.Proof, error)

func (PV) GetPubKey

func (pv PV) GetPubKey() (crypto.PubKey, error)

GetPubKey implements PrivValidator interface

func (PV) SignProposal

func (pv PV) SignProposal(chainID string, proposal *ocproto.Proposal) error

SignProposal implements PrivValidator interface

func (PV) SignVote

func (pv PV) SignVote(chainID string, vote *ocproto.Vote) error

SignVote implements PrivValidator interface