feat: get transfer status function

.github/workflows/ci.yaml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [16, 18]
+        node: [18, 20]
       fail-fast: true
     steps:
       - uses: actions/checkout@v3
@@ -22,6 +22,7 @@ jobs:
           cache: 'yarn' # cache node modules
           node-version: ${{ matrix.node }}
       - run: corepack enable
+      - run: yarn set version stable
       - run: yarn
       - run: yarn run sdk:lint # lint code
       - run: yarn run sdk:build # compile typescript into javascript

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           cache: 'yarn'
-          node-version: 16
+          node-version: 18
           registry-url: 'https://registry.npmjs.org'
           scope: '@buildwithsygma'
         env:

.yarnrc.yml

@@ -7,13 +7,9 @@ nmMode: hardlinks-local
 nodeLinker: node-modules
 
 plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: "@yarnpkg/plugin-interactive-tools"
-  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
-    spec: "@yarnpkg/plugin-workspace-tools"
-  - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
-    spec: "@yarnpkg/plugin-typescript"
   - path: .yarn/plugins/@yarnpkg/plugin-engines.cjs
     spec: "https://raw.githubusercontent.com/devoto13/yarn-plugin-engines/main/bundles/%40yarnpkg/plugin-engines.js"
 
-yarnPath: .yarn/releases/yarn-3.4.1.cjs
+yarnPath: .yarn/releases/yarn-4.0.1.cjs
+
+checksumBehavior: update

examples/evm-to-evm-fungible-transfer/src/transfer.ts

@@ -1,4 +1,8 @@
-import { EVMAssetTransfer, Environment } from "@buildwithsygma/sygma-sdk-core";
+import {
+  EVMAssetTransfer,
+  Environment,
+  getTransferStatusData,
+} from "@buildwithsygma/sygma-sdk-core";
 import { Wallet, providers } from "ethers";
 import dotenv from "dotenv";
 
@@ -14,12 +18,26 @@ const SEPOLIA_CHAIN_ID = 11155111;
 const RESOURCE_ID =
   "0x0000000000000000000000000000000000000000000000000000000000000300";
 
+const getStatus = async (
+  txHash: string
+): Promise<{ status: string; explorerUrl: string } | void> => {
+  try {
+    const data = await getTransferStatusData(Environment.TESTNET, txHash);
+
+    return data as { status: string; explorerUrl: string };
+  } catch (e) {
+    console.log("error", e);
+    console.log("indexing and retrying");
+  }
+};
+
 export async function erc20Transfer(): Promise<void> {
   const provider = new providers.JsonRpcProvider(
     "https://rpc.goerli.eth.gateway.fm/"
   );
   const wallet = new Wallet(privateKey ?? "", provider);
   const assetTransfer = new EVMAssetTransfer();
+  // @ts-ignore-next-line
   await assetTransfer.init(provider, Environment.TESTNET);
 
   const transfer = await assetTransfer.createFungibleTransfer(
@@ -46,6 +64,28 @@ export async function erc20Transfer(): Promise<void> {
     transferTx as providers.TransactionRequest
   );
   console.log("Sent transfer with hash: ", response.hash);
+
+  let dataResponse: undefined | { status: string; explorerUrl: string };
+
+  const id = setInterval(() => {
+    getStatus(response.hash)
+      .then((data) => {
+        if (data) {
+          dataResponse = data;
+          console.log("Status of the transfer", data.status);
+        }
+      })
+      .catch((e) => {
+        console.log(e);
+        console.log("Transfer still not indexed, retrying...");
+      });
+
+    if (dataResponse && dataResponse.status === "executed") {
+      console.log("Transfer executed successfully");
+      clearInterval(id);
+      process.exit(0);
+    }
+  }, 5000);
 }
 
-erc20Transfer().finally(() => { });
+erc20Transfer().finally(() => {});

examples/evm-to-evm-generic-mesage-passing/src/transfer.ts

@@ -2,6 +2,7 @@ import dotenv from "dotenv";
 import {
   EVMGenericMessageTransfer,
   Environment,
+  getTransferStatusData,
 } from "@buildwithsygma/sygma-sdk-core";
 import { BigNumber, Wallet, providers, utils } from "ethers";
 import { Storage__factory } from "./Contracts";
@@ -14,6 +15,19 @@ if (!privateKey) {
   throw new Error("Missing environment variable: PRIVATE_KEY");
 }
 
+const getStatus = async (
+  txHash: string
+): Promise<{ status: string; explorerUrl: string } | void> => {
+  try {
+    const data = await getTransferStatusData(Environment.TESTNET, txHash);
+
+    return data as { status: string; explorerUrl: string };
+  } catch (e) {
+    console.log("error", e);
+    console.log("indexing and retrying");
+  }
+};
+
 const DESTINATION_CHAIN_ID = 5; // Goerli
 const RESOURCE_ID =
   "0x0000000000000000000000000000000000000000000000000000000000000500"; // Generic Message Handler
@@ -41,11 +55,11 @@ const sleep = (ms: number): Promise<void> =>
 const waitUntilBridged = async (
   valueBefore: BigNumber,
   intervalDuration: number = 15000,
-  attempts: number = 8,
+  attempts: number = 8
 ): Promise<void> => {
   let i = 0;
   let contractValueAfter: BigNumber;
-  for (; ;) {
+  for (;;) {
     await sleep(intervalDuration);
     contractValueAfter = await fetchAfterValue();
     if (!contractValueAfter.eq(valueBefore)) {
@@ -76,7 +90,7 @@ export async function genericMessage(): Promise<void> {
     ).toString()}`
   );
   const messageTransfer = new EVMGenericMessageTransfer();
-  await messageTransfer.init(sourceProvider, Environment.DEVNET);
+  await messageTransfer.init(sourceProvider, Environment.TESTNET);
 
   const EXECUTION_DATA = utils.defaultAbiCoder.encode(["uint"], [Date.now()]);
 
@@ -104,6 +118,27 @@ export async function genericMessage(): Promise<void> {
   console.log("Waiting for relayers to bridge transaction...");
 
   await waitUntilBridged(contractValueBefore);
+
+  let dataResponse: undefined | { status: string; explorerUrl: string };
+
+  const id = setInterval(() => {
+    getStatus(response.hash)
+      .then((data) => {
+        if (data) {
+          dataResponse = data;
+          console.log("Status of the transfer", data.status);
+        }
+      })
+      .catch(() => {
+        console.log("Transfer still not indexed, retrying...");
+      });
+
+    if (dataResponse && dataResponse.status === "executed") {
+      console.log("Transfer executed successfully");
+      clearInterval(id);
+      process.exit(0);
+    }
+  }, 5000);
 }
 
-genericMessage().finally(() => { });
+genericMessage().finally(() => {});

examples/evm-to-substrate-fungible-transfer/src/transfer.ts

@@ -1,4 +1,8 @@
-import { EVMAssetTransfer, Environment } from "@buildwithsygma/sygma-sdk-core";
+import {
+  EVMAssetTransfer,
+  Environment,
+  getTransferStatusData,
+} from "@buildwithsygma/sygma-sdk-core";
 import { Wallet, providers } from "ethers";
 import dotenv from "dotenv";
 
@@ -14,6 +18,19 @@ const DESTINATION_ADDRESS = "5CDQJk6kxvBcjauhrogUc9B8vhbdXhRscp1tGEUmniryF1Vt";
 const RESOURCE_ID =
   "0x0000000000000000000000000000000000000000000000000000000000001000";
 
+const getStatus = async (
+  txHash: string
+): Promise<{ status: string; explorerUrl: string } | void> => {
+  try {
+    const data = await getTransferStatusData(Environment.TESTNET, txHash);
+
+    return data as { status: string; explorerUrl: string };
+  } catch (e) {
+    console.log("error", e);
+    console.log("indexing and retrying");
+  }
+};
+
 export async function erc20Transfer(): Promise<void> {
   const provider = new providers.JsonRpcProvider(
     "https://rpc.goerli.eth.gateway.fm/"
@@ -47,6 +64,27 @@ export async function erc20Transfer(): Promise<void> {
     transferTx as providers.TransactionRequest
   );
   console.log("Sent transfer with hash: ", response.hash);
+
+  let dataResponse: undefined | { status: string; explorerUrl: string };
+
+  const id = setInterval(() => {
+    getStatus(response.hash)
+      .then((data) => {
+        if (data) {
+          dataResponse = data;
+          console.log(data);
+        }
+      })
+      .catch(() => {
+        console.log("Transfer still not indexed, retrying...");
+      });
+
+    if (dataResponse && dataResponse.status === "executed") {
+      console.log("Transfer executed successfully");
+      clearInterval(id);
+      process.exit(0);
+    }
+  }, 5000);
 }
 
-erc20Transfer().finally(() => { });
+erc20Transfer().finally(() => {});

examples/substrate-to-evm-fungible-transfer/src/transfer.ts

@@ -2,7 +2,11 @@ import { Keyring } from "@polkadot/keyring";
 import { ApiPromise, WsProvider } from "@polkadot/api";
 import { cryptoWaitReady } from "@polkadot/util-crypto";
 import dotenv from "dotenv";
-import { Environment, Substrate } from "@buildwithsygma/sygma-sdk-core";
+import {
+  Environment,
+  Substrate,
+  getTransferStatusData,
+} from "@buildwithsygma/sygma-sdk-core";
 
 dotenv.config();
 
@@ -18,6 +22,19 @@ if (!MNEMONIC) {
   throw new Error("Missing environment variable: PRIVATE_MNEMONIC");
 }
 
+const getStatus = async (
+  txHash: string
+): Promise<{ status: string; explorerUrl: string } | void> => {
+  try {
+    const data = await getTransferStatusData(Environment.TESTNET, txHash);
+
+    return data as { status: string; explorerUrl: string };
+  } catch (e) {
+    console.log("error", e);
+    console.log("indexing and retrying");
+  }
+};
+
 const substrateTransfer = async (): Promise<void> => {
   const keyring = new Keyring({ type: "sr25519" });
   // Make sure to fund this account with native tokens
@@ -61,6 +78,27 @@ const substrateTransfer = async (): Promise<void> => {
       );
       unsub();
     }
+
+    let dataResponse: undefined | { status: string; explorerUrl: string };
+
+    const id = setInterval(() => {
+      getStatus(transferTx)
+        .then((data) => {
+          if (data) {
+            dataResponse = data;
+            console.log(data);
+          }
+        })
+        .catch(() => {
+          console.log("Transfer still not indexed, retrying...");
+        });
+    }, 5000);
+
+    if (dataResponse && dataResponse.status === "executed") {
+      console.log("Transfer executed successfully");
+      clearInterval(id);
+      process.exit(0);
+    }
   });
 };
 

package.json

@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/sygmaprotocol/sygma-sdk"
   },
-  "packageManager": "yarn@3.4.1",
+  "packageManager": "yarn@4.0.1",
   "engines": {
     "node": ">=16.0.0"
   },
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@changesets/cli": "^2.14.1",
-    "ethers": "5.4.5"
+    "ethers": "5.6.2"
   },
   "devDependencies": {
     "@chainsafe/eslint-config": "^1.1.0",

packages/sdk/src/constants.ts

@@ -3,3 +3,13 @@ export enum ConfigUrl {
   TESTNET = 'https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-test.json',
   MAINNET = 'https://sygma-assets-mainnet.s3.us-east-2.amazonaws.com/shared-config-mainnet.json',
 }
+
+export enum IndexerUrl {
+  MAINNET = 'https://api.buildwithsygma.com',
+  TESTNET = 'https://api.test.buildwithsygma.com',
+}
+
+export enum ExplorerUrl {
+  MAINNET = 'https://scan.buildwithsygma.com',
+  TESTNET = 'https://scan.test.buildwithsygma.com',
+}

packages/sdk/src/index.ts

@@ -2,3 +2,4 @@ export * from './chains/index.js';
 export * from './config.js';
 export * from './constants.js';
 export * from './types/index.js';
+export { getTransferStatusData } from './utils.js';

packages/sdk/src/types/types.ts

@@ -82,3 +82,10 @@ export type Transfer<TransferType> = {
 };
 
 export type LiquidityError = Error & { maximumTransferAmount: bigint };
+
+export type TransferStatus = 'pending' | 'executed' | 'failed';
+
+export type TransferStatusResponse = {
+  status: TransferStatus;
+  explorerUrl: string;
+};