Algorand Quick Start

... 2022-10-5 About 4 min

# Algorand Quick Start

# Goals

The goal of this quick guide is to adapt the standard starter project and start indexing all the PLANET token transfers (opens new window) from Algorand.

Important

Before we begin, make sure that you have initialised your project using the provided steps in the Start Here section.

Now, let's move forward and update these configurations.

Previously, in the 1. Create a New Project section, you must have noted 3 key files. Let's begin updating them one by one.

Note

The final code of this project can be found here (opens new window).

# 1. Update Your GraphQL Schema File

The schema.graphql file determines the shape of your data from SubQuery due to the mechanism of the GraphQL query language. Hence, updating the GraphQL Schema file is the perfect place to start. It allows you to define your end goal right at the start.

Remove all existing entities and update the schema.graphql file as follows, here you can see we are focussing on indexing all transactions ralated to the PLANET asset.

type Transaction @entity {
  id: ID! # A unique ID - The transaction ID
  blockHeight: Int!
  sender: String!
  receiver: String
  amount: BigInt
}
1
2
3
4
5
6
7

Important

When you make any changes to the schema file, please ensure that you regenerate your types directory.

You will find the generated models in the /src/types/models directory.

Check out the GraphQL Schema documentation to get in-depth information on schema.graphql file.

Now that you have made essential changes to the GraphQL Schema file, let’s move forward to the next file.

# 2. Update Your Project Manifest File

The Project Manifest (project.yaml) file works as an entry point to your Algorand project. It defines most of the details on how SubQuery will index and transform the chain data.

Note that the manifest file has already been set up correctly and doesn’t require significant changes, but you need to change the datasource handlers. This section lists the triggers that look for on the blockchain to start indexing.

dataSources:
  - kind: algorand/Runtime
    startBlock: 8712119 #Block that planet was created on https://algoexplorer.io/tx/G66KX3TLKXUI547DFB4MNVY7SJVADOJKGP4SWMRC632GFHSFX5KQ
    mapping:
      file: ./dist/index.js
      handlers:
        - handler: handleTransaction
          kind: algorand/TransactionHandler
          filter:
            # Payments from the Planet Watch Address for the PLANET asset
            txType: axfer
            assetId: 27165954
            sender: "ZW3ISEHZUHPO7OZGMKLKIIMKVICOUDRCERI454I3DB2BH52HGLSO67W754"
1
2
3
4
5
6
7
8
9
10
11
12
13

The above code indicates that you will be running a handleTransaction mapping function whenever there is an Algorand Transaction that includes the asset ID 27165954 and is sent from the ZW3ISEHZUHPO7OZGMKLKIIMKVICOUDRCERI454I3DB2BH52HGLSO67W754 (Planet) address.

Check out our Manifest File documentation to get more information about the Project Manifest (project.yaml) file.

Next, let’s proceed ahead with the Mapping Function’s configuration.

# 3. Add a Mapping Function

Mapping functions define how chain data is transformed into the optimised GraphQL entities that we previously defined in the schema.graphql file.

Follow these steps to add a mapping function:

  • Navigate to the default mapping function in the src/mappings directory. You will be able to see two exported functions: handleBlock and handleTransaction. Delete the handleBlock function.

  • The handleTransaction function receives event data whenever an event matches the filters, which you specified previously in the project.yaml. Let’s make changes to it, process all PLANET token transactions, and save them to the GraphQL entities created earlier.

Update the handleTransaction function as follows (note the additional imports):

import { AlgorandTransaction } from "@subql/types-algorand";
import { Transaction } from "../types";

export async function handleTransaction(
  tx: AlgorandTransaction
): Promise<void> {
  // logger.info(JSON.stringify(tx));
  const transactionEntity: Transaction = Transaction.create({
    id: tx.id,
    blockHeight: tx.confirmedRound,
    sender: tx.sender,
  });
  if (tx.paymentTransaction) {
    (transactionEntity.receiver = tx.paymentTransaction.receiver),
      (transactionEntity.amount = BigInt(tx.paymentTransaction.amount));
  }
  await transactionEntity.save();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Let’s understand how the above code works.

Here, the function recieves a AlgorandTransaction which includes all transaction data on the payload. We extract this data and then instantiate a new Transaction entity (using required properties id,blockHeigh and sender) defined earlier in the schema.graphql file. After that, we add additional information about the payment (receiver and amountproperties) and then use the .save() function to save the new entity (SubQuery will automatically save this to the database).

Check out our Mappings documentation to get more information on mapping functions.

# 4. Build Your Project

Next, build your work to run your new SubQuery project. Run the build command from the project's root directory as given here:

Important

Whenever you make changes to your mapping functions, you must rebuild your project.

Now, you are ready to run your first SubQuery project. Let’s check out the process of running your project in detail.

# 5. Run Your Project Locally with Docker

Whenever you create a new SubQuery Project, first, you must run it locally on your computer and test it and using Docker is the easiest and quickiest way to do this.

The docker-compose.yml file defines all the configurations that control how a SubQuery node runs. For a new project, which you have just initialised, you won't need to change anything.

However, visit the Running SubQuery Locally to get more information on the file and the settings.

Run the following command under the project directory:

Note

It may take a few minutes to download the required images and start the various nodes and Postgres databases.

# 6. Query your Project

Next, let's query our project. Follow these three simple steps to query your SubQuery project:

  1. Open your browser and head to http://localhost:3000.

  2. You will see a GraphQL playground in the browser and the schemas which are ready to query.

  3. Find the Docs tab on the right side of the playground which should open a documentation drawer. This documentation is automatically generated and it helps you find what entities and methods you can query.

Try the following query to understand how it works for your new SubQuery starter project. Don’t forget to learn more about the GraphQL Query language.

query {
  transactions(first: 5, orderBy: AMOUNT_DESC) {
    nodes {
      id
      blockHeight
      sender
    }
  }
}
1
2
3
4
5
6
7
8
9

You will see the result similar to below:

{
  "data": {
    "transactions": {
      "nodes": [
        {
          "id": "22KTREJE4FXRL26PFS3UACSEEXFMG52RSMLGIT2V5VM65IJ37JFA",
          "blockHeight": 8716270,
          "sender": "SHTUSO6YCTH5NV74MU2HC4VOKFGX3NLOUVD5TCZCXQWDSX6JCE4SMZMOYA",
          "reciever": null,
          "amount": null
        },
        {
          "id": "236KDOYBH5CZDZSDRQ32XK5W25TQFHVTIRKRPFHLIU2PBOCWMSEQ",
          "blockHeight": 8715704,
          "sender": "SHTUSO6YCTH5NV74MU2HC4VOKFGX3NLOUVD5TCZCXQWDSX6JCE4SMZMOYA",
          "reciever": null,
          "amount": null
        },
        {
          "id": "237QLNWAR6IDCJQGSW5AF7H3TO7HM4WYF7B7XTFEFI6WZZA43I7A",
          "blockHeight": 8715145,
          "sender": "SHTUSO6YCTH5NV74MU2HC4VOKFGX3NLOUVD5TCZCXQWDSX6JCE4SMZMOYA",
          "reciever": null,
          "amount": null
        },
        {
          "id": "2466NNRTAREB2JLMDHAHJ24DDSDAYVOGO6H3VH2S45TWKVF7YOKA",
          "blockHeight": 8716418,
          "sender": "SHTUSO6YCTH5NV74MU2HC4VOKFGX3NLOUVD5TCZCXQWDSX6JCE4SMZMOYA",
          "reciever": null,
          "amount": null
        },
        {
          "id": "24JIQD73JR5KMQ5PIM3J5ZVWTF2ZP4L7N3I257JREEEHGHJTGDXA",
          "blockHeight": 8715583,
          "sender": "SHTUSO6YCTH5NV74MU2HC4VOKFGX3NLOUVD5TCZCXQWDSX6JCE4SMZMOYA",
          "reciever": null,
          "amount": null
        }
      ]
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Note

The final code of this project can be found here (opens new window).

# What's next?

Congratulations! You have now a locally running SubQuery project that accepts GraphQL API requests for transferring data.

Click here to learn what should be your next step in your SubQuery journey.

Last update: October 5, 2022 01:44