Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: fix readme #1508

Merged
merged 1 commit into from
Jul 17, 2023
Merged

fix: fix readme #1508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions x/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# 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/). |
| 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
Expand Down
Loading