πŸ’‘ Quickstart

ℹ️

In this section, we will show you how to set up a simple project to monitor an ERC20 contract.

Step 1: Create a Sentio Account

Simply go to https://app.sentio.xyz and login/create your account.

Step 2: Create a Project (optional)

By default, Sentio will create an empty "default" project for you, if you want to have a default project ID, then click "Create Project" on the project selector. In addition, our CLI can also automatically create a project for you.

Step 3: Setup Dev environment

We require users to follow setup before working on the projects.

Step 4: Create Processor Project

You can simply run the following command to create a processor project with the name default

npx @sentio/cli@latest create

You can also give the processor project a name by using the following command

npx @sentio/cli@latest create $PROJECT_NAME

The commands will generate a template project based on X2Y2 token. This should be a good starting point to write your own processor logic. It is also possible to create template projects for other types of chains, please refer CLI Reference.

ℹ️

You can directly modify the code (src/processor.ts) to fit your use case as well.

Sentio has a list of builtin ABIs. We also support custom ABIs for your own project. See decoding-from-custom-abis for more details.

For more information on how to write a processor you can refer to processor-basic

Step 5: Upload Processor

You can build and upload the processor project by using the following command

yarn sentio upload

You will see a link to data-source printed and you can open it in a browser to see the upload status.

End: Verify Metrics

The command line should tell you that the processor has been uploaded correctly and give you a link to check the status of the processor, such as what chains this processor is running, how many blocks it has processed, the version, etc.

You can go to the metrics page to check the metrics submitted to the project. Checkout metrics for more details.