Print `ast` to Solidity Source Code #201

xianlinc · 2024-04-12T03:03:15Z

Introduced a new package called ast_printer to print ast.Node[ast.NodeType] to solidity source code.
Right now, we do not support the printing of all the nodes, and we haven't tested it rigorously yet, but would love to get some feedback on what changes need to be made to integrate this into the codebase 🤩

Heres an example of how you would use this:

func printRoot(root *ast.RootNode) {
	str, ok := ast_printer.Print(root.GetSourceUnits()[0])
	if !ok {
		zap.L().Error("Failed to print root")
	}
	fmt.Println(str)
}

xianlinc · 2024-04-12T03:05:08Z

ast/parameter.go

@@ -438,5 +438,5 @@ func (p *Parameter) getStorageLocationFromCtx(ctx *parser.ParameterDeclarationCo
 		}
 	}

-	return ast_pb.StorageLocation_MEMORY
+	return ast_pb.StorageLocation_DEFAULT


I changed this from Memory to Default because we needed a way to print the storage location "memory" only when it is specified in the original antlr ast.

We print "" on Default

Good catch!

xianlinc · 2024-04-12T03:06:31Z

ast/state_variable.go

@@ -22,6 +22,7 @@ type StateVariableDeclaration struct {
 	Visibility      ast_pb.Visibility      `json:"visibility"`        // Visibility of the state variable declaration
 	StorageLocation ast_pb.StorageLocation `json:"storage_location"`  // Storage location of the state variable declaration
 	StateMutability ast_pb.Mutability      `json:"mutability"`        // State mutability of the state variable declaration
+	Override        bool                   `json:"is_override"`       // Indicates if the state variable is an override


Introduced an Override for StateVariableDeclaration, eg address public override owner;

Nice one, I missed that one 🎃

printer/ast_printer/ast_printer.go

…nter

0x19

It's all going nice way! Thank you a lot man!

Some of the things that I believe needs to be a part of this PR:

Documentation in general, it's lacking.
There are no unit tests, please at least add few of them. Does not have to be 100% code coverage even tho 80+ is preferred. We at least need to have for example 1-2 contracts, a table driven test that produces expected results back.

0x19 · 2024-04-15T11:56:59Z

ast/if.go

@@ -186,6 +186,9 @@ func (i *IfStatement) Parse(
 				body.ParseBlock(unit, contractNode, fnNode, statementCtx.Block())
 				break
 			}
+			// Edge case for single statement if
+			// Eg: if (a) b;
+			body.parseStatements(unit, contractNode, fnNode, statementCtx.GetChild(0))


This too me sounds like that it could have potential side-effects. It should probably be checked if block itself is not nil? Going to test it as well and should for sure, as we started be part of the different PR, not this one.

Will remove this from the PR!

0x19 · 2024-04-15T11:57:21Z

ast/parameter.go

@@ -438,5 +438,5 @@ func (p *Parameter) getStorageLocationFromCtx(ctx *parser.ParameterDeclarationCo
 		}
 	}

-	return ast_pb.StorageLocation_MEMORY
+	return ast_pb.StorageLocation_DEFAULT


Good catch!

0x19 · 2024-04-15T11:58:02Z

ast/state_variable.go

@@ -22,6 +22,7 @@ type StateVariableDeclaration struct {
 	Visibility      ast_pb.Visibility      `json:"visibility"`        // Visibility of the state variable declaration
 	StorageLocation ast_pb.StorageLocation `json:"storage_location"`  // Storage location of the state variable declaration
 	StateMutability ast_pb.Mutability      `json:"mutability"`        // State mutability of the state variable declaration
+	Override        bool                   `json:"is_override"`       // Indicates if the state variable is an override


Nice one, I missed that one 🎃

0x19 · 2024-04-15T11:58:49Z

ast/state_variable.go

@@ -207,6 +208,8 @@ func (v *StateVariableDeclaration) Parse(
 		v.Constant = constantCtx != nil
 	}

+	v.Override = ctx.GetOverrideSpecifierSet()


Could this panic in case that there's no specifier set? basically if not nil to set it?

0x19 · 2024-04-15T11:58:57Z

ast/state_variable.go

@@ -270,6 +273,8 @@ func (v *StateVariableDeclaration) ParseGlobal(
 		v.Constant = constantCtx != nil
 	}

+	v.Override = ctx.GetOverrideSpecifierSet()


Same as above

printer/ast_printer/ast_printer.go

xianlinc added 18 commits April 11, 2024 15:04

Print AndOperation

5567710

Print Assignment

7850787

Print BinaryOperation

e2fda85

print BodyNode

0304c61

Print Conditional

a1bae10

Print contract, Parameter, ParameterList, SourceUnit

89482cf

Print typename, Function

74d3a24

Print declarations

f226fc3

Print Emit

e95e1d6

Print For

e72e982

Print PrimaryExpression

49d2ec4

Print FunctionCall

7077282

Print Import

adb19ed

Print Unary Prefix and Suffix

b34296e

Print IndexAccess and Return

9711c18

Print tuple

ec75618

Print imports fix

8808357

Print struct

dc7e7c7

xianlinc commented Apr 12, 2024

View reviewed changes

printer/ast_printer/ast_printer.go Show resolved Hide resolved

xianlinc and others added 9 commits April 12, 2024 11:10

Merge branch 'main' into ast-printer

223edcb

Print Enum and If

be5144b

Handle "addresspayable" edge case

ab6a4a8

Merge branch 'ast-printer' of github.com:yongkangc/solgo into ast-pri…

62e058a

…nter

Print Modifier

9e0b00a

Print Event

03d551e

Print Error and handle enum type

6582c55

Print payable conversion

08eb0e2

Print Revert and fix bugs

87b6576

xianlinc added 2 commits April 12, 2024 17:40

Modify state variable printing

9855ea1

fix edge case in printing strings

e6bc022

0x19 requested changes Apr 15, 2024

View reviewed changes

0x19 assigned xianlinc Apr 15, 2024

0x19 added enhancement New feature or request ast Abstract Syntax Tree labels Apr 15, 2024

Print inline arrays

e6bf8ab

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Print `ast` to Solidity Source Code #201

Print `ast` to Solidity Source Code #201

xianlinc commented Apr 12, 2024

xianlinc Apr 12, 2024

xianlinc Apr 12, 2024

0x19 Apr 15, 2024

xianlinc Apr 12, 2024

0x19 Apr 15, 2024

0x19 left a comment

0x19 Apr 15, 2024

xianlinc Apr 17, 2024

0x19 Apr 15, 2024

0x19 Apr 15, 2024

0x19 Apr 15, 2024

0x19 Apr 15, 2024

Print ast to Solidity Source Code #201

Are you sure you want to change the base?

Print ast to Solidity Source Code #201

Conversation

xianlinc commented Apr 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0x19 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Print `ast` to Solidity Source Code #201

Print `ast` to Solidity Source Code #201