Rc/v1.4.0

.github/workflows/codeql-analysis.yml

@@ -2,7 +2,7 @@ name: "CodeQL"
 
 on:
   pull_request:
-    branches: [development]
+    branches: [development, rc/*]
     types: [opened, ready_for_review]
   push:
   workflow_dispatch:

.github/workflows/pr-build.yml

@@ -2,7 +2,7 @@ name: Go
 
 on:
   pull_request:
-    branches: [development]
+    branches: [development, rc/*]
     types: [opened, ready_for_review]
   push:
   workflow_dispatch:
@@ -29,4 +29,4 @@ jobs:
               dep ensure
           fi
       - name: Build
-        run: cd cmd/proxy/ && go build -v .
+        run: make build

.github/workflows/pr-tests.yml

@@ -2,9 +2,9 @@ name: Tests
 
 on:
   push:
-    branches: [ master, development ]
+    branches: [ master, development, rc/* ]
   pull_request:
-    branches: [ master, development ]
+    branches: [ master, development, rc/* ]
 
 jobs:
   test:

Makefile

@@ -1,5 +1,34 @@
+SHELL := $(shell which bash)
+
+.DEFAULT_GOAL := help
+
+.PHONY: clean-test test build run
+
+help:
+	@echo -e ""
+	@echo -e "Make commands:"
+	@grep -E '^[a-zA-Z_-]+:.*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":"}; {printf "\t\033[36m%-30s\033[0m\n", $$1}'
+	@echo -e ""
+
+# #########################
+# Base commands
+# #########################
+
+cmd_dir = cmd/proxy
+binary = proxy
+
 clean-test:
 	go clean -testcache ./...
 
 test: clean-test
 	go test ./...
+
+build:
+	cd ${cmd_dir} && \
+		go build -v \
+		-o ${binary} \
+		-ldflags="-X main.appVersion=$(shell git describe --tags --long --dirty) -X main.commitID=$(shell git rev-parse HEAD)"
+
+run: build
+	cd ${cmd_dir} && \
+		./${binary} --log-level="*:DEBUG"

README.md

@@ -71,6 +71,12 @@ For more details, go [here](https://docs.multiversx.com/sdk-and-tools/proxy/).
 - `/v1.0/block/:shardID/by-nonce/:nonce?withTxs=true`    (GET) --> returns a block by nonce, with transactions included
 - `/v1.0/block/:shardID/by-hash/:hash`    (GET) --> returns a block by hash
 - `/v1.0/block/:shardID/by-hash/:hash?withTxs=true`    (GET) --> returns a block by hash, with transactions included
+- `/v1.0/block/:shardID/altered-accounts/by-nonce/:nonce`    (GET) --> returns altered accounts in the given block by nonce
+- `/v1.0/block/:shardID/altered-accounts/by-nonce/:nonce?tokens=token1,token2`    (GET) --> returns altered accounts in the given block by nonce, filtered out by given tokens
+- `/v1.0/block/:shardID/altered-accounts/by-hash/:hash`    (GET) --> returns altered accounts in the given block by hash
+- `/v1.0/block/:shardID/altered-accounts/by-hash/:hash?tokens=token1,token2`    (GET) --> returns altered accounts in the given block by hash, filtered out by given tokens
+
+Please note that `altered-accounts` endpoints will only work if the backing observers of the Proxy have support for historical balances (`--operation-mode historical-balances` when starting the node)
 
 ### blocks
 
@@ -84,7 +90,9 @@ For more details, go [here](https://docs.multiversx.com/sdk-and-tools/proxy/).
 ### hyperblock
 
 - `/v1.0/hyperblock/by-nonce/:nonce`  (GET) --> returns a hyperblock by nonce, with transactions included
+- `/v1.0/hyperblock/by-nonce/:nonce?withAlteredAccounts=true`  (GET) --> returns a hyperblock by nonce, with transactions and altered accounts in each notarized block. Other available query parameters are `&tokens=token1,token2` as described in the `block` section above
 - `/v1.0/hyperblock/by-hash/:hash`    (GET) --> returns a hyperblock by hash, with transactions included
+- `/v1.0/hyperblock/by-hash/:hash?withAlteredAccounts=true`  (GET) --> returns a hyperblock by hash, with transactions and altered accounts in each notarized block. Other available query parameters are `&tokens=token1,token2` as described in the `block` section above
 
 # V_next
 

api/api.go

@@ -7,17 +7,18 @@ import (
 	"reflect"
 	"time"
 
-	"github.com/ElrondNetwork/elrond-go-core/hashing"
-	"github.com/ElrondNetwork/elrond-go-core/hashing/factory"
-	"github.com/ElrondNetwork/elrond-go-core/hashing/sha256"
-	logger "github.com/ElrondNetwork/elrond-go-logger"
-	"github.com/ElrondNetwork/elrond-proxy-go/api/middleware"
-	"github.com/ElrondNetwork/elrond-proxy-go/config"
-	"github.com/ElrondNetwork/elrond-proxy-go/data"
 	"github.com/gin-contrib/cors"
 	"github.com/gin-contrib/pprof"
+	"github.com/gin-contrib/static"
 	"github.com/gin-gonic/gin"
 	"github.com/gin-gonic/gin/binding"
+	"github.com/multiversx/mx-chain-core-go/hashing"
+	"github.com/multiversx/mx-chain-core-go/hashing/factory"
+	"github.com/multiversx/mx-chain-core-go/hashing/sha256"
+	logger "github.com/multiversx/mx-chain-logger-go"
+	"github.com/multiversx/mx-chain-proxy-go/api/middleware"
+	"github.com/multiversx/mx-chain-proxy-go/config"
+	"github.com/multiversx/mx-chain-proxy-go/data"
 	"gopkg.in/go-playground/validator.v8"
 )
 
@@ -37,6 +38,7 @@ func CreateServer(
 	statusMetricsExtractor middleware.StatusMetricsExtractor,
 	rateLimitTimeWindowInSeconds int,
 	isProfileModeActivated bool,
+	shouldStartSwaggerUI bool,
 ) (*http.Server, error) {
 	ws := gin.Default()
 	ws.Use(cors.Default())
@@ -46,7 +48,7 @@ func CreateServer(
 		return nil, err
 	}
 
-	err = registerRoutes(ws, versionsRegistry, apiLoggingConfig, credentialsConfig, statusMetricsExtractor, rateLimitTimeWindowInSeconds, isProfileModeActivated)
+	err = registerRoutes(ws, versionsRegistry, apiLoggingConfig, credentialsConfig, statusMetricsExtractor, rateLimitTimeWindowInSeconds, isProfileModeActivated, shouldStartSwaggerUI)
 	if err != nil {
 		return nil, err
 	}
@@ -82,12 +84,17 @@ func registerRoutes(
 	statusMetricsExtractor middleware.StatusMetricsExtractor,
 	rateLimitTimeWindowInSeconds int,
 	isProfileModeActivated bool,
+	shouldStartSwaggerUI bool,
 ) error {
 	versionsMap, err := versionsRegistry.GetAllVersions()
 	if err != nil {
 		return err
 	}
 
+	if shouldStartSwaggerUI {
+		ws.Use(static.ServeRoot("/", "config/swagger"))
+	}
+
 	if apiLoggingConfig.LoggingEnabled {
 		responseLoggerMiddleware := middleware.NewResponseLoggerMiddleware(time.Duration(apiLoggingConfig.ThresholdInMicroSeconds) * time.Microsecond)
 		ws.Use(responseLoggerMiddleware.MiddlewareHandlerFunc())

api/apiHandler.go

@@ -1,9 +1,9 @@
 package api
 
 import (
-	"github.com/ElrondNetwork/elrond-go-core/core/check"
-	"github.com/ElrondNetwork/elrond-proxy-go/api/groups"
-	"github.com/ElrondNetwork/elrond-proxy-go/data"
+	"github.com/multiversx/mx-chain-core-go/core/check"
+	"github.com/multiversx/mx-chain-proxy-go/api/groups"
+	"github.com/multiversx/mx-chain-proxy-go/data"
 )
 
 // apiHandler will handle the groups specific to an API version
@@ -99,6 +99,11 @@ func initBaseGroupsWithFacade(facade data.FacadeHandler) (map[string]data.GroupH
 		return nil, err
 	}
 
+	aboutGroup, err := groups.NewAboutGroup(facade)
+	if err != nil {
+		return nil, err
+	}
+
 	return map[string]data.GroupHandler{
 		"/actions":     actionsGroup,
 		"/address":     accountsGroup,
@@ -114,6 +119,7 @@ func initBaseGroupsWithFacade(facade data.FacadeHandler) (map[string]data.GroupH
 		"/validator":   validatorsGroup,
 		"/vm-values":   vmValuesGroup,
 		"/proof":       proofGroup,
+		"/about":       aboutGroup,
 	}, nil
 }
 

api/errors/errors.go

@@ -59,6 +59,9 @@ var ErrValidation = errors.New("validation error")
 // ErrBadUrlParams signals one or more incorrectly provided URL params (generic error)
 var ErrBadUrlParams = errors.New("bad url parameter(s)")
 
+// ErrGetCodeHash signals an error in fetching the code hash for an account
+var ErrGetCodeHash = errors.New("cannot get code hash")
+
 // ErrValidationQueryParameterWithResult signals that an invalid query parameter has been provided
 var ErrValidationQueryParameterWithResult = errors.New("invalid query parameter withResults")
 

api/groups/baseAboutGroup.go

@@ -0,0 +1,43 @@
+package groups
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"github.com/multiversx/mx-chain-proxy-go/api/shared"
+	"github.com/multiversx/mx-chain-proxy-go/data"
+)
+
+type aboutGroup struct {
+	facade AboutFacadeHandler
+	*baseGroup
+}
+
+// NewAboutGroup returns a new instance of aboutGroup
+func NewAboutGroup(facadeHandler data.FacadeHandler) (*aboutGroup, error) {
+	facade, ok := facadeHandler.(AboutFacadeHandler)
+	if !ok {
+		return nil, ErrWrongTypeAssertion
+	}
+	ag := &aboutGroup{
+		facade:    facade,
+		baseGroup: &baseGroup{},
+	}
+
+	baseRoutesHandlers := []*data.EndpointHandlerData{
+		{Path: "", Handler: ag.getAboutInfo, Method: http.MethodGet},
+	}
+	ag.baseGroup.endpoints = baseRoutesHandlers
+
+	return ag, nil
+}
+
+func (ag *aboutGroup) getAboutInfo(c *gin.Context) {
+	aboutInfo, err := ag.facade.GetAboutInfo()
+	if err != nil {
+		shared.RespondWith(c, http.StatusInternalServerError, nil, err.Error(), data.ReturnCodeInternalError)
+		return
+	}
+
+	c.JSON(http.StatusOK, aboutInfo)
+}

api/groups/baseAboutGroup_test.go

@@ -0,0 +1,71 @@
+package groups_test
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/multiversx/mx-chain-proxy-go/api/groups"
+	"github.com/multiversx/mx-chain-proxy-go/api/mock"
+	"github.com/multiversx/mx-chain-proxy-go/data"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+type aboutResponse struct {
+	Data  data.AboutInfo `json:"data"`
+	Error string         `json:"error"`
+	Code  string         `json:"code"`
+}
+
+func TestNewAboutGroup(t *testing.T) {
+	t.Parallel()
+
+	t.Run("wrong facade, should fail", func(t *testing.T) {
+		t.Parallel()
+
+		wrongFacade := &mock.WrongFacade{}
+		group, err := groups.NewAboutGroup(wrongFacade)
+		require.Nil(t, group)
+		require.Equal(t, groups.ErrWrongTypeAssertion, err)
+	})
+
+	t.Run("should work", func(t *testing.T) {
+		t.Parallel()
+
+		group, err := groups.NewAboutGroup(&mock.FacadeStub{})
+		require.Nil(t, err)
+		require.NotNil(t, group)
+	})
+}
+
+func TestAboutGroup_GetAboutInfo(t *testing.T) {
+	t.Parallel()
+
+	commitID := "commitID"
+	version := "appVersion"
+
+	facade := &mock.FacadeStub{
+		GetAboutInfoCalled: func() (*data.GenericAPIResponse, error) {
+			return &data.GenericAPIResponse{
+				Data: data.AboutInfo{AppVersion: version, CommitID: commitID},
+			}, nil
+		},
+	}
+	aboutGroup, err := groups.NewAboutGroup(facade)
+	require.NoError(t, err)
+
+	ws := startProxyServer(aboutGroup, "/about")
+
+	req, _ := http.NewRequest("GET", "/about", nil)
+	resp := httptest.NewRecorder()
+	ws.ServeHTTP(resp, req)
+
+	apiResp := aboutResponse{}
+	loadResponse(resp.Body, &apiResp)
+
+	assert.Equal(t, http.StatusOK, resp.Code)
+	assert.Equal(t, apiResp.Data.AppVersion, version)
+	assert.Equal(t, apiResp.Data.CommitID, commitID)
+	assert.Empty(t, apiResp.Error)
+}

api/groups/baseAccountsGroup.go

@@ -4,10 +4,10 @@ import (
 	"fmt"
 	"net/http"
 
-	"github.com/ElrondNetwork/elrond-proxy-go/api/errors"
-	"github.com/ElrondNetwork/elrond-proxy-go/api/shared"
-	"github.com/ElrondNetwork/elrond-proxy-go/data"
 	"github.com/gin-gonic/gin"
+	"github.com/multiversx/mx-chain-proxy-go/api/errors"
+	"github.com/multiversx/mx-chain-proxy-go/api/shared"
+	"github.com/multiversx/mx-chain-proxy-go/data"
 )
 
 type accountsGroup struct {
@@ -33,6 +33,7 @@ func NewAccountsGroup(facadeHandler data.FacadeHandler) (*accountsGroup, error)
 		{Path: "/:address/username", Handler: ag.getUsername, Method: http.MethodGet},
 		{Path: "/:address/nonce", Handler: ag.getNonce, Method: http.MethodGet},
 		{Path: "/:address/shard", Handler: ag.getShard, Method: http.MethodGet},
+		{Path: "/:address/code-hash", Handler: ag.getCodeHash, Method: http.MethodGet},
 		{Path: "/:address/transactions", Handler: ag.getTransactions, Method: http.MethodGet},
 		{Path: "/:address/keys", Handler: ag.getKeyValuePairs, Method: http.MethodGet},
 		{Path: "/:address/key/:key", Handler: ag.getValueForKey, Method: http.MethodGet},
@@ -106,6 +107,24 @@ func (group *accountsGroup) getNonce(c *gin.Context) {
 	})
 }
 
+// getCodeHash returns the code hash for the address parameter
+func (group *accountsGroup) getCodeHash(c *gin.Context) {
+	address := c.Param("address")
+	options, err := parseAccountQueryOptions(c)
+	if err != nil {
+		shared.RespondWithValidationError(c, errors.ErrBadUrlParams, err)
+		return
+	}
+
+	codeHashResponse, err := group.facade.GetCodeHash(address, options)
+	if err != nil {
+		shared.RespondWithInternalError(c, errors.ErrGetCodeHash, err)
+		return
+	}
+
+	c.JSON(http.StatusOK, codeHashResponse)
+}
+
 // getTransactions returns the transactions for the address parameter
 func (group *accountsGroup) getTransactions(c *gin.Context) {
 	transactions, status, err := group.getTransactionsFromFacade(c)
@@ -214,7 +233,8 @@ func (group *accountsGroup) getESDTTokenData(c *gin.Context) {
 
 	esdtTokenResponse, err := group.facade.GetESDTTokenData(addr, tokenIdentifier, options)
 	if err != nil {
-		shared.RespondWithInternalError(c, errors.ErrEmptyTokenIdentifier, err)
+		shared.RespondWithInternalError(c, errors.ErrGetESDTTokenData, err)
+		return
 	}
 
 	c.JSON(http.StatusOK, esdtTokenResponse)