feat: support `Panic` & custom contract errors #57

jxom · 2023-02-08T01:29:59Z

Support Panic & custom contract errors thrown from contracts
Added @wagmi/cli so we can build contract bytecode, generate abis, and then deploy them in tests

changeset-bot · 2023-02-08T01:30:02Z

🦋 Changeset detected

Latest commit: bf0ee4d

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2023-02-08T01:30:06Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
viem-benchmark	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 9, 2023 at 0:26AM (UTC)
viem-playground	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 9, 2023 at 0:26AM (UTC)
viem-site	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 9, 2023 at 0:26AM (UTC)

socket-security · 2023-02-08T01:31:27Z

Socket Security Pull Request Report

Dependency issues detected. If you merge this pull request, you will not be alerted to the instances of these issues again.

📜 Install scripts

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.

Package	Script field	Source
[email protected] (upgraded)	`postinstall`	`package.json` via @wagmi/[email protected], [email protected], `site/package.json` via [email protected]

Pull request report summary

Issue	Status
Install scripts	⚠️ 1 issue
Native code	✅ 0 issues
Bin script confusion	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore [email protected] [email protected]

@SocketSecurity ignore [email protected]

Powered by socket.dev

jxom · 2023-02-08T01:34:50Z

contracts/src/ErrorsExample.sol

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: Unlicense


This contract is to test contract errors.

jxom · 2023-02-08T01:35:25Z

src/_test/utils.ts

+  })
+}
+
+export async function deployErrorExample() {


We can deploy the bytecode generated from @wagmi/cli to use in our tests.

jxom · 2023-02-08T01:36:03Z

src/utils/contract/getContractError.ts

-  const abiItem = getAbiItem({ abi, args, name: functionName })
-  const formattedArgs = abiItem
-    ? formatAbiItemWithArgs({
-        abiItem,
-        args,
-        includeFunctionName: false,
-        includeName: false,
-      })
-    : undefined
-  const functionWithParams = abiItem
-    ? formatAbiItem(abiItem, { includeName: true })
-    : undefined
-


Just moved this logic into ContractFunctionRevertedError.

jxom · 2023-02-08T01:36:56Z

src/errors/contract.ts

+      const { abiItem, errorName, args: errorArgs } = decodedData
+      if (errorName === 'Error') {
+        reason = (errorArgs as [string])[0]
+      } else if (errorName === 'Panic') {


Support Panic & retrieve corresponding reason.

jxom · 2023-02-08T01:37:16Z

src/errors/contract.ts

+      } else if (errorName === 'Panic') {
+        const [firstArg] = errorArgs as [number]
+        reason = panicReasons[firstArg as keyof typeof panicReasons]
+      } else if (errorArgs) {


Support custom errors.

jxom · 2023-02-08T01:38:03Z

src/actions/public/readContract.test.ts

@@ -156,6 +152,159 @@ describe('bayc', () => {
  })
 })

+describe('contract errors', () => {


E2E examples of contract errors can be seen here!

jxom · 2023-02-08T10:34:38Z

.github/actions/setup/action.yml

@@ -0,0 +1,52 @@
+name: 'Setup'


Feel like we use these steps in a lot of actions. Might make sense to create a composite action for them.

tmm · 2023-02-08T23:10:55Z

.github/workflows/release.yml

        run: pnpm i
+        env:
+          SKIP_WAGMI_CLI: true


could we do pnpm i --ignore-scripts instead?

good idea lol

tmm · 2023-02-08T23:13:06Z

src/constants/index.test.ts

+      "panicReasons": {
+        "1": "An \`assert\` condition failed.",
+        "17": "Arithmic operation resulted in underflow or overflow.",
+        "18": "Division or modulo by zero (e.g. \`5 / 0\` or \`23 % 0\`).",
+        "33": "Attempted to convert to an invalid type.",
+        "34": "Attempted to access a storage byte array that is incorrectly encoded.",
+        "49": "Performed \`.pop()\` on an empty array",
+        "50": "Array index is out of bounds.",
+        "65": "Allocated too much memory or created an array which is too large.",
+        "81": "Attempted to call a zero-initialized variable of internal function type.",
+      },
+      "solidityError": {
+        "inputs": [
+          {
+            "internalType": "string",
+            "name": "message",
+            "type": "string",
+          },
+        ],
+        "name": "Error",
+        "type": "error",
+      },
+      "solidityPanic": {
+        "inputs": [
+          {
+            "internalType": "uint256",
+            "name": "reason",
+            "type": "uint256",
+          },
+        ],
+        "name": "Panic",
+        "type": "error",
+      },


some duplication here from other tests. in my mind, index.test.ts tests are for locking down exports. could switch to expect(Object.keys(exports)).toMatchInlineSnapshot() instead.

tmm · 2023-02-08T23:13:22Z

src/constants/solidity.ts

+import { AbiError } from 'abitype'
+
+// https://docs.soliditylang.org/en/v0.8.16/control-structures.html#panic-via-assert-and-error-via-require
+export const panicReasons = {


🔥🔥🔥

tmm · 2023-02-08T23:14:02Z

src/constants/solidity.ts

+export const solidityPanic: AbiError = {
+  inputs: [
+    {
+      internalType: 'uint256',


could drop internalType from here (and other ABIs that are around in the codebase).

tmm

cool use of cli

vercel bot had a problem deploying to Preview – viem-site February 8, 2023 01:30 Failure

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 01:30 Failure

vercel bot had a problem deploying to Preview – viem-playground February 8, 2023 01:30 Failure

jxom force-pushed the jxom/multicall branch from b6186bb to de56524 Compare February 8, 2023 01:31

jxom force-pushed the jxom/contract-errors branch from c01964a to 810230a Compare February 8, 2023 01:31

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 01:33 Failure

vercel bot had a problem deploying to Preview – viem-playground February 8, 2023 01:33 Failure

vercel bot had a problem deploying to Preview – viem-site February 8, 2023 01:33 Failure

jxom commented Feb 8, 2023

View reviewed changes

contracts/src/ErrorsExample.sol

@@ -0,0 +1,50 @@

// SPDX-License-Identifier: Unlicense

Copy link

Member Author

jxom Feb 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This contract is to test contract errors.

jxom commented Feb 8, 2023

View reviewed changes

vercel bot had a problem deploying to Preview – viem-site February 8, 2023 03:30 Failure

vercel bot had a problem deploying to Preview – viem-playground February 8, 2023 03:30 Failure

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 03:30 Failure

jxom force-pushed the jxom/contract-errors branch from 1a10d19 to c1f2734 Compare February 8, 2023 03:31

vercel bot had a problem deploying to Preview – viem-playground February 8, 2023 03:31 Failure

vercel bot had a problem deploying to Preview – viem-site February 8, 2023 03:32 Failure

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 03:32 Failure

vercel bot had a problem deploying to Preview – viem-site February 8, 2023 03:36 Failure

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 03:37 Failure

vercel bot had a problem deploying to Preview – viem-playground February 8, 2023 03:37 Failure

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 03:39 Failure

vercel bot had a problem deploying to Preview – viem-site February 8, 2023 03:39 Failure

vercel bot had a problem deploying to Preview – viem-benchmark February 8, 2023 03:40 Failure

vercel bot deployed to Preview – viem-playground February 8, 2023 06:26 View deployment

vercel bot deployed to Preview – viem-site February 8, 2023 06:26 View deployment

vercel bot deployed to Preview – viem-benchmark February 8, 2023 08:12 View deployment

vercel bot deployed to Preview – viem-site February 8, 2023 08:13 View deployment

vercel bot deployed to Preview – viem-playground February 8, 2023 08:13 View deployment

jxom commented Feb 8, 2023

View reviewed changes

tmm reviewed Feb 8, 2023

View reviewed changes

tmm approved these changes Feb 8, 2023

View reviewed changes

Base automatically changed from jxom/multicall to main February 8, 2023 23:57

jxom added 6 commits February 9, 2023 11:01

feat: multicall + contract error cleanup

fb167e2

tests: fix

b4a4d87

feat: support Panic & custom contract errors

320c67a

ci: refactor actions

9c71b4b

Delete foundry.toml

66e2744

chore: changeset

a3f9f6a

jxom force-pushed the jxom/contract-errors branch from 01e3fe5 to a3f9f6a Compare February 9, 2023 00:02

vercel bot deployed to Preview – viem-site February 9, 2023 00:03 View deployment

vercel bot deployed to Preview – viem-playground February 9, 2023 00:04 View deployment

vercel bot deployed to Preview – viem-benchmark February 9, 2023 00:04 View deployment

refactor

bf0ee4d

jxom merged commit 40c76e3 into main Feb 9, 2023

jxom deleted the jxom/contract-errors branch February 9, 2023 00:21

vercel bot deployed to Preview – viem-playground February 9, 2023 00:21 View deployment

github-actions bot mentioned this pull request Feb 9, 2023

Version Packages (alpha) #59

Merged

vercel bot deployed to Preview – viem-site February 9, 2023 00:22 View deployment

vercel bot deployed to Preview – viem-benchmark February 9, 2023 00:26 View deployment

github-actions bot mentioned this pull request Mar 6, 2023

Version Packages #123

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support `Panic` & custom contract errors #57

feat: support `Panic` & custom contract errors #57

jxom commented Feb 8, 2023 •

edited

Loading

changeset-bot bot commented Feb 8, 2023 •

edited

Loading

vercel bot commented Feb 8, 2023 •

edited

Loading

socket-security bot commented Feb 8, 2023

jxom Feb 8, 2023

jxom Feb 8, 2023

jxom Feb 8, 2023 •

edited

Loading

jxom Feb 8, 2023

jxom Feb 8, 2023

jxom Feb 8, 2023

jxom Feb 8, 2023

tmm Feb 8, 2023

tmm Feb 8, 2023

jxom Feb 8, 2023

tmm Feb 8, 2023

tmm Feb 8, 2023

tmm Feb 8, 2023

tmm left a comment

feat: support Panic & custom contract errors #57

feat: support Panic & custom contract errors #57

Conversation

jxom commented Feb 8, 2023 • edited Loading

changeset-bot bot commented Feb 8, 2023 • edited Loading

🦋 Changeset detected

vercel bot commented Feb 8, 2023 • edited Loading

socket-security bot commented Feb 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jxom Feb 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tmm left a comment

Choose a reason for hiding this comment

feat: support `Panic` & custom contract errors #57

feat: support `Panic` & custom contract errors #57

jxom commented Feb 8, 2023 •

edited

Loading

changeset-bot bot commented Feb 8, 2023 •

edited

Loading

vercel bot commented Feb 8, 2023 •

edited

Loading

jxom Feb 8, 2023 •

edited

Loading