@subsquid/evm-typegen 3.3.0 → 4.0.1

package/src/typegen.ts

@@ -1,143 +1,260 @@
-import * as ethers from 'ethers'
-import {Logger} from '@subsquid/logger'
-import {def} from '@subsquid/util-internal'
-import {FileOutput, OutDir} from '@subsquid/util-internal-code-printer'
-import {getFullTupleType, getReturnType, getStructType, getTupleType, getType} from './util/types'
+import { Logger } from '@subsquid/logger'
+import { def } from '@subsquid/util-internal'
+import { keccak256 } from '@subsquid/evm-abi'
+import { getType } from './util/types'
+import type { Abi, AbiEvent, AbiFunction, AbiParameter } from 'abitype'
+import { FileOutput, OutDir } from '@subsquid/util-internal-code-printer'
 
+function areItemEqual(item1: AbiEvent | AbiFunction, item2: AbiEvent | AbiFunction): boolean {
+  if (item1.name !== item2.name || item1.inputs.length !== item2.inputs.length || item1.type !== item2.type) {
+    return false
+  }
+  return item1.inputs.every((input, idx) => {
+    const input2 = item2.inputs[idx]
+    return input.name === input2.name && input.type === input2.type
+  })
+}
 
 export class Typegen {
-    private out: FileOutput
+  private out: FileOutput
 
-    constructor(private dest: OutDir, private abi: ethers.Interface, private basename: string, private log: Logger) {
-        this.out = dest.file(basename + '.ts')
-    }
+  constructor(
+    dest: OutDir,
+    private abi: Abi,
+    basename: string,
+    private log: Logger,
+  ) {
+    this.out = dest.file(basename + '.ts')
+  }
+
+  async generate() {
+    this.out.line(`import * as p from '@subsquid/evm-codec'`)
+    this.out.line(
+      `import { event, fun, indexed, ContractBase } from '@subsquid/evm-abi'`,
+    )
+    this.out.line(
+      `import type { EventParams as EParams, FunctionArguments, FunctionReturn } from '@subsquid/evm-abi'`,
+    )
 
-    generate(): void {
-        this.out.line("import * as ethers from 'ethers'")
-        this.out.line("import {LogEvent, Func, ContractBase} from './abi.support'")
-        this.out.line(`import {ABI_JSON} from './${this.basename}.abi'`)
-        this.out.line()
-        this.out.line("export const abi = new ethers.Interface(ABI_JSON);")
+    this.generateEvents()
+    this.generateFunctions()
+    this.generateContract()
+    this.generateEventTypes()
+    this.generateFunctionTypes()
 
-        this.generateEvents()
-        this.generateFunctions()
-        this.generateContract()
+    await this.out.write()
+    this.log.info(`saved ${this.out.file}`)
+  }
 
-        this.writeAbi()
-        this.out.write()
-        this.log.info(`saved ${this.out.file}`)
+  private generateEvents() {
+    let events = this.getEvents()
+    if (events.length == 0) {
+      return
     }
+    this.out.line()
+    this.out.block(`export const events =`, () => {
+      for (let e of events) {
+        this.out.line(
+          `${this.getPropName(e)}: event("${this.topic0(e)}", {${this.toTypes(
+            e.inputs,
+          )}}),`,
+        )
+      }
+    })
+  }
 
-    private writeAbi() {
-        let out = this.dest.file(this.basename + '.abi.ts')
-        let json = this.abi.formatJson()
-        json = JSON.stringify(JSON.parse(json), null, 4)
-        out.line(`export const ABI_JSON = ${json}`)
-        out.write()
-        this.log.info(`saved ${out.file}`)
+  private topic0(e: AbiEvent): string {
+    return `0x${keccak256(this.sighash(e)).toString('hex')}`
+  }
+
+  private toTypes(inputs: readonly AbiParameter[]): string {
+    return inputs.map((input, idx) => getType(input, idx)).join(', ')
+  }
+
+  private generateFunctions() {
+    let functions = this.getFunctions()
+    if (functions.length == 0) {
+      return
     }
+    this.out.line()
+    this.out.block(`export const functions =`, () => {
+      for (let f of functions) {
+        let returnType = ''
+        if (f.outputs?.length === 1) {
+          returnType = getType({ ...f.outputs[0], name: undefined })
+        }
+        if (f.outputs?.length > 1) {
+          returnType = `{${this.toTypes(f.outputs)}}`
+        }
+
+        this.out.line(
+          `${this.getPropName(f)}: fun("${this.functionSelector(
+            f,
+          )}", {${this.toTypes(f.inputs)}}, ${returnType}),`,
+        )
+      }
+    })
+  }
+
+  private functionSelector(f: AbiFunction): string {
+    const sighash = this.sighash(f)
+    return `0x${keccak256(sighash).slice(0, 4).toString('hex')}`
+  }
 
-    private generateEvents() {
-        let events = this.getEvents()
-        if (events.length == 0) {
-            return
+  private generateContract() {
+    this.out.line()
+    this.out.block(`export class Contract extends ContractBase`, () => {
+      let functions = this.getFunctions()
+      for (let f of functions) {
+        if ((f.stateMutability === 'pure' || f.stateMutability === 'view') &&
+          f.outputs?.length
+        ) {
+          this.out.line()
+          let argNames = f.inputs.map((a, idx) => a.name || `_${idx}`)
+          const ref = this.getPropNameGetter(f)
+          const [argsType] = this.toFunctionTypes(f)
+          let args = f.inputs
+            .map(
+              (a, idx) =>
+                `${argNames[idx]}: ${argsType}["${argNames[idx]}"]`,
+            )
+            .join(', ')
+          this.out.block(`${this.getPropName(f)}(${args})`, () => {
+            this.out.line(
+              `return this.eth_call(functions${ref}, {${argNames.join(', ')}})`,
+            )
+          })
         }
-        this.out.line()
-        this.out.block(`export const events =`, () => {
-            for (let e of events) {
-                this.out.line(`${this.getPropName(e)}: new LogEvent<${getFullTupleType(e.inputs)}>(`)
-                this.out.indentation(() => this.out.line(`abi, '${e.topicHash}'`))
-                this.out.line('),')
-            }
-        })
+      }
+    })
+  }
+
+  private cannonicalType(param: AbiParameter): string {
+    if (!param.type.startsWith('tuple')) {
+      return param.type
     }
+    const arrayBrackets = param.type.slice(5)
+    return `(${(param as any).components.map((param: AbiParameter) =>
+      this.cannonicalType(param),
+    )})${arrayBrackets}`
+  }
 
-    private generateFunctions() {
-        let functions = this.getFunctions()
-        if (functions.length == 0) {
-            return
-        }
-        this.out.line()
-        this.out.block(`export const functions =`, () => {
-            for (let f of functions) {
-                let sighash = f.selector
-                let pArgs = getTupleType(f.inputs)
-                let pArgStruct = getStructType(f.inputs)
-                let pResult = getReturnType(f.outputs)
-                this.out.line(`${this.getPropName(f)}: new Func<${pArgs}, ${pArgStruct}, ${pResult}>(`)
-                this.out.indentation(() => this.out.line(`abi, '${sighash}'`))
-                this.out.line('),')
-            }
-        })
+  private sighash(item: AbiEvent | AbiFunction): string {
+    return `${item.name}(${item.inputs
+      .map((param) => this.cannonicalType(param))
+      .join(',')})`
+  }
+
+  private getPropName(item: AbiEvent | AbiFunction): string {
+    if (this.getOverloads(item) == 1) {
+      return item.name
+    } else {
+      return `"${this.sighash(item)}"`
     }
+  }
 
-    private generateContract() {
-        this.out.line()
-        this.out.block(`export class Contract extends ContractBase`, () => {
-            let functions = this.getFunctions()
-            for (let f of functions) {
-                if (f.constant && f.outputs?.length) {
-                    this.out.line()
-                    let argNames = f.inputs.map((a, idx) => a.name || `arg${idx}`)
-                    let args  = f.inputs.map((a, idx) => `${argNames[idx]}: ${getType(a)}`).join(', ')
-                    this.out.block(`${this.getPropName(f)}(${args}): Promise<${getReturnType(f.outputs)}>`, () => {
-                        this.out.line(`return this.eth_call(functions${this.getRef(f)}, [${argNames.join(', ')}])`)
-                    })
-                }
-            }
-        })
+  private getPropNameGetter(item: AbiEvent | AbiFunction): string {
+    if (this.getOverloads(item) == 1) {
+      return '.' + item.name
+    } else {
+      return `["${this.sighash(item)}"]`
     }
+  }
 
-    private getRef(item: ethers.EventFragment | ethers.FunctionFragment): string {
-        let key = this.getPropName(item)
-        if (key[0] == "'") {
-            return `[${key}]`
-        } else {
-            return '.' + key
-        }
+  private getOverloads(item: AbiEvent | AbiFunction): number {
+    if (item.type === 'event') {
+      return this.eventOverloads()[item.name]
+    } else {
+      return this.functionOverloads()[item.name]
     }
+  }
 
-    private getPropName(item: ethers.EventFragment | ethers.FunctionFragment): string {
-        if (this.getOverloads(item) == 1) {
-            return item.name
-        } else {
-            return `'${item.format('sighash')}'`
-        }
+  private capitalize(s: string): string {
+    return s.charAt(0).toUpperCase() + s.slice(1)
+  }
+
+  private getOverloadIndex(item: AbiEvent | AbiFunction): number {
+    const abi = [...this.getEvents(), ...this.getFunctions()]
+    const overloads = abi.filter((x) => x.name === item.name)
+    return overloads.findIndex((x) => areItemEqual(x, item))
+  }
+
+  private toEventType(e: AbiEvent): string {
+    if (this.getOverloads(e) === 1) {
+      return `${this.capitalize(e.name)}EventArgs`
     }
+    const index = this.getOverloadIndex(e)
+    return `${this.capitalize(e.name)}EventArgs_${index}`
+  }
 
-    private getOverloads(item: ethers.EventFragment | ethers.FunctionFragment): number {
-        if (item instanceof ethers.EventFragment) {
-            return this.eventOverloads()[item.name]
-        } else {
-            return this.functionOverloads()[item.name]
-        }
+  private generateEventTypes() {
+    const events = this.getEvents()
+    if (events.length == 0) {
+      return
+    }
+    this.out.line()
+    this.out.line(`/// Event types`)
+    for (let e of events) {
+      const propName = this.getPropNameGetter(e)
+      this.out.line(
+        `export type ${this.toEventType(e)} = EParams<typeof events${propName}>`,
+      )
     }
+  }
 
-    @def
-    private functionOverloads(): Record<string, number> {
-        let overloads: Record<string, number> = {}
-        for (let item of this.getFunctions()) {
-            overloads[item.name] = (overloads[item.name] || 0) + 1
-        }
-        return overloads
+  private toFunctionTypes(f: AbiFunction): [string, string] {
+    if (this.getOverloads(f) === 1) {
+      return [`${this.capitalize(f.name)}Params`, `${this.capitalize(f.name)}Return`]
     }
+    const index = this.getOverloadIndex(f)
+    return [`${this.capitalize(f.name)}Params_${index}`, `${this.capitalize(f.name)}Return_${index}`]
+  }
 
-    @def
-    private eventOverloads(): Record<string, number> {
-        let overloads: Record<string, number> = {}
-        for (let item of this.getEvents()) {
-            overloads[item.name] = (overloads[item.name] || 0) + 1
-        }
-        return overloads
+  private generateFunctionTypes() {
+    let functions = this.getFunctions()
+    if (functions.length == 0) {
+      return
+    }
+    this.out.line()
+    this.out.line(`/// Function types`)
+    for (let f of functions) {
+      const propName = this.getPropNameGetter(f)
+      const [args, ret] = this.toFunctionTypes(f)
+      this.out.line(
+        `export type ${args} = FunctionArguments<typeof functions${propName}>`,
+      )
+      this.out.line(
+        `export type ${ret} = FunctionReturn<typeof functions${propName}>`,
+      )
+      this.out.line()
     }
+  }
 
-    @def
-    private getFunctions(): ethers.FunctionFragment[] {
-        return this.abi.fragments.filter(f => f.type === 'function') as ethers.FunctionFragment[]
+  @def
+  private functionOverloads(): Record<string, number> {
+    let overloads: Record<string, number> = {}
+    for (let item of this.getFunctions()) {
+      overloads[item.name] = (overloads[item.name] || 0) + 1
     }
+    return overloads
+  }
 
-    @def
-    private getEvents(): ethers.EventFragment[] {
-        return this.abi.fragments.filter(f => f.type === 'event') as ethers.EventFragment[]
+  @def
+  private eventOverloads(): Record<string, number> {
+    let overloads: Record<string, number> = {}
+    for (let item of this.getEvents()) {
+      overloads[item.name] = (overloads[item.name] || 0) + 1
     }
+    return overloads
+  }
+
+  @def
+  private getFunctions(): AbiFunction[] {
+    return this.abi.filter((f) => f.type === 'function') as AbiFunction[]
+  }
+
+  @def
+  private getEvents(): AbiEvent[] {
+    return this.abi.filter((f) => f.type === 'event') as AbiEvent[]
+  }
 }

package/src/util/fetch.ts

@@ -1,13 +1,11 @@
-import {createLogger} from '@subsquid/logger'
-import {HttpClient} from '@subsquid/http-client'
-
+import { createLogger } from '@subsquid/logger'
+import { HttpClient } from '@subsquid/http-client'
 
 const http = new HttpClient({
-    log: createLogger('sqd:evm-typegen:fetch'),
-    retryAttempts: 3
+  log: createLogger('sqd:evm-typegen:fetch'),
+  retryAttempts: 3,
 })
 
-
-export function GET<T=any>(url: string): Promise<T> {
-    return http.get(url)
+export function GET<T = any>(url: string): Promise<T> {
+  return http.get(url)
 }

package/src/util/types.ts

@@ -1,72 +1,54 @@
-import assert from 'assert'
-import type {ParamType} from 'ethers'
+import type { AbiEventParameter } from 'abitype'
 
-
-// taken from: https://github.com/ethers-io/ethers.js/blob/948f77050dae884fe88932fd88af75560aac9d78/packages/cli/src.ts/typescript.ts#L10
-export function getType(param: ParamType): string {
-    if (param.baseType === 'array') {
-        assert(param.arrayChildren != null, 'Missing children for array type')
-        return 'Array<' + getType(param.arrayChildren) + '>'
-    }
-
-    if (param.baseType === 'tuple') {
-        assert(param.components != null, 'Missing components for tuple type')
-        return getFullTupleType(param.components)
-    }
-
-    if (param.type === 'address' || param.type === 'string') {
-        return 'string'
-    }
-
-    if (param.type === 'bool') {
-        return 'boolean'
-    }
-
-    let match = param.type.match(/^(u?int)([0-9]+)$/)
-    if (match) {
-        return parseInt(match[2]) < 53 ? 'number' : 'bigint'
-    }
-
-    if (param.type.substring(0, 5) === 'bytes') {
-        return 'string'
-    }
-
-    throw new Error('unknown type')
+function isStaticArray(param: AbiEventParameter) {
+  return param.type.match(/\[\d+]$/)
 }
 
-
-export function getFullTupleType(params: ReadonlyArray<ParamType>): string {
-    let tuple = getTupleType(params)
-    let struct = getStructType(params)
-    if (struct == '{}') {
-        return tuple
-    } else {
-        return `(${tuple} & ${struct})`
-    }
+function isDynamicArray(param: AbiEventParameter) {
+  return param.type.endsWith('[]')
 }
 
-
-export function getTupleType(params: ReadonlyArray<ParamType>): string {
-    return '[' + params.map(p => {
-        return p.name ? `${p.name}: ${getType(p)}` : `_: ${getType(p)}`
-    }).join(', ') + ']'
+function elementsCount(param: AbiEventParameter) {
+  return Number(param.type.match(/\[(\d+)]$/)?.[1] ?? 0)
 }
 
-
-// https://github.com/ethers-io/ethers.js/blob/278f84174409b470fa7992e1f8b5693e6e5d2dac/src.ts/abi/coders/tuple.ts#L36
-export function getStructType(params: ReadonlyArray<ParamType>): string {
-    let array: any = []
-    let counts: Record<string, number> = {}
-    for (let p of params) {
-        if (p.name && array[p.name] == null) {
-            counts[p.name] = (counts[p.name] || 0) + 1
-        }
-    }
-    let fields = params.filter(p => counts[p.name] == 1)
-    return '{' + fields.map(f => `${f.name}: ${getType(f)}`).join(', ') + '}'
+function arrayChildType(param: AbiEventParameter) {
+  return param.type.replace(/\[\d*]$/, '')
 }
 
-
-export function getReturnType(outputs: ReadonlyArray<ParamType>) {
-    return outputs.length == 1 ? getType(outputs[0]) : getFullTupleType(outputs)
+export function getType(param: AbiEventParameter, index?: number): string {
+  const { name, ...namelessParam } = param
+
+  if (name) {
+    return `"${name}": ${getType(namelessParam as any)}`
+  }
+
+  if (index !== undefined) {
+    return `"_${index}": ${getType(namelessParam)}`
+  }
+
+  const { indexed, ...indexlessParam } = param
+  if (indexed) {
+    return `indexed(${getType(indexlessParam as any)})`
+  }
+  if (isStaticArray(param)) {
+    const elements = elementsCount(param)
+    return `p.fixedSizeArray(${getType({
+      ...param,
+      type: arrayChildType(param),
+    })}, ${elements})`
+  }
+
+  if (isDynamicArray(param)) {
+    return `p.array(${getType({
+      ...param,
+      type: arrayChildType(param),
+    })})`
+  }
+
+  if (param.type === 'tuple') {
+    return `p.struct({${(param as any).components.map((type: AbiEventParameter, idx: number) => getType(type, idx)).join(', ')}})`
+  }
+
+  return `p.${param.type}`
 }

package/lib/abi.support.d.ts

@@ -1,57 +0,0 @@
-import * as ethers from 'ethers';
-export interface EventRecord {
-    topics: string[];
-    data: string;
-}
-export type LogRecord = EventRecord;
-export declare class LogEvent<Args> {
-    private abi;
-    readonly topic: string;
-    private fragment;
-    constructor(abi: ethers.Interface, topic: string);
-    is(rec: EventRecord): boolean;
-    decode(rec: EventRecord): Args;
-}
-export interface FuncRecord {
-    sighash?: string;
-    input: string;
-}
-export declare class Func<Args extends any[], FieldArgs, Result> {
-    private abi;
-    readonly sighash: string;
-    private fragment;
-    constructor(abi: ethers.Interface, sighash: string);
-    is(rec: FuncRecord): boolean;
-    decode(input: ethers.BytesLike): Args & FieldArgs;
-    decode(rec: FuncRecord): Args & FieldArgs;
-    encode(args: Args): string;
-    decodeResult(output: ethers.BytesLike): Result;
-    tryDecodeResult(output: ethers.BytesLike): Result | undefined;
-}
-export declare function isFunctionResultDecodingError(val: unknown): val is Error & {
-    data: string;
-};
-export interface ChainContext {
-    _chain: Chain;
-}
-export interface BlockContext {
-    _chain: Chain;
-    block: Block;
-}
-export interface Block {
-    height: number;
-}
-export interface Chain {
-    client: {
-        call: <T = any>(method: string, params?: unknown[]) => Promise<T>;
-    };
-}
-export declare class ContractBase {
-    private readonly _chain;
-    private readonly blockHeight;
-    readonly address: string;
-    constructor(ctx: BlockContext, address: string);
-    constructor(ctx: ChainContext, block: Block, address: string);
-    eth_call<Args extends any[], FieldArgs, Result>(func: Func<Args, FieldArgs, Result>, args: Args): Promise<Result>;
-}
-//# sourceMappingURL=abi.support.d.ts.map

package/lib/abi.support.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"abi.support.d.ts","sourceRoot":"","sources":["../src/abi.support.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACf;AACD,MAAM,MAAM,SAAS,GAAG,WAAW,CAAA;AAEnC,qBAAa,QAAQ,CAAC,IAAI;IAGV,OAAO,CAAC,GAAG;aAAoC,KAAK,EAAE,MAAM;IAFxE,OAAO,CAAC,QAAQ,CAAsB;gBAElB,GAAG,EAAE,MAAM,CAAC,SAAS,EAAkB,KAAK,EAAE,MAAM;IAMxE,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO;IAI7B,MAAM,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;CAGjC;AAED,MAAM,WAAW,UAAU;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,qBAAa,IAAI,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM;IAGvC,OAAO,CAAC,GAAG;aAAoC,OAAO,EAAE,MAAM;IAF1E,OAAO,CAAC,QAAQ,CAAyB;gBAErB,GAAG,EAAE,MAAM,CAAC,SAAS,EAAkB,OAAO,EAAE,MAAM;IAM1E,EAAE,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO;IAK5B,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,SAAS;IACjD,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI,GAAG,SAAS;IAMzC,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAI1B,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,GAAG,MAAM;IAK9C,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,GAAG,MAAM,GAAG,SAAS;CAOhE;AAGD,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,KAAK,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAOzF;AAGD,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,KAAK,CAAA;CAChB;AAGD,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,KAAK,CAAA;IACb,KAAK,EAAE,KAAK,CAAA;CACf;AAGD,MAAM,WAAW,KAAK;IAClB,MAAM,EAAE,MAAM,CAAA;CACjB;AAGD,MAAM,WAAW,KAAK;IAClB,MAAM,EAAG;QACL,IAAI,EAAE,CAAC,CAAC,GAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;KAClE,CAAA;CACJ;AAGD,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAO;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEZ,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM;gBAClC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM;IAetD,QAAQ,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;CAQ1H"}