Skip to content
← Open Cap Table Protocol Canton Node SDK

Reference

getAmulets

GET wallet amulets — spendable Amulet holdings plus locked Amulet rows with round and fee metadata.

getAmulets surfaces ACS-backed wallet inventory needed before composing transfers or inspecting locking states—pairs naturally with getWalletBalance aggregates.

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

Minimal example

const holdings = await canton.validator.getAmulets();
console.log(holdings.amulets.length, holdings.locked_amulets.length);

Parameters

None.

Returns

  • amulets (array) — Each row bundles nested contract metadata (template_id, contract_id, payload blobs), mining round, string quantities accrued_holding_fee, effective_amount.
  • locked_amulets (array) — Same structural shape for coins temporarily locked by workflows.

Errors and pitfalls

  • Empty arrays simply indicate zero holdings—differentiate from wallet-not-installed flows via getUserStatus.

Auth and party

Bearer token tied to validator wallet identity; respects Canton visibility for acting party.

See also

Source

src/clients/validator-api/operations/v0/wallet/get-amulets.ts on GitHub.