feat: connector property to skip contract simulation (#3868)

* feat: connector property to indicate skip simulation * remove console.log * tweak * chore: skip on send tx * chore: comment * changeset * chore: skipSimulateContract -> supportsSimulation * chore: tweaks * update snap
wevm · Apr 29, 2024 · c2af20b · c2af20b
1 parent 3f36d70
commit c2af20b
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 2 deletions.
diff --git a/.changeset/twelve-walls-deny.md b/.changeset/twelve-walls-deny.md
@@ -0,0 +1,7 @@
+---
+"@wagmi/connectors": minor
+"@wagmi/core": minor
+"wagmi": minor
+---
+
+Added `supportsSimulation` property to connectors that indicates if the connector's wallet supports contract simulation.
diff --git a/docs/dev/creating-connectors.md b/docs/dev/creating-connectors.md
@@ -54,6 +54,7 @@ The type error tells you what properties are missing from `createConnector`'s re
 - `icon`: Optional icon URL for the connector.
 - `id`: The ID for the connector. This should be camel-cased and as short as possible. Example: `fooBarBaz`.
 - `name`: Human-readable name for the connector. Example: `'Foo Bar Baz'`.
+- `supportsSimulation`: Whether the connector supports contract simulation. This should be disabled if a connector's wallet cannot accurately simulate contract writes or display contract revert messages. Defaults to `false`.
 
 #### Methods
 

diff --git a/packages/connectors/src/coinbaseWallet.ts b/packages/connectors/src/coinbaseWallet.ts
@@ -60,6 +60,7 @@ export function coinbaseWallet(parameters: CoinbaseWalletParameters) {
   return createConnector<Provider, Properties>((config) => ({
     id: 'coinbaseWalletSDK',
     name: 'Coinbase Wallet',
+    supportsSimulation: true,
     type: coinbaseWallet.type,
     async connect({ chainId } = {}) {
       try {

diff --git a/packages/core/src/actions/sendTransaction.test.ts b/packages/core/src/actions/sendTransaction.test.ts
@@ -75,7 +75,6 @@ test('behavior: value exceeds balance', async () => {
       from:   0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
       to:     0xd2135CfB216b74109775236E36d4b433F1DF507B
       value:  99999 ETH
-      gas:    21000
 
     Details: Insufficient funds for gas * price + value
     Version: viem@2.8.4"

diff --git a/packages/core/src/actions/sendTransaction.ts b/packages/core/src/actions/sendTransaction.ts
@@ -21,6 +21,7 @@ import type {
 } from '../types/properties.js'
 import { type Evaluate } from '../types/utils.js'
 import { getAction } from '../utils/getAction.js'
+import { getAccount } from './getAccount.js'
 import {
   type GetConnectorClientErrorType,
   getConnectorClient,
@@ -74,7 +75,15 @@ export async function sendTransaction<
   else
     client = await getConnectorClient(config, { account, chainId, connector })
 
+  const { connector: activeConnector } = getAccount(config)
+
   const gas = await (async () => {
+    // Skip gas estimation if `data` doesn't exist (not a contract interaction).
+    if (!('data' in parameters) || !parameters.data) return undefined
+
+    // Skip gas estimation if connector supports simulation.
+    if (activeConnector?.supportsSimulation) return undefined
+
     // Skip gas estimation if `null` is provided.
     if (gas_ === null) return undefined
 

diff --git a/packages/core/src/actions/writeContract.ts b/packages/core/src/actions/writeContract.ts
@@ -21,6 +21,7 @@ import {
 } from '../types/properties.js'
 import type { Evaluate, UnionEvaluate, UnionOmit } from '../types/utils.js'
 import { getAction } from '../utils/getAction.js'
+import { getAccount } from './getAccount.js'
 import {
   type GetConnectorClientErrorType,
   getConnectorClient,
@@ -101,8 +102,11 @@ export async function writeContract<
   else
     client = await getConnectorClient(config, { account, chainId, connector })
 
+  const { connector: activeConnector } = getAccount(config)
+
   let request
-  if (__mode === 'prepared') request = rest
+  if (__mode === 'prepared' || activeConnector?.supportsSimulation)
+    request = rest
   else {
     const { request: simulateRequest } = await simulateContract(config, {
       ...rest,

diff --git a/packages/core/src/connectors/createConnector.ts b/packages/core/src/connectors/createConnector.ts
@@ -35,6 +35,7 @@ export type CreateConnectorFn<
     readonly icon?: string | undefined
     readonly id: string
     readonly name: string
+    readonly supportsSimulation?: boolean | undefined
     readonly type: string
 
     setup?(): Promise<void>

diff --git a/packages/core/src/connectors/injected.ts b/packages/core/src/connectors/injected.ts
@@ -34,6 +34,9 @@ export type InjectedParameters = {
   target?: TargetId | Target | (() => Target | undefined) | undefined
 }
 
+// Regex of wallets/providers that can accurately simulate contract calls & display contract revert reasons.
+const supportsSimulationIdRegex = /(rabby|trustwallet)/
+
 const targetMap = {
   coinbaseWallet: {
     id: 'coinbaseWallet',
@@ -141,6 +144,9 @@ export function injected(parameters: InjectedParameters = {}) {
     get name() {
       return getTarget().name
     },
+    get supportsSimulation() {
+      return supportsSimulationIdRegex.test(this.id.toLowerCase())
+    },
     type: injected.type,
     async setup() {
       const provider = await this.getProvider()