Uses WebSocketClient on /v2/state/active-contracts (not REST). Builds eventFormat via buildPartyList() when parties omitted; defaults activeAtOffset from getLedgerEnd when omitted. Optional onItem streams each JsGetActiveContractsResponseItem before resolve.
Receiver: await canton.ledger.getActiveContracts
Setup
import { Canton } from '@fairmint/canton-node-sdk';
const canton = new Canton({
network: 'devnet',
provider: '5n',
partyId: 'OWN_PARTY_ID',
});Minimal example
const acs = await canton.ledger.getActiveContracts({
templateIds: ['#pkg:Mod:T'],
});Parameters — GetActiveContractsParams
Core (ActiveContractsParamsSchema): optional parties, templateIds, includeCreatedEventBlob, activeAtOffset. Extended: onItem callback per contract row before aggregated resolve.
Returns — JsGetActiveContractsResponse
Array of JsGetActiveContractsResponseItem pushed until socket closes cleanly after snapshot delivery.
Errors
Non-item Canton frames become ApiError; transport errors reject the promise.
Auth and party
Bearer token; parties default to client buildPartyList().