Skip to main content
The FXOrder is Musubi’s core on-ledger coordination record. This page enumerates every field on the FXOrder template and each record that binds to it through the order lifecycle. For how the FXOrder moves through its lifecycle, see the per-role overviews and the trust model.

Package

The FXOrder template and every other settlement template on this page ship in one Daml package, musubi. Version 3.0.0 is the package a participant uploads and vets to take part in settlement. Its main package id is 478d7372a9b6d99e1f3fa84832582f4e499d63c4e2d69411f96aeda12eab278b; check it before you vet. The package holds the settlement templates only. It contains no test fixtures, no test scripts and no Daml Script library.

Enums

FXOrder

Top-level template. Signatories: operator + sender’s custodian. Observers: sender, receiver, receiver’s custodian. The market maker is not an observer — it reads a separate identity-free projection of a won order. It does become a party to the settlement transaction that completes the order, and receives the settled contract as a consequence; see Privacy. The ensure clause requires targetAmount > 0, expiresAt > createdAt, a non-empty intentId, and valid source / target currency identifiers.

SenderInfo / ReceiverInfo

Mirror records on either side of the trade. They carry party identity only.

CurrencyIdentifier

Dual-identifier scheme. iso4217 is the three-letter reference currency; tokenSymbol is the on-ledger token symbol.

SourceAsset / TargetAsset

SourceAsset describes what the sender is selling; TargetAsset describes what the receiver is to be paid. Musubi is receiver-fixed: targetAmount is the primary input; market makers quote sourceAmountMax.

QuoteInfo

Populated at QUOTED. Rate-source fields carry non-derivable market evidence at the moment the quote was captured. The fee amount itself is not stored because it is derivable: feeAmount ≡ mmQuotedSourceAmount − (midMarketRate × targetAmount).

MarketMakerInfo

Populated at QUOTED.

SettlementInfo

Populated at SETTLED.
  • Privacy — how per-sub-transaction privacy keeps counterparty identity out of the RFQ, and exactly where that boundary ends.
  • Trust model — operator-less, four-eyes co-signature, and the atomic settlement guarantee.