Skip to content

Reference

Amulet utility types — LockedAmulet

Branded structs and selection options shared by locked-amulet helpers in the Canton Node SDK.

LockedAmulet

Returned by getLockedAmuletsForParty. Fields:

FieldMeaning
contractIdBranded ContractId for the locked wrapper.
templateIdTemplate string for the LockedAmulet contract family.
ownerBranded PartyId extracted from nested amulet payload.
effectiveAmountnumber parsed from validator wallet response.
holdersParties listed in lock.holders (string or { owner }).
lockExpiresAtISO timestamp or null when absent / unparseable.
domainIdDomainId taken from validator response row.
createdEventBlobDisclosure payload required for exercise commands.

LockedAmuletSelectionOptions

Used with selectLockedAmuletForAmount:

FieldDefaultRole
requireExclusiveHoldertrueDrop multi-holder locks.
rejectExpiredLockstrueDrop locks already expired versus clock.
nowMsDate.now()Override clock for deterministic tests.

Import

import type { LockedAmulet, LockedAmuletSelectionOptions } from '@fairmint/canton-node-sdk';

See also

Source

src/utils/amulet/types.ts