🪲 Fix issues with type literal size limits when exporting deployments (…

…#953)

.changeset/wise-onions-try.md

@@ -0,0 +1,5 @@
+---
+"@layerzerolabs/export-deployments": patch
+---
+
+Work around the compiler type literal limits

.dockerignore

@@ -11,6 +11,9 @@ docker-*.yaml
 .github
 .husky
 .turbo
+.netrc
+.env
+.env*
 
 # Misc
 *ignore

packages/export-deployments/src/generator/typescript/generate.ts

@@ -11,10 +11,14 @@ import {
     createExportConst,
     createIdentifier,
     createStringLiteral,
+    createTypeDeclaration,
+    createTypeOf,
+    createTypeReferenceNode,
     creteAsConst,
     normalizeIdentifierName,
     printTSFile,
     recordToObjectLiteral,
+    recordToRecordType,
     runtimeObjectToExpressionSafe,
 } from './typescript'
 import { OutputFile } from '../types'
@@ -111,6 +115,8 @@ const contractsInformationSafe = flow(
  */
 const createAbiIdentifier = (index: number) => createIdentifier(`abi${index}`)
 
+const createAbiTypeIdentifier = (index: number) => createIdentifier(`Abi${index}`)
+
 /**
  * Converts GroupedContractInformation into a TypeScript file contents string.
  *
@@ -146,12 +152,30 @@ const transformGroupedContractInformation = ({ addresses, abis, transactionHashe
                 E.map((declarations) => [
                     // We'll return all the variable declarations
                     ...declarations,
+                    // Then we'll add their types
+                    ...pipe(
+                        declarations,
+                        A.mapWithIndex((index) =>
+                            pipe(
+                                createTypeDeclaration()(createAbiTypeIdentifier(index))(
+                                    createTypeOf(createAbiIdentifier(index))
+                                )
+                            )
+                        )
+                    ),
+                    // Then we'll add the type of the 'abis' object
+                    pipe(
+                        abiIndexesByNetworkName,
+                        R.map(createAbiTypeIdentifier),
+                        recordToRecordType,
+                        createTypeDeclaration()(createIdentifier('Abis'))
+                    ),
                     // And we'll add an object export to map network names to the ABIs
                     pipe(
                         abiIndexesByNetworkName,
                         R.map(createAbiIdentifier),
                         recordToObjectLiteral,
-                        createExportConst('abis')
+                        createExportConst('abis', createTypeReferenceNode('Abis'))
                     ),
                 ])
             ),

packages/export-deployments/src/generator/typescript/typescript.ts

@@ -15,33 +15,42 @@ import {
     SyntaxKind,
     createPrinter,
     ListFormat,
+    Identifier,
+    TypeNode,
 } from 'typescript'
 import { stringify } from 'fp-ts/lib/Json'
 import { Ord } from 'fp-ts/lib/string'
 
 export const createConst =
     (modifiers: ModifierLike[] = []) =>
-    (name: string | BindingName) =>
+    (name: string | BindingName, type?: TypeNode) =>
     (expression: Expression) =>
         factory.createVariableStatement(
             modifiers,
             factory.createVariableDeclarationList(
-                [factory.createVariableDeclaration(name, undefined, undefined, expression)],
+                [factory.createVariableDeclaration(name, undefined, type, expression)],
                 NodeFlags.Const
             )
         )
 
+export const createTypeOf = factory.createTypeQueryNode
+
+export const createTypeReferenceNode = factory.createTypeReferenceNode
+
+export const createTypeDeclaration =
+    (modifiers: ModifierLike[] = []) =>
+    (name: Identifier) =>
+    (type: TypeNode) =>
+        factory.createTypeAliasDeclaration(modifiers, name, undefined, type)
+
 /**
  * Wraps an expression with "as const"
  *
  * @param {Expression} expression
  * @returns {Expression}
  */
 export const creteAsConst = (expression: Expression): Expression =>
-    factory.createAsExpression(
-        expression,
-        factory.createTypeReferenceNode(factory.createIdentifier('const'), undefined)
-    )
+    factory.createAsExpression(expression, createTypeReferenceNode(createIdentifier('const'), undefined))
 
 export const createIdentifier = factory.createIdentifier
 
@@ -70,6 +79,18 @@ export const recordToObjectLiteral = flow(
     (properties) => factory.createObjectLiteralExpression(properties, true)
 )
 
+export const recordToRecordType = flow(
+    R.collect(Ord)((key: string, value: Identifier) =>
+        factory.createPropertySignature(
+            undefined,
+            factory.createStringLiteral(key),
+            undefined,
+            createTypeReferenceNode(value)
+        )
+    ),
+    (properties) => factory.createTypeLiteralNode(properties)
+)
+
 /**
  * Parses a JSON string into TypeScript AST
  *