WIP

db/historydb/apiqueries.go

@@ -38,7 +38,7 @@ func (hdb *HistoryDB) GetBatchAPI(batchNum common.BatchNum) (*BatchAPI, error) {
 	return hdb.getBatchAPI(hdb.dbRead, batchNum)
 }
 
-// GetBatchAPI return the batch with the given batchNum
+// GetBatchInternalAPI return the batch with the given batchNum
 func (hdb *HistoryDB) GetBatchInternalAPI(batchNum common.BatchNum) (*BatchAPI, error) {
 	return hdb.getBatchAPI(hdb.dbRead, batchNum)
 }
@@ -944,6 +944,7 @@ func (hdb *HistoryDB) GetCoordinatorAPI(bidderAddr ethCommon.Address) (*Coordina
 	defer hdb.apiConnCon.Release()
 	return hdb.getCoordinatorAPI(hdb.dbRead, bidderAddr)
 }
+
 func (hdb *HistoryDB) getCoordinatorAPI(d meddler.DB, bidderAddr ethCommon.Address) (*CoordinatorAPI, error) {
 	coordinator := &CoordinatorAPI{}
 	err := meddler.QueryRow(
@@ -954,6 +955,7 @@ func (hdb *HistoryDB) getCoordinatorAPI(d meddler.DB, bidderAddr ethCommon.Addre
 	return coordinator, tracerr.Wrap(err)
 }
 
+// GetNodeInfoAPI retusnt he NodeInfo
 func (hdb *HistoryDB) GetNodeInfoAPI() (*NodeInfo, error) {
 	cancel, err := hdb.apiConnCon.Acquire()
 	defer cancel()
@@ -964,9 +966,9 @@ func (hdb *HistoryDB) GetNodeInfoAPI() (*NodeInfo, error) {
 	return hdb.GetNodeInfo()
 }
 
+// GetBucketUpdatesInternalAPI returns the latest bucket updates
 func (hdb *HistoryDB) GetBucketUpdatesInternalAPI() ([]BucketUpdateAPI, error) {
 	var bucketUpdates []*BucketUpdateAPI
-	// var bucketUpdates []*common.BucketUpdate
 	err := meddler.QueryAll(
 		hdb.dbRead, &bucketUpdates,
 		`SELECT num_bucket, withdrawals FROM bucket_update 
@@ -977,7 +979,7 @@ func (hdb *HistoryDB) GetBucketUpdatesInternalAPI() ([]BucketUpdateAPI, error) {
 	return db.SlicePtrsToSlice(bucketUpdates).([]BucketUpdateAPI), tracerr.Wrap(err)
 }
 
-// getNextForgers returns next forgers
+// GetNextForgersInternalAPI returns next forgers
 func (hdb *HistoryDB) GetNextForgersInternalAPI(auctionVars *common.AuctionVariables,
 	auctionConsts *common.AuctionConstants,
 	lastBlock common.Block, currentSlot, lastClosedSlot int64) ([]NextForgerAPI, error) {
@@ -1071,7 +1073,7 @@ func (hdb *HistoryDB) GetNextForgersInternalAPI(auctionVars *common.AuctionVaria
 	return nextForgers, nil
 }
 
-// UpdateMetrics update Status.Metrics information
+// GetMetricsInternalAPI returns the MetricsAPI
 func (hdb *HistoryDB) GetMetricsInternalAPI(lastBatchNum common.BatchNum) (*MetricsAPI, error) {
 	var metrics MetricsAPI
 	// Get the first and last batch of the last 24h and their timestamps
@@ -1171,6 +1173,7 @@ func (hdb *HistoryDB) GetMetricsInternalAPI(lastBatchNum common.BatchNum) (*Metr
 	return &metrics, nil
 }
 
+// GetStateAPI returns the StateAPI
 func (hdb *HistoryDB) GetStateAPI() (*StateAPI, error) {
 	cancel, err := hdb.apiConnCon.Acquire()
 	defer cancel()

db/historydb/historydb.go

@@ -1171,7 +1171,7 @@ func (hdb *HistoryDB) GetTokensTest() ([]TokenWithUSD, error) {
 	return db.SlicePtrsToSlice(tokens).([]TokenWithUSD), nil
 }
 
-// UpdateRecommendedFee update Status.RecommendedFee information
+// GetRecommendedFee returns the RecommendedFee information
 func (hdb *HistoryDB) GetRecommendedFee(minFeeUSD float64) (*common.RecommendedFee, error) {
 	var recommendedFee common.RecommendedFee
 	// Get total txs and the batch of the first selected tx of the last hour

db/historydb/historydb_test.go

@@ -1172,15 +1172,6 @@ func TestGetMetricsAPI(t *testing.T) {
 		assert.NoError(t, err)
 	}
 
-	// clientSetupExample := test.NewClientSetupExample()
-	// apiStateUpdater := NewAPIStateUpdater(historyDB, &NodeConfig{1000, 0.5},
-	// 	&Constants{
-	// 		RollupConstants:   *clientSetupExample.RollupConstants,
-	// 		AuctionConstants:  *clientSetupExample.AuctionConstants,
-	// 		WDelayerConstants: *clientSetupExample.WDelayerConstants,
-	// 		ChainID:           uint16(clientSetupExample.ChainID.Int64()),
-	// 		HermezAddress:     clientSetupExample.AuctionConstants.HermezRollup,
-	// 	})
 	res, err := historyDB.GetMetricsInternalAPI(common.BatchNum(numBatches))
 	assert.NoError(t, err)
 
@@ -1467,7 +1458,7 @@ func setTestBlocks(from, to int64) []common.Block {
 func TestNodeInfo(t *testing.T) {
 	test.WipeDB(historyDB.DB())
 
-	err := historyDB.SetAPIState(&StateAPI{})
+	err := historyDB.SetStateInternalAPI(&StateAPI{})
 	require.NoError(t, err)
 
 	clientSetup := test.NewClientSetupExample()
@@ -1503,7 +1494,7 @@ func TestNodeInfo(t *testing.T) {
 			ExistingAccount: 0.15,
 		},
 	}
-	err = historyDB.SetAPIState(stateAPI)
+	err = historyDB.SetStateInternalAPI(stateAPI)
 	require.NoError(t, err)
 
 	nodeConfig := &NodeConfig{
@@ -1521,7 +1512,7 @@ func TestNodeInfo(t *testing.T) {
 	require.NoError(t, err)
 	assert.Equal(t, nodeConfig, dbNodeConfig)
 
-	dbStateAPI, err := historyDB.GetStateAPI()
+	dbStateAPI, err := historyDB.getStateAPI(historyDB.dbRead)
 	require.NoError(t, err)
 	assert.Equal(t, stateAPI, dbStateAPI)
 }

db/historydb/nodeinfo.go

@@ -14,6 +14,7 @@ const (
 	createAccountInternalExtraFeePercentage float64 = 2.5
 )
 
+// Period represents a time period in ethereum
 type Period struct {
 	SlotNum       int64     `json:"slotNum"`
 	FromBlock     int64     `json:"fromBlock"`
@@ -22,11 +23,13 @@ type Period struct {
 	ToTimestamp   time.Time `json:"toTimestamp"`
 }
 
+// NextForgerAPI represents the next forger exposed via the API
 type NextForgerAPI struct {
 	Coordinator CoordinatorAPI `json:"coordinator"`
 	Period      Period         `json:"period"`
 }
 
+// NetworkAPI is the network state exposed via the API
 type NetworkAPI struct {
 	LastEthBlock  int64           `json:"lastEthereumBlock"`
 	LastSyncBlock int64           `json:"lastSynchedBlock"`
@@ -41,6 +44,7 @@ type NodePublicConfig struct {
 	ForgeDelay float64 `json:"forgeDelay"`
 }
 
+// StateAPI is an object representing the node and network state exposed via the API
 type StateAPI struct {
 	// NodePublicConfig is the configuration of the node that is exposed via API
 	NodePublicConfig  NodePublicConfig         `json:"nodeConfig"`
@@ -52,27 +56,28 @@ type StateAPI struct {
 	RecommendedFee    common.RecommendedFee    `json:"recommendedFee"`
 }
 
+// Constants contains network constants
 type Constants struct {
-	// RollupConstants   common.RollupConstants
-	// AuctionConstants  common.AuctionConstants
-	// WDelayerConstants common.WDelayerConstants
 	common.SCConsts
 	ChainID       uint16
 	HermezAddress ethCommon.Address
 }
 
+// NodeConfig contains the node config exposed in the API
 type NodeConfig struct {
 	MaxPoolTxs uint32  `meddler:"max_pool_txs"`
 	MinFeeUSD  float64 `meddler:"min_fee"`
 }
 
+// NodeInfo contains information about he node used when serving the API
 type NodeInfo struct {
 	ItemID     int         `meddler:"item_id,pk"`
-	APIState   *StateAPI   `meddler:"state,json"`
+	StateAPI   *StateAPI   `meddler:"state,json"`
 	NodeConfig *NodeConfig `meddler:"config,json"`
 	Constants  *Constants  `meddler:"constants,json"`
 }
 
+// GetNodeInfo returns the NodeInfo
 func (hdb *HistoryDB) GetNodeInfo() (*NodeInfo, error) {
 	ni := &NodeInfo{}
 	err := meddler.QueryRow(
@@ -81,6 +86,7 @@ func (hdb *HistoryDB) GetNodeInfo() (*NodeInfo, error) {
 	return ni, tracerr.Wrap(err)
 }
 
+// GetConstants returns the Constats
 func (hdb *HistoryDB) GetConstants() (*Constants, error) {
 	var nodeInfo NodeInfo
 	err := meddler.QueryRow(
@@ -90,6 +96,7 @@ func (hdb *HistoryDB) GetConstants() (*Constants, error) {
 	return nodeInfo.Constants, tracerr.Wrap(err)
 }
 
+// SetConstants sets the Constants
 func (hdb *HistoryDB) SetConstants(constants *Constants) error {
 	_constants := struct {
 		Constants *Constants `meddler:"constants,json"`
@@ -105,6 +112,7 @@ func (hdb *HistoryDB) SetConstants(constants *Constants) error {
 	return tracerr.Wrap(err)
 }
 
+// GetStateInternalAPI returns the StateAPI
 func (hdb *HistoryDB) GetStateInternalAPI() (*StateAPI, error) {
 	return hdb.getStateAPI(hdb.dbRead)
 }
@@ -115,14 +123,15 @@ func (hdb *HistoryDB) getStateAPI(d meddler.DB) (*StateAPI, error) {
 		d, &nodeInfo,
 		"SELECT state FROM node_info WHERE item_id = 1;",
 	)
-	return nodeInfo.APIState, tracerr.Wrap(err)
+	return nodeInfo.StateAPI, tracerr.Wrap(err)
 }
 
-func (hdb *HistoryDB) SetAPIState(apiState *StateAPI) error {
-	_apiState := struct {
-		APIState *StateAPI `meddler:"state,json"`
-	}{apiState}
-	values, err := meddler.Default.Values(&_apiState, false)
+// SetStateInternalAPI sets the StateAPI
+func (hdb *HistoryDB) SetStateInternalAPI(stateAPI *StateAPI) error {
+	_stateAPI := struct {
+		StateAPI *StateAPI `meddler:"state,json"`
+	}{stateAPI}
+	values, err := meddler.Default.Values(&_stateAPI, false)
 	if err != nil {
 		return tracerr.Wrap(err)
 	}
@@ -133,6 +142,7 @@ func (hdb *HistoryDB) SetAPIState(apiState *StateAPI) error {
 	return tracerr.Wrap(err)
 }
 
+// GetNodeConfig returns the NodeConfig
 func (hdb *HistoryDB) GetNodeConfig() (*NodeConfig, error) {
 	var nodeInfo NodeInfo
 	err := meddler.QueryRow(
@@ -142,6 +152,7 @@ func (hdb *HistoryDB) GetNodeConfig() (*NodeConfig, error) {
 	return nodeInfo.NodeConfig, tracerr.Wrap(err)
 }
 
+// SetNodeConfig sets the NodeConfig
 func (hdb *HistoryDB) SetNodeConfig(nodeConfig *NodeConfig) error {
 	_nodeConfig := struct {
 		NodeConfig *NodeConfig `meddler:"config,json"`
@@ -151,65 +162,8 @@ func (hdb *HistoryDB) SetNodeConfig(nodeConfig *NodeConfig) error {
 		return tracerr.Wrap(err)
 	}
 	_, err = hdb.dbWrite.Exec(
-		"UPDATE config SET state = $1 WHERE item_id = 1;",
+		"UPDATE node_info SET config = $1 WHERE item_id = 1;",
 		values[0],
 	)
 	return tracerr.Wrap(err)
 }
-
-// func (hdb *HistoryDB) SetInitialNodeInfo(maxPoolTxs uint32, minFeeUSD float64, constants *Constants) error {
-// 	ni := &NodeInfo{
-// 		MaxPoolTxs: &maxPoolTxs,
-// 		MinFeeUSD:  &minFeeUSD,
-// 		Constants:  constants,
-// 	}
-// 	return tracerr.Wrap(meddler.Insert(hdb.dbWrite, "node_info", ni))
-// }
-
-// apiSlotToBigInts converts from [6]*apitypes.BigIntStr to [6]*big.Int
-// func apiSlotToBigInts(defaultSlotSetBid [6]*apitypes.BigIntStr) ([6]*big.Int, error) {
-// 	var slots [6]*big.Int
-//
-// 	for i, slot := range defaultSlotSetBid {
-// 		bigInt, ok := new(big.Int).SetString(string(*slot), 10)
-// 		if !ok {
-// 			return slots, tracerr.Wrap(fmt.Errorf("can't convert %T into big.Int", slot))
-// 		}
-// 		slots[i] = bigInt
-// 	}
-//
-// 	return slots, nil
-// }
-
-// func (hdb *HistoryDB) updateNodeInfo(setUpdatedNodeInfo func(*sqlx.Tx, *NodeInfo) error) error {
-// 	// Create a SQL transaction or read and update atomicaly
-// 	txn, err := hdb.dbWrite.Beginx()
-// 	if err != nil {
-// 		return tracerr.Wrap(err)
-// 	}
-// 	defer func() {
-// 		if err != nil {
-// 			db.Rollback(txn)
-// 		}
-// 	}()
-// 	// Read current node info
-// 	ni := &NodeInfo{}
-// 	if err := meddler.QueryRow(
-// 		txn, ni, "SELECT * FROM node_info;",
-// 	); err != nil {
-// 		return tracerr.Wrap(err)
-// 	}
-// 	// Update NodeInfo struct
-// 	if err := setUpdatedNodeInfo(txn, ni); err != nil {
-// 		return tracerr.Wrap(err)
-// 	}
-// 	// Update NodeInfo at DB
-// 	if _, err := txn.Exec("DELETE FROM node_info;"); err != nil {
-// 		return tracerr.Wrap(err)
-// 	}
-// 	if err := meddler.Insert(txn, "node_info", ni); err != nil {
-// 		return tracerr.Wrap(err)
-// 	}
-// 	// Commit NodeInfo update
-// 	return tracerr.Wrap(txn.Commit())
-// }