Quickstart

Create a Convect Function

In the preferred project, create a new Convect Function.

Initialise Convect

Initialise Convect in your project directory.

terminal

npx convect-xyz init

This will create a convect.config.mjs file in your root project directory.

You can read more about the Convect config file here.

The transaction API is used to define a handler for transactions that contain event logs that match all of the signatures specified in the logs property. When your Convect Function runs, it receives these transactions in batches (max 60 transactions per batch).

For the example below, the transfer handler will be called for all transactions that contain a Transfer log originating from the USDC contract.

You can read the API reference for detailed information on what you can do with the transaction API.

src/convect/handlers/transfer.ts

import { tokenABI, tokenAddress } from './abis/token'
import { ethMainnet, log, transaction } from "convect-xyz";

const usdc = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';

export const transfer = transaction({
  name: "transfer",
  chains: [ethMainnet],
  logs: [
    log({
      origin: usdc,
      signature: "event Transfer(address indexed from, address indexed to, uint256 value)"
    })
  ],
  handler: async (transactions) => {
    // Implement your transaction handler here. eg.
    await prisma.activity.createMany({
      data: transactions.flatMap(tx => tx.logs).map((log) => ({
        from: log.args.from // Inferred as `0x${string}`,
        to: log.args.to // Inferred as `0x${string}`,
        tokenId: log.args.tokenId // Inferred as bigint
      }))
    })
  }
});

Convention

For better readability, define related handlers in a separate file as shown above.

Export a Convect Function

The convect API is used to export a Convect Function. This ties all your handlers together. Handlers run in the order they are specified in the handlers array.

src/convect/[project-name]/[function-name].convect.ts

import { transfer } from "../../handlers/transfer";
import { convect } from "convect-xyz";

export default convect({
  handlers: [transfer]
});

Good to know

When your Convect Function receives batches of transactions, it will call all matching transaction handlers in the order they are specified in the handlers array.

Authenticate & Deploy

Authenticate with the command below.

terminal

npx convect-xyz auth

Create a new deployment with the command below.

terminal

npx convect-xyz deploy -s [project-name]/[function-name]

The new deployment should be available in the Projects page.

Quickstart

Create a Convect Function

Initialise Convect

Write your handler

Export a Convect Function

Authenticate & Deploy

On this page