BlueForge Docs

client.wallet.getBalance

Get wallet balance for a workspace

Signature

class Client {
  wallet: {
    getBalance(workspaceId: string): Promise<WalletBalance>
  }
}

Parameters

NameTypeRequiredNotes
workspaceId
string
YesWorkspace ID

Throws

  • NotFoundError
    — workspace not found

Examples

import { Client } from '@blueforge/client'

const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })

const balance = await bf.wallet.getBalance('ws_abc')

Pitfalls

  • Stale balance — the balance may lag behind recent transactions; force a refresh by reading from the wallet worker directly if real-time accuracy is needed

See also

  • client.wallet.listTransactions

Tested against

  • Unit:
    packages/client/src/__tests__/wallet.test.ts