getInstrument

getInstrument hits token-metadata registry routes proxied under validator scan-proxy—ideal before composing bespoke ledger integrations keyed off canonical identifiers.

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.getInstrument.

Minimal example

const instrument = await canton.validator.getInstrument({
  instrumentId: '<canonical-id-from-listInstruments>',
});
console.log(instrument.symbol, instrument.decimals);

Parameters

instrumentId (required, string) — Registry-assigned identifier from listings.

Returns

Instrument descriptor covering identifiers (id, name, symbol), decimal precision, optional supply metadata timestamps, and supportedApis map describing callable splice endpoints.

Errors and pitfalls

Missing IDs yield HTTP errors cached aggressively—retry after verifying instrumentation catalogs refreshed via listInstruments.

Auth and party

Authenticated bearer token; purely descriptive reads seldom gate beyond OAuth issuance success.

Source

src/clients/validator-api/operations/v0/scan-proxy/registry/metadata/v1/get-instrument.ts on GitHub.