Skip to content

Latest commit

 

History

History
133 lines (91 loc) · 5.98 KB

README.md

File metadata and controls

133 lines (91 loc) · 5.98 KB
Raw

Nibiru Chain

Nibiru Test workflow Nibiru Test workflow GitHub Personal Website Nibiru Discord Nibiru Medium Blog

Nibiru Chain is a proof-of-stake blockchain and member of a family of interconnected blockchains that comprise the Cosmos Ecosystem. Nibiru powers three main decentralized applications:

  • Nibi-Perps - Perpetuals Exchange: On the perps exchange, users can take leveraged exposure and trade on a plethora of assets: completely on-chain, completely non-custodially, and with minimal gas fees.
  • Nibi-Swap - Spot AMM: An automated market maker for multichain assets. This application gives users access to swaps, pools, and bonded liquidity gauges.
  • NUSD Stablecoin: Nibiru employs a two-token economic model, where NIBI is the governance and utility token for the protocol and NUSD is a capital-efficient, partially collateralized algorithmic stablecoin created by the protocol.

Nibiru is built with the Cosmos-SDK, accurately prices assets using a system of decentralized oracles, and communicates with other Cosmos layer-1 chains using the Inter-Blockchain Communication (IBC) protocol.

⚙️ — Documentation

Conceptual and technical documentation can be found in the Nibiru docs. Each module also contains a detailed specification in its "spec" directory (e.g. x/stablecoin/spec).

💬 — Community

If you have questions or concerns, feel free to connect with a developer or community member in the Nibiru discord. We also have active communities on Twitter and Telegram.

Discord Tweet Telegram

⛓️ Installation: Developing on the chain locally

Installation instructions for the nibid binary can be found in INSTALL.md.

Recommended minimum specs:

  • 2CPU, 4GB RAM, 100GB SSD
  • Unix system: MacOS or Ubuntu 18+

Nibid CLI

To simply access the nibid CLI, run:

make install

Usage instructions for the nibid CLI are available at docs.nibiru.fi/dev/cli and the Nibiru Module Reference.

Running a Local Node

On a fresh clone of the repo, simply run:

make localnet

and open another terminal.

Generate the protobufs

make proto-gen

Linter

We use the golangci-lint linter. Install it and run

golangci-lint run

at the root directory. You can also install the VSCode or Goland IDE plugins.

Multiple Nodes

Run the following commands to set up a local network of Docker containers running the chain.

make build-docker-nibidnode

make localnet-start

License

Copyright © Nibi, Inc. All rights reserved.

Licensed under the MIT License.