README.md

Python SDK - Nibiru Chain

Python-based client for interacting with the Nibiru blockchain.

The nibiru package allows you to index, query, and send transactions on Nibiru Chain using Python. It provides access to market data for analysis, visualization, indicator development, algorithmic trading, strategy backtesting, bot programming, and related software engineering.

The package is intended to be used by coders, developers, technically-skilled traders and data-scientists for building trading algorithms.

README Contents

• Python SDK Tutorial
• Installation from PyPI
• Usage
  • Ex: Creating a wallet and SDK client
  • Ex: Using the faucet
  • Ex: Querying chain state
  • Ex: Submitting transactions
• Documentation Website
• Contributing

Python SDK Tutorial

Installation from PyPI

pip install nibiru  # requires Python 3.7+

You may need to update pip to get this to run:

python -m pip install --upgrade pip

Usage

Ex: Creating a wallet and SDK client

from nibiru import wallet

# Save the mnemonic for later
mnemonic, private_key = wallet.PrivateKey.generate()

After, creating an account, you can create an Sdk instance.

import nibiru

network = nibiru.network.Network.testnet(2)
sdk = nibiru.Sdk.authorize(mnemonic)
  .with_network(network)

The Sdk class creates an interface to sign and send transactions or execute queries. It is associated with:

• A transaction signer (wallet), which is configured from existing mnemonic to recover a PrivateKey.
• A Network, which specifies the RPC, LCD, and gRPC endpoints for connecting to Nibiru Chain.
• An optional TxConfig for changing gas parameters.

Ex: Using the faucet

import requests

requests.post(
    "https://faucet.testnet-2.nibiru.fi/",
    json={
        "address": sdk.address,
        "coins": ["10000000unibi", "100000000000unusd"],
    },
)

Ex: Querying chain state

# Querying the token balances of the account
sdk.query.get_bank_balances(sdk.address)

# Querying from the vpool module
query_resp = sdk.query.vpool.all_pools()
print(query_resp)
# Queries from other modules can be accessed from "sdk.query.module"

Ex: Submitting transactions

# version 0.16.3
from nibiru import Msg

tx_resp = sdk.tx.execute_msgs(
    Msg.perp.open_position(
        sender=sdk.address,
        pair="ubtc:unusd",
        is_long=True,
        quote_asset_amount=10,
        leverage=10,
        base_asset_amount_limit=0,
    )
)

You can broadcast any available transaction by passing its corresponding Msg to the sdk.tx.execute_msgs function.

Documentation Website

Documentation can be found here: Nibiru-py documentation

• Learn more about opening and managing your spot and perp positions here
• Learn about querying the chain using the Sdk here

Contributing

Please read HACKING.MD for developer environment setup.