package
0.12.4
Repository: https://github.com/mokitanetwork/aether.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DefaultGenesisState returns a default genesis state.
DefaultParams returns default params for swap module.
DepositorPoolSharesKey returns a key from a depositor and poolID.
NewAllowedPool returns a new AllowedPool object.
NewAllowedPools returns AllowedPools from the provided values.
NewBasePool returns a pointer to a base pool with reserves and total shares initialized.
NewBasePoolWithExistingShares returns a pointer to a base pool with existing shares.
NewDenominatedPool creates a new denominated pool from reserve coins.
NewDenominatedPoolWithExistingShares creates a new denominated pool from reserve coins.
NewDepositsQueryResult creates a new DepositsQueryResult.
NewGenesisState creates a new genesis state.
No description provided by the author
NewMsgDeposit returns a new MsgDeposit.
NewMsgSwapExactForTokens returns a new MsgSwapExactForTokens.
NewMsgSwapForExactTokens returns a new MsgSwapForExactTokens.
NewMsgWithdraw returns a new MsgWithdraw.
NewParams returns a new params object.
NewPoolRecord takes reserve coins and total shares, returning a new pool record with a id.
NewPoolRecordFromPool takes a pointer to a denominated pool and returns a pool record for storage in state.
NewPoolStatsQueryResult creates a new PoolStatsQueryResult.
No description provided by the author
NewQueryDepositsParams creates a new QueryDepositsParams.
NewQueryPoolParams creates a new QueryPoolParams.
NewShareRecord takes a depositor, poolID, and shares and returns a new share record for storage in state.
ParamKeyTable for swap module.
PoolID returns an alphabetically sorted pool name from two denoms.
PoolIDFromCoins returns a poolID from a coins object.
PoolKey returns a key generated from a poolID.
RegisterInterfaces registers proto messages under their interfaces for unmarshalling, in addition to registerting the msg service for handling tx msgs.
RegisterLegacyAminoCodec registers all the necessary types and interfaces for the governance module.
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author

# Constants

Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
Event types for swap module.
DefaultParamspace default name for parameter store.
Event types for swap module.
Event types for swap module.
Event types for swap module.
ModuleAccountName name of module account used to hold liquidity.
ModuleName name that will be used throughout the module.
PoolIDSep represents the separator used in pool ids to separate two denominations.
QuerierRoute Top level query string.
Querier routes for the swap module.
Querier routes for the swap module.
Querier routes for the swap module.
Querier routes for the swap module.
RouterKey Top level router key.
StoreKey Top level store key where all module items will be stored.
TypeMsgDeposit represents the type string for MsgDeposit.
TypeMsgWithdraw represents the type string for MsgWithdraw.
TypeSwapExactForTokens represents the type string for MsgSwapExactForTokens.
TypeSwapForExactTokens represents the type string for MsgSwapForExactTokens.

# Variables

Parameter keys and default values.
DefaultPoolRecords is used to set default records in default genesis state.
DefaultShareRecords is used to set default records in default genesis state.
Parameter keys and default values.
key prefixes for store.
swap module errors.
swap module errors.
swap module errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
swap module errors.
swap module errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
swap module errors.
swap module errors.
swap module errors.
swap module errors.
swap module errors.
swap module errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Parameter keys and default values.
Parameter keys and default values.
Parameter keys and default values.
ModuleCdc represents the legacy amino codec for the module.
key prefixes for store.

# Structs

AllowedPool defines a pool that is allowed to be created.
BasePool implements a unitless constant-product liquidity pool.
DenominatedPool implements a denominated constant-product liquidity pool.
DepositResponse defines a single deposit query response type.
DepositsQueryResult contains the result of a deposits query.
GenesisState defines the swap module's genesis state.
MsgDeposit represents a message for depositing liquidity into a pool.
MsgDepositResponse defines the Msg/Deposit response type.
MsgSwapExactForTokens represents a message for trading exact coinA for coinB.
MsgSwapExactForTokensResponse defines the Msg/SwapExactForTokens response type.
MsgSwapForExactTokens represents a message for trading coinA for an exact coinB.
MsgSwapForExactTokensResponse defines the Msg/SwapForExactTokensResponse response type.
MsgWithdraw represents a message for withdrawing liquidity from a pool.
MsgWithdrawResponse defines the Msg/Withdraw response type.
Params defines the parameters for the swap module.
PoolRecord represents the state of a liquidity pool and is used to store the state of a denominated pool.
Pool represents the state of a single pool.
PoolStatsQueryResult contains the result of a pool query.
QueryDepositsParams is the params for a filtered deposits query.
QueryDepositsRequest is the request type for the Query/Deposits RPC method.
QueryDepositsResponse is the response type for the Query/Deposits RPC method.
QueryParamsRequest defines the request type for querying x/swap parameters.
QueryParamsResponse defines the response type for querying x/swap parameters.
QueryPoolParams is the params for a pool query.
QueryPoolsRequest is the request type for the Query/Pools RPC method.
QueryPoolsResponse is the response type for the Query/Pools RPC method.
ShareRecord stores the shares owned for a depositor and pool.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.

# Interfaces

AccountKeeper defines the expected account keeper (noalias).
BankKeeper defines the expected interface needed to retrieve account balances.
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
MsgWithDeadline allows messages to define a deadline of when they are considered invalid.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.
SwapHooks are event hooks called when a user's deposit to a swap pool changes.

# Type aliases

AllowedPools is a slice of AllowedPool.
DepositsQueryResults is a slice of DepositsQueryResult.
PoolRecords is a slice of PoolRecord.
PoolStatsQueryResults is a slice of PoolStatsQueryResult.
ShareRecords is a slice of ShareRecord.