@instadapp/interop-x 0.0.0-dev.0134f74

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

@@ -0,0 +1,70 @@
+import { BaseDialProtocol } from "./BaseDialProtocol";
+import wait from "waait";
+import config from "@/config";
+import { Transaction } from "@/db";
+import { signGnosisSafeTx } from "@/utils";
+import { addresses } from "@/constants";
+import { ChainId } from "@/types";
+import { buildGnosisAction } from "@/gnosis";
+
+export interface ISignatureRequest {
+    type: 'source' | 'target',
+    transactionHash: string
+    safeTxGas: string
+    safeNonce: string
+    chainId: number
+}
+export interface ISignatureResponse {
+    signer: string,
+    data?: string | null,
+    error?: string | null,
+}
+export class SignatureDialProtocol extends BaseDialProtocol<ISignatureRequest, ISignatureResponse> {
+    protected timeout = 30000;
+
+    constructor(libp2p) {
+        super(libp2p, '/interop-x/signatures')
+    }
+
+    async response(data: ISignatureRequest): Promise<ISignatureResponse> {
+        console.log({
+            tag: 'SignatureDialProtocol',
+            data
+        })
+        const signer = config.wallet;
+
+        let transaction: Transaction | null;
+        let maxTimeout = 20000;
+
+        do {
+            transaction = await Transaction.findOne({ where: { transactionHash: data.transactionHash } })
+
+            if (!transaction) {
+                await wait(1000);
+                maxTimeout -= 1000;
+            }
+        } while (!transaction && maxTimeout > 0)
+
+        if (!transaction) {
+            return {
+                signer: signer.address,
+                data: null,
+                error: 'Event not found'
+            };
+        }
+        const { data: gnosisData } = await buildGnosisAction(transaction, data.type);
+
+        const signedData = await signGnosisSafeTx({
+            to: addresses[data.chainId].multisend,
+            data: gnosisData,
+            chainId: data.chainId as ChainId,
+            safeTxGas: data.safeTxGas,
+            nonce: data.safeNonce,
+        }, { signer });
+
+        return {
+            signer: signer.address,
+            data: signedData
+        }
+    }
+}

package/src/net/protocol/dial/TransactionStatusDialProtocol.ts

@@ -0,0 +1,33 @@
+import { BaseDialProtocol } from "./BaseDialProtocol";
+import { Transaction } from "@/db";
+
+export class TransactionStatusDialProtocol extends BaseDialProtocol<string, Pick<Transaction, 'transactionHash' | 'sourceStatus' | 'sourceTransactionHash' | 'sourceErrors' | 'sourceLogs'  | 'targetStatus' | 'targetTransactionHash' | 'targetErrors' | 'targetLogs' | '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,
+            sourceLogs: transaction.sourceLogs,
+
+            targetStatus: transaction.targetStatus,
+            targetTransactionHash: transaction.targetTransactionHash,
+            targetErrors: transaction.targetErrors,
+            targetLogs: transaction.targetLogs,
+
+            status: transaction.status,
+        }
+    }
+}

package/src/net/protocol/index.ts

@@ -0,0 +1,204 @@
+import { EventEmitter } from "stream";
+import Libp2p from 'libp2p';
+import { bufferToInt, rlp } from 'ethereumjs-util'
+import { SignatureDialProtocol, ISignatureRequest, ISignatureResponse } from "./dial/SignatureDialProtocol";
+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) */
+    timeout?: number
+}
+
+
+export type Message = {
+    name: string
+    code: number
+    payload?: any
+    response?: number
+    encode: Function
+    decode: Function
+}
+
+interface BaseMessageEvent {
+    peerId: string
+    name: string
+    code: number
+    data: any
+}
+
+
+interface PeerInfoEvent extends BaseMessageEvent {
+    data: Omit<IPeerInfo, 'id' | 'updated' | 'idle' | 'pooled'>
+}
+
+interface TransactionStatusEvent extends BaseMessageEvent {
+    data: Pick<Transaction, 'transactionHash' | 'sourceStatus' | 'sourceTransactionHash' | 'sourceErrors' | 'sourceLogs' | 'targetStatus' | 'targetTransactionHash' | 'targetErrors' | 'targetLogs' | '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;
+}
+
+class Protocol extends EventEmitter {
+    private libp2p: Libp2p;
+    private topic: string;
+    private protocolMessages: Message[] = [
+        {
+            name: 'PeerInfo',
+            code: 0x01,
+            encode: (info: Pick<IPeerInfo, 'publicAddress'>) => [
+                Buffer.from(info.publicAddress),
+            ],
+            decode: ([publicAddress]: [Buffer]) => ({
+                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)) : [],
+                transaction.sourceLogs ? transaction.sourceLogs.map((e) => [Buffer.from(e.type), Buffer.from(e.message)]) : [],
+
+                Buffer.from(transaction.targetStatus),
+                Buffer.from(transaction.targetTransactionHash || ''),
+                transaction.targetErrors ? transaction.targetErrors.map((e) => Buffer.from(e)) : [],
+                transaction.targetLogs ? transaction.targetLogs.map((e) => [Buffer.from(e.type), Buffer.from(e.message)]) : [],
+
+                Buffer.from(transaction.status),
+            ],
+            decode: ([transactionHash, sourceStatus, sourceTransactionHash, sourceErrors, sourceLogs, targetStatus, targetTransactionHash, targetErrors, targetLogs, status]: [Buffer, Buffer, Buffer, Buffer[],[Buffer,Buffer][], Buffer, Buffer, Buffer[],[Buffer,Buffer][], Buffer]) => ({
+                transactionHash: transactionHash.toString(),
+
+                sourceStatus: sourceStatus.toString(),
+                sourceTransactionHash: sourceTransactionHash.toString() || null,
+                sourceErrors: sourceErrors.map((e) => e.toString()),
+                sourceLogs: sourceLogs.map(e => ({
+                    type: e[0].toString(),
+                    message: e[1].toString(),
+                })),
+
+                targetStatus: targetStatus.toString(),
+                targetTransactionHash: targetTransactionHash.toString() || null,
+                targetErrors: targetErrors.map((e) => e.toString()),
+                targetLogs: targetLogs.map(e => ({
+                    type: e[0].toString(),
+                    message: e[1].toString(),
+                })),
+
+                status: status.toString(),
+            }),
+        },
+    ];
+    private signature: SignatureDialProtocol;
+    private transactionStatus: TransactionStatusDialProtocol;
+
+
+    start({ libp2p, topic = null, }) {
+        this.libp2p = libp2p
+        this.topic = topic || 'itnerop-x-protocol'
+
+        if (this.libp2p.isStarted()) this.init()
+
+        this.on('PeerInfo', (payload) => {
+
+            config.events.emit(Event.PEER_CONNECTED, {
+                id: payload.peerId,
+                publicAddress: payload.data.publicAddress,
+                pooled: false,
+                updated: new Date(),
+            })
+        })
+
+        this.signature = new SignatureDialProtocol(this.libp2p);
+        this.transactionStatus = new TransactionStatusDialProtocol(this.libp2p);
+    }
+
+
+    init() {
+        this.libp2p.pubsub.subscribe(this.topic)
+
+        this.libp2p.pubsub.on(this.topic, (message) => {
+            try {
+                const [codeBuf, payload]: any = rlp.decode(message.data);
+
+                const code = bufferToInt(codeBuf);
+
+                const protocolMessage = this.protocolMessages.find((m) => m.code === code);
+                if (!protocolMessage) {
+                    return;
+                }
+                const decoded = protocolMessage.decode(payload);
+                this.emit(
+                    protocolMessage.name,
+                    {
+                        peerId: message.from,
+                        name: protocolMessage.name,
+                        code: protocolMessage.code,
+                        data: decoded
+                    }
+                )
+
+                this.emit('all', {
+                    peerId: message.from,
+                    name: protocolMessage.name,
+                    code: protocolMessage.code,
+                    data: decoded,
+                })
+            } catch (err) {
+                console.error(err)
+            }
+        })
+    }
+
+
+    public sendPeerInfo(data: Pick<IPeerInfo, 'publicAddress'>) {
+        const message = this.protocolMessages.find((m) => m.name === 'PeerInfo')!
+
+        const encoded = rlp.encode([message.code, message.encode(data)]);
+
+        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;
+            const promises = peerIds.map((peerId) => this.signature.send(data, peerId))
+            return (await Promise.allSettled(promises))
+                .map((p) => p.status === 'fulfilled' ? p.value : null)
+                .filter(Boolean) as ISignatureResponse[]
+        } catch (error) {
+            console.log(error);
+            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

@@ -0,0 +1,85 @@
+import config from "@/config";
+import EventEmitter from "events";
+import wait from "waait";
+import Logger from "@/logger";
+
+export interface IBaseTask {
+    pollCheck(): Promise<void>
+    prePollHandler(): boolean
+    pollHandler(): Promise<void>
+    postPollHandler(): Promise<void>
+
+    start(): Promise<void>
+    stop(): Promise<void>
+}
+
+
+export class BaseTask extends EventEmitter implements IBaseTask {
+    logger: Logger
+    started: boolean = false
+    pollIntervalMs: number = 10 * 1000
+    leadNodeOnly: boolean = false
+    exceptLeadNode: boolean = false
+
+    public constructor({ logger }: { logger?: Logger }) {
+        super()
+
+        this.logger = logger ?? new Logger('BaseTask')
+    }
+
+    async pollCheck() {
+        while (true) {
+            if (!this.started) {
+                return
+            }
+            try {
+                const shouldPoll = this.prePollHandler()
+                if (shouldPoll) {
+                    await this.pollHandler()
+                }
+            } catch (err) {
+                this.logger.error(`poll check error:\n${err.message}\ntrace: ${err.stack}`)
+            }
+
+            await this.postPollHandler()
+        }
+    }
+
+    prePollHandler(): boolean {
+        if(config.isMaintenanceMode()){
+            this.logger.warn('Maintenance mode is enabled. Skipping task.')
+            return false
+        }
+
+        if (this.exceptLeadNode) {
+            return !config.isLeadNode();
+        }
+
+        if (this.leadNodeOnly) {
+            return config.isLeadNode()
+        }
+
+        return true
+    }
+
+    async pollHandler() {
+        this.logger.warn('pollHandler not implemented')
+    }
+
+    async postPollHandler() {
+        await wait(this.pollIntervalMs)
+    }
+
+    async start() {
+        this.started = true
+        try {
+            await this.pollCheck()
+        } catch (err) {
+            this.logger.error(`base task error: ${err.message}\ntrace: ${err.stack}`)
+        }
+    }
+
+    async stop() {
+        this.started = false
+    }
+}