@instadapp/interop-x 0.0.0-dev.051cd4e

package/src/db/models/transaction.ts

@@ -0,0 +1,96 @@
+import { sequelize } from '@/db/sequelize'
+import { CreationOptional, InferAttributes, InferCreationAttributes, Model, DataTypes } from 'sequelize';
+
+export class Transaction extends Model<InferAttributes<Transaction>, InferCreationAttributes<Transaction>> {
+    declare id: CreationOptional<number>;
+
+    declare transactionHash: string;
+    declare action: string;
+    declare from: string;
+    declare to: string;
+
+    declare submitTransactionHash: string;
+    declare submitBlockNumber: number;
+
+    declare sourceChainId: number;
+    declare sourceTransactionHash: CreationOptional<string>;
+    declare sourceBlockNumber: CreationOptional<number>;
+    declare sourceStatus: string;
+    declare sourceErrors: CreationOptional<string[]>;
+    declare sourceCreatedAt: CreationOptional<Date>;
+    declare sourceDelayUntil: CreationOptional<Date>;
+
+    declare targetChainId: number;
+    declare targetTransactionHash: CreationOptional<string>;
+    declare targetBlockNumber: CreationOptional<number>;
+    declare targetStatus: string;
+    declare targetErrors: CreationOptional<string[]>;
+    declare targetCreatedAt: CreationOptional<Date>;
+    declare targetDelayUntil: CreationOptional<Date>;
+
+    declare submitEvent: any;
+    declare sourceEvent: CreationOptional<any>;
+    declare targetEvent: CreationOptional<any>;
+
+    declare metadata: CreationOptional<any>;
+
+    declare status: string;
+
+    declare createdAt: CreationOptional<Date>;
+    declare updatedAt: CreationOptional<Date>;
+}
+
+Transaction.init({
+    id: {
+        type: DataTypes.INTEGER,
+        autoIncrement: true,
+        primaryKey: true
+    },
+
+    submitTransactionHash: DataTypes.NUMBER,
+    submitBlockNumber: DataTypes.NUMBER,
+
+    transactionHash: DataTypes.STRING,
+    action: DataTypes.STRING,
+
+    from: DataTypes.STRING,
+    to: DataTypes.STRING,
+
+    sourceChainId: DataTypes.NUMBER,
+    sourceTransactionHash: DataTypes.STRING,
+    sourceBlockNumber: DataTypes.NUMBER,
+    sourceStatus: DataTypes.STRING,
+    sourceErrors: {
+        type: DataTypes.JSON,
+        // defaultValue: [],
+    },
+    sourceCreatedAt: {
+        type: DataTypes.DATE,
+        defaultValue: Date.now()
+    },
+    sourceDelayUntil: DataTypes.STRING,
+
+    targetChainId: DataTypes.NUMBER,
+    targetTransactionHash: DataTypes.STRING,
+    targetBlockNumber: DataTypes.NUMBER,
+    targetStatus: DataTypes.STRING,
+    targetErrors: {
+        type: DataTypes.JSON,
+        // defaultValue: [],
+    },
+    targetCreatedAt: DataTypes.DATE,
+    targetDelayUntil: DataTypes.DATE,
+
+    submitEvent: DataTypes.JSON,
+    sourceEvent: DataTypes.JSON,
+    targetEvent: DataTypes.JSON,
+
+    metadata: DataTypes.JSON,
+
+    status: {
+        type: DataTypes.STRING,
+        defaultValue: 'pending'
+    },
+    createdAt: DataTypes.DATE,
+    updatedAt: DataTypes.DATE,
+}, { sequelize, tableName: 'transactions' });

package/src/db/sequelize.ts

@@ -0,0 +1,22 @@
+//@ts-ignore
+import config from "@/config";
+import expandHomeDir from "expand-home-dir";
+
+import { Sequelize } from 'sequelize';
+
+const basePath = expandHomeDir(`~/.interop-x/data/${config.publicAddress}/${config.staging ? 'staging' : ''}`);
+
+export const sequelize = new Sequelize({
+    dialect: 'sqlite',
+    storage: `${basePath}/localDB.sqlite`,
+    // dialectModulePath: '@journeyapps/sqlcipher',
+    logging: false,
+});
+
+sequelize.sync({
+    alter: true
+}).then(() => {
+    //     sequelize.query('PRAGMA cipher_compatibility = 3');
+    //     sequelize.query("PRAGMA key = 'your-encryption-key'");
+})
+

package/src/index.ts

@@ -0,0 +1,123 @@
+import moduleAlias from 'module-alias';
+
+moduleAlias.addAliases({
+    "@/": __dirname + "/",
+    "@/logger": __dirname + "/logger",
+    "@/tasks": __dirname + "/tasks",
+    "@/utils": __dirname + "/utils",
+    "@/api": __dirname + "/api",
+    "@/net": __dirname + "/net",
+    "@/db": __dirname + "/db",
+    "@/config": __dirname + "/config",
+    "@/types": __dirname + "/types",
+    "@/abi": __dirname + "/abi",
+    "@/constants": __dirname + "/constants",
+    "@/typechain": __dirname + "/typechain"
+})
+
+moduleAlias();
+import dotenv from "dotenv";
+import chalk from 'chalk';
+import { ethers } from "ethers";
+import packageJson from '../package.json'
+dotenv.config();
+
+import Logger from "@/logger";
+const logger = new Logger('Process')
+
+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)
+}
+
+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) {
+    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})`)
+
+import { Tasks } from "@/tasks";
+import { startPeer, protocol, peerPool } from "@/net";
+import { startApiServer } from '@/api';
+import { Transaction } from './db';
+
+async function main() {
+
+    startPeer({})
+
+    const tasks = new Tasks()
+
+    tasks.start();
+
+    startApiServer()
+
+    protocol.on('TransactionStatus', async (payload) => {
+        if (!peerPool.isLeadNode(payload.peerId)) {
+            const peer = peerPool.getPeer(payload.peerId)
+            logger.info(`ignored transaction status from ${payload.peerId} ${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()
+    .then(() => {
+    }).catch(err => {
+        console.error(err);
+    });
+
+process.on('SIGINT', () => {
+    logger.debug('received SIGINT signal. exiting.')
+    process.exit(0)
+})
+
+process.on('SIGTERM', () => {
+    logger.debug('received SIGTERM signal. exiting.')
+    process.exit(0)
+})
+
+process.on('unhandledRejection', (reason: Error, p: Promise<any>) => {
+    logger.error('unhandled rejection: promise:', p, 'reason:', reason)
+})

package/src/logger/index.ts

@@ -0,0 +1,157 @@
+import chalk from 'chalk'
+import { DateTime } from 'luxon'
+
+export type Options = {
+    tag?: string
+    prefix?: string
+    color: string
+}
+
+type AdditionalDataLabel = {
+    id?: string
+    root?: string
+}
+
+export enum LogLevels {
+    Critical,
+    Error,
+    Warn,
+    Info,
+    Log,
+    Debug
+}
+
+const logLevelColors: { [key: string]: string } = {
+    [LogLevels.Critical]: 'red',
+    [LogLevels.Error]: 'red',
+    [LogLevels.Warn]: 'yellow',
+    [LogLevels.Info]: 'blue',
+    [LogLevels.Log]: 'white',
+    [LogLevels.Debug]: 'white'
+}
+
+let logLevel = LogLevels.Debug
+export const setLogLevel = (_logLevel: LogLevels | string) => {
+    if (typeof _logLevel === 'string') {
+        const mapping: { [key: string]: number } = {
+            error: LogLevels.Error,
+            warn: LogLevels.Warn,
+            info: LogLevels.Info,
+            debug: LogLevels.Debug
+        }
+        _logLevel = mapping[_logLevel]
+    }
+    logLevel = _logLevel
+}
+
+class Logger {
+    private readonly tag: string = ''
+    private readonly prefix: string = ''
+    private readonly options: any = {}
+    enabled: boolean = true
+
+    setEnabled(enabled: boolean) {
+        this.enabled = enabled
+    }
+
+    constructor(
+        tag: Partial<Options> | string = '',
+        opts: Partial<Options> = {
+            color: 'white'
+        }
+    ) {
+        if (tag instanceof Object) {
+            opts = tag
+            tag = opts.tag ?? ''
+        }
+        if (opts.prefix) {
+            this.prefix = `<${opts.prefix}>`
+        }
+        if (tag) {
+            if (opts.color) {
+                //@ts-ignore
+                this.tag = chalk[opts.color](`[${tag}]`)
+            } else {
+                this.tag = `[${tag}]`
+            }
+        }
+        if (process.env.DISABLE_LOGGER) {
+            this.enabled = false
+        }
+        this.options = opts
+    }
+
+    create(additionalDataLabel: AdditionalDataLabel): Logger {
+        let label: string
+        if (additionalDataLabel.id) {
+            label = `id: ${additionalDataLabel.id}`
+        } else {
+            label = `root: ${additionalDataLabel.root}`
+        }
+
+        return new Logger(
+            this.options.tag,
+            Object.assign({}, this.options, {
+                prefix: `${this.options.prefix ? `${this.options.prefix} ` : ''}${label}`
+            })
+        )
+    }
+
+    get timestamp(): string {
+        return DateTime.now().toISO()
+    }
+
+    headers(logLevelEnum: LogLevels): string[] {
+        const keys = Object.keys(LogLevels)
+        const logLevelName = keys[logLevelEnum + keys.length / 2].toUpperCase()
+        //@ts-ignore
+        const coloredLogLevel = chalk[logLevelColors[logLevelEnum]](
+            logLevelName.padEnd(5, ' ')
+        )
+        return [this.timestamp, coloredLogLevel, this.tag, this.prefix]
+    }
+
+    critical = (...input: any[]) => {
+        if (!this.enabled) return
+        console.error(...this.headers(LogLevels.Critical), ...input)
+    }
+
+    debug = (...input: any[]) => {
+        if (!this.enabled) return
+        if (logLevel !== LogLevels.Debug) {
+            return
+        }
+        console.debug(...this.headers(LogLevels.Debug), ...input)
+    }
+
+    error = (...input: any[]) => {
+        if (!this.enabled) return
+        console.error(...this.headers(LogLevels.Error), ...input)
+    }
+
+    info = (...input: any[]) => {
+        if (!this.enabled) return
+        if (!(logLevel === LogLevels.Debug || logLevel === LogLevels.Info)) {
+            return
+        }
+        console.info(...this.headers(LogLevels.Info), ...input)
+    }
+
+    log = (...input: any[]) => {
+        if (!this.enabled) return
+        if (logLevel < LogLevels.Info) {
+            return
+        }
+        console.log(...this.headers(LogLevels.Log), ...input)
+    }
+
+    warn = (...input: any[]) => {
+        if (!this.enabled) return
+        if (logLevel < LogLevels.Warn) {
+            return
+        }
+        console.warn(...this.headers(LogLevels.Warn), ...input)
+    }
+}
+
+export default Logger

package/src/net/index.ts

@@ -0,0 +1,3 @@
+export * from './peer';
+export * from './pool';
+export * from './protocol';

package/src/net/peer/index.ts

@@ -0,0 +1,120 @@
+import Libp2p from "libp2p";
+import TCP from "libp2p-tcp";
+//@ts-ignore
+import WS from "libp2p-websockets";
+//@ts-ignore
+import Mplex from "libp2p-mplex";
+import { NOISE } from "libp2p-noise";
+import Logger from "@/logger";
+import Bootstrap from "libp2p-bootstrap";
+import wait from "waait";
+import Gossipsub from "@achingbrain/libp2p-gossipsub";
+//@ts-ignore
+import MulticastDNS from "libp2p-mdns";
+//@ts-ignore
+import KadDHT from "libp2p-kad-dht";
+//@ts-ignore
+import PubsubPeerDiscovery from "libp2p-pubsub-peer-discovery";
+import { protocol } from "@/net";
+import config from "@/config";
+
+const logger = new Logger("Peer");
+
+let node: Libp2p;
+
+// Known peers addresses
+const bootstrapMultiaddrs = [
+  '/ip4/164.92.249.133/tcp/15001/ws/p2p/QmVGmkqRn8FEw4PQz83L8Mun24ALxXB2fEyS5aEfT2gGqz',
+  '/ip4/164.92.249.133/tcp/15000/p2p/QmVGmkqRn8FEw4PQz83L8Mun24ALxXB2fEyS5aEfT2gGqz',
+];
+
+interface IPeerOptions {
+}
+
+export const startPeer = async ({ }: IPeerOptions) => {
+  node = await Libp2p.create({
+    addresses: {
+      listen: ["/ip4/0.0.0.0/tcp/0", "/ip4/0.0.0.0/tcp/0/ws"],
+    },
+    modules: {
+      transport: [TCP, WS],
+      streamMuxer: [Mplex],
+      connEncryption: [NOISE],
+      peerDiscovery: [MulticastDNS, Bootstrap, PubsubPeerDiscovery],
+      pubsub: Gossipsub,
+      dht: KadDHT,
+    },
+
+    config: {
+      dht: {
+        enabled: true,
+      },
+      peerDiscovery: {
+        autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections)
+        // The `tag` property will be searched when creating the instance of your Peer Discovery service.
+        // The associated object, will be passed to the service when it is instantiated.
+        [Bootstrap.tag]: {
+          enabled: true,
+          interval: 60e3,
+          list: bootstrapMultiaddrs, // provide array of multiaddrs
+        },
+        [MulticastDNS.tag]: {
+          interval: 20e3,
+          enabled: true,
+        },
+        [PubsubPeerDiscovery.tag]: {
+          interval: 1000,
+          enabled: true,
+        },
+      },
+      relay: {
+        enabled: true,
+        autoRelay: {
+          enabled: true,
+          maxListeners: 10,
+        },
+      },
+    },
+    peerStore: {
+      persistence: true,
+    },
+  });
+
+  logger.info("Peer ID:", node.peerId.toB58String());
+
+  await node.start();
+
+  protocol.start({
+    libp2p: node
+  })
+
+  node.on("peer:discovery", (peer) => {
+    // logger.log(`Discovered peer ${peer}`)
+  }); // peer disc.
+
+  node.connectionManager.on("peer:connect", (connection) => {
+    // logger.log(`Connected to ${connection.remotePeer.toB58String()}`)
+  });
+
+  logger.log("Peer discovery started");
+
+  await wait(1000);
+
+
+  setInterval(() => protocol.sendPeerInfo({
+    publicAddress: config.wallet.address,
+  }), 5000)
+};
+
+export const stopPeer = async () => {
+  if (node) {
+    // stop libp2p
+    await node.stop();
+    logger.log("libp2p has stopped");
+  }
+
+  process.exit(0);
+};
+
+process.on("SIGTERM", stopPeer);
+process.on("SIGINT", stopPeer);

package/src/net/pool/index.ts

@@ -0,0 +1,154 @@
+import { Event } from "@/types";
+import config from "@/config";
+import Logger from "@/logger";
+import { getAddress } from "ethers/lib/utils";
+
+
+const logger = new Logger('PeerPool')
+
+export interface IPeerInfo {
+    id: string;
+    publicAddress: string;
+    pooled: boolean;
+    updated: Date;
+}
+
+export class PeerPool {
+    public PEERS_CLEANUP_TIME_LIMIT = 1
+    private pool: Map<string, IPeerInfo>
+
+
+    constructor() {
+        this.pool = new Map<string, IPeerInfo>()
+
+        config.events.on(Event.PEER_CONNECTED, (peer) => {
+            this.connected(peer)
+        })
+
+        config.events.on(Event.PEER_DISCONNECTED, (peer) => {
+            this.disconnected(peer)
+        })
+    }
+
+
+    /**
+     * Connected peers
+     */
+    get peers(): IPeerInfo[] {
+        const connectedPeers: IPeerInfo[] = Array.from(this.pool.values())
+        return connectedPeers
+    }
+
+    /**
+     * Number of peers in pool
+     */
+    get size() {
+        return this.peers.length
+    }
+
+    /**
+     * Return true if pool contains the specified peer
+     * @param peer peer object or id
+     */
+    contains(peer: IPeerInfo | string): boolean {
+        if (typeof peer !== 'string') {
+            peer = peer.id
+        }
+        return !!this.pool.get(peer)
+    }
+
+    /**
+     * Handler for peer connections
+     * @param peer peer
+     */
+    private connected(peer: IPeerInfo) {
+        if (this.size >= config.maxPeers) return
+        this.add(peer)
+    }
+
+    /**
+     * Handler for peer disconnections
+     * @param peer peer
+     */
+    private disconnected(peer: IPeerInfo) {
+        this.remove(peer)
+    }
+
+    /**
+     * Add peer to pool
+     * @param peer peer
+     * @emits {@link Event.POOL_PEER_ADDED}
+     */
+    add(peer?: IPeerInfo) {
+        if (peer && peer.id) {
+            const newPeer = !this.pool.get(peer.id);
+            this.pool.set(peer.id, peer)
+            peer.pooled = true
+
+            if (newPeer) {
+                config.events.emit(Event.POOL_PEER_ADDED, peer)
+                logger.info(`Peer ${peer.id} with address ${peer.publicAddress} added to pool`)
+            }
+        }
+    }
+
+    /**
+     * Remove peer from pool
+     * @param peer peer
+     * @emits {@link Event.POOL_PEER_REMOVED}
+     */
+    remove(peer?: IPeerInfo) {
+        if (peer && peer.id) {
+            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`)
+            }
+        }
+    }
+
+    get activePeers() {
+        this.cleanup()
+
+        return this.peers.filter((p) => {
+            if (!p.pooled) return false;
+
+            const now = new Date()
+
+            return (now.getTime() - p.updated.getTime()) < 1000 * 10 // 10 seconds
+        })
+    }
+
+    get activePeerIds() {
+        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)
+    }
+
+
+    cleanup() {
+        // let compDate = Date.now() - this.PEERS_CLEANUP_TIME_LIMIT * 60
+
+        // this.peers.forEach((peerInfo) => {
+        //     if (peerInfo.updated.getTime() < compDate) {
+        //         console.log(`Peer ${peerInfo.id} idle for ${this.PEERS_CLEANUP_TIME_LIMIT} minutes`)
+        //         this.remove(peerInfo)
+        //     }
+        // })
+    }
+}
+
+export const peerPool = new PeerPool()