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.
A public function for FSPs to activate new financial instruments in NUTS Platform.
Type | Name | Description |
address | instrumentAddress | The address of the deployed financial instrument contract. A financial instrument contract can be shared by multiple activated financial instruments. |
bytes | instrumentParameters | Custom parameters about the instrument. |
Type | Name | Description |
uint256 | instrumentId | ID of the activated financial instrument. |
A public function to query Instrument Manager contract address with Instrument ID.
Type | Name | Description |
uint256 | instrumentId | ID of the activated financial instrument. |
Type | Name | Description |
address | instrumentManagerAddress | Address of the Instrument Manager Contract. |
Get the address of the Instrument Escrow owned by the current Instrument Manager.
None
Type | Name | Description |
address | instrumentEscrowAddress | Address of the Instrument Escrow owned by the current Instrument Manager. |
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.
None
None
Update the maker whitelist.
Type | Name | Description |
address | makerAddress | The address of the maker. |
bool | allowed | Whether the maker is allowed to create new issuance. |
None.
Update the taker whitelist.
Type | Name | Description |
address | takerAddress | The address of the taker. |
bool | allowed | Whether the taker is allowed to engage existing issuance. |
None.
Create a new issuance of the financial instrument. Only whitelisted makers are allowed if maker whitelist is enabled.
Type | Name | Description |
bytes | makerParameters | Custom parameters of the issuance. |
Type | Name | Description |
uint256 | issuanceId | ID of the newly created issuance. |
Engage an existing issuance.. Only whitelisted takers are allowed if taker whitelist is enabled.
Type | Name | Description |
uint256 | issuanceId | ID of the issuance to engage. |
bytes | takerParameters | Custom parameters of the engagement. |
None.
Deposit from Instrument Escrow to issuance.
Type | Name | Description |
uint256 | issuanceId | ID of the issuance to engage. |
address | tokenAddress | Address of the token to deposit. ETH address is Constants.getEthAddress(). |
uint256 | amount | Amount of token to deposit. |
None.
Withdraw from issuance to Instrument Escrow.
Type | Name | Description |
uint256 | issuanceId | ID of the issuance to engage. |
address | tokenAddress | Address of the token to withdraw. ETH address is Constants.getEthAddress(). |
uint256 | amount | Amount of token to withdraw. |
None.
Notify a custom event to the issuance.
Type | Name | Description |
uint256 | issuanceId | ID of the issuance to engage. |
bytes32 | eventName | Name of the custom event. |
bytes | eventPayload | Payload of the custom event. |
None.
Get custom data from the issuance.
Type | Name | Description |
uint256 | issuanceId | ID of the issuance to engage. |
bytes32 | dataName | Name of the data to retrieve. |
Type | Name | Description |
bytes | customData | The custom data to return. |
