Merge pull request #31 from syscoin/sponsor-wallet-implementation

Move transaction submission on UI side
Fix NEVM Freeze and burn issue

Author: osiastedian

.github/workflows/aws.yml

@@ -6,6 +6,7 @@ on:
   push:
     branches:
       - main
+      - sponsor-wallet-implementation
 
 env:
   AWS_REGION: us-east-1                   # set this to your preferred AWS region, e.g. us-west-1

api/services/sponsor-wallet.ts

@@ -1,7 +1,8 @@
+import { DEFAULT_GAS_LIMIT } from "@constants";
 import SponsorWallet, { ISponsorWallet } from "models/sponsor-wallet";
 import SponsorWalletTransactions, {
   ISponsorWalletTransaction,
-  SponsorWalletTransactionStatus,
+  SponsorWalletTransactionCollectionName,
 } from "models/sponsor-wallet-transactions";
 import web3 from "utils/get-web3";
 import { TransactionConfig } from "web3-core";
@@ -44,12 +45,20 @@ export class SponsorWalletService {
       return existingTransaction;
     }
 
-    const nonce = await this.getWalletNextNonce(wallet.id);
+    const nonce = await this.getWalletNextNonce(wallet._id);
 
     const sender = web3.eth.accounts.privateKeyToAccount(wallet.privateKey);
 
+    const gasPrice = await web3.eth.getGasPrice();
+    const gas = await web3.eth.estimateGas(transactionConfig).catch((e) => {
+      console.error("estimateGas error", e);
+      return DEFAULT_GAS_LIMIT;
+    });
+
     const signedTransaction = await sender.signTransaction({
       ...transactionConfig,
+      gasPrice: web3.utils.toHex(gasPrice),
+      gas: web3.utils.toHex(gas),
       nonce,
     });
 
@@ -62,27 +71,15 @@ export class SponsorWalletService {
 
     let walletTransaction = new SponsorWalletTransactions({
       transferId: transferId,
-      walletId: wallet.id,
-      transactionHash: signedTransaction.transactionHash,
+      walletId: wallet._id,
+      transaction: {
+        hash: signedTransaction.transactionHash,
+        rawData: signedTransaction.rawTransaction,
+        nonce: nonce,
+      },
       status: "pending",
     });
 
-    walletTransaction = await walletTransaction.save();
-
-    let receipt = await web3.eth
-      .getTransactionReceipt(signedTransaction.transactionHash)
-      .catch(() => undefined);
-    let status: SponsorWalletTransactionStatus = "success";
-
-    if (!receipt) {
-      receipt = await web3.eth.sendSignedTransaction(
-        signedTransaction.rawTransaction
-      );
-      status = "pending";
-    }
-
-    walletTransaction.status = status;
-
     return walletTransaction.save();
   }
 
@@ -101,31 +98,32 @@ export class SponsorWalletService {
     }
 
     transaction.status = receipt.status ? "success" : "failed";
+    transaction.transaction.confirmedHash = receipt.transactionHash;
     await transaction.save();
   }
 
   private async getWalletNextNonce(walletId: string): Promise<number> {
-    const wallet = await SponsorWallet.findOne({ id: walletId });
+    const wallet = await SponsorWallet.findById(walletId);
     if (!wallet) {
       throw new Error("Wallet not found");
     }
-    const lastTransaction = await SponsorWalletTransactions.findOne({
+    const [lastTransaction] = await SponsorWalletTransactions.find({
       walletId: wallet?.id,
-    }).sort({ createdAt: -1 });
-
-    if (!lastTransaction) {
-      const nonce = await web3.eth.getTransactionCount(
-        wallet.address,
-        "pending"
-      );
-      return nonce;
-    }
+    }).sort({ "transaction.nonce": -1 }).limit(1);
 
-    const transaction = await web3.eth.getTransaction(
-      lastTransaction.transactionHash
+    const pendingNonce = await web3.eth.getTransactionCount(
+      wallet.address,
+      "pending"
     );
 
-    return transaction.nonce + 1;
+    console.log("pendingNonce", pendingNonce);
+    console.log("lastTransaction nonce", lastTransaction?.transaction.nonce);
+
+    const internalNonce = lastTransaction
+      ? lastTransaction.transaction.nonce
+      : -1;
+
+    return pendingNonce > internalNonce ? pendingNonce : internalNonce + 1;
   }
 
   private async getAvailableWalletForSigning(): Promise<ISponsorWallet> {
@@ -146,7 +144,7 @@ export class SponsorWalletService {
     return SponsorWallet.aggregate([
       {
         $lookup: {
-          from: "sponsorwallettransactions",
+          from: SponsorWalletTransactionCollectionName,
           localField: "_id",
           foreignField: "walletId",
           as: "transactions",
@@ -166,7 +164,7 @@ export class SponsorWalletService {
     return SponsorWallet.aggregate([
       {
         $lookup: {
-          from: "sponsorwallettransactions",
+          from: SponsorWalletTransactionCollectionName,
           localField: "_id",
           foreignField: "walletId",
           as: "transactions",

api/services/transfer.ts

@@ -40,7 +40,7 @@ export class TransferService {
     }, [] as Record<string, string>[]);
     return TransferModel.find({
       $or: queryConstraints,
-    });
+    }).sort({ createdAt: -1 }) as unknown as ITransfer[];
   }
 
   async getTransfer(id: string): Promise<ITransfer> {

components/Bridge/v3/Steps/ConfirmNEVMTransaction.tsx

@@ -1,10 +1,10 @@
 import { ITransferLog, TransferStatus } from "@contexts/Transfer/types";
 import { useTransfer } from "../context/TransferContext";
-import { useWeb3 } from "../context/Web";
 import { Alert, CircularProgress, Link, Typography } from "@mui/material";
 import { useNevmTransaction } from "../hooks/useNevmTransaction";
 import { useEffect } from "react";
 import { NEVM_TX_BLOCKCHAIN_URL } from "@constants";
+import NEVMStepWrapper from "../NEVMStepWrapepr";
 
 type Props = {
   successStatus: TransferStatus;
@@ -70,4 +70,10 @@ const BridgeV3ConfirmNEVMTransaction: React.FC<Props> = ({
   );
 };
 
-export default BridgeV3ConfirmNEVMTransaction;
+const Wrapped: React.FC<Props> = (props) => (
+  <NEVMStepWrapper>
+    <BridgeV3ConfirmNEVMTransaction {...props} />
+  </NEVMStepWrapper>
+);
+
+export default Wrapped;

components/Bridge/v3/Steps/ConfirmUTXOTransaction.tsx

@@ -2,8 +2,9 @@ import { Alert, Box, CircularProgress, Link } from "@mui/material";
 import { useTransfer } from "../context/TransferContext";
 import { useUtxoTransaction } from "components/Bridge/v3/hooks/useUtxoTransaction";
 import { ITransferLog, TransferStatus } from "@contexts/Transfer/types";
-import { useEffect } from "react";
+import React, { useEffect } from "react";
 import { SYSCOIN_TX_BLOCKCHAIN_URL } from "@constants";
+import UTXOStepWrapper from "../UTXOStepWrapper";
 
 type Props = {
   invalidStateMessage: string;
@@ -76,4 +77,10 @@ const BridgeV3StepConfirmUTXOTransaction: React.FC<Props> = ({
   );
 };
 
-export default BridgeV3StepConfirmUTXOTransaction;
+const Wrapped: React.FC<Props> = (props) => (
+  <UTXOStepWrapper>
+    <BridgeV3StepConfirmUTXOTransaction {...props} />
+  </UTXOStepWrapper>
+);
+
+export default Wrapped;

components/Bridge/v3/hooks/useFreezeAndBurn.ts

@@ -4,6 +4,7 @@ import { useMutation } from "react-query";
 import { SYSX_ASSET_GUID } from "@contexts/Transfer/constants";
 import { toWei } from "web3-utils";
 import { useErc20ManagerContract } from "./useErc20ManagerContract";
+import { DEFAULT_GAS_LIMIT } from "@constants";
 
 export const useFreezeAndBurn = (transfer: ITransfer) => {
   const erc20ManagerContract = useErc20ManagerContract();
@@ -21,6 +22,7 @@ export const useFreezeAndBurn = (transfer: ITransfer) => {
 
       const gas = await method.estimateGas().catch((error: Error) => {
         console.error("Estimate gas error", error);
+        return DEFAULT_GAS_LIMIT
       });
 
       return new Promise<string>((resolve, reject) => {

components/Bridge/v3/hooks/useSyscoinSubmitProofs.tsx

@@ -2,6 +2,7 @@ import { ITransfer } from "@contexts/Transfer/types";
 import { useMutation } from "react-query";
 import { useWeb3 } from "../context/Web";
 import { ISponsorWalletTransaction } from "models/sponsor-wallet-transactions";
+import { rejects } from "assert";
 
 const useSyscoinSubmitProofs = (
   transfer: ITransfer,
@@ -11,7 +12,7 @@ const useSyscoinSubmitProofs = (
   return useMutation(
     ["syscoin-submit-proofs", transfer.id],
     async () => {
-      const submitProofsResponse: ISponsorWalletTransaction = await fetch(
+      const sponsorWalletTransaction: ISponsorWalletTransaction = await fetch(
         `/api/transfer/${transfer.id}/signed-submit-proofs-tx`
       ).then((res) => {
         if (res.ok) {
@@ -20,13 +21,43 @@ const useSyscoinSubmitProofs = (
         return res.json().then(({ message }) => Promise.reject(message));
       });
 
-      return submitProofsResponse.transactionHash;
+      const receipt = await web3.eth.getTransactionReceipt(
+        sponsorWalletTransaction.transaction.hash,
+      );
+
+      if (receipt) {
+        return receipt.transactionHash;
+      }
+
+      return new Promise<string>((resolve, reject) => {
+        const method = web3.eth.sendSignedTransaction(
+          sponsorWalletTransaction.transaction.rawData
+        );
+        method
+          .once("transactionHash", (hash: string | { success: false }) => {
+            if (typeof hash === "string") {
+              return resolve(hash);
+            }
+            if (!hash.success) {
+              reject("Failed to submit proofs. Check browser logs");
+              console.error("Submission failed", hash);
+            }
+          })
+          .on("error", (error: { message: string }) => {
+            if (/might still be mined/.test(error.message)) {
+              resolve("");
+            } else {
+              console.error(error);
+              reject(error);
+            }
+          });
+      });
     },
     {
-      onSuccess: (data) => {
+      onSuccess: (data: string) => {
         onSuccess(data);
       },
-      retry: 3
+      retry: 3,
     }
   );
 };

constants.ts

@@ -1,4 +1,5 @@
 export const MIN_AMOUNT = 0.01;
+export const DEFAULT_GAS_LIMIT = 120_000
 
 export const RELAY_CONTRACT_ADDRESS =
   "0xD822557aC2F2b77A1988617308e4A29A89Cb95A6";

models/sponsor-wallet-transactions.ts

@@ -2,39 +2,48 @@ import mongoose from "mongoose";
 
 export type SponsorWalletTransactionStatus = "pending" | "success" | "failed";
 
+export const SponsorWalletTransactionCollectionName = 'sponsorwallettransactions'
+
 export interface ISponsorWalletTransaction extends mongoose.Document {
-  transferId: string
+  transferId: string;
   walletId: string;
-  transactionHash: string;
   status: SponsorWalletTransactionStatus;
   createdAt: Date;
   updatedAt: Date;
+  transaction: {
+    hash: string;
+    rawData: string;
+    confirmedHash: string;
+    nonce: number;
+  };
 }
 
 const SponsorWalletTransactionSchema =
   new mongoose.Schema<ISponsorWalletTransaction>(
     {
       transferId: {
-        type: String
-      },
-      walletId: {
         type: String,
       },
-      transactionHash: {
+      walletId: {
         type: String,
       },
       status: {
         type: String,
         default: "pending",
       },
+      transaction: {
+        type: Object,
+        default: {},
+      },
     },
     { timestamps: true }
   );
 
 const generateModel = () =>
   mongoose.model("SponsorWalletTransaction", SponsorWalletTransactionSchema);
 
-let model: ReturnType<typeof generateModel> = mongoose.models.SponsorWalletTransaction;
+let model: ReturnType<typeof generateModel> =
+  mongoose.models.SponsorWalletTransaction;
 
 if (!model) {
   model = generateModel();

pages/api/transfer/[id]/signed-submit-proofs-tx.ts

@@ -51,18 +51,12 @@ const handler: NextApiHandler = async (
 
     const encoded = method.encodeABI();
 
-    const gasPrice = await web3.eth.getGasPrice();
-    const gas = await method.estimateGas();
-    const gasLimit = gas ?? 400_000;
-
     const sponsorWalletService = new SponsorWalletService();
 
     const sponsoredTransaction = await sponsorWalletService.sponsorTransaction(
       transfer.id,
       {
         to: RELAY_CONTRACT_ADDRESS,
-        gasPrice: web3.utils.toHex(gasPrice),
-        gas: web3.utils.toHex(gasLimit),
         data: encoded,
         value: 0,
       }