Add support for user defined type values

Author: fvictorio

antlr

@@ -730,6 +730,18 @@ export class ASTBuilder
     return this._addMeta(node, ctx)
   }
 
+  public visitTypeDefinition(
+    ctx: SP.TypeDefinitionContext
+  ): AST.TypeDefinition & WithMeta {
+    const node: AST.TypeDefinition = {
+      type: 'TypeDefinition',
+      name: this._toText(ctx.identifier()),
+      definition: this.visitElementaryTypeName(ctx.elementaryTypeName())
+    }
+
+    return this._addMeta(node, ctx)
+  }
+
   public visitRevertStatement(
     ctx: SP.RevertStatementContext
   ): AST.RevertStatement & WithMeta {

src/ASTBuilder.ts

@@ -19,6 +19,7 @@ import { ContractPartContext } from "./SolidityParser";
 import { StateVariableDeclarationContext } from "./SolidityParser";
 import { FileLevelConstantContext } from "./SolidityParser";
 import { CustomErrorDefinitionContext } from "./SolidityParser";
+import { TypeDefinitionContext } from "./SolidityParser";
 import { UsingForDeclarationContext } from "./SolidityParser";
 import { StructDefinitionContext } from "./SolidityParser";
 import { ModifierDefinitionContext } from "./SolidityParser";
@@ -282,6 +283,17 @@ export interface SolidityListener extends ParseTreeListener {
 	 */
 	exitCustomErrorDefinition?: (ctx: CustomErrorDefinitionContext) => void;
 
+	/**
+	 * Enter a parse tree produced by `SolidityParser.typeDefinition`.
+	 * @param ctx the parse tree
+	 */
+	enterTypeDefinition?: (ctx: TypeDefinitionContext) => void;
+	/**
+	 * Exit a parse tree produced by `SolidityParser.typeDefinition`.
+	 * @param ctx the parse tree
+	 */
+	exitTypeDefinition?: (ctx: TypeDefinitionContext) => void;
+
 	/**
 	 * Enter a parse tree produced by `SolidityParser.usingForDeclaration`.
 	 * @param ctx the parse tree

src/antlr/Solidity.interp

@@ -19,6 +19,7 @@ import { ContractPartContext } from "./SolidityParser";
 import { StateVariableDeclarationContext } from "./SolidityParser";
 import { FileLevelConstantContext } from "./SolidityParser";
 import { CustomErrorDefinitionContext } from "./SolidityParser";
+import { TypeDefinitionContext } from "./SolidityParser";
 import { UsingForDeclarationContext } from "./SolidityParser";
 import { StructDefinitionContext } from "./SolidityParser";
 import { ModifierDefinitionContext } from "./SolidityParser";
@@ -221,6 +222,13 @@ export interface SolidityVisitor<Result> extends ParseTreeVisitor<Result> {
 	 */
 	visitCustomErrorDefinition?: (ctx: CustomErrorDefinitionContext) => Result;
 
+	/**
+	 * Visit a parse tree produced by `SolidityParser.typeDefinition`.
+	 * @param ctx the parse tree
+	 * @return the visitor result
+	 */
+	visitTypeDefinition?: (ctx: TypeDefinitionContext) => Result;
+
 	/**
 	 * Visit a parse tree produced by `SolidityParser.usingForDeclaration`.
 	 * @param ctx the parse tree

src/antlr/SolidityListener.ts

@@ -119,6 +119,7 @@ export const astNodeTypes = [
   'CatchClause',
   'FileLevelConstant',
   'AssemblyMemberAccess',
+  'TypeDefinition'
 ] as const
 
 export type ASTNodeTypeString = typeof astNodeTypes[number]
@@ -188,11 +189,19 @@ export interface FunctionDefinition extends BaseASTNode {
   isFallback: boolean
   isVirtual: boolean
 }
+
 export interface CustomErrorDefinition extends BaseASTNode {
   type: 'CustomErrorDefinition'
   name: string
   parameters: VariableDeclaration[]
 }
+
+export interface TypeDefinition extends BaseASTNode {
+  type: 'TypeDefinition'
+  name: string
+  definition: ElementaryTypeName
+}
+
 export interface RevertStatement extends BaseASTNode {
   type: 'RevertStatement'
   revertCall: FunctionCall
@@ -614,6 +623,7 @@ export type ASTNode =
   | AssemblyMemberAccess
   | CatchClause
   | FileLevelConstant
+  | TypeDefinition
 
 export type AssemblyItem =
   | Identifier

src/antlr/SolidityParser.ts

@@ -3463,4 +3463,32 @@ describe('AST', () => {
       },
     })
   })
+
+  it('should support top-level user defined value types', function () {
+    const ast = parseNode('type Price is uint128;')
+
+    assert.deepEqual(ast, {
+      type: 'TypeDefinition',
+      name: 'Price',
+      definition: {
+        type: 'ElementaryTypeName',
+        name: 'uint128',
+        stateMutability: null
+      }
+    })
+  });
+
+  it('should support contract-level user defined value types', function () {
+    const ast = parseContract('contract Foo { type Price is uint128; }')
+
+    assert.deepEqual(ast.subNodes[0], {
+      type: 'TypeDefinition',
+      name: 'Price',
+      definition: {
+        type: 'ElementaryTypeName',
+        name: 'uint128',
+        stateMutability: null
+      }
+    })
+  });
 })

src/antlr/SolidityVisitor.ts

@@ -749,3 +749,35 @@ contract CustomErrors {
     revert ContractCustomError();
   }
 }
+
+// User defined value types
+type Price is uint128;
+type Quantity is uint128;
+
+contract Foo {
+  type Id is uint8;
+
+  Id public id;
+}
+
+type UFixed is uint256;
+
+library FixedMath {
+    uint constant multiplier = 10**18;
+
+    function add(UFixed a, UFixed b) internal pure returns (UFixed) {
+        return UFixed.wrap(UFixed.unwrap(a) + UFixed.unwrap(b));
+    }
+
+    function mul(UFixed a, uint256 b) internal pure returns (UFixed) {
+        return UFixed.wrap(UFixed.unwrap(a) * b);
+    }
+
+    function floor(UFixed a) internal pure returns (uint256) {
+        return UFixed.unwrap(a) / multiplier;
+    }
+
+    function toUFixed(uint256 a) internal pure returns (UFixed) {
+        return UFixed.wrap(a * multiplier);
+    }
+}