Catenis Flow Guide

Get Asset Balance Node

The “Get Asset Balance” node can be used to retrieve the current balance of a given asset held by a device. It will take as input the device Id and return two numbers: one corresponding to the balance and another corresponding to how many of the assets remain unconfirmed.

Image of the Get Asset Balance Node

Node Properties Panel Field Description

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

2020-07-27_20-49-27
Image of The Get Asset Balance Properties Panel

Node-RED Specific Fields

  1. Name Field:  Add a descriptive name of your choice 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 direction on setting up a new virtual device that can be found here.

Catenis Flow Setting Fields

  1. Asset ID: Enter the ID of an asset you have previously created.

How to use

  1. Drag and drop this node from the Catenis Flow pallet area to the Node-RED workspace. Double-click it to display its 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 (device ID and API Secret key). If you do not have a virtual device configured see section titled: “Configure your first virtual device on Node-RED” 
  3. Add the node’s configuration information based on your needs 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” on proper usage.
  4. 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  “Get Asset Balance” node, then 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 choose 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. Then 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

This node can be used in two modes: interactive and run-time. In interactive mode, the end user clicks on the action button attached to the node and the Catenis API method is called using the default settings (as specified in the node’s properties slide out panel configuration).

  1. Follow steps 1 through 4 under “How to use” above
  2. Click the red Deploy button on the upper right hand side of the Node-RED dashboard to deploy this flow.
  3. 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. 
  4. 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 this node


{
    "assetId": "akXJpFoD79GZy7wWc9cd"
}


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. You will also need to alter the JSON input to match the asset Id of an asset you have previously generated. The one on the example you will not have permission to retrieve.

Example Flow - Import Into Node-Red to Get Started


[{"id":"e0e6b028.d502d","type":"debug","z":"67ec4e0f.45d34","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","x":650,"y":180,"wires":[]},{"id":"a0b9a64f.c57df8","type":"get asset balance","z":"67ec4e0f.45d34","name":"","device":"","assetId":"abjd8ZWx7CSTm7LSgoBz","x":430,"y":180,"wires":[["e0e6b028.d502d"]]},{"id":"926935a4.d99e48","type":"comment","z":"67ec4e0f.45d34","name":"Set virtual device for this Catenis node","info":"All Catenis nodes require that you set the proper virtual device on its slideout property panel on the device field.\n\nNot setting the device properly will result in a \"TypeError: Cannot read property 'ctnApiClient' of null\" \n\nAsset Id field required","x":430,"y":140,"wires":[]},{"id":"c9d0ddf6.36ddc","type":"inject","z":"67ec4e0f.45d34","name":"","topic":"","payload":"{\"assetId\":\"enter your asstId here\"}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":231,"y":180,"wires":[["a0b9a64f.c57df8"]]},{"id":"8f0365a9.e63cb8","type":"comment","z":"67ec4e0f.45d34","name":"Double click for instructions","info":"Warning: You must enter your own asset ID in the JSON field.\n\n\n\n\n","x":230,"y":240,"wires":[]}]


Note: After importing this flow you will need to set the Catenis Flow node(s) in this flow to use a previously configured virtual devices. Instructions on how to set up your virtual device on Node-RED can be found here: https://blockchainofthings.com/docs/configure-your-first-virtual-device-on-catenis-flow/

Related Articles

CompanyElement_SM_LightBackgrounds
How can we make things Better for you?
  • Accepted file types: jpg, gif, png, pdf.
  • This field is for validation purposes and should be left unchanged.