getAmuletRules

Gets amulet rules. This method delegates to the generated Scan operation with the same name in ScanApiClient.ts.

Setup

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

const canton = new Canton({
  network: 'NETWORK_NAME',
});

Minimal example

const result = await canton.scan.getAmuletRules({
  REQUEST_FIELDS_PLACEHOLDER,
});

Parameters

Single argument object forwarded to the Scan HTTP operation (see scan.ts for query/body fields and validation). Replace placeholders with concrete values from your deployment.

Fields vary by route — typical examples include:

Query-only routes: pagination after, limit, or encoded path segments such as domainId / partyId.
POST routes with JSON bodies: nested body objects matching the OpenAPI request schema for that operation version (v0, v1, v2).

Returns

Promise resolving to the Scan API JSON payload for this route (TypeScript types derive from the generated OpenAPI client). Inspect your editor tooltip or the Scan schema package under generated/apps/scan in the SDK repo.

Errors

Throws ApiError when the HTTP layer receives an error response. Throws NetworkError on transport failures before a response body exists.

Rotation across SV Scan bases applies only to retry-eligible failures — client-side validation errors from Scan (4xx excluding rate limits/timeouts) surface directly without advancing to another endpoint.

Auth and party

Scan endpoints do not require OAuth2 bearer tokens. Some routes still require identifiers such as domain IDs or party IDs as documented on each route.

Source

ScanApiClient.ts · getAmuletRules