-
Notifications
You must be signed in to change notification settings - Fork 202
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
In order to keep module docs in sync between this repo and the official docs site
- Loading branch information
1 parent
82aa7d9
commit cf9cf35
Showing
1 changed file
with
1 addition
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,3 @@ | ||
| # Nibiru Modules | ||
|
|
||
| | Module | Active? | Description | | ||
| | ------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [common][code-x-common] | ✔️ | Holds helper and utility functions to be utilized by other `x/` modules. | | ||
| | [epochs][code-x-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][code-x-oracle] | ✔️ | Handles the posting of an up-to-date and accurate feed of exchange rates from the validators. | | ||
| | [perp][code-x-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][code-x-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][code-x-stablecoin] | ⭕️ | Resonsible for handling mint and redeem transactions with NUSD. | | ||
| | [testutil][code-x-testutil] | ✔️ | Helper functions for unit and integration tests. | | ||
| | [wasm][code-x-wasm] | ✔️ | Implements the execution environment for [WebAssembly (WASM) smart contracts](https://book.cosmwasm.com/). | | ||
|
|
||
| [code-x-common]: https://github.com/NibiruChain/nibiru/tree/master/x/common | ||
| [code-x-epochs]: https://github.com/NibiruChain/nibiru/tree/master/x/epochs | ||
| [code-x-oracle]: https://github.com/NibiruChain/nibiru/tree/master/x/oracle | ||
| [code-x-perp]: https://github.com/NibiruChain/nibiru/tree/master/x/perp | ||
| [code-x-spot]: https://github.com/NibiruChain/nibiru/tree/master/x/spot | ||
| [code-x-stablecoin]: https://github.com/NibiruChain/nibiru/tree/master/x/stablecoin | ||
| [code-x-testutil]: https://github.com/NibiruChain/nibiru/tree/master/x/testutil | ||
| [code-x-wasm]: https://github.com/NibiruChain/nibiru/tree/master/x/wasm | ||
| See [BlockChain Modules - Nibiru Docs](https://nibiru.fi/docs/dev/x/) |