getTransferInstructionAcceptContext

getTransferInstructionAcceptContext prepares disclosures keyed by transferInstructionId for receivers settling splice-token transfers surfaced via registry workflows.

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

Minimal example

const ctx = await canton.validator.getTransferInstructionAcceptContext({
  transferInstructionId: '<transfer-instruction-id>',
  meta: { source: 'wallet-ui' },
});

Parameters

transferInstructionId (required, string) — Identifier in the REST path.
meta (optional, string record) — Optional hints forwarded in the POST body when provided.
excludeDebugFields (optional, boolean) — Defaults to false.

Returns

Choice context from the registry: choiceContextData plus disclosedContracts entries ready to attach to a ledger submission bundle.

Errors and pitfalls

Unknown ids yield HTTP failures—confirm the instruction exists on the participant backing your wallet session.

Auth and party

Authenticated bearer token; accepting on-chain still requires receiver authorization.

Source

src/clients/validator-api/operations/v0/scan-proxy/registry/transfer-instruction/v1/get-transfer-instruction-accept-context.ts on GitHub.