This feature has been introduced with version
0.15 of the Registry App.For Registrars
Create an Instrument with Force Transfer Enabled
- In the Registry UI, click Instrument > Management in the left sidebar.
- Click + New Instrument.
- Fill in the instrument details, and check Enable Force Transfer.
- Click Create.
utility-registry-v0 version 0.9.0 or later. To check whether force transfer is enabled for an instrument, click its row on the Instrument Management page: the details show Force Transfer as Enabled or Disabled.
Informing holders that an instrument has force transfer enabled is the registrarās responsibility.
Perform a Force Transfer
- On the Instrument Management page, click Forced Transfer above the instrument table.
- In Instrument ID, select the instrument. The list shows your instruments with force transfer enabled.
- In Sender, enter the party ID of the affected holder. Requester and Receiver show your registrar party.
- In Amount, enter the amount to transfer, or click Max. The form shows the holderās Available funds: their unlocked holdings with force transfer enabled. The amount cannot exceed them.
- In Reference, add a note, for example a regulatory order reference. It appears in the transaction history as
Force transfer: <reference>. - Click Send.
Perform a Force Transfer Programmatically
The registrar exercises theHolding_ForceTransfer choice of Utility.Registry.Holding.V0.Holding:Holding (utility-registry-holding-v0 version 0.4.0 or later) on one of the holderās holdings:
The result contains the registrarās new holding (
receiverHoldingCid) and the holderās remaining holding, if any (remainingHoldingCid). The remaining holding is in the account of the holding the choice is exercised on.
Limitations
- Locked holdings cannot be force transferred. This includes holdings locked in pending transfer offers and allocations.
- The participant node(s) hosting the holder must be online, because it automatically validates and confirms the transaction. The holder does not need to approve it.
- The participant node(s) hosting the holder must have vetted
utility-registry-holding-v0version0.4.0or later.
Effect on Holdings
The table shows how each operation affects the holdings of an instrument with force transfer enabled:
For instruments with force transfer disabled, nothing changes.
For Wallets
Detect Force Transfer on Holdings
Holdings with force transfer enabled include this entry in themeta of their token standard holding view (v1 and v2):
Show Force Transfers in the Transaction History
A force transfer appears in the token standard transaction history (v1 and v2) as a transfer from the holder to the registrar (the instrument admin), with the reasonForce transfer: <reference>. The holder does not submit this transaction, so wallets may want to label it, for example as āForce transfer by the registrarā.
For Trading Venues
Check Whether an Instrument Has Force Transfer Enabled
Settlements of instruments with force transfer enabled require all involved participants to have vetted Registry App version0.15 or later, see V1 / V2 cross-version compatibility. To check whether an instrument has force transfer enabled, call the instrument configuration endpoint of the Registry App with the instrumentās default identifier:
payload.forceTransferEnabled field of the response is true if the instrument has force transfer enabled.