Introduce advanced Web3.go capabilities (Devel Branch)...

.github/workflows/gosec.yml

@@ -7,10 +7,19 @@ jobs:
  SOLC_SWITCH_GITHUB_TOKEN: ${{ secrets.SOLC_SWITCH_GITHUB_TOKEN }}
  FULL_NODE_TEST_URL: ${{ secrets.FULL_NODE_TEST_URL }}
  ARCHIVE_NODE_TEST_URL: ${{ secrets.ARCHIVE_NODE_TEST_URL }}
+ # Initialize SOLGO_ANVIL_PATH, will be set after installing Foundry
+ SOLGO_ANVIL_PATH: ''
  steps:
  - name: Checkout Source
  uses: actions/checkout@v3
 
+ # Install Foundry and Anvil
+ - name: Install Foundry and Anvil
+ run: |
+ curl -L https://foundry.paradigm.xyz | bash
+ foundryup
+ echo "SOLGO_ANVIL_PATH=$(which anvil)" >> $GITHUB_ENV
+
  # Install solc-select
  - name: Install solc-select
  run: |

.github/workflows/goveralls.yml

@@ -7,6 +7,8 @@ jobs:
  SOLC_SWITCH_GITHUB_TOKEN: ${{ secrets.SOLC_SWITCH_GITHUB_TOKEN }}
  FULL_NODE_TEST_URL: ${{ secrets.FULL_NODE_TEST_URL }}
  ARCHIVE_NODE_TEST_URL: ${{ secrets.ARCHIVE_NODE_TEST_URL }}
+ # Initialize SOLGO_ANVIL_PATH, will be set after installing Foundry
+ SOLGO_ANVIL_PATH: ''
  strategy:
  fail-fast: false
  matrix:
@@ -20,6 +22,13 @@ jobs:
  - uses: actions/checkout@v3
  - run: make submodules
 
+ # Install Foundry and Anvil
+ - name: Install Foundry and Anvil
+ run: |
+ curl -L https://foundry.paradigm.xyz | bash
+ foundryup
+ echo "SOLGO_ANVIL_PATH=$(which anvil)" >> $GITHUB_ENV
+
  # Install solc-select
  - name: Install solc-select
  run: |

.github/workflows/test.yml

@@ -7,6 +7,7 @@ jobs:
  SOLC_SWITCH_GITHUB_TOKEN: ${{ secrets.SOLC_SWITCH_GITHUB_TOKEN }}
  FULL_NODE_TEST_URL: ${{ secrets.FULL_NODE_TEST_URL }}
  ARCHIVE_NODE_TEST_URL: ${{ secrets.ARCHIVE_NODE_TEST_URL }}
+ SOLGO_ANVIL_PATH: ''
  steps:
  - name: Checkout Source
  uses: actions/checkout@v3
@@ -19,6 +20,12 @@ jobs:
  - name: Checkout submodules
  run: make submodules
 
+ - name: Install Foundry and Anvil
+ run: |
+ curl -L https://foundry.paradigm.xyz | bash
+ foundryup
+ echo "SOLGO_ANVIL_PATH=$(which anvil)" >> $GITHUB_ENV
+
  - name: Install solc-select
  run: |
  python3 -m venv solgoenv
@@ -35,6 +42,4 @@ jobs:
  - name: Run Tests
  run: |
  source solgoenv/bin/activate
- solc-select install 0.8.19
- solc-select use 0.8.19 
  make test

.gitignore

@@ -27,3 +27,4 @@ go.work
 solgo
 playground/*
 bin/*
+exchanges_old/*

README.md

@@ -30,6 +30,8 @@ Once I am confident that the project is fully ready for production, this disclai
 
 The SolGo basic documentation is hosted on GitHub, ensuring it's always up-to-date with the latest changes and features. You can access the full documentation [here](https://github.com/unpackdev/solgo/wiki).
 
+**NOTE: Statement above is not true yet (lazy to change it)... Documentation is still being written.**
+
 ## Getting Started
 
 Detailed examples of how to install and use this package can be found in the [Usage](https://github.com/unpackdev/solgo/wiki/Getting-Started) section.

abi/builder.go

@@ -36,7 +36,8 @@ func NewBuilderFromSources(ctx context.Context, sources *solgo.Sources) (*Builde
  parser: parser,
  astBuilder: parser.GetAstBuilder(),
  resolver: &TypeResolver{
- parser: parser,
+ parser: parser,
+ processedTypes: make(map[string]bool),
  },
  }, nil
 }
@@ -124,9 +125,11 @@ func (b *Builder) Parse() (errs []error) {
 }
 
 // Build constructs the ABIs from the sources.
-func (b *Builder) Build() error {
+func (b *Builder) Build() (err error) {
  if root := b.GetParser().GetRoot(); root != nil {
- b.root = b.processRoot(root)
+ if b.root, err = b.processRoot(root); err != nil {
+ return err
+ }
  }
  return nil
 }

abi/constructor.go

@@ -1,10 +1,14 @@
 package abi
 
-import "github.com/unpackdev/solgo/ir"
+import (
+ "fmt"
+
+ "github.com/unpackdev/solgo/ir"
+)
 
 // processConstructor processes an IR constructor and returns a Method representation of it.
 // It extracts the input and output parameters of the constructor and normalizes its state mutability.
-func (b *Builder) processConstructor(unit *ir.Constructor) *Method {
+func (b *Builder) processConstructor(unit *ir.Constructor) (*Method, error) {
  // Initialize a new Method structure for the constructor.
  toReturn := &Method{
  Name: "", // Constructors in Ethereum don't have a name.
@@ -15,6 +19,10 @@ func (b *Builder) processConstructor(unit *ir.Constructor) *Method {
  }
 
  for _, parameter := range unit.GetParameters() {
+ if parameter.GetTypeDescription() == nil {
+ return nil, fmt.Errorf("nil type description for constructor parameter %s", parameter.GetName())
+ }
+
  methodIo := MethodIO{
  Name: parameter.GetName(),
  }
@@ -24,17 +32,5 @@ func (b *Builder) processConstructor(unit *ir.Constructor) *Method {
  )
  }
 
- // Process return statements of the constructor.
- // Note: In Ethereum, constructors don't return values. This might be specific to the IR representation.
- /* for _, parameter := range unit.GetReturnStatements() {
- methodIo := MethodIO{
- Name: parameter.GetName(),
- }
- toReturn.Outputs = append(
- toReturn.Outputs,
- b.buildMethodIO(methodIo, parameter.GetTypeDescription()),
- )
- } */
-
- return toReturn
+ return toReturn, nil
 }

abi/constructor_test.go

@@ -47,7 +47,8 @@ func TestProcessConstructor(t *testing.T) {
  }
 
  builder := &Builder{}
- result := builder.processConstructor(mockConstructor)
+ result, err := builder.processConstructor(mockConstructor)
+ assert.NoError(t, err)
 
  // Assert that the returned Method object has the expected properties
  assert.Equal(t, "constructor", result.Type)

abi/contract.go

@@ -2,6 +2,7 @@ package abi
 
 import (
  abi_pb "github.com/unpackdev/protos/dist/go/abi"
+ ast_pb "github.com/unpackdev/protos/dist/go/ast"
  "github.com/unpackdev/solgo/ast"
  "github.com/unpackdev/solgo/ir"
 )
@@ -44,39 +45,56 @@ func (c *Contract) ToProto() *abi_pb.Contract {
 
 // processContract processes an IR contract and returns a Contract representation of it.
 // It extracts state variables, events, errors, constructor, functions, fallback, and receive methods.
-func (b *Builder) processContract(contract *ir.Contract) *Contract {
+func (b *Builder) processContract(contract *ir.Contract) (*Contract, error) {
  toReturn := Contract{}
 
  // Process state variables.
  for _, stateVar := range contract.GetStateVariables() {
+ //fmt.Println("StateVar:", stateVar.GetName())
  method := b.processStateVariable(stateVar)
  toReturn = append(toReturn, method)
  }
 
  // Process events.
  for _, event := range contract.GetEvents() {
- method := b.processEvent(event)
+ method, err := b.processEvent(event)
+ if err != nil {
+ return nil, err
+ }
+
  toReturn = append(toReturn, method)
  }
 
  // Process errors.
  for _, errorNode := range contract.GetErrors() {
- method := b.processError(errorNode)
+ method, err := b.processError(errorNode)
+ if err != nil {
+ return nil, err
+ }
+
  toReturn = append(toReturn, method)
  }
 
  // Process constructor.
  if contract.GetConstructor() != nil {
- toReturn = append(
- toReturn,
- b.processConstructor(contract.GetConstructor()),
- )
+ method, err := b.processConstructor(contract.GetConstructor())
+ if err != nil {
+ return nil, err
+ }
+
+ toReturn = append(toReturn, method)
  }
 
  // Process functions.
  for _, function := range contract.GetFunctions() {
- method := b.processFunction(function)
- toReturn = append(toReturn, method)
+ if function.GetVisibility() == ast_pb.Visibility_PUBLIC && function.GetVisibility() == ast_pb.Visibility_EXTERNAL {
+ method, err := b.processFunction(function)
+ if err != nil {
+ return nil, err
+ }
+
+ toReturn = append(toReturn, method)
+ }
  }
 
  // Process fallback.
@@ -89,13 +107,15 @@ func (b *Builder) processContract(contract *ir.Contract) *Contract {
 
  // Process receive.
  if contract.GetReceive() != nil {
- toReturn = append(
- toReturn,
- b.processReceive(contract.GetReceive()),
- )
+ method, err := b.processReceive(contract.GetReceive())
+ if err != nil {
+ return nil, err
+ }
+
+ toReturn = append(toReturn, method)
  }
 
- return &toReturn
+ return &toReturn, nil
 }
 
 // buildMethodIO constructs a MethodIO object based on the provided method and type description.

abi/error.go

@@ -1,12 +1,15 @@
 package abi
 
 import (
+ "fmt"
+
  "github.com/unpackdev/solgo/ir"
+ "github.com/unpackdev/solgo/utils"
 )
 
 // processError processes an IR error and returns a Method representation of it.
 // It extracts the name and parameters of the error and sets its type to "error" and state mutability to "view".
-func (b *Builder) processError(unit *ir.Error) *Method {
+func (b *Builder) processError(unit *ir.Error) (*Method, error) {
  toReturn := &Method{
  Name: unit.GetName(),
  Inputs: make([]MethodIO, 0),
@@ -16,13 +19,21 @@ func (b *Builder) processError(unit *ir.Error) *Method {
  }
 
  for _, parameter := range unit.GetParameters() {
- toReturn.Inputs = append(toReturn.Inputs, MethodIO{
- Name: parameter.GetName(),
- Type: normalizeTypeName(parameter.GetTypeDescription().GetString()),
- InternalType: parameter.GetTypeDescription().GetString(),
- Indexed: true, // Parameters for errors are indexed by default.
- })
+ if parameter.GetTypeDescription() == nil {
+ fmt.Println("PROCESS ERROR ABI")
+ utils.DumpNodeNoExit(parameter)
+ return nil, fmt.Errorf("nil type description for error parameter %s", parameter.GetName())
+ }
+
+ methodIo := MethodIO{
+ Name: parameter.GetName(),
+ Indexed: parameter.IsIndexed(),
+ }
+ toReturn.Inputs = append(
+ toReturn.Inputs,
+ b.buildMethodIO(methodIo, parameter.GetTypeDescription()),
+ )
  }
 
- return toReturn
+ return toReturn, nil
 }

abi/error_test.go

@@ -36,7 +36,7 @@ func TestProcessError(t *testing.T) {
  Name: "param1",
  Type: "uint256",
  InternalType: "uint256",
- Indexed: true,
+ Indexed: false,
  },
  },
  Outputs: []MethodIO{},
@@ -52,12 +52,14 @@ func TestProcessError(t *testing.T) {
  TypeDescription: &ast.TypeDescription{
  TypeString: "uint256",
  },
+ Indexed: true,
  },
  {
  Name: "param2",
  TypeDescription: &ast.TypeDescription{
  TypeString: "address",
  },
+ Indexed: true,
  },
  },
  },
@@ -88,7 +90,8 @@ func TestProcessError(t *testing.T) {
 
  for _, tt := range tests {
  t.Run(tt.name, func(t *testing.T) {
- result := builder.processError(tt.input)
+ result, err := builder.processError(tt.input)
+ assert.NoError(t, err)
  assert.Equal(t, tt.expected, result)
  })
  }

abi/event.go

@@ -1,12 +1,14 @@
 package abi
 
 import (
+ "fmt"
+
  "github.com/unpackdev/solgo/ir"
 )
 
 // processEvent processes an IR event and returns a Method representation of it.
 // It extracts the name and parameters of the event and sets its type to "event" and state mutability to "view".
-func (b *Builder) processEvent(unit *ir.Event) *Method {
+func (b *Builder) processEvent(unit *ir.Event) (*Method, error) {
  toReturn := &Method{
  Name: unit.GetName(),
  Inputs: make([]MethodIO, 0),
@@ -18,13 +20,28 @@ func (b *Builder) processEvent(unit *ir.Event) *Method {
  // Process parameters of the event.
  // Note: In Ethereum, event parameters are considered as outputs.
  for _, parameter := range unit.GetParameters() {
- toReturn.Outputs = append(toReturn.Outputs, MethodIO{
- Name: parameter.GetName(),
- Type: parameter.GetTypeDescription().TypeString,
- InternalType: parameter.GetTypeDescription().TypeString,
- Indexed: true, // Parameters for events can be indexed.
- })
+ if parameter.GetTypeDescription() == nil {
+ return nil, fmt.Errorf("nil type description for event parameter %s", parameter.GetName())
+ }
+
+ methodIo := MethodIO{
+ Name: parameter.GetName(),
+ Indexed: parameter.IsIndexed(),
+ }
+ toReturn.Inputs = append(
+ toReturn.Inputs,
+ b.buildMethodIO(methodIo, parameter.GetTypeDescription()),
+ )
+ }
+
+ return toReturn, nil
+}
+
+func (b *Builder) GetEventAsAbi(unit *ir.Event) ([]*Method, error) {
+ method, err := b.processEvent(unit)
+ if err != nil {
+ return nil, err
  }
 
- return toReturn
+ return []*Method{method}, nil
 }