Documentation
¶
Index ¶
- Constants
- Variables
- func AppStateFromGenesisFileFn(r io.Reader, cdc codec.JSONCodec, genesisFile string) (cmttypes.GenesisDoc, []simtypes.Account)
- func BlockedAddresses() map[string]bool
- func EnsureERC2470AuthAccount(cdc codec.JSONCodec, appState GenesisState)
- func GetWasmOpts(nibiru NibiruApp, appOpts servertypes.AppOptions, ...) []wasmkeeper.Option
- func NewAnteHandler(keepers AppKeepers, options ante.AnteHandlerOptions) sdk.AnteHandler
- func NewAnteHandlerNonEVM(pk keepers.PublicKeepers, opts ante.AnteHandlerOptions) sdk.AnteHandler
- func NewEVMPrepareProposalHandler(app *NibiruApp, verifier prepareProposalTxVerifier) sdk.PrepareProposalHandler
- func RegisterSwaggerAPI(ctx client.Context, rtr *mux.Router)
- func SetPrefixes(accountAddressPrefix string)
- type AppKeepers
- type AuthModule
- type BankModule
- type CrisisModule
- type EncodingConfig
- type GenesisState
- type GovModule
- type NibiruApp
- func (app *NibiruApp) AppCodec() codec.Codec
- func (app *NibiruApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
- func (app *NibiruApp) CommitTimeoutFunc() cs.CommitTimeoutFunc
- func (app *NibiruApp) DefaultGenesis() GenesisState
- func (app *NibiruApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
- func (app *NibiruApp) ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs []string, modulesToExport []string) (servertypes.ExportedApp, error)
- func (app *NibiruApp) GetAccountKeeper() authkeeper.AccountKeeper
- func (app *NibiruApp) GetBankKeeper() bankkeeper.Keeper
- func (app *NibiruApp) GetBaseApp() *baseapp.BaseApp
- func (app *NibiruApp) GetIBCKeeper() *ibckeeper.Keeper
- func (app *NibiruApp) GetKey(storeKey string) *storetypes.KVStoreKey
- func (app *NibiruApp) GetScopedIBCKeeper() capabilitykeeper.ScopedKeeper
- func (app *NibiruApp) GetStakingKeeper() *stakingkeeper.Keeper
- func (app *NibiruApp) GetTransferKeeper() ibctransferkeeper.Keeper
- func (app *NibiruApp) GetTxConfig() client.TxConfig
- func (app *NibiruApp) GetWasmKeeper() wasmkeeper.Keeper
- func (app *NibiruApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
- func (app *NibiruApp) InterfaceRegistry() codectypes.InterfaceRegistry
- func (app *NibiruApp) LegacyAmino() *codec.LegacyAmino
- func (app *NibiruApp) LoadHeight(height int64) error
- func (app *NibiruApp) ModuleAccountAddrs() map[string]bool
- func (app *NibiruApp) Name() string
- func (app *NibiruApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)
- func (app *NibiruApp) RegisterNodeService(clientCtx client.Context)
- func (app *NibiruApp) RegisterTendermintService(clientCtx client.Context)
- func (app *NibiruApp) RegisterTxService(clientCtx client.Context)
- func (app *NibiruApp) ResolveSaiOracleAddr(ctx sdk.Context) (string, error)
- func (app *NibiruApp) SimulationManager() *module.SimulationManager
- type StakingModule
Constants ¶
const DefaultMaxTxGasWanted uint64 = 0
const (
DisplayDenom = "NIBI"
)
Variables ¶
var ( // DefaultNodeHome default home directories for the application daemon DefaultNodeHome string // ModuleBasics defines the module BasicManager is in charge of setting up basic, // non-dependant module elements, such as codec registration // and genesis verification. ModuleBasics = module.NewBasicManager( AuthModule{}, genutil.NewAppModuleBasic(genutiltypes.DefaultMessageValidator), BankModule{}, capability.AppModuleBasic{}, StakingModule{}, distr.AppModuleBasic{}, NewGovModuleBasic( paramsclient.ProposalHandler, upgradeclient.LegacyProposalHandler, upgradeclient.LegacyCancelProposalHandler, ibcclientclient.UpdateClientProposalHandler, ibcclientclient.UpgradeProposalHandler, ), params.AppModuleBasic{}, CrisisModule{}, slashing.AppModuleBasic{}, feegrantmodule.AppModuleBasic{}, upgrade.AppModuleBasic{}, evidence.AppModuleBasic{}, authzmodule.AppModuleBasic{}, ibc.AppModuleBasic{}, ibctransfer.AppModuleBasic{}, ibctm.AppModuleBasic{}, ica.AppModuleBasic{}, ibcwasm.AppModuleBasic{}, evmmodule.AppModuleBasic{}, oraclemod.AppModuleBasic{}, epochsmod.AppModuleBasic{}, mintmod.AppModuleBasic{}, sudomodule.AppModuleBasic{}, wasm.AppModuleBasic{}, devgas.AppModuleBasic{}, tokenfactory.AppModuleBasic{}, genmsg.AppModule{}, ) )
var (
AppConfig depinject.Config
)
var ErrOracleAdapterNotConfigured = errors.New("x-oracle adapter has no Sai oracle")
ErrOracleAdapterNotConfigured reports that state names no x-oracle adapter or that the adapter runs in fixture mode, so there is no Sai oracle address to match. It selects the [oracleLaneRule] fallback without an error log.
var Upgrades = upgrades.AllUpgrades
Functions ¶
func AppStateFromGenesisFileFn ¶
func AppStateFromGenesisFileFn(r io.Reader, cdc codec.JSONCodec, genesisFile string) (cmttypes.GenesisDoc, []simtypes.Account)
AppStateFromGenesisFileFn util function to generate the genesis AppState from a genesis.json file.
func BlockedAddresses ¶
BlockedAddresses returns all the app's blocked account addresses.
func EnsureERC2470AuthAccount ¶ added in v2.17.0
func EnsureERC2470AuthAccount(cdc codec.JSONCodec, appState GenesisState)
EnsureERC2470AuthAccount adds the canonical factory's auth account to a caller-supplied genesis when a test or tooling path replaces the default auth genesis wholesale.
func GetWasmOpts ¶
func GetWasmOpts( nibiru NibiruApp, appOpts servertypes.AppOptions, wasmMsgHandlerArgs wasmext.MsgHandlerArgs, ) []wasmkeeper.Option
GetWasmOpts build wasm options
func NewAnteHandler ¶
func NewAnteHandler( keepers AppKeepers, options ante.AnteHandlerOptions, ) sdk.AnteHandler
NewAnteHandler returns and AnteHandler that checks and increments sequence numbers, checks signatures and account numbers, and deducts fees from the first signer.
func NewAnteHandlerNonEVM ¶
func NewAnteHandlerNonEVM( pk keepers.PublicKeepers, opts ante.AnteHandlerOptions, ) sdk.AnteHandler
NewAnteHandlerNonEVM: Default ante handler for non-EVM transactions.
func NewEVMPrepareProposalHandler ¶ added in v2.17.0
func NewEVMPrepareProposalHandler( app *NibiruApp, verifier prepareProposalTxVerifier, ) sdk.PrepareProposalHandler
NewEVMPrepareProposalHandler returns Nibiru's EVM-aware proposal builder.
The handler snapshots evm.Mempool via evm.Mempool.Snapshot and selects each sender's complete state nonce chain (contiguous live slots from the committed state nonce) through [executableProposalChains], prioritizes executable sender heads with [proposalHeap], and returns original outer bytes from evm.MempoolTx.TxBytes.
The proposal is built in [proposalLane] order, as assigned by [classifyProposalTx]:
- Oracle lane: zero-gas actor transactions (x/sudo ZeroGasActors) that call the Sai oracle contract, signed by their sender alone ([isOracleLaneTx]). Any oracle execute qualifies: price writes, expiration updates, and permission or admin calls.
- Zero-gas lane: other zero-gas actor transactions, such as keeper calls and oracle calls with a co-signer or a distinct fee payer.
- EVM lane: the [proposalHeap] selection above.
- Default lane: all other non-EVM transactions.
The Sai oracle address is read once per proposal from committed state, through the x-oracle adapter named by the EVM params Wasm plugins ([resolveOracleLaneRule]). When the plugin is missing, the adapter is in fixture mode, or the query fails, the oracle lane falls back to price writes matched by message key ([isOraclePriceWriteMsg]).
Lanes 1, 2, and 4 come from RequestPrepareProposal.Txs and keep their CometBFT-provided relative order. EVM transactions present in req.Txs are ignored so proposal construction does not rebuild the EVM index from Comet candidates.
Putting oracle calls first means that, in a block that contains a price write, every later transaction, including keeper actions and trades submitted as EVM transactions, executes against that write rather than the previous block's price. This holds only when all of the following are true:
- The block contains a price write at all.
- CometBFT reaped the write into req.Txs. Reaping is FIFO under the block byte limit, and EVM transactions also occupy the CometBFT mempool, so under a large backlog the write may be absent while the EVM lane still fills from the app mempool.
- The proposer runs this handler. ProcessProposal does not check lane order, so another proposer may order the block differently.
Closing the reap gap and enforcing lane order in ProcessProposal are scope for the lane-enforcement follow-up; this handler is proposer-local.
A signer's non-EVM transactions are never reordered across lanes. Earlier candidates are promoted to the lane of a later candidate sharing a signer, so a fast-lane transaction keeps its lane (see [splitNonEVMProposalTxs]). Promotion is computed over all candidates before selection, so a promoted transaction keeps its lane even when the transaction that promoted it is skipped; the block stays valid. This does not track the EVM mempool, so if one account has an EVM transaction at nonce N and a zero-gas Cosmos transaction at sequence N+1, the Cosmos transaction is verified first, fails its sequence check, and waits for a later block. Zero-gas actor keys do not send EVM transactions in practice, so this case is accepted.
Every lane shares one byte and gas budget, filled in lane order; a candidate that does not fit is skipped and stays in the CometBFT mempool. In addition, lanes 1 and 2 together may use at most 1/[priorityLanesMaxBytesDivisor] of RequestPrepareProposal.MaxTxBytes, filled oracle lane first. The cap bounds what a compromised or runaway zero-gas actor key, which pays no fees, can take from the EVM and default lanes.
Gas is charged at each transaction's declared limit, because the default ProcessProposal sums declared gas against max_gas. Zero-gas actor transactions execute on a fixed zero gas meter but may declare a large limit, so with a finite max_gas, lanes 1 and 2 can use the gas budget before any EVM transaction is considered. A per-lane gas cap is left for the lane-enforcement follow-up. With max_gas = -1 the hazard does not apply.
A recovered panic yields an empty proposal rather than an unfiltered EVM candidate set. Node-local mempool membership affects only this node's candidate selection; ProcessProposal and delivery validate from proposal bytes and application state alone.
func RegisterSwaggerAPI ¶
RegisterSwaggerAPI registers swagger route with API Server
func SetPrefixes ¶
func SetPrefixes(accountAddressPrefix string)
Types ¶
type AppKeepers ¶
type AppKeepers struct {
keepers.PublicKeepers
// contains filtered or unexported fields
}
type AuthModule ¶ added in v2.17.0
type AuthModule struct {
auth.AppModuleBasic
}
AuthModule extends the Cosmos SDK auth default genesis with the canonical ERC-2470 EthAccount required by the matching EVM genesis account.
func (AuthModule) DefaultGenesis ¶ added in v2.17.0
func (AuthModule) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
func (AuthModule) RegisterInterfaces ¶ added in v2.17.0
func (AuthModule) RegisterInterfaces(registry codectypes.InterfaceRegistry)
type BankModule ¶
type BankModule struct {
bank.AppModuleBasic
}
BankModule defines a custom wrapper around the x/bank module's AppModuleBasic implementation to provide custom default genesis state.
func (BankModule) DefaultGenesis ¶
func (BankModule) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns custom Nibiru x/bank module genesis state.
type CrisisModule ¶
type CrisisModule struct {
crisis.AppModuleBasic
}
CrisisModule defines a custom wrapper around the x/crisis module's AppModuleBasic implementation to provide custom default genesis state.
func (CrisisModule) DefaultGenesis ¶
func (CrisisModule) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns custom Nibiru x/crisis module genesis state.
type EncodingConfig ¶
type EncodingConfig struct {
InterfaceRegistry types.InterfaceRegistry
Codec codec.Codec
TxConfig client.TxConfig
Amino *codec.LegacyAmino
}
EncodingConfig specifies the concrete encoding types to use for a given app. This is provided for compatibility between protobuf and amino implementations.
func MakeEncodingConfig ¶
func MakeEncodingConfig() EncodingConfig
MakeEncodingConfig creates an EncodingConfig for an amino based test configuration.
type GenesisState ¶
type GenesisState map[string]json.RawMessage
GenesisState of the blockchain is represented here as a map of raw json messages key'd by a identifier string. The identifier is used to determine which module genesis information belongs to so it may be appropriately routed during init chain. Within this application default genesis information is retrieved from the ModuleBasicManager which populates json from each BasicModule object provided to it during init.
type GovModule ¶
type GovModule struct {
gov.AppModuleBasic
}
GovModule defines a custom wrapper around the x/gov module's AppModuleBasic implementation to provide custom default genesis state.
func NewGovModuleBasic ¶
func NewGovModuleBasic(proposalHandlers ...govclient.ProposalHandler) GovModule
func (GovModule) DefaultGenesis ¶
func (GovModule) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns custom Nibiru x/gov module genesis state.
type NibiruApp ¶
type NibiruApp struct {
*runtime.App
EvmMempool *evm.Mempool
AppKeepers // embed all module keepers
// contains filtered or unexported fields
}
NibiruApp extends an ABCI application, but with most of its parameters exported. They are exported for convenience in creating helper functions, as object capabilities aren't needed for testing.
func NewNibiruApp ¶
func NewNibiruApp( logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bool, appOpts servertypes.AppOptions, baseAppOptions ...func(*baseapp.BaseApp), ) *NibiruApp
NewNibiruApp returns a reference to an initialized NibiruApp.
func (*NibiruApp) AppCodec ¶
AppCodec returns SimApp's app codec.
NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.
func (*NibiruApp) BeginBlocker ¶
func (app *NibiruApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
BeginBlocker application updates every begin block
func (*NibiruApp) CommitTimeoutFunc ¶
func (app *NibiruApp) CommitTimeoutFunc() cs.CommitTimeoutFunc
CommitTimeoutFunc returns the hook Nibiru BFT uses for its commit wait (node.CommitTimeoutFunc). The x-consensus value min_block_commit_duration_ms replaces config.toml timeout_commit on every node once it is set.
The engine calls the hook under its consensus mutex after committing H, with height H+1, so the closure only loads an atomic. The x/consensus EndBlocker sets it during EndBlock H, before that commit, which makes a change executed in H govern the wait before H+1, together with the app params and header of H+1. The height argument is not needed for that.
func (*NibiruApp) DefaultGenesis ¶ added in v2.17.0
func (app *NibiruApp) DefaultGenesis() GenesisState
DefaultGenesis returns the application default genesis using Nibiru's customized ModuleBasics. This keeps app-generated genesis (including test apps) aligned with `nibid init` and includes the paired ERC-2470 auth/EVM accounts.
func (*NibiruApp) EndBlocker ¶
func (app *NibiruApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
EndBlocker application updates every end block
func (*NibiruApp) ExportAppStateAndValidators ¶
func (app *NibiruApp) ExportAppStateAndValidators( forZeroHeight bool, jailAllowedAddrs []string, modulesToExport []string, ) (servertypes.ExportedApp, error)
ExportAppStateAndValidators exports the state of the application for a genesis file.
func (*NibiruApp) GetAccountKeeper ¶ added in v2.17.0
func (app *NibiruApp) GetAccountKeeper() authkeeper.AccountKeeper
func (*NibiruApp) GetBankKeeper ¶ added in v2.17.0
func (app *NibiruApp) GetBankKeeper() bankkeeper.Keeper
func (*NibiruApp) GetBaseApp ¶
func (*NibiruApp) GetIBCKeeper ¶
func (*NibiruApp) GetKey ¶
func (app *NibiruApp) GetKey(storeKey string) *storetypes.KVStoreKey
GetKey returns the KVStoreKey for the provided store key.
NOTE: This is solely to be used for testing purposes.
func (*NibiruApp) GetScopedIBCKeeper ¶
func (app *NibiruApp) GetScopedIBCKeeper() capabilitykeeper.ScopedKeeper
func (*NibiruApp) GetStakingKeeper ¶
func (app *NibiruApp) GetStakingKeeper() *stakingkeeper.Keeper
func (*NibiruApp) GetTransferKeeper ¶ added in v2.17.0
func (app *NibiruApp) GetTransferKeeper() ibctransferkeeper.Keeper
func (*NibiruApp) GetTxConfig ¶
func (*NibiruApp) GetWasmKeeper ¶ added in v2.17.0
func (app *NibiruApp) GetWasmKeeper() wasmkeeper.Keeper
These keeper getters satisfy the first-party Wasm IBC test harness interface. Production code should prefer direct field access on NibiruApp.
func (*NibiruApp) InitChainer ¶
func (app *NibiruApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
InitChainer application update at chain initialization
func (*NibiruApp) InterfaceRegistry ¶
func (app *NibiruApp) InterfaceRegistry() codectypes.InterfaceRegistry
InterfaceRegistry returns App's InterfaceRegistry
func (*NibiruApp) LegacyAmino ¶
func (app *NibiruApp) LegacyAmino() *codec.LegacyAmino
LegacyAmino returns SimApp's amino codec.
NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.
func (*NibiruApp) LoadHeight ¶
LoadHeight loads a particular height
func (*NibiruApp) ModuleAccountAddrs ¶
ModuleAccountAddrs returns all the app's module account addresses.
func (*NibiruApp) RegisterAPIRoutes ¶
RegisterAPIRoutes registers all application module routes with the provided API server.
func (*NibiruApp) RegisterNodeService ¶
func (*NibiruApp) RegisterTendermintService ¶
RegisterTendermintService implements the Application.RegisterTendermintService method.
func (*NibiruApp) RegisterTxService ¶
RegisterTxService implements the Application.RegisterTxService method.
func (*NibiruApp) ResolveSaiOracleAddr ¶
ResolveSaiOracleAddr returns the Sai oracle address that PrepareProposal uses for [proposalLaneOracle], read from the committed state in ctx. It is empty when the lane uses the fallback; the error says why, as described in [resolveOracleLaneRule].
func (*NibiruApp) SimulationManager ¶
func (app *NibiruApp) SimulationManager() *module.SimulationManager
SimulationManager implements the SimulationApp interface
type StakingModule ¶
type StakingModule struct {
staking.AppModuleBasic
}
StakingModule defines a custom wrapper around the x/staking module's AppModuleBasic implementation to provide custom default genesis state.
func (StakingModule) DefaultGenesis ¶
func (StakingModule) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns custom Nibiru x/staking module genesis state.
func (StakingModule) ValidateGenesis ¶
func (StakingModule) ValidateGenesis( cdc codec.JSONCodec, txConfig sdkclient.TxEncodingConfig, bz json.RawMessage, ) error
ValidateGenesis: Verifies that the provided staking genesis state holds expected invariants. I.e., params in correct bounds, no duplicate validators. This implements the module.HasGenesisBasics interface and gets called during the setup of the chain's module.BasicManager.