@tevm/compiler/src/types.ts

Utilities around compiler

import type { ResolvedCompilerConfig } from '@tevm/config'
import type { ModuleInfo } from '@tevm/resolutions'
import type { SolcContractOutput, SolcInputDescription, SolcOutput } from '@tevm/solc'
import type { Node } from 'solidity-ast/node.js'

export type ResolvedArtifacts = {
	artifacts: Artifacts
	modules: Record<string, ModuleInfo>
	asts?: Record<string, Node> | undefined
	solcInput?: SolcInputDescription | undefined
	solcOutput?: SolcOutput | undefined
}

export type ResolveArtifacts = (
	solFile: string,
	basedir: string,
	logger: Logger,
	config: ResolvedCompilerConfig,
	includeAst: boolean,
	includeBytecode: boolean,
	fao: FileAccessObject,
	solc: any,
) => Promise<ResolvedArtifacts>

export type ResolveArtifactsSync = (
	solFile: string,
	basedir: string,
	logger: Logger,
	config: ResolvedCompilerConfig,
	includeAst: boolean,
	includeBytecode: boolean,
	fao: FileAccessObject,
	solc: any,
) => ResolvedArtifacts

export type FileAccessObject = {
	readFile: (path: string, encoding: BufferEncoding) => Promise<string>
	readFileSync: (path: string, encoding: BufferEncoding) => string
	existsSync: (path: string) => boolean
	exists: (path: string) => Promise<boolean>
}

export type Logger = {
	info: (...messages: string[]) => void
	error: (...message: string[]) => void
	warn: (...message: string[]) => void
	log: (...message: string[]) => void
}

export type { ModuleInfo, SolcInputDescription, SolcOutput, SolcContractOutput }

export type CompiledContracts<TIncludeAsts extends boolean = boolean> = {
	artifacts: SolcOutput['contracts'][string] | undefined
	modules: Record<string, ModuleInfo>
	asts: TIncludeAsts extends true ? Record<string, Node> : undefined
	solcInput?: SolcInputDescription
	solcOutput?: SolcOutput
}

export type Artifacts = Record<string, Pick<SolcContractOutput, 'abi' | 'userdoc' | 'evm'> & { contractName: string }>