x/

directory
v25.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 25, 2024 License: Apache-2.0

README

Osmosis modules

Osmosis implements the following custom modules:

  • epochs - Makes on-chain timers which other modules can execute code during.
  • gamm - Generalized AMM infrastructure, which includes balancer and stableswap
  • incentives - Controls specification and distribution of rewards to lockups
  • lockup - Enables time-lock escrowing of tokens. (Often called Locking or Bonding)
  • mint - Controls token supply emissions, and what modules they are directed to.
  • pool-incentives - Controls how incentives allocated towards "Liquidity Providing" are directed
    • These go towards gauges defined by the incentives module
  • protorev - Cyclic arbitrage module that redistributes backrunning profits to the protocol
  • superfluid - Defines superfluid staking, allowing DeFi assets to have their osmo-backing be staked.
  • tokenfactory - Allows minting of new tokens of the form factory/{creator address}/{subdenom} for user-defined subdenoms.
  • twap - The TWAP package is responsible for being able to serve TWAPs for every AMM pool.
  • txfees - Contains logic for whitelisting txfee tokens, making them easily priceable in osmo, and auto-swapping to osmo.
    • Also contains logic for custom Osmosis mempool logic, though this should perhaps relocate.

See the module dependence graph below for further information:

ModuleDependenceGraph

This is done in addition to updates to several modules within the SDK.

  • gov - {Voting period changes}
  • vesting - {vesting changes}
  • Various binding & performance improvements to other modules

Directories

Path Synopsis
This file implements the poolmanagertypes.PoolModule interface
This file implements the poolmanagertypes.PoolModule interface
Incentives module provides general interface to give yield to stakers.
Incentives module provides general interface to give yield to stakers.
The `mint` module is responsible for creating tokens in a flexible way to reward validators, incentivize providing pool liquidity, provide funds for Osmosis governance, and pay developers to maintain and improve Osmosis.
The `mint` module is responsible for creating tokens in a flexible way to reward validators, incentivize providing pool liquidity, provide funds for Osmosis governance, and pay developers to maintain and improve Osmosis.
The `pool-incentives` module automatically creates individual gauges in the `incentives` module for every lock duration that exists in that pool.
The `pool-incentives` module automatically creates individual gauges in the `incentives` module for every lock duration that exists in that pool.
The superfluid module handles all logic in relation to the superfluid staking feature on Osmosis.
The superfluid module handles all logic in relation to the superfluid staking feature on Osmosis.
The tokenfactory module allows any account to create a new token with the name `factory/{creator address}/{subdenom}`.
The tokenfactory module allows any account to create a new token with the name `factory/{creator address}/{subdenom}`.
The txfees modules allows nodes to easily support many tokens for usage as txfees, while letting node operators only specify their tx fee parameters for a single "base" asset.
The txfees modules allows nodes to easily support many tokens for usage as txfees, while letting node operators only specify their tx fee parameters for a single "base" asset.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL