Catenis Flow Guide

Asset Migration Outcome Node

The Asset Migration Outcome node retrieves the current information about the Catenis Smart Asset units previously transferred (Assets Migrated) to the foreign blockchain. This node will show details about the asset migrated such as the Asset ID, how many units were migrated to, Ethereum • Binance Smart Chain • Polygon PoS Chain, which direction they were migrated to (inward or outward), etc.

Image of the Asset Migration Outcome Node

Node Properties Panel Field Description

Node property configuration slide-out panel (this panel is accessed by double-clicking on the node).

Properties Configuration Panel of the Asset Migration Outcome Node

Node-RED Specific Fields

  1. Name Field:  Add a descriptive name that will help differentiate this node from others of the same type on the Node-RED workspace (not required).
  2. Connection Field: This drop-down selection is required.  Set a previously configured Catenis connection (virtual device). If you need to configure a new virtual device, click the pencil button to the right of the field and follow the directions on setting up a new virtual device that you can find here.

Catenis Flow Setting Fields

  1. Migration ID: Enter the ID of the Asset Migration event that was conducted when you migrated units of the Catenis Smart Assets to a foreign blockchain.

Note: This node can be used in two modes: “Interactive” and “Run-Time.”

How to Use in Run-Time Mode

  1. Drag-and-drop the Asset Migration Outcome Node from the Catenis Flow pallet on the left-hand side of the interface to the Node-RED workspace. Double-click on the node to display the properties slide-out panel.
  2. On the “Device” drop-down field of the properties slide-out panel, choose the Catenis Virtual Device you previously configured. The virtual device is a configuration node containing the Catenis Virtual Device information (The device ID and API Secret key). If you do not have a virtual device already configured, please refer to our documentation titled: “Configure your First Virtual Device on Node-RED” here:
  3. Add the node’s configuration information to each field of the properties slide-out panel.  Please refer to the description of each field under the section named “Node Properties Panel Field Description” for proper usage.
  4. Then, wire this node to a debug node.
  5. Next, drag-and-drop an “inject” node to the Node-RED workspace.
  6. Wire the “inject” node to the “Asset Migration Outcome” Node, and double click the inject node to open its properties slide-out panel.
  7. Alter the information in the inject node’s properties slide-out panel by selecting the drop-down “Payload” field and choosing the “JSON” Type. An Ellipse button “…” will appear to the right of the field. Click this ellipse button to display a JSON edit box.
  8. Enter the JSON information you wish to pass as input to the Catenis Node (an example JSON input is below). After entering your JSON text entry, click the red “Done” button. Click the Done button again to exit the properties dialogue box.
  9. Click the red “Deploy” button on the upper right-hand side of the Node-RED dashboard to deploy this flow.
  10. Now, let’s test the flow: Click the button on the left attached to the inject node to send the input from the inject node to the flow.
  11. The debug sidebar should display the returned JSON object containing the API call results to the right side of the workspace.

How to Use Interactively

  1. In Interactive Mode: The end-user clicks on the action button (on the left) attached to the node. Then the Catenis API method is called, using the default settings (as specified in the node’s properties slide-out panel configuration).
  2. Follow steps 1 through 4 under “How to use in Run-Time mode” in the section above.
  3. Click the red “Deploy” button on the upper right-hand side of the Node-RED dashboard to deploy this flow.
  4. Now, let’s test the flow: Click the button on the left attached to this node to send the default property panel setting to the Catenis APIs and through the flow. 
  5. The debug sidebar should display the returned JSON object containing the results to the right side of the workspace

Example JSON Object that can be Passed to the Catenis Flow Node


{
    "migrationId": "INSERT_MIGRATION_ID"
}

Note: Inputs injected into this node via a JSON object containing alternate node properties will override the properties set on this node's slide-out properties panel.

Example Flow - Import into Node-Red to Get Started


[{"id":"ca297f95.c9b1e","type":"asset migration outcome","z":"3dbf2c28.70dd6c","name":"","connection":"","migrationId":"","x":410,"y":440,"wires":[["58296246.b22f9c"]]},{"id":"c563d2c7.bca0c","type":"inject","z":"3dbf2c28.70dd6c","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"{\"migrationId\":\"gDCMoq3GAF4BJyZDfHsf\"}","payloadType":"json","x":170,"y":440,"wires":[["ca297f95.c9b1e"]]},{"id":"58296246.b22f9c","type":"debug","z":"3dbf2c28.70dd6c","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":690,"y":440,"wires":[]},{"id":"32daad09.df69e2","type":"comment","z":"3dbf2c28.70dd6c","name":"Set virtual device for this Catenis node - Click for instructions","info":"All Catenis nodes require that you set the proper virtual device on its slideout property panel on the device field. A Catenis Virtual Device is the equivalent of an API Account credential. If you are not familiar with a Catneis Virtual device, please read \"The Catenis Virtual Device\" in the Users guide.\n\n\nNot setting the virtual device properly will result in a \"TypeError: Cannot read property 'ctnApiClient' of null.\" ","x":440,"y":380,"wires":[]},{"id":"89e506a4.c0f73","type":"comment","z":"3dbf2c28.70dd6c","name":"Click for instructions","info":"Please use an migration ID generated when you previously migrated units of an asset to a foreign blockchain. \n\nSTEPS:\n1) Double-click the \"inject\" node to alter the information in the inject node. Select the drop-down payload field and choose the \"JSON\" Type.\n\n2)Click the ellipses \"...\" to the right of the JSON field. This will open up a slide-out box where you can edit the JSON File.\n\n3)Modify the Migration ID information by using an Migration ID you have previously received when migrating units of the asset.\n","x":150,"y":480,"wires":[]}]

Related Articles