@0xsequence/catapult 1.1.0

package/src/lib/parsers/__tests__/buildinfo.spec.ts

@@ -0,0 +1,122 @@
+import * as fs from 'fs'
+import * as path from 'path'
+import { parseBuildInfo, isBuildInfoFile, extractedContractToArtifact } from '../buildinfo'
+
+describe('Build-Info Parsing', () => {
+  const fixturesDir = path.join(__dirname, 'fixtures/buildinfo')
+
+  // Helper function to read fixture files
+  const readFixture = (filename: string): string => {
+    return fs.readFileSync(path.join(fixturesDir, filename), 'utf-8')
+  }
+
+  describe('isBuildInfoFile function', () => {
+    it('should identify build-info files correctly', () => {
+      expect(isBuildInfoFile('artifacts/build-info/abc123.json')).toBe(true)
+      expect(isBuildInfoFile('out/build-info/def456.json')).toBe(true)
+      expect(isBuildInfoFile('/path/to/artifacts/build-info/xyz789.json')).toBe(true)
+      
+      expect(isBuildInfoFile('artifacts/Contract.json')).toBe(false)
+      expect(isBuildInfoFile('src/Contract.sol')).toBe(false)
+      expect(isBuildInfoFile('build-info.json')).toBe(false)
+    })
+  })
+
+  describe('parseBuildInfo function', () => {
+    it('should parse a simple build-info file with one contract', () => {
+      const content = readFixture('simple-buildinfo.json')
+      const result = parseBuildInfo(content, '/test/simple-buildinfo.json')
+
+      expect(result).not.toBeNull()
+      expect(result).toHaveLength(1)
+      
+      const contract = result![0]
+      expect(contract.contractName).toBe('Counter')
+      expect(contract.sourceName).toBe('src/Counter.sol')
+      expect(contract.fullyQualifiedName).toBe('src/Counter.sol:Counter')
+      expect(contract.abi).toBeInstanceOf(Array)
+      expect(contract.abi.length).toBe(2)
+      expect(contract.bytecode).toMatch(/^0x[0-9a-fA-F]+$/)
+      expect(contract.deployedBytecode).toMatch(/^0x[0-9a-fA-F]+$/)
+      expect(contract.compiler.version).toBe('0.8.30+commit.8fe82020')
+      expect(contract.buildInfoId).toBe('901568e56d422b1e1e3f64004cb4dd6e')
+    })
+
+    it('should parse a build-info file with multiple contracts', () => {
+      const content = readFixture('multi-contract-buildinfo.json')
+      const result = parseBuildInfo(content, '/test/multi-contract-buildinfo.json')
+
+      expect(result).not.toBeNull()
+      expect(result).toHaveLength(2)
+      
+      const contracts = result!
+      expect(contracts.map(c => c.contractName)).toEqual(['Token', 'TokenFactory'])
+      expect(contracts.map(c => c.sourceName)).toEqual(['src/Token.sol', 'src/TokenFactory.sol'])
+      expect(contracts.map(c => c.fullyQualifiedName)).toEqual([
+        'src/Token.sol:Token',
+        'src/TokenFactory.sol:TokenFactory'
+      ])
+    })
+
+    it('should return null for invalid JSON', () => {
+      const content = readFixture('invalid-json.txt')
+      const result = parseBuildInfo(content, '/test/invalid-json.txt')
+
+      expect(result).toBeNull()
+    })
+
+    it('should return null for JSON with wrong format', () => {
+      const content = readFixture('wrong-format.json')
+      const result = parseBuildInfo(content, '/test/wrong-format.json')
+
+      expect(result).toBeNull()
+    })
+
+    it('should return null for build-info with no contracts', () => {
+      const content = readFixture('no-contracts-buildinfo.json')
+      const result = parseBuildInfo(content, '/test/no-contracts-buildinfo.json')
+
+      expect(result).toBeNull()
+    })
+
+    it('should skip contracts with invalid bytecode', () => {
+      const content = readFixture('invalid-bytecode-buildinfo.json')
+      const result = parseBuildInfo(content, '/test/invalid-bytecode-buildinfo.json')
+
+      expect(result).not.toBeNull()
+      expect(result).toHaveLength(1) // Only one valid contract should be extracted
+      expect(result![0].contractName).toBe('ValidContract')
+    })
+
+    it('should include source content when available', () => {
+      const content = readFixture('simple-buildinfo.json')
+      const result = parseBuildInfo(content, '/test/simple-buildinfo.json')
+
+      expect(result).not.toBeNull()
+      expect(result![0].source).toContain('contract Counter')
+    })
+  })
+
+  describe('extractedContractToArtifact function', () => {
+    it('should convert ExtractedContract to Artifact format', () => {
+      const content = readFixture('simple-buildinfo.json')
+      const contracts = parseBuildInfo(content, '/test/simple-buildinfo.json')
+      
+      expect(contracts).not.toBeNull()
+      const extracted = contracts![0]
+      const artifact = extractedContractToArtifact(extracted)
+
+      expect(artifact.contractName).toBe(extracted.contractName)
+      expect(artifact.abi).toBe(extracted.abi)
+      expect(artifact.bytecode).toBe(extracted.bytecode)
+      expect(artifact.deployedBytecode).toBe(extracted.deployedBytecode)
+      expect(artifact.sourceName).toBe(extracted.sourceName)
+      expect(artifact.source).toBe(extracted.source)
+      expect(artifact.compiler).toBe(extracted.compiler)
+      
+      // Should not have build-info specific fields
+      expect(artifact).not.toHaveProperty('buildInfoId')
+      expect(artifact).not.toHaveProperty('fullyQualifiedName')
+    })
+  })
+}) 

package/src/lib/parsers/__tests__/fixtures/buildinfo/invalid-bytecode-buildinfo.json

@@ -0,0 +1,62 @@
+{
+  "_format": "hh-sol-build-info-1",
+  "id": "invalid123456789012345678901234567890abcd",
+  "solcVersion": "0.8.30",
+  "solcLongVersion": "0.8.30+commit.8fe82020",
+  "input": {
+    "language": "Solidity",
+    "sources": {
+      "src/ValidContract.sol": {
+        "content": "pragma solidity 0.8.30; contract ValidContract {}"
+      },
+      "src/InvalidContract.sol": {
+        "content": "pragma solidity 0.8.30; contract InvalidContract {}"
+      }
+    },
+    "settings": {
+      "outputSelection": {
+        "*": {
+          "*": ["abi", "evm.bytecode", "evm.deployedBytecode"]
+        }
+      }
+    }
+  },
+  "output": {
+    "contracts": {
+      "src/ValidContract.sol": {
+        "ValidContract": {
+          "abi": [],
+          "evm": {
+            "bytecode": {
+              "object": "0x608060405234801561001057600080fd5b50005b"
+            },
+            "deployedBytecode": {
+              "object": "0x608060405234801561001057600080fd5b50005b"
+            }
+          }
+        }
+      },
+      "src/InvalidContract.sol": {
+        "InvalidContract": {
+          "abi": [],
+          "evm": {
+            "bytecode": {
+              "object": "invalid_bytecode_without_0x_prefix"
+            },
+            "deployedBytecode": {
+              "object": "0x608060405234801561001057600080fd5b50005b"
+            }
+          }
+        }
+      }
+    },
+    "sources": {
+      "src/ValidContract.sol": {
+        "id": 0
+      },
+      "src/InvalidContract.sol": {
+        "id": 1
+      }
+    }
+  }
+} 

package/src/lib/parsers/__tests__/fixtures/buildinfo/invalid-json.txt

@@ -0,0 +1,2 @@
+This is not valid JSON at all!
+{ invalid: json, missing quotes 

package/src/lib/parsers/__tests__/fixtures/buildinfo/multi-contract-buildinfo.json

@@ -0,0 +1,89 @@
+{
+  "_format": "hh-sol-build-info-1",
+  "id": "abc123def456789012345678901234567890abcd",
+  "solcVersion": "0.8.30",
+  "solcLongVersion": "0.8.30+commit.8fe82020",
+  "input": {
+    "language": "Solidity",
+    "sources": {
+      "src/Token.sol": {
+        "content": "pragma solidity 0.8.30;\n\ncontract Token {\n  string public name = \"TestToken\";\n  uint256 public totalSupply = 1000;\n}"
+      },
+      "src/TokenFactory.sol": {
+        "content": "pragma solidity 0.8.30;\n\ncontract TokenFactory {\n  function createToken() external returns (address) {\n    // Factory logic here\n    return address(0);\n  }\n}"
+      }
+    },
+    "settings": {
+      "optimizer": {
+        "enabled": true,
+        "runs": 200
+      },
+      "outputSelection": {
+        "*": {
+          "*": ["abi", "evm.bytecode", "evm.deployedBytecode"]
+        }
+      }
+    }
+  },
+  "output": {
+    "contracts": {
+      "src/Token.sol": {
+        "Token": {
+          "abi": [
+            {
+              "type": "function",
+              "name": "name",
+              "inputs": [],
+              "outputs": [{"name": "", "type": "string", "internalType": "string"}],
+              "stateMutability": "view"
+            },
+            {
+              "type": "function",
+              "name": "totalSupply",
+              "inputs": [],
+              "outputs": [{"name": "", "type": "uint256", "internalType": "uint256"}],
+              "stateMutability": "view"
+            }
+          ],
+          "evm": {
+            "bytecode": {
+              "object": "0x608060405234801561001057600080fd5b50600436106100365760003560e01c806306fdde031461003b57806318160ddd14610059575b600080fd5b610043610077565b6040516100509190610100565b60405180910390f35b610061610115565b60405161006e9190610122565b60405180910390f35b60606040518060400160405280600981526020017f546573745f546f6b656e0000000000000000000000000000000000000000000081525090565b60006103e890505b90565b600081519050919050565b600082825260208201905092915050565b60005b8381101561015957808201518184015260208101905061013e565b83811115610168576000848401525b50505050565b6000601f19601f8301169050919050565b6000610186826101225b61019081610174565b9050919050565b60006020820190508181036000830152610197816101a0565b9050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b600060028204905060018216806101d957607f821691505b602082108114156101ed576101ec6101a2565b5b5091905056fea2646970667358221220d4c6f7e4b8f9a5d8c2b1a0e9f8d7c6b5a4938271605948372819465730384756464736f6c634300081e0033"
+            },
+            "deployedBytecode": {
+              "object": "0x608060405234801561001057600080fd5b50600436106100365760003560e01c806306fdde031461003b57806318160ddd14610059575b600080fd5b610043610077565b6040516100509190610100565b60405180910390f35b610061610115565b60405161006e9190610122565b60405180910390f35b60606040518060400160405280600981526020017f546573745f546f6b656e0000000000000000000000000000000000000000000081525090565b60006103e890505b90565b600081519050919050565b600082825260208201905092915050565b60005b8381101561015957808201518184015260208101905061013e565b83811115610168576000848401525b50505050565b6000601f19601f8301169050919050565b6000610186826101225b61019081610174565b9050919050565b60006020820190508181036000830152610197816101a0565b9050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b600060028204905060018216806101d957607f821691505b602082108114156101ed576101ec6101a2565b5b5091905056fea2646970667358221220e5d7f6e4b8f9a5d8c2b1a0e9f8d7c6b5a4938271605948372819465730384756464736f6c634300081e0033"
+            }
+          }
+        }
+      },
+      "src/TokenFactory.sol": {
+        "TokenFactory": {
+          "abi": [
+            {
+              "type": "function",
+              "name": "createToken",
+              "inputs": [],
+              "outputs": [{"name": "", "type": "address", "internalType": "address"}],
+              "stateMutability": "nonpayable"
+            }
+          ],
+          "evm": {
+            "bytecode": {
+              "object": "0x608060405234801561001057600080fd5b50600436106100295760003560e01c8063c63a5b6d1461002e575b600080fd5b61003661004c565b60405161004391906100a1565b60405180910390f35b60006000905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b600061007f82610054565b9050919050565b61008f81610074565b82525050565b60006020820190506100aa6000830184610086565b92915050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b600060028204905060018216806100f857607f821691505b6020821081141561010c5761010b6100b1565b5b5091905056fea2646970667358221220e5d7f6e4b8f9a5d8c2b1a0e9f8d7c6b5a4938271605948372819465730384756464736f6c634300081e0033"
+            },
+            "deployedBytecode": {
+              "object": "0x608060405234801561001057600080fd5b50600436106100295760003560e01c8063c63a5b6d1461002e575b600080fd5b61003661004c565b60405161004391906100a1565b60405180910390f35b60006000905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b600061007f82610054565b9050919050565b61008f81610074565b82525050565b60006020820190506100aa6000830184610086565b92915050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b600060028204905060018216806100f857607f821691505b6020821081141561010c5761010b6100b1565b5b5091905056fea2646970667358221220e5d7f6e4b8f9a5d8c2b1a0e9f8d7c6b5a4938271605948372819465730384756464736f6c634300081e0033"
+            }
+          }
+        }
+      }
+    },
+    "sources": {
+      "src/Token.sol": {
+        "id": 0
+      },
+      "src/TokenFactory.sol": {
+        "id": 1
+      }
+    }
+  }
+} 

package/src/lib/parsers/__tests__/fixtures/buildinfo/no-contracts-buildinfo.json

@@ -0,0 +1,17 @@
+{
+  "_format": "hh-sol-build-info-1",
+  "id": "000000000000000000000000000000000000000000000000000000000000000",
+  "solcVersion": "0.8.30",
+  "solcLongVersion": "0.8.30+commit.8fe82020",
+  "input": {
+    "language": "Solidity",
+    "sources": {},
+    "settings": {
+      "outputSelection": {}
+    }
+  },
+  "output": {
+    "contracts": {},
+    "sources": {}
+  }
+} 

package/src/lib/parsers/__tests__/fixtures/buildinfo/simple-buildinfo.json

@@ -0,0 +1,63 @@
+{
+  "_format": "hh-sol-build-info-1",
+  "id": "901568e56d422b1e1e3f64004cb4dd6e",
+  "solcVersion": "0.8.30",
+  "solcLongVersion": "0.8.30+commit.8fe82020",
+  "input": {
+    "language": "Solidity",
+    "sources": {
+      "src/Counter.sol": {
+        "content": "pragma solidity 0.8.30;\n\ncontract Counter {\n  uint256 public count;\n  \n  function increment() external {\n    count++;\n  }\n  \n  function getCount() external view returns (uint256) {\n    return count;\n  }\n}"
+      }
+    },
+    "settings": {
+      "optimizer": {
+        "enabled": true,
+        "runs": 200
+      },
+      "outputSelection": {
+        "*": {
+          "*": ["abi", "evm.bytecode", "evm.deployedBytecode"]
+        }
+      }
+    }
+  },
+  "output": {
+    "contracts": {
+      "src/Counter.sol": {
+        "Counter": {
+          "abi": [
+            {
+              "type": "function",
+              "name": "increment",
+              "inputs": [],
+              "outputs": [],
+              "stateMutability": "nonpayable"
+            },
+            {
+              "type": "function",
+              "name": "getCount",
+              "inputs": [],
+              "outputs": [{"name": "", "type": "uint256", "internalType": "uint256"}],
+              "stateMutability": "view"
+            }
+          ],
+          "evm": {
+            "bytecode": {
+              "object": "0x608060405234801561001057600080fd5b50600436106100365760003560e01c8063a87d942c1461003b578063d09de08a14610059575b600080fd5b610043610063565b6040516100509190610084565b60405180910390f35b610061610069565b005b60005481565b600160008082825461007b919061009f565b92505081905550565b60005b8381101561009e5780820151818401526020810190506100835b50505050565b60008201905061009c565b60008219050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b600081905091905056fea2646970667358221220c4d6f7e4b8f9a5d8c2b1a0e9f8d7c6b5a4938271605948372819465730384756464736f6c634300081e0033",
+              "sourceMap": "25:194:0:-:0;;;67:1;44:24;;25:194;;;;;;"
+            },
+            "deployedBytecode": {
+              "object": "0x608060405234801561001057600080fd5b50600436106100365760003560e01c8063a87d942c1461003b578063d09de08a14610059575b600080fd5b610043610063565b6040516100509190610084565b60405180910390f35b610061610069565b005b60005481565b600160008082825461007b919061009f565b92505081905550565b60005b8381101561009e5780820151818401526020810190506100835b50505050565b60008201905061009c565b60008219050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b600081905091905056fea2646970667358221220c4d6f7e4b8f9a5d8c2b1a0e9f8d7c6b5a4938271605948372819465730384756464736f6c634300081e0033"
+            }
+          }
+        }
+      }
+    },
+    "sources": {
+      "src/Counter.sol": {
+        "id": 0
+      }
+    }
+  }
+} 

package/src/lib/parsers/__tests__/fixtures/buildinfo/wrong-format.json

@@ -0,0 +1,4 @@
+{
+  "_format": "wrong-format",
+  "someData": "this is not a build-info file"
+}