[SDK] Issue using Paymaster with zkSync-web3.Web3Provider and WalletConnect-v2

[equalogix]

Environment

Testnet

Acknowledgement

• I understand that issues are expected with the Python and Java SDK as they are being updated.

Issue Description

It is not possible to send transactions using a Paymaster when using WalletConnect-v2 Ethereum-Provider (tested with Metamask as the wallet), the transactions are sent to the wallet, but no approval pop-up is ever triggered and in the app an error is thrown with the generic message {code: -32603, message: 'internal error'}.

When executing the same code using Metamask instead of WalletConnect, both on desktop and from the MM-Browser transaction are sent successfully without throwing any errors.

When one replaces the zkSync-web3.Web3Provider with the ethers.js Web3Provider and one uses WalletConnect, then it throws an error for invalid key customData which is expected (but not desired). In this case, it also throws the error when using Metamask to connect.

We have tried to send the transactions using contract[method] and sendTransaction with the contract method/abi and paymaster encoded, in both cases the transactions fail. We have also tried contract.populateTransaction and sendUncheckedTransaction but that simply ignores the paymaster and requires the user to pay the gas fees. I have opened a separate thread for that issue, as sending transaction using the method is required when using WC on iOS. See: #53

Expected Behavior

When a transaction is sent using a Paymaster it should open an approval pop-up in the wallet to sign a type 113 transaction and not throw any errors.

Code Example

  const overrides = { 
    customData: { 
      gasPerPubdata: ethers.BigNumber.from(utils.DEFAULT_GAS_PER_PUBDATA_LIMIT),
      paymasterAddress, 
          {
            type: "General",
            innerInput: new Uint8Array(),
          }
    } 
  }

  useEffect(() => {
    if(!contractRef.current && address && signer){ 
      contractRef.current = new Contract(
        address,
        abi,
        signer
      )
    }
  },[address, abi, signer])

  useEffect(() => {
    if(gasPrice?.maxFeePerGas && gasLimit && nonce && !finalOverrides){
      setFinalOverrides(state => ({
        customData: {...overrides.customData},
        maxFeePerGas: gasPrice.maxFeePerGas,
        maxPriorityFeePerGas: gasPrice.maxPriorityFeePerGas,
        gasLimit,
        type: 113,
        nonce
      }))
    }
  },[gasPrice?.maxFeePerGas, gasLimit, overrides])

const transact = () => {
  contractRef.current[method](...params, finalOverrides)
    .then( txHash => {
      txHash.wait()
        .then( awaited =>  { /* ... do something with the result... */})
    })
}

Repo Link (Optional)

No response

[dutterbutter]

Hey there! 😊 Thanks for the super detailed info you've provided here and in #53! Sorry for the delayed response, we'll aim to be speedier next time. 🐢➡️🐇

We understand how crucial it is for WalletConnect and paymasters to work seamlessly together, so rest assured we're on the case. We will be investigating this further to find a resolution for yourself and the community. We want to give you the ease-of-use you're after! I know patience is a virtue and you've been super virtuous so far! 🙏 Thank you for that.

I will update here as soon as we have some updates.

Again, thank you for being an awesome community member! 🙌

[equalogix]

Thank you very much. I'm available if you need more information or other assistance.

[davidonuh]

this was very helpful btw thanks

[equalogix]

By chance, I figured out what the problem was. It was a really small mistake in how WalletConnect's EthereumProvider was being initialized. When specifying the methods to use in the session, I used the key methods instead of optionalMethods, here are the docs explaining this: https://docs.walletconnect.com/2.0/web/providers/ethereum#required-and-optional-methods

But the real problem remains. The issue is the error returned is always {code: 32603, message: internal-error} regardless of the actual error. For example, if a transaction is cancelled, I should get a code 4001 error but I still get 32603 error. The problem I just resolved could have been fixed in minutes, if I only had the correct error message.

The big question now is what is causing the error message bug? Is it WalletConnect, zksync-web3 or MetaMask or any combination? I believe that this is a WalletConnect issue because there are other reports in their repo from devs not using zkSync of the same error message, but again the message is so generic that it is impossible to know.

Here are some examples of reports of the issue:
WC github repo:

• "Internal error" exception instead of a proper "Unknown network [network_id]" exception WalletConnect/walletconnect-monorepo#2825

MM github repo:

• eth_signTypedData_v4 get: Internal Error : {"code": -32603, "message": "Internal error"}  MetaMask/metamask-mobile#6740
• Internal Error : {"code": -32603, "message": "Internal error"} MetaMask/metamask-mobile#6715

Assuming that this is an issue with WC or MM, ideally if the zkSync team could reach out to WC/MM it could potentially get this issue prioritized.

Also this does nothing to solve my issue #53 which remains a big concern and for which I see no easy solution.

[equalogix]

Good and bad news.
Good news: Metamask/mobile released an update we are now at v7.3.0. It fixed the bug with the error messages, I am now seeing a full error message: {code: 5000, message: '{"code":-32603,"message":"Internal JSON-RPC error.…ata":{"code":-32600,"message":"Invalid request"}}'}

Bad news: It stopped working again. WTF!!! I feel like I'm going crazy... I didn't change anything on my end, and the everything continues
to work fine in the MM-browser, but I can't get WalletConnect to work, it's broken both on iOS and Android.

[equalogix]

I should add, that this doesn't appear to be related to the paymaster. I have tried with and without including the custom data and neither works. The only way currently to interact with a smart contract using WC is the use contract.populateTransaction followed by sendUncheckedTransaction, which ignores the paymaster.

[equalogix]

I figured it out, (I hope!) the issue is with WalletConnect, and the passing of the methods during the initialization of the EthereumProvider. The TS type for the methods object is limited to a set of specific methods, if you try to pass a method that is not explicitly declared in WC's code it throws the generic error message.

Here is the link to WC's code that shows the explicit list.
https://github.com/WalletConnect/walletconnect-monorepo/blob/dc26b396c3a1a2f266143289842d7c7695eaf3ef/providers/ethereum-provider/src/EthereumProvider.ts#L36

[dutterbutter]

Thank you for this. I intend to reproduce and document the behaviour explicitly to share with their team. Thank you for the diligent debugging here!

[equalogix]

I was planning on opening issue in the WC repo for this. This isn't really a bug, it's just that the error thrown provides you with no clue to what the problem.

[equalogix]

Guess what? The issue is not resolved. Last week when I was working on this I made a fatal assumption. When clicking the "mint token" button in my dApp MetaMask correctly displayed the transaction pop-up with type 113 transaction message to sign. I assumed that it meant that it was good, because once I've reached that point it was always good. So as not to waste testnet tokens I simply clicked cancel. But I was wrong, it wasn't good.

This morning I got back onto the project, I tried minting, and I did click submit, and the transaction failed. internal JSON-RPC error. I tried again a few times, it always fails, checked the paymaster balance to ensure there was sufficient funds to cover the gas fees, all is good, but transaction still fails. I then tried it the MM Browser and it worked no problem.

Since now both WC and MM provide me with the transaction message, I compared the messages and they are both identical. I really don't get what the problem could be.

Here is the message:

[dutterbutter]

It seems that WC does not support paymaster customData payload at this time. We are investigating a patch or a way to circumvent this for the short-term, and then hopefully a longer-term solution is an upstream fix to WC. Paymaster transactions will work fine with MM so its specific to WC. This issue is separate from the issues you faced prior and tagged accordingly.

[equalogix]

Thanks for this confirmation. It is worth mentioning that I was using the paymaster with WC without any issue when I was using WCv1, this is a bug/side-effect that was introduced with the switch to V2.

Note: I opened an issue with WC WalletConnect/walletconnect-monorepo#3269

[lutr0]

Hi, is there any update on WC? I got to the same error trying to send a paymaster tx.
Apart from Metamask, which other wallets work?

[glitch-txs]

Hi! is this still an issue? could you please provide a minimal reproducible example that we can run?

EthereumProvider is meant to follow EIP-1163 so for custom methods we usually use Universal Provider, but we can add more to the first one if required.

[bxpana]

@lutr0 and @glitch-txs this should be working with WC now. If you run into any issues feel free to open up a new discussion