README
¶
Nibiru Modules
| Module | Active? | Description |
|---|---|---|
| common | Holds helper and utility functions to be utilized by other x/ modules. |
|
| epochs | Often in the SDK, we would like to run certain code every-so often. The purpose of epochs module is to allow other modules to set that they would like to be signaled once every period. So another module can specify it wants to execute code once a week, starting at UTC-time = x. epochs creates a generalized epoch interface to other modules so that they can easily be signalled upon such events. |
|
| oracle | Handles the posting of an up-to-date and accurate feed of exchange rates from the validators. | |
| perp | Powers the Nibi-Perps exchange. This module enables traders to open long and short leveraged positions and houses all of the PnL calculation and liquidation logic. | |
| spot | Responsible for creating, joining, and exiting liquidity pools. It also allows users to swap between two assets in an existing pool. It's a fully functional AMM. | |
| stablecoin | Resonsible for handling mint and redeem transactions with NUSD. | |
| testutil | Helper functions for unit and integration tests. | |
| wasm | Implements the execution environment for WebAssembly (WASM) smart contracts. |
Directories
¶
| Path | Synopsis |
|---|---|
|
testutil
Package nullify provides methods to init nil values structs for test assertion.
|
Package nullify provides methods to init nil values structs for test assertion. |
|
testutil/cli
Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators.
|
Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
keeper
nolint
|
nolint |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
perp
|
|
|
v2/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
keeper
Package keeper that mints Nibiru stablecoins, maintains their price stability, and ensures that the protocol remains collateralized enough for stablecoins to be redeemed.
|
Package keeper that mints Nibiru stablecoins, maintains their price stability, and ensures that the protocol remains collateralized enough for stablecoins to be redeemed. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
pb
Package pb is a reverse proxy.
|
Package pb is a reverse proxy. |
|
wasm
|
|
Click to show internal directories.
Click to hide internal directories.