comments

.github/workflows/pr-build.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v2
         with:
-          go-version: ^1.17.6
+          go-version: 1.20.7
         id: go
 
       - name: Check out code into the Go module directory

pkg/proxy/configs.go

@@ -9,18 +9,21 @@ import (
 	"github.com/multiversx/mx-chain-proxy-go/data"
 )
 
+// ArgsProxyConfigs holds the arguments needed to create the proxy configs
 type ArgsProxyConfigs struct {
 	TemDir            string
 	PathToProxyConfig string
 	ServerPort        int
 	RestApiInterfaces map[uint32]string
 }
 
+// ArgsOutputConfig holds the output arguments for proxy configs
 type ArgsOutputConfig struct {
 	Config           *config.Config
 	PathToTempConfig string
 }
 
+// CreateProxyConfigs will create the proxy configs
 func CreateProxyConfigs(args ArgsProxyConfigs) (*ArgsOutputConfig, error) {
 	newConfigsPath := path.Join(args.TemDir, "proxyConfig")
 

pkg/proxy/creator.go

@@ -25,6 +25,7 @@ import (
 
 var log = logger.GetOrCreate("proxy")
 
+// ArgsProxy holds the arguments needed to create a new instance of proxy
 type ArgsProxy struct {
 	Config       *config.Config
 	NodeHandler  process.NodeHandler
@@ -36,6 +37,7 @@ type proxy struct {
 	httpServer         *http.Server
 }
 
+// CreateProxy will create a new instance of proxy
 func CreateProxy(args ArgsProxy) (ProxyHandler, error) {
 	proxyInstance := &proxy{
 		closableComponents: data.NewClosableComponentsHandler(),
@@ -214,6 +216,7 @@ func CreateProxy(args ArgsProxy) (ProxyHandler, error) {
 	return proxyInstance, nil
 }
 
+// Close will close the proxy
 func (p *proxy) Close() {
 	p.closableComponents.Close()
 }

pkg/proxy/interface.go

@@ -1,5 +1,6 @@
 package proxy
 
+// ProxyHandler defines what a proxy handler should be able to do
 type ProxyHandler interface {
 	Close()
 }