Prevent abiParser from breaking too easily (#661)

* Prevent abiParser from breaking too easily * Improve test case name
dethcrypto · Mar 23, 2022 · e1f832c · e1f832c
1 parent 7931301
commit e1f832c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/.changeset/wet-turtles-type.md b/.changeset/wet-turtles-type.md
@@ -0,0 +1,5 @@
+---
+'typechain': patch
+---
+
+Make parsing JSON abi files more resilent. This should improve foundry integration.
diff --git a/packages/typechain/src/parser/abiParser.ts b/packages/typechain/src/parser/abiParser.ts
@@ -402,25 +402,31 @@ export function extractBytecode(rawContents: string): BytecodeWithLinkReferences
 
   if (!json) return undefined
 
+  function tryMatchBytecode(obj: any | undefined): any | undefined {
+    if (obj && obj.match instanceof Function) {
+      return obj.match(bytecodeRegex)
+    }
+  }
+
   // `json.evm.bytecode` often has more information than `json.bytecode`, needs to be checked first
-  if (json.evm?.bytecode?.object?.match(bytecodeRegex)) {
+  if (tryMatchBytecode(json.evm?.bytecode?.object)) {
     return extractLinkReferences(json.evm.bytecode.object, json.evm.bytecode.linkReferences)
   }
 
   // handle json schema of @0x/sol-compiler
-  if (json.compilerOutput?.evm?.bytecode?.object?.match(bytecodeRegex)) {
+  if (tryMatchBytecode(json.compilerOutput?.evm?.bytecode?.object)) {
     return extractLinkReferences(
       json.compilerOutput.evm.bytecode.object,
       json.compilerOutput.evm.bytecode.linkReferences,
     )
   }
 
   // handle json schema of @foundry/forge
-  if (json.bytecode?.object?.match(bytecodeRegex)) {
+  if (tryMatchBytecode(json.bytecode?.object)) {
     return extractLinkReferences(json.bytecode.object, json.bytecode.linkReferences)
   }
 
-  if (json.bytecode?.match(bytecodeRegex)) {
+  if (tryMatchBytecode(json.bytecode)) {
     return extractLinkReferences(json.bytecode, json.linkReferences)
   }
 

diff --git a/packages/typechain/test/parser/abiParser.test.ts b/packages/typechain/test/parser/abiParser.test.ts
@@ -145,6 +145,10 @@ describe('extractBytecode', () => {
     expect(extractBytecode(`{ "bytecode": { "object": "${sampleBytecode}" } }`)).toEqual(resultBytecode)
   })
 
+  it('should not throw when unexpected abi was passed', () => {
+    expect(extractBytecode(`{ "bytecode": { "smt_else": "${sampleBytecode}" } }`)).toEqual(undefined)
+  })
+
   it('should return undefined when nested abi bytecode is malformed', () => {
     expect(extractBytecode(`{ "bytecode": "surely-not-bytecode" }`)).toEqual(undefined)
   })