feat: support local solidity imports (#29)

Author: Markeljan

README.md

@@ -41,3 +41,7 @@ bun install
 ```bash
 bun dev
 ```
+
+## Deploying Contracts with Local Imports
+
+Web3GPT now supports deploying factory contracts that rely on local Solidity imports. Provide additional source files alongside your main contract and reference them with relative paths (e.g., `import "./AddressBook.sol";`). The compiler will include these dependencies automatically, enabling factory patterns without flattening contracts.

lib/actions/deploy-contract.ts

@@ -8,8 +8,16 @@ import { withUser } from "@/lib/data/kv"
 import { getContractFileName, prepareContractSources } from "@/lib/solidity/utils"
 import { ensureHashPrefix } from "@/lib/utils"
 
-export async function compileContract({ contractName, sourceCode }: { contractName: string; sourceCode: string }) {
-  const sources = await prepareContractSources(contractName, sourceCode)
+export async function compileContract({
+  contractName,
+  sourceCode,
+  sources: additionalSources,
+}: {
+  contractName: string
+  sourceCode: string
+  sources?: Record<string, string>
+}) {
+  const sources = await prepareContractSources(contractName, sourceCode, additionalSources)
   const standardJsonInputString = JSON.stringify({
     language: "Solidity",
     sources,

lib/hooks/use-wallet-deploy.ts

@@ -24,18 +24,24 @@ export function useWalletDeploy() {
       contractName,
       sourceCode,
       constructorArgs,
+      imports,
     }: {
       contractName: string
       sourceCode: string
       constructorArgs: Array<string>
+      imports?: Record<string, string>
     }) => {
       if (!viemChain || !walletClient || !address || !chainId) {
         return
       }
       const deployLoadingToast = toast.loading("Deploying contract...")
 
       try {
-        const { abi, bytecode, standardJsonInput, sources } = await compileContract({ contractName, sourceCode })
+        const { abi, bytecode, standardJsonInput, sources } = await compileContract({
+          contractName,
+          sourceCode,
+          sources: imports,
+        })
 
         const parsedConstructorArgs = constructorArgs.map((arg) => {
           if (arg.startsWith("[") && arg.endsWith("]") && arg.match(/(?<=\[)(?=[^"'])(.*)(?<=[^"'])(?=\])/g)) {

lib/solidity/deploy.ts

@@ -33,14 +33,19 @@ export const deployContract = async ({
   contractName,
   sourceCode,
   constructorArgs,
+  imports,
 }: DeployContractParams): Promise<DeployContractResult> => {
   const viemChain = getChainById(Number(chainId))
 
   if (!viemChain) {
     throw new Error(`Chain ${chainId} not found`)
   }
 
-  const { abi, bytecode, standardJsonInput, sources } = await compileContract({ contractName, sourceCode })
+  const { abi, bytecode, standardJsonInput, sources } = await compileContract({
+    contractName,
+    sourceCode,
+    sources: imports,
+  })
 
   const walletClient = createWalletClient({
     account: DEPLOYER_ACCOUNT,

lib/solidity/utils.ts

@@ -1,12 +1,16 @@
 // Recursive function to resolve imports in a source code.  Fetches the source code of the imports one by one and returns the final source code with all imports resolved and urls / aliases replaced with relative paths.
-export async function resolveImports(sourceCode: string, sourcePath?: string) {
+export async function resolveImports(sourceCode: string, sourcePath?: string, localSources?: Record<string, string>) {
   const sources: { [fileName: string]: { content: string } } = {}
   const importRegex = /import\s+(?:{[^}]+}\s+from\s+)?["']([^"']+)["'];/g
   const matches = Array.from(sourceCode.matchAll(importRegex))
   let sourceCodeWithImports = sourceCode
   for (const match of matches) {
     const importPath = match[1]
-    const { sources: importedSources, sourceCode: mainSourceCode } = await fetchImport(importPath, sourcePath)
+    const { sources: importedSources, sourceCode: mainSourceCode } = await fetchImport(
+      importPath,
+      sourcePath,
+      localSources,
+    )
 
     // Merge the imported sources into the main sources object
     Object.assign(sources, importedSources)
@@ -21,12 +25,26 @@ export async function resolveImports(sourceCode: string, sourcePath?: string) {
     sources[sourceFileName] = {
       content: mainSourceCode,
     }
-    sourceCodeWithImports = sourceCode.replace(match[0], `import "${sourceFileName}";`)
+    sourceCodeWithImports = sourceCodeWithImports.replace(match[0], `import "${sourceFileName}";`)
   }
   return { sources, sourceCode: sourceCodeWithImports }
 }
 
-async function fetchImport(importPath: string, sourcePath?: string) {
+async function fetchImport(importPath: string, sourcePath?: string, localSources?: Record<string, string>) {
+  // Check if the import exists in provided local sources
+  if (localSources) {
+    let localPath = importPath
+    if (importPath[0] === "." && sourcePath) {
+      localPath = resolveImportPath(importPath, sourcePath)
+    }
+    localPath = localPath.replace(/^\.\//, "")
+    if (localSources[localPath]) {
+      const importedSource = localSources[localPath]
+      const { sources, sourceCode } = await resolveImports(importedSource, localPath, localSources)
+      return { sources, sourceCode }
+    }
+  }
+
   // Determine the URL to fetch
   let urlToFetch: string
   if (importPath[0] === "." && sourcePath) {
@@ -55,7 +73,7 @@ async function fetchImport(importPath: string, sourcePath?: string) {
   const importedSource = await response.text()
 
   // Handle any imports within the fetched source code
-  const { sources, sourceCode } = await resolveImports(importedSource, urlToFetch)
+  const { sources, sourceCode } = await resolveImports(importedSource, urlToFetch, localSources)
 
   return { sources, sourceCode }
 }
@@ -88,10 +106,14 @@ export const getContractFileName = (contractName: string): string => {
   return `${contractName.replace(/[/\\:*?"<>|.\s]+$/g, "_")}.sol`
 }
 
-export async function prepareContractSources(contractName: string, sourceCode: string) {
+export async function prepareContractSources(
+  contractName: string,
+  sourceCode: string,
+  localSources?: Record<string, string>,
+) {
   const fileName = getContractFileName(contractName)
 
-  const handleImportsResult = await resolveImports(sourceCode)
+  const handleImportsResult = await resolveImports(sourceCode, fileName, localSources)
 
   const sources = {
     [fileName]: {

lib/types.ts

@@ -49,6 +49,7 @@ export type DeployContractParams = {
   contractName: string
   sourceCode: string
   constructorArgs: Array<string | string[]>
+  imports?: Record<string, string>
 }
 
 export type DeployContractResult = {