Catenis Flow Guide

Export Asset Node

The Export Asset node, when used, creates a “Token” equivalent to a Catenis Smart Asset on the foreign blockchain (deploys the smart contract). This action creates the equivalent of the Catenis Smart Asset with all of its properties. However, exporting an asset does not create any units on the foreign blockchain; it simply creates the “Asset Type.”  Assets must first be exported before the units of the asset can be transferred to the foreign blockchain. The same Catenis Smart Assets can be exported to more than one foreign blockchain; however, there will need to be sufficient units of that Catenis asset to migrate to more than one blockchain. To transfer units after exporting, see “Migrating Assets” Node here:

Image of the Export Asset 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 Export Asset 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. Asset ID: Enter the ID of an asset that has been previously created and will be exported to a foreign blockchain.
  2. Foreign Blockchain: On this drop-down field, select the foreign blockchain to export Catenis Smart Assets to. The blockchains currently available to export to: Ethereum Binance Smart ChainPolygon PoS Chain
  3. Consumption Profile: When executing the Export Asset functionality, a transaction is issued on the foreign blockchain, you have the ability to choose how fast or slow this transaction will be confirmed. Fastest Fast · Average · Slow. This transaction creates a smart contract that exports the token type and its properties to the foreign blockchain and costs foreign blockchain native cryptocurrency. Setting the consumption profile at this level overrides the consumption profile settings at the administrative dashboard on your account.

Note: Faster is more expensive, and slower is least expensive.

Note: Blockchain of Thing, Inc. does not charge a fee for the Asset Export Functionality. The fees deposited into the Asset Export Account are based on the fee market of the foreign blockchain and fluctuation per blockchain ecosystem and must be decided by the user. All native tokens deposited into this account for tokens exporting are non-refundable.

  1. Estimate Only: Selecting this option allows the ability to simulate the process and returns an estimate of the fee amount in the foreign blockchain’s cryptocurrency. The result indicates the amount of cryptocurrency needed in your administrative dashboard’s “Asset Export Admin Account.” Select the profile setting to either Fastest (more expensive) • Fast • Average • Slow (less expensive) to receive a different estimate.

How to use

  1. Drag-and-drop the Export Asset 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 based on your needs.  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 “Export Assets” 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 an 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.
  12. To ensure that the export has been performed correctly, you can use the “Asset Export Outcome Node,” alternatively, you can get the TX ID from the returned JSON object and check the transaction using a block explorer.

Note: A foreign blockchain wallet that supports the chain you are exporting the Catenis Smart Assets to will need to be installed (i.e., MetaMask)

Note: Some wallets require tokens to be added to the wallet by supplying the token contract address to the wallet (i.e., MetaMask). After exporting the token, a smart contract will be created, and its address will be available to be provided to a wallet. You can get the contract’s address by executing the "Asset Export Outcome" node or the "List Exported Assets" node. The result of each node will have a "token.id" object in the JSON result. The contract address will be in the token.id resulting property. Alternatively, you can automatically receive the contract address via the Asset Export Outcome (Asset-Export-Outcome) notification or simply examine the transaction ID on a block explorer.

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


{
    "assetId": "Insert_Asset_ID",
    "foreignBlockchain": "ethereum",
    "token": {
        "name": "Export Demo Token",
        "symbol": "EDT"
    },
    "options": {
        "estimateOnly": true
    }
}

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":"eaddef34.1f5d7","type":"export asset","z":"3dbf2c28.70dd6c","name":"","connection":"","assetId":"","foreignBlockchain":"","consumptionProfile":"slow","estimateOnly":true,"x":470,"y":100,"wires":[["af1112a5.2ddf3"]]},{"id":"af1112a5.2ddf3","type":"debug","z":"3dbf2c28.70dd6c","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":710,"y":100,"wires":[]},{"id":"e47e18d4.0082","type":"inject","z":"3dbf2c28.70dd6c","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"{\"assetId\":\"Insert_Your_Asset_ID\",\"foreignBlockchain\":\"ethereum\",\"token\":{\"name\":\"Export Demo Token\",\"symbol\":\"EDT\"},\"options\":{\"estimateOnly\":true}}","payloadType":"json","x":190,"y":100,"wires":[["eaddef34.1f5d7"]]},{"id":"7dbbd9be.b62088","type":"comment","z":"3dbf2c28.70dd6c","name":"Double click for instructions","info":"Please use your own asset ID generated when you previously issued an asset with Catenis. If you are not familiar with issuing assets on Catenis, please see the documentation titled issuing assets with Catenis flow.\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 Asset ID information by using an asset ID you have previously issued. \n\n4) Make any adjustments as necessary to the JSON inputs. \n\n\n","x":180,"y":140,"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":480,"y":60,"wires":[]}]

Related Articles