@instadapp/interop-x 0.0.0-dev.dc4f10a → 0.0.0-dev.e69b5e8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instadapp/interop-x",
-  "version": "0.0.0-dev.dc4f10a",
+  "version": "0.0.0-dev.e69b5e8",
   "license": "MIT",
   "main": "dist/index.js",
   "engines": {
@@ -24,9 +24,10 @@
   },
   "dependencies": {
     "@achingbrain/libp2p-gossipsub": "^0.12.2",
+    "@fastify/cors": "^7.0.0",
+    "await-spawn": "^4.0.2",
     "axios": "^0.27.1",
     "axios-retry": "^3.2.4",
-    "bignumber.js": "^9.0.2",
     "chalk": "4.1.2",
     "dotenv": "^16.0.0",
     "ethereumjs-util": "^7.1.4",
@@ -34,7 +35,6 @@
     "ethers-multisend": "^2.1.1",
     "expand-home-dir": "^0.0.3",
     "fastify": "^3.28.0",
-    "fastify-cors": "^6.0.3",
     "libp2p": "^0.36.2",
     "libp2p-bootstrap": "^0.14.0",
     "libp2p-kad-dht": "^0.28.6",
@@ -46,6 +46,8 @@
     "libp2p-websockets": "^0.16.2",
     "luxon": "^2.3.2",
     "module-alias": "^2.2.2",
+    "patch-package": "^6.4.7",
+    "postinstall-postinstall": "^2.1.0",
     "sequelize": "6.18.0",
     "sqlite3": "^5.0.5",
     "waait": "^1.0.5"
@@ -60,8 +62,6 @@
     "@types/fs-extra": "^9.0.13",
     "@types/node": "^17.0.17",
     "nodemon": "^2.0.15",
-    "patch-package": "^6.4.7",
-    "postinstall-postinstall": "^2.1.0",
     "replace-in-file": "^6.3.2",
     "rimraf": "^3.0.2",
     "ts-node": "^10.5.0",

package/src/api/index.ts

@@ -1,5 +1,5 @@
 import fastify from "fastify"
-import cors from 'fastify-cors'
+import cors from '@fastify/cors'
 import Logger from "@/logger"
 import { Transaction } from "@/db";
 
@@ -27,7 +27,7 @@ export const startApiServer = async () => {
 
         logger.log(`RPC Server listening at http://${HOST}:${PORT}`)
     } catch (err) {
-        logger.error(err)
+        logger.error(err.message)
         process.exit(1)
     }
 }

package/src/config/index.ts

@@ -8,12 +8,14 @@ class Config {
     public readonly privateKey: string
     public readonly wallet: Wallet
     public readonly staging: boolean
+    public readonly autoUpdate: boolean
 
     constructor() {
         this.events = new EventBus()  as EventBusType
         this.maxPeers = 10
         this.privateKey = process.env.PRIVATE_KEY as string;
         this.staging = !! process.env.STAGING && process.env.STAGING === 'true';
+        this.autoUpdate = !! process.env.AUTO_UPDATE && process.env.AUTO_UPDATE === 'true';
         this.wallet = new Wallet(this.privateKey);
         this.leadNodeAddress = '0x910E413DBF3F6276Fe8213fF656726bDc142E08E'
     }

package/src/index.ts

@@ -16,8 +16,8 @@ moduleAlias.addAliases({
 })
 
 moduleAlias();
-import assert from "assert";
 import dotenv from "dotenv";
+import chalk from 'chalk';
 import { ethers } from "ethers";
 import packageJson from '../package.json'
 dotenv.config();
@@ -25,28 +25,46 @@ dotenv.config();
 import Logger from "@/logger";
 const logger = new Logger('Process')
 
-
-if (process.argv.at(-1) === 'help') {
+const printUsage = () => {
     console.log('Usage:')
     console.log('   PRIVATE_KEY=abcd1234 interop-x')
     console.log('   PRIVATE_KEY=abcd1234 STAGING=true interop-x')
+    console.log('   PRIVATE_KEY=abcd1234 AUTO_UPDATE=true interop-x')
+    console.log('   PRIVATE_KEY=abcd1234 API_HOST=0.0.0.0 API_PORT=8080 interop-x')
+}
+
+if (process.argv.at(-1) === 'help') {
+    printUsage()
     process.exit(0)
 }
 
-assert(process.env.PRIVATE_KEY, "PRIVATE_KEY is not defined");
+const GIT_SHORT_HASH = '@GIT_SHORT_HASH@';
 
+if (process.argv.at(-1) === 'version') {
+    console.log(`Interop X Node (v${packageJson.version} - rev.${GIT_SHORT_HASH})`)
+    process.exit(0)
+}
+
+if(! process.env.PRIVATE_KEY) {
+    console.error(chalk.bgRed.white.bold('Please provide a private key\n'))
+    printUsage()
+    process.exit(1)
+}
 try {
     new ethers.Wallet(process.env.PRIVATE_KEY!)
 } catch (e) {
-    logger.error('Invalid private key')
+    console.error(chalk.bgRed.white('Invalid private key\n'))
+    printUsage()
     process.exit(1)
 }
 
-logger.debug(`Starting Interop X Node (v${packageJson.version} - rev.@GIT_SHORT_HASH@)`)
+logger.debug(`Starting Interop X Node (v${packageJson.version} - rev.${GIT_SHORT_HASH})`)
 
 import { Tasks } from "@/tasks";
-import { startPeer } from "@/net";
+import { startPeer, protocol, peerPool } from "@/net";
 import { startApiServer } from '@/api';
+import { Transaction } from './db';
+import { shortenHash } from './utils';
 
 async function main() {
 
@@ -57,6 +75,37 @@ async function main() {
     tasks.start();
 
     startApiServer()
+
+    protocol.on('TransactionStatus', async (payload) => {
+        if (!peerPool.isLeadNode(payload.peerId)) {
+            const peer = peerPool.getPeer(payload.peerId)
+
+            if(! peer) {
+                return;
+            }
+            
+            logger.info(`ignored transaction status from ${payload.peerId} ${shortenHash(peer.publicAddress)} `)
+            return;
+        }
+
+        const transaction = await Transaction.findOne({ where: { transactionHash: payload.data.transactionHash } })
+
+        if (!transaction) {
+            return;
+        }
+
+        transaction.sourceStatus = payload.data.sourceStatus
+        transaction.sourceTransactionHash = payload.data.sourceTransactionHash
+        transaction.sourceErrors = payload.data.sourceErrors
+
+        transaction.targetStatus = payload.data.targetStatus
+        transaction.targetTransactionHash = payload.data.targetTransactionHash
+        transaction.targetErrors = payload.data.targetErrors
+
+        transaction.status = payload.data.status
+
+        await transaction.save()
+    })
 }
 
 main()

package/src/net/peer/index.ts

@@ -17,6 +17,7 @@ import KadDHT from "libp2p-kad-dht";
 import PubsubPeerDiscovery from "libp2p-pubsub-peer-discovery";
 import { protocol } from "@/net";
 import config from "@/config";
+import chalk from "chalk";
 
 const logger = new Logger("Peer");
 
@@ -80,7 +81,7 @@ export const startPeer = async ({ }: IPeerOptions) => {
     },
   });
 
-  logger.info("Peer ID:", node.peerId.toB58String());
+  logger.info("Peer ID:", chalk.bold(node.peerId.toB58String()));
 
   await node.start();
 

package/src/net/pool/index.ts

@@ -1,6 +1,9 @@
 import { Event } from "@/types";
 import config from "@/config";
 import Logger from "@/logger";
+import { getAddress } from "ethers/lib/utils";
+import { shortenHash } from "@/utils";
+import chalk from "chalk";
 
 
 const logger = new Logger('PeerPool')
@@ -83,10 +86,10 @@ export class PeerPool {
             const newPeer = !this.pool.get(peer.id);
             this.pool.set(peer.id, peer)
             peer.pooled = true
-           
-            if(newPeer) {
+
+            if (newPeer) {
                 config.events.emit(Event.POOL_PEER_ADDED, peer)
-                logger.info(`Peer ${peer.id} with address ${peer.publicAddress} added to pool`)
+                logger.info(`Peer ${chalk.bold(shortenHash(peer.id, 16))} with address ${chalk.bold(shortenHash(peer.publicAddress))} added to pool`)
             }
         }
     }
@@ -101,7 +104,7 @@ export class PeerPool {
             if (this.pool.delete(peer.id)) {
                 peer.pooled = false
                 config.events.emit(Event.POOL_PEER_REMOVED, peer)
-                logger.info(`Peer ${peer.id} with address ${peer.publicAddress} removed from pool`)
+                logger.info(`Peer ${chalk.bold(shortenHash(peer.id, 16))} with address ${chalk.bold(shortenHash(peer.publicAddress))} removed from pool`)
             }
         }
     }
@@ -110,7 +113,7 @@ export class PeerPool {
         this.cleanup()
 
         return this.peers.filter((p) => {
-            if(!p.pooled) return false;
+            if (!p.pooled) return false;
 
             const now = new Date()
 
@@ -122,6 +125,23 @@ export class PeerPool {
         return this.activePeers.map((p) => p.id)
     }
 
+    getPeer(id: string){
+     return this.pool.get(id);   
+    }
+
+    isLeadNode(id: string) {
+        const peer = this.pool.get(id);
+
+        if (!peer) {
+            return false;
+        }
+
+        return getAddress(peer.publicAddress) === getAddress(config.leadNodeAddress)
+    }
+
+    getLeadPeer() {
+        return this.peers.find((p) => this.isLeadNode(p.id))
+    }
 
     cleanup() {
         // let compDate = Date.now() - this.PEERS_CLEANUP_TIME_LIMIT * 60

package/src/net/protocol/dial/SignatureDialProtocol.1.ts

@@ -0,0 +1,31 @@
+import { BaseDialProtocol } from "./BaseDialProtocol";
+import { Transaction } from "@/db";
+
+export class TransactionStatusDialProtocol extends BaseDialProtocol<string, Pick<Transaction, 'transactionHash' | 'sourceStatus' | 'sourceTransactionHash' | 'sourceErrors' | 'targetStatus' | 'targetTransactionHash' | 'targetErrors' | 'status'> | null> {
+    protected timeout = 30000;
+
+    constructor(libp2p) {
+        super(libp2p, '/interop-x/transaction-status')
+    }
+
+    async response(transactionHash: string){
+        const transaction = await Transaction.findOne({ where: { transactionHash } })
+
+        if(! transaction){
+            return null
+        }
+        return {
+            transactionHash: transaction.transactionHash,
+
+            sourceStatus: transaction.sourceStatus,
+            sourceTransactionHash: transaction.sourceTransactionHash,
+            sourceErrors: transaction.sourceErrors,
+
+            targetStatus: transaction.targetStatus,
+            targetTransactionHash: transaction.targetTransactionHash,
+            targetErrors: transaction.targetErrors,
+
+            status: transaction.status,
+        }
+    }
+}

package/src/net/protocol/index.ts

@@ -5,6 +5,8 @@ import { SignatureDialProtocol, ISignatureRequest, ISignatureResponse } from "./
 import { IPeerInfo, peerPool } from "..";
 import config from "@/config";
 import { Event } from "@/types";
+import { Transaction } from "@/db";
+import { TransactionStatusDialProtocol } from "./dial/SignatureDialProtocol.1";
 
 export interface ProtocolOptions {
     /* Handshake timeout in ms (default: 8000) */
@@ -33,7 +35,12 @@ interface PeerInfoEvent extends BaseMessageEvent {
     data: Omit<IPeerInfo, 'id' | 'updated' | 'idle' | 'pooled'>
 }
 
+interface TransactionStatusEvent extends BaseMessageEvent {
+    data: Pick<Transaction, 'transactionHash' | 'sourceStatus' | 'sourceTransactionHash' | 'sourceErrors' | 'targetStatus' | 'targetTransactionHash' | 'targetErrors' | 'status'>
+}
+
 declare interface Protocol {
+    on(event: 'TransactionStatus', listener: (payload: TransactionStatusEvent) => void): this;
     on(event: 'PeerInfo', listener: (payload: PeerInfoEvent) => void): this;
     on(event: string, listener: (payload: BaseMessageEvent) => void): this;
 }
@@ -44,7 +51,7 @@ class Protocol extends EventEmitter {
     private protocolMessages: Message[] = [
         {
             name: 'PeerInfo',
-            code: 0x09,
+            code: 0x01,
             encode: (info: Pick<IPeerInfo, 'publicAddress'>) => [
                 Buffer.from(info.publicAddress),
             ],
@@ -52,8 +59,39 @@ class Protocol extends EventEmitter {
                 publicAddress: publicAddress.toString(),
             }),
         },
+        {
+            name: 'TransactionStatus',
+            code: 0x02,
+            encode: (transaction: Transaction) => [
+                Buffer.from(transaction.transactionHash),
+
+                Buffer.from(transaction.sourceStatus),
+                Buffer.from(transaction.sourceTransactionHash),
+                transaction.sourceErrors ? transaction.sourceErrors.map((e) => Buffer.from(e)) : [],
+
+                Buffer.from(transaction.targetStatus),
+                Buffer.from(transaction.targetTransactionHash),
+                transaction.targetErrors ? transaction.targetErrors.map((e) => Buffer.from(e)) : [],
+
+                Buffer.from(transaction.status),
+            ],
+            decode: ([transactionHash, sourceStatus, sourceTransactionHash, sourceErrors, targetStatus, targetTransactionHash, targetErrors, status]: [Buffer, Buffer, Buffer, Buffer[], Buffer, Buffer, Buffer[], Buffer]) => ({
+                transactionHash: transactionHash.toString(),
+
+                sourceStatus: sourceStatus.toString(),
+                sourceTransactionHash: sourceTransactionHash.toString(),
+                sourceErrors: sourceErrors.map((e) => e.toString()),
+
+                targetStatus: targetStatus.toString(),
+                targetTransactionHash: targetTransactionHash.toString(),
+                targetErrors: targetErrors.map((e) => e.toString()),
+
+                status: status.toString(),
+            }),
+        },
     ];
     private signature: SignatureDialProtocol;
+    private transactionStatus: TransactionStatusDialProtocol;
 
 
     start({ libp2p, topic = null, }) {
@@ -73,6 +111,7 @@ class Protocol extends EventEmitter {
         })
 
         this.signature = new SignatureDialProtocol(this.libp2p);
+        this.transactionStatus = new TransactionStatusDialProtocol(this.libp2p);
     }
 
 
@@ -121,6 +160,14 @@ class Protocol extends EventEmitter {
         this.libp2p.pubsub.publish(this.topic, encoded)
     }
 
+    public sendTransaction(transaction: Transaction) {
+        const message = this.protocolMessages.find((m) => m.name === 'TransactionStatus')!
+
+        const encoded = rlp.encode([message.code, message.encode(transaction)]);
+
+        this.libp2p.pubsub.publish(this.topic, encoded)
+    }
+
     async requestSignatures(data: ISignatureRequest, peerIds?: string[]) {
         try {
             peerIds = peerIds || peerPool.activePeerIds;
@@ -133,6 +180,15 @@ class Protocol extends EventEmitter {
             return []
         }
     }
+
+    async requestTransactionStatus(transactionHash: string, peerId: string) {
+        try {
+            return await this.transactionStatus.send(transactionHash, peerId);
+        } catch (error) {
+            console.log(error);
+            return null
+        }
+    }
 }
 
 export const protocol = new Protocol();

package/src/tasks/AutoUpdateTask.ts

@@ -0,0 +1,81 @@
+import { BaseTask } from "./BaseTask";
+import Logger from '@/logger';
+import { http } from "@/utils";
+import spawn from 'await-spawn';
+import config from "@/config";
+import wait from "waait";
+import packageJson from "../../package.json";
+
+const currentVersion = packageJson.version;
+
+class AutoUpdateTask extends BaseTask {
+    pollIntervalMs: number = 60 * 5 * 1000
+
+    constructor() {
+        super({
+            logger: new Logger("AutoUpdateTask"),
+        })
+    }
+
+    prePollHandler(): boolean {
+        return config.autoUpdate && !config.isLeadNode();
+    }
+
+    async getInstalledVersion() {
+        try {
+            const stdout = await spawn('npm', ['-g', 'ls', '--depth=0', '--json'])
+            return JSON.parse(stdout.toString()).dependencies[packageJson.name].version
+        } catch (error) {
+            this.logger.error(error)
+            
+            return currentVersion
+        }
+    }
+
+    async getLatestVersion() {
+        try {
+            const stdout = await spawn('npm', ['view', packageJson.name, 'version'])
+            return stdout.toString().trim()
+        } catch (error) {
+            this.logger.error(error)
+            
+            return currentVersion
+        }
+    }
+
+    async pollHandler() {
+        const version = await this.getLatestVersion()
+
+        if (version === currentVersion) {
+            return;
+        }
+
+        this.logger.warn(`New version ${version} available.`)
+
+
+        this.logger.info('Updating...')
+
+        const spawner = spawn('npm', ['-g', 'install', '@instadapp/interop-x@latest', '-f']);
+        spawner.child.on('data', console.log)
+        await spawner
+
+        await wait(5000)
+
+        if (version !== await this.getInstalledVersion()) {
+            this.logger.warn(`failed to install ${version}, retrying in 5 minutes`)
+            return;
+        }
+
+        this.logger.warn(`Installed version ${version}`)
+        this.logger.warn(`Restarting...`)
+
+        spawn(process.argv[0], process.argv.slice(1), {
+            cwd: process.cwd(),
+            stdio: "inherit"
+        });
+
+        process.exit()
+    }
+}
+
+export default AutoUpdateTask;

package/src/tasks/BaseTask.ts

@@ -19,6 +19,7 @@ export class BaseTask extends EventEmitter implements IBaseTask {
     started: boolean = false
     pollIntervalMs: number = 10 * 1000
     leadNodeOnly: boolean = false
+    exceptLeadNode: boolean = false
 
     public constructor({ logger }: { logger?: Logger }) {
         super()
@@ -45,11 +46,15 @@ export class BaseTask extends EventEmitter implements IBaseTask {
     }
 
     prePollHandler(): boolean {
-        if (!this.leadNodeOnly) {
-            return true
+        if (this.exceptLeadNode) {
+            return !config.isLeadNode();
         }
 
-        return config.isLeadNode()
+        if (this.leadNodeOnly) {
+            return config.isLeadNode()
+        }
+
+        return true
     }
 
     async pollHandler() {

package/src/tasks/InteropBridge/ProcessWithdrawEvents.ts

@@ -54,9 +54,7 @@ const generateGnosisTransaction = async (transactionData: any, safeContract: Gno
 }
 
 class ProcessWithdrawEvents extends BaseTask {
-    contractAddress: string;
     provider: ethers.providers.JsonRpcProvider;
-    contract: InteropXGateway;
     chainId: ChainId;
     leadNodeOnly = true
 
@@ -209,31 +207,23 @@ class ProcessWithdrawEvents extends BaseTask {
         if (parsedLogs.find(e => e.name === 'ExecutionSuccess')) {
             console.log('ExecutionSuccess')
             transaction.targetStatus = 'success'
+            transaction.targetTransactionHash = txSent.hash
             transaction.status = 'success'
             await transaction.save();
         } else {
             console.log('ExecutionFailure')
             transaction.targetStatus = 'failed'
+            transaction.targetTransactionHash = txSent.hash
             transaction.status = 'failed'
             await transaction.save();
         }
     }
 
     async start(): Promise<void> {
-        this.logger.info(`Starting execution watcher on interop chain`);
-
-        this.contractAddress = addresses[this.chainId].interopXGateway;
-
         this.provider = new ethers.providers.JsonRpcProvider(
             getRpcProviderUrl(this.chainId)
         );
 
-        this.contract = getContract<InteropXGateway>(
-            this.contractAddress,
-            abi.interopXGateway,
-            new ethers.Wallet(config.privateKey!, this.provider)
-        );
-
         await super.start()
     }
 }

package/src/tasks/InteropBridge/SyncWithdrawEvents.ts

@@ -102,8 +102,6 @@ class SyncWithdrawEvents extends BaseTask {
     }
 
     async start(): Promise<void> {
-        this.logger.info(`Starting execution watcher on interop chain`);
-
         this.provider = new ethers.providers.JsonRpcProvider(
             getRpcProviderUrl(this.chainId)
         );

package/src/tasks/InteropXGateway/ProcessDepositEvents.ts

@@ -209,19 +209,21 @@ class ProcessDepositEvents extends BaseTask {
         if (parsedLogs.find(e => e.name === 'ExecutionSuccess')) {
             console.log('ExecutionSuccess')
             transaction.targetStatus = 'success'
+            transaction.targetTransactionHash = txSent.hash
             transaction.status = 'success'
             await transaction.save();
         } else {
             console.log('ExecutionFailure')
             transaction.targetStatus = 'failed'
+            transaction.targetTransactionHash = txSent.hash
             transaction.status = 'failed'
             await transaction.save();
         }
+
+        protocol.sendTransaction(transaction)
     }
 
     async start(): Promise<void> {
-        this.logger.info(`Starting execution watcher on interop chain`);
-
         this.contractAddress = addresses[this.chainId].interopXGateway;
 
         this.provider = new ethers.providers.JsonRpcProvider(

package/src/tasks/InteropXGateway/SyncDepositEvents.ts

@@ -105,8 +105,6 @@ class SyncDepositEvents extends BaseTask {
     }
 
     async start(): Promise<void> {
-        this.logger.info(`Starting execution watcher on interop chain`);
-
         this.contractAddress = addresses[this.chainId].interopXGateway;
 
         this.provider = new ethers.providers.JsonRpcProvider(

package/src/tasks/Transactions/SyncTransactionStatusTask.ts

@@ -0,0 +1,65 @@
+import { BaseTask } from "../BaseTask";
+import Logger from '@/logger';
+import config from "@/config";
+import { peerPool, protocol } from "@/net";
+import { Transaction } from "@/db";
+import { Op } from "sequelize";
+
+class SyncTransactionStatusTask extends BaseTask {
+    pollIntervalMs: number = 60 * 1000
+    exceptLeadNode: boolean = true;
+
+    constructor() {
+        super({
+            logger: new Logger("SyncTransactionStatusTask"),
+        })
+    }
+    
+    async pollHandler() {
+        // if transaction is pending for more than 1 hour, check lead node for status
+        const leadNode = peerPool.getLeadPeer();
+
+        if (!leadNode) {
+            return;
+        }
+
+        const transaction = await Transaction.findOne({
+            where: {
+                status: 'pending',
+                sourceCreatedAt: {
+                    [Op.gte]: new Date(Date.now() - 60 * 60 * 1000),
+                },
+            }
+        })
+
+        if (!transaction) {
+            return;
+        }
+
+        this.logger.info(`Requesting transaction status for ${transaction.transactionHash}`)
+
+        const transactionStatus = await protocol.requestTransactionStatus(transaction.transactionHash, leadNode.id);
+
+        if (!transactionStatus) {
+            return;
+        }
+
+        this.logger.info(`Received transaction status for ${transaction.transactionHash}`)
+
+        transaction.sourceStatus = transactionStatus.sourceStatus
+        transaction.sourceTransactionHash = transactionStatus.sourceTransactionHash
+        transaction.sourceErrors = transactionStatus.sourceErrors
+
+        transaction.targetStatus = transactionStatus.targetStatus
+        transaction.targetTransactionHash = transactionStatus.targetTransactionHash
+        transaction.targetErrors = transactionStatus.targetErrors
+
+        transaction.status = transactionStatus.status
+
+        await transaction.save()
+
+        this.logger.info(`Updated transaction status for ${transaction.transactionHash}`)
+    }
+}
+
+export default SyncTransactionStatusTask;

package/src/tasks/index.ts

@@ -4,10 +4,15 @@ import InteropXGatewaySyncDepositEvents from "./InteropXGateway/SyncDepositEvent
 
 import InteropBridgeSyncWithdrawEvents from "./InteropBridge/SyncWithdrawEvents";
 import InteropBridgeProcessWithdrawEvents from "./InteropBridge/ProcessWithdrawEvents";
+import AutoUpdateTask from "./AutoUpdateTask";
+import SyncTransactionStatusTask from "./Transactions/SyncTransactionStatusTask";
 
 export class Tasks {
     
     tasks: BaseTask[] = [
+        new SyncTransactionStatusTask(),
+        new AutoUpdateTask(),
+
         new InteropXGatewaySyncDepositEvents({
             chainId: 43114
         }),