-
Notifications
You must be signed in to change notification settings - Fork 195
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.
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
fix: unwire spot module for main branch #1831
Changes from 5 commits
6cc5357
c7d06d6
c7e901b
79b704b
7dc56be
32514fc
96e0599
3078576
33d933f
e9f10e7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -22,17 +22,17 @@ | |||
|
||||
## ⚙️ — Documentation | ||||
|
||||
- [Docs | Nibiru Chain](https://nibiru.fi/docs/): Conceptual and technical documentation can be found here. | ||||
- [Docs | Nibiru Chain](https://nibiru.fi/docs/): Conceptual and technical documentation can be found here. | ||||
- [Complete Golang reference docs](https://pkg.go.dev/github.com/NibiruChain/nibiru): (`pkg.go.dev`) For the blockchain implementation . | ||||
- ["X Module"](https://nibiru.fi/docs/dev/x/)-specific documentation | ||||
|
||||
## 💬 — Community | ||||
|
||||
If you have questions or concerns, feel free to connect with a developer or community member in the [Nibiru Discord][social-discord]. We also have active communities on [Twitter][social-twitter] and [Telegram][social-telegram]. | ||||
|
||||
<!-- Markdown versions of the social badges | ||||
[![description][discord-badge]][social-discord] | ||||
[![description][twitter-badge]][social-twitter] | ||||
<!-- Markdown versions of the social badges | ||||
[![description][discord-badge]][social-discord] | ||||
[![description][twitter-badge]][social-twitter] | ||||
[![description][telegram-badge]][social-telegram] | ||||
--> | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The operating system from Apple should be written as “macOS” instead of “MacOS” to align with the official branding and naming conventions. - Unix system: MacOS or Ubuntu 18+
+ Unix system: macOS or Ubuntu 18+ |
||||
|
@@ -44,33 +44,30 @@ If you have questions or concerns, feel free to connect with a developer or comm | |||
|
||||
## 🧱 — Components of Nibiru | ||||
|
||||
- **CosmWasm Smart Contracts**: Rust-based, Wasm smart contracts built enhanced security, performance, and interoperability. See our [CosmWasm sandbox monorepo (cw-nibiru)](https://github.com/NibiruChain/cw-nibiru/tree/main) for the protocol's core smart contracts. | ||||
- **Nibi-Perps**: A perpetual futures exchange where users can take leveraged exposure and trade on a plethora of assets — completely on-chain, completely non-custodially, and with minimal gas fees. | ||||
- **CosmWasm Smart Contracts**: Rust-based, Wasm smart contracts built enhanced security, performance, and interoperability. See our [CosmWasm sandbox monorepo (cw-nibiru)](https://github.com/NibiruChain/cw-nibiru/tree/main) for the protocol's core smart contracts. | ||||
- **Nibi-Oracle**: Nibiru accurately prices assets using a native, system of decentralized oracles, and communicates with other Cosmos layer-1 chains using the Inter-Blockchain Communication (IBC) (opens new window)protocol. | ||||
- **Nibi-Swap**: An automated market maker protocol for multichain assets. This application gives users access to swaps, pools, and bonded liquidity gauges. | ||||
|
||||
| Module | Description | | ||||
| --- | --- | | ||||
| [wasm][code-x-wasm] | Implements the execution environment for [WebAssembly (WASM) smart contracts](https://nibiru.fi/docs/wasm/). | | ||||
| [devgas][code-x-devgas] | The `devgas` module of Nibiru Chain shares contract execution fees with smart contract developers. This aims to increase the adoption of Nibiru by offering CosmWasm smart contract developers a direct source of income based on usage. | | ||||
| [epochs][code-x-epochs] | The `epochs` module allows other modules to set hooks to be called to execute code automatically on a period basis. For example, "once a week, starting at UTC-time = x". `epochs` creates a generalized epoch interface. | | ||||
| [inflation][code-x-inflation] | Implements the [tokenomics](https://nibiru.fi/docs/learn/tokenomics.html) for Nibiru. | | ||||
| [common][code-x-common] | Holds helper and utility functions to be utilized by other `x/` modules. | | ||||
| [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. | | ||||
| Module | Description | | ||||
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||||
| [wasm][code-x-wasm] | Implements the execution environment for [WebAssembly (WASM) smart contracts](https://nibiru.fi/docs/wasm/). | | ||||
| [devgas][code-x-devgas] | The `devgas` module of Nibiru Chain shares contract execution fees with smart contract developers. This aims to increase the adoption of Nibiru by offering CosmWasm smart contract developers a direct source of income based on usage. | | ||||
| [epochs][code-x-epochs] | The `epochs` module allows other modules to set hooks to be called to execute code automatically on a period basis. For example, "once a week, starting at UTC-time = x". `epochs` creates a generalized epoch interface. | | ||||
| [inflation][code-x-inflation] | Implements the [tokenomics](https://nibiru.fi/docs/learn/tokenomics.html) for Nibiru. | | ||||
| [common][code-x-common] | Holds helper and utility functions to be utilized by other `x/` modules. | | ||||
| [oracle][code-x-oracle] | Handles the posting of an up-to-date and accurate feed of exchange rates from the validators. | | ||||
| [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. | | ||||
|
||||
[code-x-common]: https://github.com/NibiruChain/nibiru/tree/main/x/common | ||||
[code-x-devgas]: https://nibiru.fi/docs/dev/x/nibiru-chain/devgas.html | ||||
[code-x-epochs]: https://github.com/NibiruChain/nibiru/tree/main/x/epochs | ||||
[code-x-inflation]: https://github.com/NibiruChain/nibiru/tree/main/x/inflation | ||||
[code-x-oracle]: https://github.com/NibiruChain/nibiru/tree/main/x/oracle | ||||
[code-x-perp]: https://github.com/NibiruChain/nibiru/tree/main/x/perp | ||||
[code-x-spot]: https://github.com/NibiruChain/nibiru/tree/main/x/spot | ||||
|
||||
Nibiru is built with the [Cosmos-SDK][cosmos-sdk-repo] on [Tendermint Core](https://tendermint.com/core/) consensus and communicates with other blockchain chains using the [Inter-Blockchain Communication (IBC)](https://github.com/cosmos/ibc) protocol. | ||||
|
||||
---- | ||||
--- | ||||
|
||||
## ⛓️ — Building: `make` commands | ||||
|
||||
|
@@ -94,10 +91,12 @@ Usage instructions for the `nibid` CLI are available at [docs.nibiru.fi/dev/cli] | |||
### Running a Local Node | ||||
|
||||
On a fresh clone of the repo, simply run: | ||||
|
||||
```bash | ||||
make localnet | ||||
``` | ||||
and open another terminal. | ||||
``` | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This sentence does not start with an uppercase letter. Ensure that the documentation follows consistent grammatical rules for readability and professionalism. - and open another terminal.
+ And open another terminal. Committable suggestion
Suggested change
|
||||
and open another terminal. | ||||
|
||||
### Generate the protobufs | ||||
|
||||
|
@@ -131,19 +130,13 @@ Licensed under the [MIT License](./LICENSE.md). | |||
|
||||
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg | ||||
[cosmos-sdk-repo]: https://github.com/cosmos/cosmos-sdk | ||||
[badge-go-linter]: | ||||
https://github.com/NibiruChain/nibiru/actions/workflows/golangci-lint.yml/badge.svg?query=branch%3Amain | ||||
[workflow-go-linter]: | ||||
https://github.com/NibiruChain/nibiru/actions/workflows/golangci-lint.yml?query=branch%3Amain | ||||
[badge-go-releaser]: | ||||
https://github.com/NibiruChain/nibiru/actions/workflows/goreleaser.yml/badge.svg?query=branch%3Amain | ||||
[workflow-go-releaser]: | ||||
https://github.com/NibiruChain/nibiru/actions/workflows/goreleaser.yml?query=branch%3Amain | ||||
|
||||
[badge-go-linter]: https://github.com/NibiruChain/nibiru/actions/workflows/golangci-lint.yml/badge.svg?query=branch%3Amain | ||||
[workflow-go-linter]: https://github.com/NibiruChain/nibiru/actions/workflows/golangci-lint.yml?query=branch%3Amain | ||||
[badge-go-releaser]: https://github.com/NibiruChain/nibiru/actions/workflows/goreleaser.yml/badge.svg?query=branch%3Amain | ||||
[workflow-go-releaser]: https://github.com/NibiruChain/nibiru/actions/workflows/goreleaser.yml?query=branch%3Amain | ||||
[social-twitter]: https://twitter.com/NibiruChain | ||||
[social-discord]: https://discord.gg/nibirufi | ||||
[social-telegram]: https://t.me/nibiruchain | ||||
|
||||
[discord-badge]: https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white | ||||
[twitter-badge]: https://img.shields.io/badge/Twitter-1DA1F2?&logo=twitter&logoColor=white | ||||
[telegram-badge]: https://img.shields.io/badge/Telegram-2CA5E0?&logo=telegram&logoColor=white | ||||
|
@@ -153,7 +146,7 @@ https://github.com/NibiruChain/nibiru/actions/workflows/goreleaser.yml?query=bra | |||
|
||||
[](https://github.com/NibiruChain/nibiru/releases/latest) | ||||
|
||||
[](https://goreportcard.com/report/github.com/NibiruChain/nibiru) | ||||
[](https://goreportcard.com/report/github.com/NibiruChain/nibiru) | ||||
|
||||
[](https://godoc.org/github.com/NibiruChain/nibiru) | ||||
|
||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "For the blockchain implementation." should not have a space before the period. Consider revising to maintain grammatical correctness.
Committable suggestion