ammswap

README

OKExChain PoolSwap Module

OKExChain PoolSwap Protocol.

Documentation

Index

• Constants
• Variables
• func BeginBlocker(ctx sdk.Context, k Keeper)
• func EndBlocker(ctx sdk.Context, k Keeper)
• func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState)
• func NewHandler(k Keeper) sdk.Handler
• func ValidateGenesis(data GenesisState) error
• type AppModule
  • func NewAppModule(k Keeper) AppModule
  • func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)
  • func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate
  • func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate
  • func (am AppModule) NewHandler() sdk.Handler
  • func (am AppModule) NewQuerierHandler() sdk.Querier
  • func (AppModule) QuerierRoute() string
  • func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)
  • func (AppModule) Route() string
• type AppModuleBasic
  • func (AppModuleBasic) DefaultGenesis() json.RawMessage
  • func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) Name() string
  • func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)
  • func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error
• type GenesisState
  • func DefaultGenesisState() GenesisState
  • func ExportGenesis(ctx sdk.Context, k Keeper) GenesisState
  • func NewGenesisState(swapTokenPairRecords []SwapTokenPair) GenesisState
• type Keeper
• type Params
• type SwapTokenPair
  • func NewTestSwapTokenPairWithInitLiquidity(t *testing.T, ctx sdk.Context, k swapkeeper.Keeper, ...) SwapTokenPair

Constants

const (
	// nolint
	ModuleName        = types.ModuleName
	RouterKey         = types.RouterKey
	StoreKey          = types.StoreKey
	DefaultParamspace = types.DefaultParamspace
	QuerierRoute      = types.QuerierRoute
)

Variables

var (
	// functions aliases
	// nolint
	NewKeeper            = keeper.NewKeeper
	NewQuerier           = keeper.NewQuerier
	RegisterCodec        = types.RegisterCodec
	NewMsgAddLiquidity   = types.NewMsgAddLiquidity
	GetSwapTokenPairName = types.GetSwapTokenPairName

	// variable aliases
	// nolint
	ModuleCdc = types.ModuleCdc
)

Functions

func BeginBlocker

func BeginBlocker(ctx sdk.Context, k Keeper)

BeginBlocker check for infraction evidence or downtime of validators on every begin block

func EndBlocker

func EndBlocker(ctx sdk.Context, k Keeper)

EndBlocker called every block, process inflation, update validator set.

func InitGenesis

func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState)

InitGenesis init genesis data to keeper

func NewHandler

func NewHandler(k Keeper) sdk.Handler

NewHandler creates an sdk.Handler for all the ammswap type messages

func ValidateGenesis

func ValidateGenesis(data GenesisState) error

ValidateGenesis validates the format of the specified genesisState

Types

type AppModule

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

AppModule implements an application module for the swap module.

func NewAppModule

func NewAppModule(k Keeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock

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

BeginBlock returns the begin blocker for the swap module.

func (AppModule) EndBlock

func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate

EndBlock returns the end blocker for the swap module. It returns no validator updates.

func (AppModule) ExportGenesis

func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

ExportGenesis returns the exported genesis state as raw bytes for the swap module.

func (AppModule) InitGenesis

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

InitGenesis performs genesis initialization for the swap module. It returns no validator updates.

func (AppModule) NewHandler

func (am AppModule) NewHandler() sdk.Handler

NewHandler returns an sdk.Handler for the swap module.

func (AppModule) NewQuerierHandler

func (am AppModule) NewQuerierHandler() sdk.Querier

NewQuerierHandler returns the swap module sdk.Querier.

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

QuerierRoute returns the swap module's querier route name.

func (AppModule) RegisterInvariants

func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

RegisterInvariants registers the swap module invariants.

func (AppModule) Route

func (AppModule) Route() string

Route returns the message routing key for the swap module.

type AppModuleBasic

type AppModuleBasic struct{}

AppModuleBasic defines the basic application module used by the swap module.

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

DefaultGenesis returns default genesis state as raw bytes for the swap module.

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

GetQueryCmd returns no root query command for the swap module.

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

GetTxCmd returns the root tx command for the swap module.

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

Name returns the swap module's name.

func (AppModuleBasic) RegisterCodec

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

RegisterCodec registers the swap module's types for the given codec.

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)

RegisterRESTRoutes registers the REST routes for the swap module.

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

ValidateGenesis performs genesis state validation for the swap module.

type GenesisState

type GenesisState struct {
	Params               Params          `json:"params"`
	SwapTokenPairRecords []SwapTokenPair `json:"swap_token_pair_records"`
}

GenesisState stores genesis data, all slashing state that must be provided at genesis

func DefaultGenesisState

func DefaultGenesisState() GenesisState

nolint

func ExportGenesis

func ExportGenesis(ctx sdk.Context, k Keeper) GenesisState

ExportGenesis exports genesis from keeper

func NewGenesisState

func NewGenesisState(swapTokenPairRecords []SwapTokenPair) GenesisState

nolint

type Keeper

type Keeper = keeper.Keeper

nolint

type Params

type Params = types.Params

type SwapTokenPair

type SwapTokenPair = types.SwapTokenPair

nolint

func NewTestSwapTokenPairWithInitLiquidity

func NewTestSwapTokenPairWithInitLiquidity(t *testing.T, ctx sdk.Context, k swapkeeper.Keeper,
	baseToken, quoteToken sdk.DecCoin, addrList []sdk.AccAddress) SwapTokenPair