search

paltalabs / mercury-client

The following script is to show how one can use Mercury service for indexing Stellar & Soroban Network.
GNU General Public License v3.0
0 stars 1 forks source link

readme

Mercury Sandbox

This repository contains a Mercury client developed with Node.js and Axios. It demonstrates how to create a subscription by using Axios to send POST requests to the Mercury Service. Additionally, it provides examples for executing GraphQL queries to Mercury's GraphQL endpoint.

A subscription signifies that Mercury will store data selected by the subscriber. Consequently, the retrievable data will only encompass events that occur from the moment the subscription is activated. Therefore, when opting to monitor a specific smart contract, you should either interact with that contract yourself or wait for another party to invoke some operation on it. Data from before the subscription's activation will not be available for review.

The most important script here is do7txs.js which executes 7 transactions on Stellar/Soroban. It also subscribes the address created in the script to Mercury.

What is Mercury?

Mercury is an indexer service for Stellar and Soroban. Check more in the Mercury Docs Page

Pre-requisites

You need docker installed. It is tested with: Docker version 24.0.2, build cb74dfc

Get started

  1. Set your .env file Copy and update the access token provided by Mercury, refer to request access
cp .env.example .env

For executing the do7txs script, you need to set the following variables:

MERCURY_BACKEND_ENDPOINT=http://ec2-16-170-242-7.eu-north-1.compute.amazonaws.com:3030
MERCURY_GRAPHQL_ENDPOINT=http://ec2-16-170-242-7.eu-north-1.compute.amazonaws.com:5000
MERCURY_TESTER_EMAIL=
MERCURY_TESTER_PASSWORD=

Those will be used to update the access token on the Mercury server.

For other scripts, you'll need to paste your access token as well as the address of the Soroban Smart Contract that you want to track, and the endpoint address of the Mercury Server.

MERCURY_ACCESS_TOKEN=
CONTRACT_ADDRESS=CBYTTONE7AK2IEPRQUIPAJF6G35KE6HQCA3RFZWKH4HZQGIVQANUMVAN
MERCURY_BACKEND_ENDPOINT=http://ec2-16-170-242-7.eu-north-1.compute.amazonaws.com:3030
MERCURY_GRAPHQL_ENDPOINT=http://ec2-16-170-242-7.eu-north-1.compute.amazonaws.com:5000
  1. Run a node docker image and install: Get the node:18.18.2 container going: 
    bash run.sh

Inside the Node Docker containr, install packages:

yarn

Run scripts

There are several scripts written in this repo. The main script for this repo is "do7txs" which executes 7 transactions on Stellar/Soroban. It also subscribe the address created in the script to Mercury.

you can run it with:

yarn do7txs <standalone | testnet>

if you are using standalone, make sure you have a running instance of soroswap/core, with contracts deployed. Also, you need to serve the soroswap's API.

Then, if you have run the previous script on testnet, you will be able to retrieve the information using mercury. You can do that with:

yarn retrieve7txs

Also, there are other scripts to play around:

  1. Subscribe to ledger entries from contract defined on .env

    node scripts/subscribeToEntries.js

  2. Run a query asking for ledger entries:

    node scripts/getAllEntriesForContract.js

    The retrieved data will be available on results/responseData.json

Subscribe to contract events

Get the container going:

bash run.sh

Subscribe to events from a contract:

node scripts/subscribeToEvent.js

The retrieved data will be available on results/responseData.json

check your ledger entries and contract events subscriptions

With your container up and running. Plus, you connected to the shell of the container:

node scripts/getEntrySubscriptions.js
node scripts/getEventSubscriptions.js

Choosing contract to subscribe and get data from

You may want to modify the CONTRACT_ADDRESS environment variable on the .env file, for this example we are going to use the deployed Factory contract of Soroswap. You are able to find the address of the contract on this link.

...
CONTRACT_ADDRESS=CDN7QWURHQAVVTM6EEENOGGXTRQIRQR5KQPB7QBEQQVFQLANGSCN6LEZ
...

Update Mercury's access token

prerequisites:

Run script:

node scripts/updateToken.js

Developing mercury-sdk Using yarn link

To locally utilize mercury-sdk while working with containerized services, several steps must be followed to set up the environment.

Modify the relativePathToMercurySdk variable in the run.sh file to align with your local machine's relative path to mercury-sdk. This adjustment will mount an additional volume containing the mercury-sdk code.

Next, within the container, navigate to the mercury-sdk directory and link the package using the following commands:

cd /linked_sdk
yarn link

Afterward, switch to the /workspace directory and execute:

yarn link "mercury-sdk"

Notes on Package Development