npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@maticnetwork/openapi-watchgod-merger

v1.0.9

Published

merge open api and watchgod responses to get latest transaction status

Downloads

8

Readme

openapi-watchgod-merger

Merge OpenAPI and Watchgod responses to track latest status of a deposit/withdraw transaction on Ethereum Chain and Polygon Chain.

Usage

Installation

npm i openapi-watchgod-merger
import openapiWatchgodMerge from openapi-watchgod-merger

// Folllowing variables represent data
// from OpenAPI and Watchgod API
const openApiDepositResponse = []
const openApiWithdrawResponse = []
const openApiBurnResponse = []
const watchGodResponse = []

// below given function expects all 4 arguments
// and in same order
const mergedData = openapiWatchgodMerge(
    openApiDepositResponse,
    openApiWithdrawResponse,
    openApiBurnResponse,
    watchGodResponse
);

Detailed Explanation

For now, it is not giving out exact intelligent status of a transaction. It just merges all related transactions into one and appends some additional information based on below given priority.

A merged transaction will have all the undisturbed response with some additional fields added.

NOTE: All fields added by this library starts with an underscore(e.g. _latestStatus)

Deposits

Deposit transactions can be tracked via 2 places with below mentioned priorities

Priority for Deposit Txs(Highest to Lowest)

  • OpenAPI
  • Watchgod

Additional fields

  • _txType
  • _txSource
  • _openapiTxStatus
  • _watchgodTxStatus
  • _latestStatus

Withdraw

Withdraw transactions consists of 2 parts(i.e. withdraw init/burn and exit). Withdraw transactions can be tracked via 2 places with below mentioned priorities

Priority for Withdraw+Exit Txs(Highest to Lowest)

  • OpenAPI Exit
  • Watchgod Exit
  • OpenAPI Withdraw
  • Watchgod Withdraw

Additional fields

  • _txType
  • _txSource
  • _burnTxHash
  • _exitTxHash
  • _openapiExitTxStatus
  • _watchgodExitTxStatus
  • _openapiBurnTxStatus
  • _watchgodBurnTxStatus
  • _latestStatus

Interface

Since different APIs uses their own names for naming a variable(e.g. openapi:transactionHash, watchgod:hash), to avoid juggling between 2 naming conventions we will be parsing some common variable names.

Interface

amount
blockNumber
data
from
network
rootToken
timestamp
to
txBurnHash
txHash
txStatus
txType
_txSource
_txType
_depositTxHash
_burnTxHash
_exitTxHash
_openapiExitTxStatus
_watchgodExitTxStatus
_openapiBurnTxStatus
_watchgodBurnTxStatus
_latestStatus

If required, to parse and unparse you can use the util methods provided by this library.

  • convertOpenapiToInterface(openapiTx)
  • convertWatchgodToInterface(watchgodTx)
  • (watchgodTx)

Usage

import {
  convertOpenapiToInterface,
  convertWatchgodToInterface,
  convertInterfaceToWatchgod,
} from "openapi-watchgod-merger";

const openapiTx = {
  /*...*/
};
const watchgodTx = {
  /*...*/
};

const parsedOpenapiTx = convertOpenapiToInterface(openapiTx);
const parsedWatchgodTx = convertWatchgodToInterface(openapiTx);

const unparsedWatchgodTx = convertInterfaceToWatchgod(parsedWatchgodTx);

Note: convertInterfaceToWatchgod will still have the additional fields added by library

OpenAPI mapping

| OpenAPI | Interface | | --------------------- | ------------ | | transactionHash | txHash | | transactionStatus | txStatus | | depositor | from | | isPos | isPoS | | burnTransactionHash | txBurnHash |

Watchgod mapping

| Watchgod | Interface | | -------------- | ------------ | | hash | txHash | | status | txStatus | | isPos | isPoS | | prevBurnHash | txBurnHash |

Other helpful constants

Constants can also be imported for use

  • TX_SOURCE can be used with _txSource
  • TX_TYPE can be used with _txType
import { TX_SOURCE, TX_TYPE } from "openapi-watchgod-merger";

const depositTxs = (mergedTransactions) =>
  mergedTransactions.filter((tx) => TX_TYPE.DEPOSIT === tx._txType);