/xcallscan

xCallScan is an Explorer that allows users to look up relay messages and transactions being sent through xCall Service

Primary LanguageTypeScriptMIT LicenseMIT

xCallScan

xCallScan is an Explorer that allows users to look up relay messages and transactions being sent through xCall Service.

xCallScan is typically made of:

  1. Indexer: that fetches the raw data from the on-chain, extracts, transforms, and stores it in the database in an efficient way to provide quick access to the blockchain data

  2. API: an API that queries the database

  3. Explorer: A frontend app that displays the data

Highlevel architecture

Screenshots

Live: http://testnet.xcallscan.xyz

Getting started

Indexer

  • Install package

  • Change .env.example to .env and configure environment settings

  • Initialize database

    ts-node cmd db init

  • Migrate database

    ts-node cmd db migrate <filename.sql>

  • Start indexer

    npm run indexer

  • Start web socket

    npm run ws

  • Command

    ts-node cmd scan <network> <event> <flag_number> <xcall_address>
ts-node cmd fetch <network> <event> <flag_number> <update_counter>
ts-node cmd sync <from_sn><comma_or_hyphen><to_sn> <networks_separated_by_comma>

Api

  • Install package
  • Change .env.example to .env and configure environment settings
  • Start API 
    npm start

Explorer

  • Install package

  • Configure env in next.config.js

  • Build

    npm run build

  • Run dev

    npm run dev

  • Start app

    npm start

What's next

  • This is still under testing and known issues found.
  • Improving Indexer to fetch data faster.
  • Improving Explorer UI/UX, supporting mobile responsiveness.

References