ContextQMD
Back to Sui

Escrow API Demo

examples/trading/api/README.md

latest2.8 KB
Original Source

Escrow API Demo

This demo is built to showcase how we can build an event indexer + API to efficiently serve on-chain data for our app.

The demo indexer uses polling to watch for new events.

Everything is pre-configured on Testnet, but can be tweaked to work on any other network. You can change the network by creating a .env file with the variable NETWORK=<mainnet|testnet|devnet|localnet>

Installation

  1. Install dependencies by running
pnpm install --ignore-workspace
  1. Setup the database by running
pnpm db:setup:dev

  1. Publish the contract & demo data

  2. Run both the API and the indexer

pnpm dev
  1. Visit http://localhost:3000/escrows or http://localhost:3000/locked

Demo Data<a name="demo-data"></a>

Make sure you have enough Testnet (or any net) SUI in the active address of the CLI.

There are some helper functions to:

  1. Publish the smart contract
  2. Create some demo data (for testnet)

To produce demo data:

  1. Publish the smart contract by running
npx ts-node helpers/publish-contracts.ts
  1. Produce demo non-locked and locked objects
npx ts-node helpers/create-demo-data.ts
  1. Produce demo escrows
npx ts-node helpers/create-demo-escrows.ts

If you want to reset the database (start from scratch), run:

pnpm db:reset:dev && pnpm db:setup:dev

API

The API exposes data written from the event indexer.

For each request, we have pagination with a max limit of 50 per page.

ParameterExpected value
limitnumber (1-50)
cursornumber
sort'asc' | 'desc'

There are two available routes:

/locked: Returns indexed locked objects

Available query parameters:

ParameterExpected value
deleted'true' | 'false'
keyIdstring
creatorstring

/escrows: Returns indexed escrow objects

Available query parameters:

ParameterExpected value
cancelled'true' | 'false'
swapped'true' | 'false'
recipientstring
senderstring

Example Query: Get only active escrows for address (5 per page) 0xfe09cf0b3d77678b99250572624bf74fe3b12af915c5db95f0ed5d755612eb68

curl --location 'http://localhost:3000/escrows?limit=5&recipient=0xfe09cf0b3d77678b99250572624bf74fe3b12af915c5db95f0ed5d755612eb68&cancelled=false&swapped=false'

Event Indexer

Run only a single instance of the indexer.

Indexer uses polling to watch for new events. We're saving the cursor data in the database so we can start from where we left off when restarting the API.

To run the indexer individually, run:

pnpm indexer