getMemberTrafficStatus

getMemberTrafficStatus reads sequencer traffic usage for a member in a mining domain. Call with {} to infer domainId from getOpenAndIssuingMiningRounds and memberId from the client party (getPartyId); pass both explicitly when you need deterministic routing.

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Import and receiver

import { Canton } from '@fairmint/canton-node-sdk';

Receiver: canton.validator.getMemberTrafficStatus.

Minimal example

const status = await canton.validator.getMemberTrafficStatus();
// Equivalent specify overrides explicitly:
await canton.validator.getMemberTrafficStatus({
  domainId: '<mining-domain-guid>',
  memberId: 'PAR::<participant>::...',
});

Parameters

Optional overrides merged prior REST invocation:

domainId (optional, string) — Mining-domain GUID defaulting to current issuance domain resolved internally when omitted (requires open-round introspection).
memberId (optional, string) — Member fingerprint observed by sequencer—defaults to [client.getPartyId() equivalent routing identifiers].

Returns

Response exposing nested telemetry surfaces described via structured validators capturing consumed totals versus purchased allowances (traffic_status.actual.total_consumed, traffic_status.actual.total_limit, traffic_status.target.total_purchased).

Errors and pitfalls

Throws when executor lacks getOpenAndIssuingMiningRounds — verify ValidatorApiClient.
Domain inference failures bubble descriptive thrown errors instructing manual domain provisioning.

Auth and party

Authenticated bearer token plus whichever participant mappings Canton sequencer recognizes.

Source

src/clients/validator-api/operations/v0/scan-proxy/get-member-traffic-status.ts on GitHub.