feat: improve tx batching

Author: DiRaiks

features/defi-wrapper/defi-wrapper-factory.ts

@@ -101,7 +101,9 @@ export const finalizePoolCreation = async (
   });
 
   if (!finalizeResult.receipt || !finalizeResult.tx) {
-    logInfo('Transaction has been sent');
+    logInfo(
+      'Transaction has been sent. Use "log-finalizing-pool-data" command to get the Pool data after the transaction is signed and executed',
+    );
     return;
   }
 

features/index.ts

@@ -13,3 +13,4 @@ export * from './lazy-oracle.js';
 export * from './defi-wrapper/index.js';
 export * from './dev-tools/index.js';
 export * from './metrics.js';
+export * from './with-report.js';

features/mint-burn/allowance.ts

@@ -1,4 +1,4 @@
-import { formatEther } from 'viem';
+import { formatEther, Hex, TransactionReceipt } from 'viem';
 
 import {
   getStethContract,
@@ -7,26 +7,31 @@ import {
 } from 'contracts';
 import { getAccount } from 'providers';
 import {
-  callReadMethod,
   callReadMethodSilent,
   callWriteMethodWithReceipt,
   confirmOperation,
   logInfo,
+  PopulatedTx,
 } from 'utils';
 
 export const checkAllowance = async (
   contract: DashboardContract,
   amount: bigint,
   token: 'steth' | 'wsteth' | 'shares',
-) => {
+  populateTx?: boolean,
+): Promise<{
+  receipt?: TransactionReceipt;
+  tx?: Hex;
+  data?: PopulatedTx;
+} | void> => {
   const accountAddress = (await getAccount()).address;
   const isShares = token === 'shares';
   let currentAmount = amount;
 
   if (token === 'steth' || isShares) {
     const stethContract = await getStethContract();
 
-    const allowance = await callReadMethod(stethContract, 'allowance', [
+    const allowance = await callReadMethodSilent(stethContract, 'allowance', [
       accountAddress,
       contract.address,
     ]);
@@ -46,19 +51,21 @@ export const checkAllowance = async (
       );
       if (!confirm) throw new Error('Allowance not set');
 
-      await callWriteMethodWithReceipt({
+      return await callWriteMethodWithReceipt({
         contract: stethContract,
         methodName: 'approve',
         payload: [contract.address, currentAmount],
+        populateTx,
       });
     }
   } else {
     const wstethContract = await getWstethContract();
 
-    const wstethAllowance = await callReadMethod(wstethContract, 'allowance', [
-      accountAddress,
-      accountAddress,
-    ]);
+    const wstethAllowance = await callReadMethodSilent(
+      wstethContract,
+      'allowance',
+      [accountAddress, contract.address],
+    );
     if (wstethAllowance < amount) {
       logInfo('Insufficient allowance');
 
@@ -67,10 +74,11 @@ export const checkAllowance = async (
       );
       if (!confirm) throw new Error('Allowance not set');
 
-      await callWriteMethodWithReceipt({
+      return await callWriteMethodWithReceipt({
         contract: wstethContract,
         methodName: 'approve',
         payload: [contract.address, amount],
+        populateTx,
       });
     }
   }

features/mint-burn/burn-shares.ts

@@ -5,7 +5,8 @@ import {
   fetchAndCalculateVaultHealthWithNewValue,
   showSpinner,
   confirmBurn,
-  callWriteMethodWithReceipt,
+  PopulatedTx,
+  callWriteMethodWithCalls,
 } from 'utils';
 import { checkLiabilityShares } from 'features';
 
@@ -14,6 +15,7 @@ export const burnShares = async (
   amountOfShares: bigint,
   vault: Address,
   method: 'burnShares' | 'burnWstETH',
+  populatedAllowance?: PopulatedTx,
 ) => {
   const type = method === 'burnShares' ? 'shares' : 'wstETH';
 
@@ -55,9 +57,10 @@ export const burnShares = async (
   });
   if (!confirm) return;
 
-  await callWriteMethodWithReceipt({
+  await callWriteMethodWithCalls({
     contract,
     methodName: method,
     payload: [amountOfShares],
+    calls: [...(populatedAllowance ? [populatedAllowance] : [])],
   });
 };

features/mint-burn/burn-steth.ts

@@ -5,15 +5,17 @@ import {
   fetchAndCalculateVaultHealthWithNewValue,
   showSpinner,
   confirmBurn,
-  callWriteMethodWithReceipt,
   callReadMethodSilent,
+  PopulatedTx,
+  callWriteMethodWithCalls,
 } from 'utils';
 import { checkLiabilityShares } from 'features';
 
 export const burnSteth = async (
   contract: DashboardContract,
   amountOfSteth: bigint,
   vault: Address,
+  populatedAllowance?: PopulatedTx,
 ) => {
   const stethContract = await getStethContract();
   const amountOfShares = await callReadMethodSilent(
@@ -60,9 +62,10 @@ export const burnSteth = async (
   });
   if (!confirm) return;
 
-  await callWriteMethodWithReceipt({
+  await callWriteMethodWithCalls({
     contract,
     methodName: 'burnStETH',
     payload: [amountOfSteth],
+    calls: [...(populatedAllowance ? [populatedAllowance] : [])],
   });
 };

features/mint-burn/mint-shares.ts

@@ -5,9 +5,11 @@ import {
   fetchAndCalculateVaultHealthWithNewValue,
   showSpinner,
   confirmMint,
-  callWriteMethodWithReceipt,
 } from 'utils';
-import { checkIsReportFresh, checkMintingCapacity } from 'features';
+import {
+  callWriteMethodsWithReportFresh,
+  checkMintingCapacity,
+} from 'features';
 
 export const mintShares = async (
   contract: DashboardContract,
@@ -18,9 +20,6 @@ export const mintShares = async (
 ) => {
   const type = method === 'mintShares' ? 'shares' : 'wstETH';
 
-  const isReportFresh = await checkIsReportFresh(vault);
-  if (!isReportFresh) return;
-
   const isMintingCapacityOk = await checkMintingCapacity(
     contract,
     amountOfShares,
@@ -60,7 +59,8 @@ export const mintShares = async (
   });
   if (!confirm) return;
 
-  await callWriteMethodWithReceipt({
+  await callWriteMethodsWithReportFresh({
+    vault,
     contract,
     methodName: method,
     payload: [recipient, amountOfShares],

features/mint-burn/mint-steth.ts

@@ -5,10 +5,12 @@ import {
   fetchAndCalculateVaultHealthWithNewValue,
   showSpinner,
   confirmMint,
-  callWriteMethodWithReceipt,
   callReadMethodSilent,
 } from 'utils';
-import { checkIsReportFresh, checkMintingCapacity } from 'features';
+import {
+  callWriteMethodsWithReportFresh,
+  checkMintingCapacity,
+} from 'features';
 
 export const mintSteth = async (
   contract: DashboardContract,
@@ -23,9 +25,6 @@ export const mintSteth = async (
     [amountOfSteth],
   );
 
-  const isReportFresh = await checkIsReportFresh(vault);
-  if (!isReportFresh) return;
-
   const isMintingCapacityOk = await checkMintingCapacity(
     contract,
     amountOfShares,
@@ -65,7 +64,8 @@ export const mintSteth = async (
   });
   if (!confirm) return;
 
-  await callWriteMethodWithReceipt({
+  await callWriteMethodsWithReportFresh({
+    vault,
     contract,
     methodName: 'mintStETH',
     payload: [recipient, amountOfSteth],

features/utils/liability-shares.ts

@@ -1,3 +1,4 @@
+import { formatEther } from 'viem';
 import { DashboardContract } from 'contracts';
 import { callReadMethodSilent, logError } from 'utils';
 
@@ -11,7 +12,9 @@ export const checkLiabilityShares = async (
   );
 
   if (amountOfShares > liabilityShares) {
-    logError('Cannot burn more shares than the liability shares');
+    logError(
+      `Cannot burn more shares than the liability shares (Liability shares: ${formatEther(liabilityShares)}, Amount of shares to burn: ${formatEther(amountOfShares)})`,
+    );
     return false;
   }
 

features/utils/report-fresh.ts

@@ -6,6 +6,7 @@ import {
   confirmOperation,
   submitReport,
   logInfo,
+  PopulatedTx,
 } from 'utils';
 
 const checkIsDisconnected = async (vault: Address) => {
@@ -28,11 +29,17 @@ const checkIsDisconnected = async (vault: Address) => {
   return false;
 };
 
-export const checkIsReportFresh = async (vault: Address) => {
+export const checkIsReportFresh = async ({
+  vault,
+  populateTx = false,
+}: {
+  vault: Address;
+  populateTx?: boolean;
+}): Promise<{ isFresh: boolean; data?: PopulatedTx }> => {
   const vaultHubContract = await getVaultHubContract();
   const isDisconnected = await checkIsDisconnected(vault);
 
-  if (isDisconnected) return true;
+  if (isDisconnected) return { isFresh: true, data: undefined };
 
   const isReportFresh = await callReadMethodSilent(
     vaultHubContract,
@@ -45,16 +52,16 @@ export const checkIsReportFresh = async (vault: Address) => {
     const confirm = await confirmOperation(
       'Do you want to submit a fresh report?',
     );
-    if (!confirm) return false;
+    if (!confirm) return { isFresh: false, data: undefined };
 
-    const isReportSubmitted = await submitReport({ vault });
+    const result = await submitReport({ vault, populateTx });
 
-    return isReportSubmitted;
+    return result;
   }
 
   logInfo('The report is fresh');
 
-  return isReportFresh;
+  return { isFresh: true, data: undefined };
 };
 
 export const reportFreshWarning = async (vault: Address): Promise<boolean> => {