API Reference
This page lists the APIs that are accessible to NUTS Platform users. For more information about the APIs that are used inside NUTS Platform or used only by NUTS Platform owner, please refer to the NUTS Platform smart contracts.
InstrumentRegistry
activateInstrument()
A public function for FSPs to activate new financial instruments in NUTS Platform.
Parameters
Return Values
lookupInstrumentManager()
A public function to query Instrument Manager contract address with Instrument ID.
Parameters
Return Values
InstrumentManager
getInstrumentEscrowAddress()
Get the address of the Instrument Escrow owned by the current Instrument Manager.
Parameters
None
Return Values
deactivate()
Deactivate the activated financial instrument managed by the current Instrument Manager. Once deactivated, the financial instrument cannot create new issuance, but the existing issuances are not affected.
A financial instrument can be deactivated only once. It can only be deactivated by maker before the instrument override time. After that, anyone can deactivate this instrument.
Parameters
None
Return Values
None
setMakerWhitelist()
Update the maker whitelist.
Parameters
Return Values
None.
setTakerWhitelist()
Update the taker whitelist.
Parameters
Return Values
None.
createIssuance()
Create a new issuance of the financial instrument. Only whitelisted makers are allowed if maker whitelist is enabled.
Parameters
Return Values
engageIssuance()
Engage an existing issuance.. Only whitelisted takers are allowed if taker whitelist is enabled.
Parameters
Return Values
None.
depositToIssuance()
Deposit from Instrument Escrow to issuance.
Parameters
Return Values
None.
withdrawFromIssuance()
Withdraw from issuance to Instrument Escrow.
Parameters
Return Values
None.
notifyCustomEvent()
Notify a custom event to the issuance.
Parameters
Return Values
None.
getCustomData()
Get custom data from the issuance.
Parameters
Return Values
Last updated