getTrafficStatus

Two overloads:

Client	Requirements
`ValidatorApiClient`	Optional `domainId`, `memberId` — forwards to `getMemberTrafficStatus` with validator-side defaults when omitted.
`ScanApiClient`	Requires `domainId` + `partyId` — resolves `participant_id` via `getPartyToParticipant` unless `memberId` override supplied.

Returned TrafficStatus maps traffic_status.actual totals plus target.total_purchased.

Setup

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

const canton = new Canton({
  network: 'NETWORK_NAME',
  partyId: 'PARTY_ID',
});

Minimal example — validator

const status = await getTrafficStatus(canton.validator);
console.log(status.consumed, status.limit);

Minimal example — scan

const status = await getTrafficStatus(canton.scan, {
  domainId: 'DOMAIN_ID',
  partyId: 'PARTY_ID',
});
console.log(status.purchased);

Parameters

GetTrafficStatusOptions plus whichever identifiers each overload mandates — ScanApiClient variant throws Error when domainId or partyId missing.

Returns

Promise<TrafficStatus> — consumed, limit, purchased numeric aggregates.

Errors

Throws Error for Scan overload missing identifiers; validator errors propagate from getMemberTrafficStatus.

Auth and party

Validator path respects authenticated participant defaults; Scan path only needs public endpoints plus supplied identifiers.

Source

src/utils/traffic/get-traffic-status.ts