@instadapp/interop-x 0.0.0-dev.9b1fcb8 → 0.0.0-dev.9e91661

package/src/gnosis/index.ts

@@ -0,0 +1,13 @@
+import { Transaction } from "@/db";
+import { encodeMulti } from "ethers-multisend";
+import actions from "./actions";
+
+export const buildGnosisData = async (transaction: Transaction, type?: 'source' | 'target') => {
+    type = type || transaction.sourceStatus === 'pending' ? 'source' : 'target';
+
+    if (actions.hasOwnProperty(transaction.action)) {
+        return encodeMulti(actions[transaction.action](transaction, type)).data;
+    }
+
+    throw new Error(`Unknown action: ${transaction.action}`);
+}

package/src/index.ts

@@ -1,5 +1,6 @@
 import moduleAlias from 'module-alias';
-
+import expandHomeDir from "expand-home-dir";
+import fs from 'fs-extra'
 moduleAlias.addAliases({
     "@/": __dirname + "/",
     "@/logger": __dirname + "/logger",
@@ -16,8 +17,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 +26,77 @@ dotenv.config();
 import Logger from "@/logger";
 const logger = new Logger('Process')
 
+const GIT_SHORT_HASH = '@GIT_SHORT_HASH@';
+
+const printUsage = () => {
+    console.log()
+    console.log(`Interop X Node (v${packageJson.version} - rev.${GIT_SHORT_HASH})`)
+    console.log()
 
-if (process.argv.at(-1) === 'help') {
     console.log('Usage:')
-    console.log('   PRIVATE_KEY=abcd1234 interop-x')
-    console.log('   PRIVATE_KEY=abcd1234 STAGING=true interop-x')
+    console.log('   interop-x help                                                              Show this message')
+    console.log('   interop-x version                                                           Print out the installed version of Interop X')
+
+    console.log()
+
+    console.log('   interop-x down                                                              Put the node into maintenance mode')
+    console.log('   interop-x up                                                                Take the node out of maintenance mode')
+
+    console.log()
+
+    console.log('   PRIVATE_KEY=abcd1234 interop-x                                              Start the node with the given private key')
+    console.log('   PRIVATE_KEY=abcd1234 STAGING=true interop-x                                 Start the node in staging mode')
+    console.log('   PRIVATE_KEY=abcd1234 AUTO_UPDATE=true interop-x                             Start the node in auto update mode')
+    console.log('   PRIVATE_KEY=abcd1234 API_HOST=0.0.0.0 API_PORT=8080 interop-x               Start the node with custom API host and port')
+    console.log()
+
+}
+
+if (process.argv.at(-1) === 'help') {
+    printUsage()
+    process.exit(0)
+}
+
+const basePath = expandHomeDir(`~/.interop-x`);
+
+if (process.argv.at(-1) === 'down') {
+    fs.outputFileSync(basePath + '/maintenance', Date.now().toString())
+    console.log(chalk.red('Maintenance mode enabled'))
+    process.exit(0)
+}
+
+if (process.argv.at(-1) === 'up') {
+    fs.removeSync(basePath + '/maintenance')
+    console.log(chalk.green('Maintenance mode disabled'))
     process.exit(0)
 }
 
-assert(process.env.PRIVATE_KEY, "PRIVATE_KEY is not defined");
 
+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 +107,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.ts

@@ -2,9 +2,10 @@ import { BaseDialProtocol } from "./BaseDialProtocol";
 import wait from "waait";
 import config from "@/config";
 import { Transaction } from "@/db";
-import { buildDataForTransaction, signGnosisSafeTx } from "@/utils";
+import { signGnosisSafeTx } from "@/utils";
 import { addresses } from "@/constants";
 import { ChainId } from "@/types";
+import { buildGnosisData } from "@/gnosis";
 
 export interface ISignatureRequest {
     type: 'source' | 'target' ,
@@ -47,17 +48,9 @@ export class SignatureDialProtocol extends BaseDialProtocol<ISignatureRequest, I
             };
         }
 
-        console.log("signing:", {
-            to: addresses[transaction.targetChainId].multisend,
-            data: await buildDataForTransaction(transaction, data.type),
-            chainId: transaction.targetChainId as ChainId,
-            safeTxGas: data.safeTxGas,
-            nonce: data.safeNonce,
-        });
-
         const signedData = await signGnosisSafeTx({
             to: addresses[transaction.targetChainId].multisend,
-            data: await buildDataForTransaction(transaction, data.type),
+            data: await buildGnosisData(transaction, data.type),
             chainId: transaction.targetChainId as ChainId,
             safeTxGas: data.safeTxGas,
             nonce: data.safeNonce,

package/src/net/protocol/dial/TransactionStatusDialProtocol.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/TransactionStatusDialProtocol";
 
 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() || null,
+                sourceErrors: sourceErrors.map((e) => e.toString()),
+
+                targetStatus: targetStatus.toString(),
+                targetTransactionHash: targetTransactionHash.toString()|| null,
+                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,82 @@
+import { BaseTask } from "./BaseTask";
+import Logger from '@/logger';
+import spawnAsync from 'await-spawn';
+import { spawn } from 'child_process'
+import config from "@/config";
+import wait from "waait";
+import packageJson from "../../package.json";
+
+const currentVersion = packageJson.version;
+const tag = config.staging ? 'dev' : 'latest';
+
+class AutoUpdateTask extends BaseTask {
+    pollIntervalMs: number = 60 * 10 * 1000
+
+    constructor() {
+        super({
+            logger: new Logger("AutoUpdateTask"),
+        })
+    }
+
+    prePollHandler(): boolean {
+        return config.autoUpdate && !config.isLeadNode();
+    }
+
+    async getInstalledVersion() {
+        try {
+            const stdout = await spawnAsync('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 spawnAsync('npm', ['view', `${packageJson.name}@${tag}`, '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...')
+
+        await spawnAsync('npm', ['-g', 'install', `@instadapp/interop-x@${tag}`, '-f']);
+
+        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...`)
+
+
+        // TODO: its restarting in the bg, but it should be in the fg
+        const subprocess = spawn(process.argv[0], process.argv.slice(1), {
+            cwd: process.cwd(),
+            stdio: "inherit",
+            // shell: process.env.SHELL, 
+        });
+
+        subprocess.unref();
+
+        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,20 @@ export class BaseTask extends EventEmitter implements IBaseTask {
     }
 
     prePollHandler(): boolean {
-        if (!this.leadNodeOnly) {
-            return true
+        if(config.isMaintenanceMode()){
+            this.logger.warn('Maintenance mode is enabled. Skipping task.')
+            return false
         }
 
-        return config.isLeadNode()
+        if (this.exceptLeadNode) {
+            return !config.isLeadNode();
+        }
+
+        if (this.leadNodeOnly) {
+            return config.isLeadNode()
+        }
+
+        return true
     }
 
     async pollHandler() {