createBobRestClient

createBobRestClient creates an HTTP client for Bob's REST API. Use it for one-shot lookups: current node status, account balances, asset positions, and transaction records.

All methods return Result<T, BobRpcError>: { ok: true, value } on success, { ok: false, error } on failure.

createBobRestClient(options?)

import { createBobRestClient } from "@qubic.org/bob"

const rest = createBobRestClient({ baseUrl: "http://localhost:40420" })

If you need the REST client alongside the RPC or subscription clients, use createBobClient instead — it creates all three from a single options object.

Options

rest.getStatus(opts?)

Returns the current node status, including chain ID and tick number.

const result = await rest.getStatus()
if (!result.ok) throw result.error

console.log(result.value)

Returns Result<BobStatus, BobRpcError>

rest.getBalance(identity, opts?)

Returns the QU balance for an identity.

import { toIdentity } from "@qubic.org/types"

const result = await rest.getBalance(
  toIdentity("CFBMEMZOIDEXQAUXYYSZIURADQLAPWPMNJXQSNVQZAHYVOPYUKKJBJUCTVJL")
)
if (!result.ok) throw result.error

console.log(result.value)

Parameters

Returns Result<BobBalance, BobRpcError>

rest.getAsset(identity, issuer, assetName, manageSCIndex, opts?)

Returns the asset position for a specific identity, issuer, asset name, and managing contract index.

const result = await rest.getAsset(
  identity,
  issuer,
  "QWALLET",
  0,
)
if (!result.ok) throw result.error

console.log(result.value)

Parameters

Returns Result<BobAsset, BobRpcError>

rest.getEpochInfo(epoch, opts?)

Returns epoch metadata including tick range boundaries.

const result = await rest.getEpochInfo(150)
if (!result.ok) throw result.error

console.log(result.value)

Parameters

Returns Result<BobEpochInfo, BobRpcError>

rest.getTransaction(txHash, opts?)

Returns a transaction by its hash.

const result = await rest.getTransaction(
  "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
)
if (!result.ok) throw result.error

const tx = result.value
console.log(tx)

Parameters

Returns Result<BobTx, BobRpcError>

rest.getTick(tickNumber, opts?)

Returns tick data for the given tick number.

const result = await rest.getTick(17_000_500)
if (!result.ok) throw result.error

console.log(result.value)

Parameters

Returns Result<BobTickResponse, BobRpcError>

rest.broadcastTransaction(body, opts?)

Broadcasts a signed transaction.

const result = await rest.broadcastTransaction({ data: encodedHex })
if (!result.ok) throw result.error

Parameters

Returns Result<BroadcastResponse, BobRpcError>

rest.querySmartContract(body, opts?)

Calls a smart contract read-only function.

const result = await rest.querySmartContract({
  nonce: 0,
  scIndex: 9,
  funcNumber: 1,
  data: base64EncodedInput,
})
if (!result.ok) throw result.error

Parameters

Returns Result<QuerySmartContractResponse, BobRpcError>