NibiJS Documentation - v4.1.0

The official TypeScript SDK for the Nibiru blockchain

The NibiJS (@nibiruchain/nibijs) package makes it possible to interact with Nibiru from a Node.js or browser environment. nibijs provides simple abstractions for core data structures, serialization, key management, API requests, and the submission of transactions.

The nibijs source code can be found in the "packages" directory (opens new window). The types and classes generated from Nibiru's .proto files are inside a separate npm package called @nibiruchain/protojs.

Table of Contents

• NibiJS Documentation - v4.1.0 - Table of Contents
  • Installation
  • Usage
    • Example: Creating a wallet
    • Example: Querying
    • Example: Sending funds
    • Example: Transaction with arbitrary messages
  • Codebase structure
  • Development Quick Start
  • 🔓 License

To learn more about Nibiru, see nibiru.fi/docs (opens new window)

---

Installation

@nibiruchain/nibijs (opens new window) is available on the npm registry.

Copy npm install @nibiruchain/nibijs # or yarn add

Usage

The entrypoint for nibijs is the Sdk object, which is meant to mimic the root of a command line interface. It can be used for both queries and transactions.

Example: Creating a wallet

Copy import { newRandomWallet } from "@nibiruchain/nibijs" // Create a new Nibiru wallet const wallet = await newRandomWallet() const [{ address }] = await wallet.getAccounts() // Save the mnemonic somewhere to re-use the account console.log("mnemonic: ", wallet.mnemonic) console.log("address: ", address)

Example: Querying

Copy import { NibiruQuerier, NibiruTxClient, Localnet } from "@nibiruchain/nibijs" export const CHAIN: Chain = Localnet const querier = await NibiruQuerier.connect(CHAIN.endptTm) const perpParamsResp = await querier.nibiruExtensions.perp.params() console.log("perpParams: %o", perpParamsResp) const allMarkets = await querier.nibiruExtensions.perp.markets({ pair: "ueth:unusd", }) console.log("allMarkets: %o", allMarkets) const blockHeight = 1 const block = await querier.getBlock(blockHeight)

Example: Sending funds

Copy import { Coin, NibiruTxClient, newSignerFromMnemonic, Localnet } from "@nibiruchain/nibijs" import { coins } from "@cosmjs/proto-signing" export const CHAIN: Chain = Localnet const signer = await newSignerFromMnemonic(mnemonic!) const txClient = await NibiruTxClient.connectWithSigner( CHAIN.endptTm, signer, ) const [{ address: fromAddr }] = await signer.getAccounts() const tokens: Coin[] = coins(5, "unibi") const toAddr: string = "..." // bech32 address of the receiving party const txResp = await txClient.sendTokens(fromAddr, toAddr, tokens, "auto")

Example: Transaction with arbitrary messages

Copy import { NibiruTxClient, newSignerFromMnemonic, Msg, TxMessage, StdFee, toSdkInt, parseEventLogs, Localnet } from "@nibiruchain/nibijs" import { Msg, TxMessage } from "@nibiruchain/nibijs/dist/msg" import { coin } from "@cosmjs/proto-signing" // const mnemonic = "..." <-- export const CHAIN: Chain = Localnet const signer = await newSignerFromMnemonic(mnemonic!) signer.getAccounts() const txClient = await NibiruTxClient.connectWithSigner( CHAIN.endptTm, signer, ) const [{ address: fromAddr }] = await signer.getAccounts() const pair = "ubtc:unusd" // ------------------------------------ // Construct tx msgs // ------------------------------------ const msgs: TxMessage[] = [ Msg.perp.openPosition({ sender: fromAddr, pair: pair, quoteAssetAmount: 10, leverage: 1, goLong: true, baseAssetAmountLimit: 0, }), Msg.perp.addMargin({ sender: fromAddr, pair: pair, margin: coin("20", "unusd"), }), Msg.perp.removeMargin({ sender: fromAddr, pair: pair, margin: coin("5", "unusd"), }), // final margin value of 10 (open) + 20 (add) - 5 (remove) = 25 ] // ------------------------------------ // Broadcast tx // ------------------------------------ const txResp = await txClient.signAndBroadcast(fromAddr, msgs, "auto")

Codebase structure

Directories of @nibiruchain/nibijs	Purpose/Utility
common	home to several commonly needed types, constants and configurations such as Network.
msg	Implements functions for creating messages (Msgs). These are objects that trigger state-transitions and get wrapped into transactions.
query	For querying state via the consensus engine of a full-node and the application blockchain interface (ABCI).
tx	For signing and to submitting transactions given a set of Msg objects.
wallet	A simple wrapper around the Keplr wallet. This module will grow as support is added for other wallets (like MetaMask).

@nibiruchain/protojs provides types generated from the protocol buffers of the Cosmos-SDK, Tendermint Core, and Nibiru Chain. For most use cases, it won't be necessary to interact with this layer.

---

Development Quick Start

1. Install and use nvm.

   Copy wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.6/install.sh | bash nvm use

2. Install yarn.

   Copy npm install -g yarn

3. Then, install package dependencies. At the root of the repository, run

   Copy yarn

4. Lastly, compile the code in each package.

   Copy yarn build

See HACKING.md (opens new window) for the full development guide. It includes instructions on:

1. Running tests
2. Generating code for the @nibiruchain/protojs package
3. Generating documentation in HTML or Markdown from the comments of @nibiruchain/nibijs

---

🔓 License

This software is licensed under the MIT license. See LICENSE (opens new window) for full disclosure.

© 2023 Nibi, Inc.