![](\"https://raw.githubusercontent.com/NibiruChain/ts-sdk/develop/img/nibijs.png\")
\n\n\n
\nThe official TypeScript SDK for the Nibiru blockchain!\n
\n\n\n\nThe 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.\n\nThe `nibijs` source code can be found in the `src` directory.\n\n#### Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n - [Example: Creating a wallet](#example-creating-a-wallet)\n - [Example: Querying](#example-querying)\n - [Example: Sending funds](#example-sending-funds)\n- [Codebase structure](#codebase-structure)\n- [Development Quick Start](#development-quick-start)\n- [š License](#-license)\n\nTo learn more about Nibiru, see [nibiru.fi/docs](https://nibiru.fi/docs)\n\n---\n\n## Installation\n\n[@nibiruchain/nibijs][npm-nibijs] is available on the npm registry.\n\n[npm-nibijs]: https://www.npmjs.com/package/@nibiruchain/nibijs\n\n```\nnpm install @nibiruchain/nibijs # or yarn add\n```\n\n## Usage\n\nThe 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.\n\n### Example: Creating a wallet\n\n```js\nimport { newRandomWallet } from \"@nibiruchain/nibijs\"\n\n// Create a new Nibiru wallet\nconst wallet = await newRandomWallet()\nconst [{ address }] = await wallet.getAccounts()\n\n// Save the mnemonic somewhere to re-use the account\nconsole.log(\"mnemonic: \", wallet.mnemonic)\nconsole.log(\"address: \", address)\n```\n\n### Example: Querying\n\n```js\nimport { NibiruQuerier, Testnet } from \"@nibiruchain/nibijs\"\n\nexport const CHAIN = Testnet(2)\nconst querier = await NibiruQuerier.connect(CHAIN.endptTm)\n\n// Query balances\nconst exampleAddress = \"nibi17dz4cdw5fmm2cxd4ht9xvjmpw3ycmpkpcc6js9\"\nconst balances = await querier.getAllBalances(exampleAddress)\nconsole.log(\"balances: %o\", balances)\n\n// Query block\nconst blockHeight = 200000\nconst block = await querier.getBlock(blockHeight)\nconsole.log(\"block: %o\", block)\n```\n\n### Example: Sending funds\n\n```js\nimport {\n NibiruTxClient,\n newSignerFromMnemonic,\n Testnet,\n NibiruQuerier,\n} from \"@nibiruchain/nibijs\"\nimport { coins } from \"@cosmjs/proto-signing\"\n\nexport const CHAIN = Testnet(2)\nconst mnemonic = \"your mnemonic here...\"\nconst signer = await newSignerFromMnemonic(mnemonic)\nconst querier = await NibiruQuerier.connect(CHAIN.endptTm)\nconst txClient = await NibiruTxClient.connectWithSigner(CHAIN.endptTm, signer)\nconst [{ address: fromAddr }] = await signer.getAccounts()\n\n// Check balance before sending tokens\nconst exampleAddress = \"nibi1mzjkw9z5ugajxchl884y0c28lk2627hpuljuw4\"\nlet balances = await querier.getAllBalances(exampleAddress)\nconsole.log(\"balances: %o\", balances)\n\nconst tokens = coins(5, \"unibi\")\nconst txResp = await txClient.sendTokens(\n fromAddr,\n exampleAddress,\n tokens,\n 5000 // gas fee 5000 unibi\n)\nconsole.log(txResp)\n\n// Execution could take several seconds\nconst delay = (ms) => new Promise((res) => setTimeout(res, ms))\nawait delay(10000)\n\n// Check balance after send tokens\nbalances = await querier.getAllBalances(exampleAddress)\nconsole.log(\"balances: %o\", balances)\n```\n\n## Codebase structure\n\n| Directories of `@nibiruchain/nibijs` | Purpose/Utility |\n| :----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| `common` | home to several commonly needed types, constants and configurations such as Network. |\n| `msg` | Implements functions for creating messages (`Msg`s). These are objects that trigger state-transitions and get wrapped into transactions. |\n| `query` | For querying state via the consensus engine of a full-node and the application blockchain interface (ABCI). |\n| `tx` | For signing and to submitting transactions given a set of `Msg` objects. |\n| `wallet` | A simple wrapper around the Keplr wallet. This module will grow as support is added for other wallets (like MetaMask). |\n\n`@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.\n\n---\n\n\n\n## Development Quick Start\n\n1. Install and use `nvm`.\n\n ```bash\n wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.6/install.sh | bash\n nvm use\n ```\n\n2. Install yarn.\n\n ```sh\n npm install -g yarn\n ```\n\n3. Then, install package dependencies. At the root of the repository, run\n\n ```sh\n yarn\n ```\n\n4. Initialize git submodules\n\n ```sh\n git submodule init\n git submodule update\n ```\n\n5. Lastly, compile the code in each package.\n\n ```sh\n yarn build\n ```\n\nSee [HACKING.md](https://github.com/NibiruChain/ts-sdk/blob/main/HACKING.md) for the full development guide. It includes instructions on:\n\n1. Running tests\n2. Generating code for the @nibiruchain/protojs package\n3. Generating documentation in HTML or Markdown from the comments of @nibiruchain/nibijs\n\n---\n\n## š License\n\nThis software is licensed under the MIT license. See [LICENSE](https://github.com/NibiruChain/ts-sdk/blob/main/LICENSE) for full disclosure.\n\nĀ© 2023 Nibi, Inc.\n\n\n![](\"https://raw.githubusercontent.com/NibiruChain/ts-sdk/main/img/nibi-logo-onwhite.png\"){kind=logo}
\n
![](\"https://img.shields.io/npm/v/@nibiruchain/nibijs.svg?color=AE8CCD\")
\n![](\"https://github.com/NibiruChain/ts-sdk/actions/workflows/test-ts-sdk.yaml/badge.svg?branch=main\"){kind=icon}
\n![](\"https://img.shields.io/npm/dm/@nibiruchain/nibijs.svg?color=FFF3CD\")
\n![](\"https://img.shields.io/npm/l/express.svg?color=050505\")
\n