ValidatorApiClient — reference

ValidatorApiClient is the OAuth-backed interface to the validator HTTP API: onboarding, ANS, scan-proxy reads (Amulet rules, mining rounds, token-standard registry), and wallet flows (balance, traffic purchase, transfer offers, token-standard transfers).

Each page follows the same shape: narrative intro, a minimal TypeScript example, parameters field-by-field, response highlights, pitfalls, auth notes, and a link into the SDK operation source.

Import

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

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

Administration — users, external party topology, identities

Method	Summary
`createUser`	Onboard a named user, optional fixed party ID
`dumpParticipantIdentities`	Participant identity dump (admin diagnostics)
`generateExternalPartyTopology`	Topology txs for external-key parties (sign offline)
`getExternalPartyBalance`	Balance view for an external party
`listExternalPartySetupProposals`	Pending external-party setup proposals
`listUsers`	List onboarded usernames
`submitExternalPartyTopology`	Submit signed topology from generation step
`registerNewUser`	One-time validator API registration
`getValidatorUserInfo`	Public validator operator party/name/featured flag

ANS (Application Name Service)

Method	Summary
`createAnsEntry`	Register name, URL, description
`getAnsRules`	ANS governance rules (optional cache hints)
`listAnsEntries`	Catalog listing
`lookupAnsEntryByName`	Resolve by ANS name
`lookupAnsEntryByParty`	Resolve by party ID

Scan proxy — Amulet rules, DSO, mining, featured apps, transfer lookups

Method	Summary
`getAmuletRules`	Active Amulet rules contract + domain
`getDsoPartyId`	DSO party identifier
`getMemberTrafficStatus`	Sequencer traffic consumed vs limits
`getMiningRoundDetails`	One mining round by number
`getOpenAndIssuingMiningRounds`	Open and issuing rounds snapshot
`lookupFeaturedAppRight`	Featured-app entitlement for a party
`lookupTransferCommandCounterByParty`	Transfer command nonce counter
`lookupTransferCommandStatus`	Status for sender + nonce
`lookupTransferPreapprovalByParty`	Transfer preapproval contract for a party

Scan proxy — token-standard registry (allocations, transfers, metadata)

Method	Summary
`getAllocationFactory`	Factory + choice context for allocations
`getAllocationCancelContext`	Cancel allocation choice context
`getAllocationTransferContext`	Execute transfer on allocation
`getAllocationWithdrawContext`	Withdraw allocation
`getInstrument`	Instrument metadata by ID
`getRegistryInfo`	Registry admin + supported APIs
`listInstruments`	Paginated instrument list
`getTransferFactory`	Transfer factory + choice context
`getTransferInstructionAcceptContext`	Accept transfer instruction
`getTransferInstructionRejectContext`	Reject transfer instruction
`getTransferInstructionWithdrawContext`	Withdraw transfer instruction

Wallet — balance, status, traffic, token-standard transfers, transfer offers

Method	Summary
`createBuyTrafficRequest`	Purchase traffic from a validator
`getBuyTrafficRequestStatus`	Poll buy-traffic request
`getAmulets`	Spendable and locked Amulet holdings
`getWalletBalance`	Aggregate wallet balance
`getUserStatus`	Onboarding / wallet installation status
`createTokenStandardTransfer`	Token-standard transfer (tracked)
`listTokenStandardTransfers`	List token-standard transfers
`createTransferOffer`	Amulet transfer offer to another party
`acceptTransferOffer`	Accept incoming offer
`rejectTransferOffer`	Reject incoming offer
`withdrawTransferOffer`	Withdraw own pending offer
`listTransferOffers`	Offers involving current party
`getTransferOfferStatus`	Poll offer by tracking ID

SDK source

index.ts (Validator API) wires each method to an operation class under operations/.