Our key concepts glossary
PARSIQ is a blockchain monitoring platform that helps users automate real-time workflows between blockchains and off-chain applications at scale. This tutorial explains the key concepts of our platform.
PARSIQ’s Web Portal enables external parties to build their applications upon it or integrate existing ones, public and partner APIs are provided.
Smart-Trigger receives input events from blockchains, processes each of them according to your logic and produces intermediate or output (result) events or programmable reactions.
User Data is meant for defining monitoring artifacts (i.e. wallet, account or smart contract addresses) with extra valuable information like labels, thresholds, scores etc.
Transports are used as delivery channels for reactions in a workflow.
A reaction can be as a notification or a programmable action to a particular blockchain network activity.
E.g. Telegram, E-mail, Google Sheets, Webhooks, etc.
Customizations give the possibility for users to implement additional logic to their monitoring and workflow triggers. For example:
– specifying which events you are interested in monitoring (deposits, withdrawals, etc)
– specifying which transfer amounts you are interested in monitoring (less than, more than, equal to, etc)
– adding risk category data to these transactions (blacklist, whitelist, graylist etc)
– adding market data to these transactions (equivalent in USD etc)
ParsiQL is a domain-specific programming language that serves the main purpose of manipulating event streams – the core concept behind ParsiQL.
Creating your first project
After logging into the PARSIQ portal and clicking ”Get Started”, select ”New Project” to begin.
Choose a name for your project.
Next, you will be directed to our easy-to-use Quick Monitoring Wizard. In the Wizard, you can enter a blockchain address that you want to monitor.
You can also choose from the tables of addresses that you have already entered in your User Data sections by referring to them.
Then, you can select a Transport.
It is the delivery channel, web service or app where you want the end result to be delivered. Assuming you already have previously set up your transports, you can choose between them.
If you are interested in all activity happening on those addresses, simply click ”Start Monitoring”.
Real-time data will start to flow to your selected Delivery Channel as soon as any blockchain activity happens. Or, you can add customizations before deploying the Smart-Trigger.
Setting up your transports
Click on the ”+” symbol next to Transports to connect a new Transport. Then choose Transport type (Ex. Telegram, Google Sheets, Webhooks, etc).
To set up Telegram transport:
Select Telegram as Transport type. Enter name for your Telegram Transport. Click ”Create Transport”.
You can scan the QR code using your phone to connect your Telegram account and click ”START” via the ParsiqDevbot.
Or you can click ”Connect Telegram” and connect it via your mobile or desktop client and click ”START” via the ParsiqDevbot.
To set up Webhook:
Select Webhook as transport type. Enter a name for your Webhook. Enter the URL. Click ”Create Transport”.
Creating a table of addresses to monitor with User Data
Choose a project that you have already created and go to the User Data section of your Project.
Click Create Record. Then provide a meaningful name to the table (i.e. MyEthereumWallets) and select the type as “table”.
Depending on the type of blockchain your addresses are tied to, the type for the mandatory field called “address” will vary as well.
This means that addresses from different blockchains will require their own table.
Other fields can also be added to the table, acting as table columns. This extends the flexibility to also contain a variety of other data in addition to basic blockchain addresses (i.e. labels, numeric thresholds …).
Beware, that once the table is created its Name, Kind and Type cannot be changed, only the data stored in the table can be.
However, this is optional and with a single mandatory “address” column it will remind of a list of related addresses one wants to monitor.
After clicking ”Create Userdata”, you will end up on the page to initialize it with values (they can be also added later).
Now you can either:
- start adding the rows manually by clicking + ”Add Row” and entering/copy-pasting the data
- or upload the data in bulk, by clicking Import and uploading a .csv file
When finished click ”Save”. The new table will appear in the list of User Data variables.
In order to alter the table data, by changing/adding/removing rows – click the table variable.
- click the “Edit” icon and to alter it manually
- or append new rows to the table by clicking the cloud icon with an arrow pointing up.
Worth mentioning is, that from now this particular table with name “MyEthereumWallets” can be accessed from Quick Monitoring Wizard and also from ParsiQL code editor.
After you’ve chosen the addresses that you want to monitor and your transport type, you can now customize your workflow by clicking ”Add customization”.
Select from one of the available customizations:
If transfer type…
– you can choose whether you want to monitor: deposits, withdrawals or both
– you can set thresholds for amounts of digital assets that you want to monitor: is lower than; is lower or equal to; is equal to; is more than or equal to; is more than;
and finally, enter the variable value
Add risk data…
PARSIQ allows to enrich the transaction data that our system gets from the blockchain with valuable risk data from different third-party providers
– select risk data provider: e.g. Uppsala
– select risk data type: e.g. risk label or risk category
– select what you want to apply to the risk data: for the sender or for the receiver
Add market data…
PARSIQ allows to enrich the transaction data that our system gets from the blockchain with valuable market data from third-party providers
– select market data provider: e.g. Cryptorank
– select market data type: e.g. fiat rate in USD
– select what you want to apply to the market data: of transfer amount
Click ”Start Monitoring”.
Now when activity on the addresses selected by you matches the conditions you already set, you’ll receive the enriched transformed data in real-time through your chosen delivery channel.
Under the projects you have created, you can create an infinite amount of monitoring Triggers.
Just click on the project to see your existing triggers or create a new one.
Under Triggers, you will have an overview of all of your Smart-Triggers and their status. You can either deploy or disable any of them at any time by clicking on the switch on the right.
By clicking on any individual Trigger, you will see the ParsiQL code for that Trigger.
For those with minimal programming experience, the code can be edited to allow maximum flexibility.
Then saved, tested and deployed. On the right, there is also a helpful stream explorer to get you started.
By clicking on Delivery Channels (next to the Code Editor), you can add or remove any Transport types for that particular Trigger.
We really hope you learned some new tips and tricks on how to up your blockchain monitoring experience with us.
If you have any extra questions about using PARSIQ’s monitoring and automation platform you can always reach us by our TELEGRAM GROUP: https://t.me/parsiq_group