BlueForge Docs

client.wallet.listAlerts

List balance alerts for a workspace

Signature

class Client {
  wallet: {
    listAlerts(workspaceId: string): Promise<BalanceAlert[]>
  }
}

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 alerts = await bf.wallet.listAlerts('ws_abc')

Pitfalls

  • Per-transaction evaluation — alerts are evaluated on each transaction, not on a continuous schedule

See also

  • client.wallet.createAlert
  • client.wallet.getBalance

Tested against

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