fix(common): use pending block tag in tx queue (#3073)

latticexyz · Sep 1, 2024 · c0764a5 · c0764a5
1 parent b434e8d
commit c0764a5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 11 deletions.
diff --git a/.changeset/poor-nails-appear.md b/.changeset/poor-nails-appear.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/common": patch
+---
+
+`writeContract` and `sendTransaction` actions now use `pending` block tag when estimating gas. This aligns with previous behavior before changes in the last version.
diff --git a/packages/common/src/sendTransaction.ts b/packages/common/src/sendTransaction.ts
@@ -6,6 +6,7 @@ import {
   Transport,
   SendTransactionReturnType,
   PublicClient,
+  SendTransactionRequest,
 } from "viem";
 import { sendTransaction as viem_sendTransaction } from "viem/actions";
 import pRetry from "p-retry";
@@ -38,10 +39,11 @@ export type SendTransactionExtraOptions<chain extends Chain | undefined> = {
 export async function sendTransaction<
   chain extends Chain | undefined,
   account extends Account | undefined,
-  chainOverride extends Chain | undefined,
+  const request extends SendTransactionRequest<chain, chainOverride>,
+  chainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, chain, account>,
-  request: SendTransactionParameters<chain, account, chainOverride>,
+  request: SendTransactionParameters<chain, account, chainOverride, request>,
   opts: SendTransactionExtraOptions<chain> = {},
 ): Promise<SendTransactionReturnType> {
   const rawAccount = request.account ?? client.account;
@@ -52,10 +54,11 @@ export async function sendTransaction<
   const account = parseAccount(rawAccount);
   const chain = client.chain;
 
+  const blockTag = "pending";
   const nonceManager = await getNonceManager({
     client: opts.publicClient ?? client,
     address: account.address,
-    blockTag: "pending",
+    blockTag,
     queueConcurrency: opts.queueConcurrency,
   });
 
@@ -70,13 +73,14 @@ export async function sendTransaction<
       pRetry(
         async () => {
           const nonce = nonceManager.nextNonce();
-          const params: SendTransactionParameters<chain, account, chainOverride> = {
+          const params = {
+            blockTag,
             ...request,
             nonce,
             ...feeRef.fees,
-          };
+          } as const satisfies SendTransactionParameters<chain, account, chainOverride, request>;
           debug("sending tx to", request.to, "with nonce", nonce);
-          return await getAction(client, viem_sendTransaction, "sendTransaction")(params);
+          return await getAction(client, viem_sendTransaction, "sendTransaction")(params as never);
         },
         {
           retries: 3,

diff --git a/packages/common/src/writeContract.ts b/packages/common/src/writeContract.ts
@@ -41,7 +41,7 @@ export type WriteContractExtraOptions<chain extends Chain | undefined> = {
 export async function writeContract<
   chain extends Chain | undefined,
   account extends Account | undefined,
-  abi extends Abi | readonly unknown[],
+  const abi extends Abi | readonly unknown[],
   functionName extends ContractFunctionName<abi, "nonpayable" | "payable">,
   args extends ContractFunctionArgs<abi, "nonpayable" | "payable", functionName>,
   chainOverride extends Chain | undefined,
@@ -58,10 +58,11 @@ export async function writeContract<
   const account = parseAccount(rawAccount);
   const chain = client.chain;
 
+  const blockTag = "pending";
   const nonceManager = await getNonceManager({
     client: opts.publicClient ?? client,
     address: account.address,
-    blockTag: "pending",
+    blockTag,
     queueConcurrency: opts.queueConcurrency,
   });
 
@@ -76,13 +77,14 @@ export async function writeContract<
       pRetry(
         async () => {
           const nonce = nonceManager.nextNonce();
-          const params: WriteContractParameters<abi, functionName, args, chain, account, chainOverride> = {
+          const params = {
+            blockTag,
             ...request,
             nonce,
             ...feeRef.fees,
-          };
+          } as const satisfies WriteContractParameters<abi, functionName, args, chain, account, chainOverride>;
           debug("calling", params.functionName, "at", params.address, "with nonce", nonce);
-          return await getAction(client, viem_writeContract, "writeContract")({ ...params });
+          return await getAction(client, viem_writeContract, "writeContract")(params as never);
         },
         {
           retries: 3,