arnaucube/hermez-node
1
0
Fork 0
mirror of https://github.com/arnaucube/hermez-node.git synced 2026-02-06 19:06:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

Impl api get batch(es)

Browse Source
This commit is contained in:
Arnau B
2020-10-26 10:43:34 +01:00
parent 7c8f380637
commit 28c0164525
15 changed files with 599 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
api/api_test.go
View File

@@ -40,7 +40,7 @@ const apiURL = "http://localhost" + apiPort + "/"
type testCommon struct {
blocks []common.Block
tokens []tokenAPI
batches []common.Batch
batches []testBatch
coordinators []coordinatorAPI
usrAddr string
usrBjj string
@@ -651,7 +651,7 @@ func TestMain(m *testing.M) {
tc = testCommon{
blocks: blocks,
tokens: tokensUSD,
batches: batches,
batches: genTestBatches(blocks, batches),
coordinators: apiCoordinators,
usrAddr: ethAddrToHez(usrAddr),
usrBjj: bjjToString(usrBjj),
@@ -1208,7 +1208,6 @@ func TestPoolTxs(t *testing.T) {
jsonTxBytes, err := json.Marshal(tx)
assert.NoError(t, err)
jsonTxReader := bytes.NewReader(jsonTxBytes)
fmt.Println(string(jsonTxBytes))
assert.NoError(
t, doGoodReq(
"POST",

116
api/batch.go Normal file
View File

@@ -0,0 +1,116 @@
package api
import (
"errors"
"net/http"
"github.com/gin-gonic/gin"
"github.com/hermeznetwork/hermez-node/common"
"github.com/hermeznetwork/hermez-node/db"
"github.com/hermeznetwork/hermez-node/db/historydb"
)
func getBatches(c *gin.Context) {
// Get query parameters
// minBatchNum
minBatchNum, err := parseQueryUint("minBatchNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
// maxBatchNum
maxBatchNum, err := parseQueryUint("maxBatchNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
// slotNum
slotNum, err := parseQueryUint("slotNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
// forgerAddr
forgerAddr, err := parseQueryEthAddr("forgerAddr", c)
if err != nil {
retBadReq(err, c)
return
}
// pagination
fromItem, order, limit, err := parsePagination(c)
if err != nil {
retBadReq(err, c)
return
}
// Fetch batches from historyDB
batches, pagination, err := h.GetBatchesAPI(
minBatchNum, maxBatchNum, slotNum, forgerAddr, fromItem, limit, order,
)
if err != nil {
retSQLErr(err, c)
return
}
// Build succesfull response
type batchesResponse struct {
Batches []historydb.BatchAPI `json:"batches"`
Pagination *db.Pagination `json:"pagination"`
}
c.JSON(http.StatusOK, &batchesResponse{
Batches: batches,
Pagination: pagination,
})
}
func getBatch(c *gin.Context) {
// Get batchNum
batchNum, err := parseParamUint("batchNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
if batchNum == nil { // batchNum is required
retBadReq(errors.New("Invalid batchNum"), c)
return
}
// Fetch batch from historyDB
batch, err := h.GetBatchAPI(common.BatchNum(*batchNum))
if err != nil {
retSQLErr(err, c)
return
}
// JSON response
c.JSON(http.StatusOK, batch)
}
type fullBatch struct {
Batch *historydb.BatchAPI
Txs []historyTxAPI
}
func getFullBatch(c *gin.Context) {
// Get batchNum
batchNum, err := parseParamUint("batchNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
if batchNum == nil {
retBadReq(errors.New("Invalid batchNum"), c)
return
}
// Fetch batch from historyDB
batch, err := h.GetBatchAPI(common.BatchNum(*batchNum))
if err != nil {
retSQLErr(err, c)
return
}
// Fetch txs from historyDB
// TODO
txs := []historyTxAPI{}
// JSON response
c.JSON(http.StatusOK, fullBatch{
Batch: batch,
Txs: txs,
})
}

243
api/batch_test.go Normal file
View File

@@ -0,0 +1,243 @@
package api
import (
"fmt"
"strconv"
"testing"
"time"
ethCommon "github.com/ethereum/go-ethereum/common"
"github.com/hermeznetwork/hermez-node/common"
"github.com/hermeznetwork/hermez-node/db"
"github.com/hermeznetwork/hermez-node/db/historydb"
"github.com/mitchellh/copystructure"
"github.com/stretchr/testify/assert"
)
type testBatch struct {
ItemID int `json:"itemId"`
BatchNum common.BatchNum `json:"batchNum"`
EthBlockNum int64 `json:"ethereumBlockNum"`
EthBlockHash ethCommon.Hash `json:"ethereumBlockHash"`
Timestamp time.Time `json:"timestamp"`
ForgerAddr ethCommon.Address `json:"forgerAddr"`
CollectedFees map[common.TokenID]string `json:"collectedFees"`
TotalFeesUSD *float64 `json:"historicTotalCollectedFeesUSD"`
StateRoot string `json:"stateRoot"`
NumAccounts int `json:"numAccounts"`
ExitRoot string `json:"exitRoot"`
ForgeL1TxsNum *int64 `json:"forgeL1TransactionsNum"`
SlotNum int64 `json:"slotNum"`
}
type testBatchesResponse struct {
Batches []testBatch `json:"batches"`
Pagination *db.Pagination `json:"pagination"`
}
func (t testBatchesResponse) GetPagination() *db.Pagination {
if t.Batches[0].ItemID < t.Batches[len(t.Batches)-1].ItemID {
t.Pagination.FirstReturnedItem = t.Batches[0].ItemID
t.Pagination.LastReturnedItem = t.Batches[len(t.Batches)-1].ItemID
} else {
t.Pagination.LastReturnedItem = t.Batches[0].ItemID
t.Pagination.FirstReturnedItem = t.Batches[len(t.Batches)-1].ItemID
}
return t.Pagination
}
func (t testBatchesResponse) Len() int {
return len(t.Batches)
}
func genTestBatches(blocks []common.Block, cBatches []common.Batch) []testBatch {
tBatches := []testBatch{}
for _, cBatch := range cBatches {
block := common.Block{}
found := false
for _, b := range blocks {
if b.EthBlockNum == cBatch.EthBlockNum {
block = b
found = true
break
}
}
if !found {
panic("block not found")
}
collectedFees := make(map[common.TokenID]string)
for k, v := range cBatch.CollectedFees {
collectedFees[k] = v.String()
}
tBatch := testBatch{
BatchNum: cBatch.BatchNum,
EthBlockNum: cBatch.EthBlockNum,
EthBlockHash: block.Hash,
Timestamp: block.Timestamp,
ForgerAddr: cBatch.ForgerAddr,
CollectedFees: collectedFees,
TotalFeesUSD: cBatch.TotalFeesUSD,
StateRoot: cBatch.StateRoot.String(),
NumAccounts: cBatch.NumAccounts,
ExitRoot: cBatch.ExitRoot.String(),
ForgeL1TxsNum: cBatch.ForgeL1TxsNum,
SlotNum: cBatch.SlotNum,
}
tBatches = append(tBatches, tBatch)
}
return tBatches
}
func TestGetBatches(t *testing.T) {
endpoint := apiURL + "batches"
fetchedBatches := []testBatch{}
appendIter := func(intr interface{}) {
for i := 0; i < len(intr.(*testBatchesResponse).Batches); i++ {
tmp, err := copystructure.Copy(intr.(*testBatchesResponse).Batches[i])
if err != nil {
panic(err)
}
fetchedBatches = append(fetchedBatches, tmp.(testBatch))
}
}
// Get all (no filters)
limit := 3
path := fmt.Sprintf("%s?limit=%d&fromItem=", endpoint, limit)
err := doGoodReqPaginated(path, historydb.OrderAsc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
assertBatches(t, tc.batches, fetchedBatches)
// minBatchNum
fetchedBatches = []testBatch{}
limit = 2
minBatchNum := tc.batches[len(tc.batches)/2].BatchNum
path = fmt.Sprintf("%s?minBatchNum=%d&limit=%d&fromItem=", endpoint, minBatchNum, limit)
err = doGoodReqPaginated(path, historydb.OrderAsc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
minBatchNumBatches := []testBatch{}
for i := 0; i < len(tc.batches); i++ {
if tc.batches[i].BatchNum > minBatchNum {
minBatchNumBatches = append(minBatchNumBatches, tc.batches[i])
}
}
assertBatches(t, minBatchNumBatches, fetchedBatches)
// maxBatchNum
fetchedBatches = []testBatch{}
limit = 1
maxBatchNum := tc.batches[len(tc.batches)/2].BatchNum
path = fmt.Sprintf("%s?maxBatchNum=%d&limit=%d&fromItem=", endpoint, maxBatchNum, limit)
err = doGoodReqPaginated(path, historydb.OrderAsc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
maxBatchNumBatches := []testBatch{}
for i := 0; i < len(tc.batches); i++ {
if tc.batches[i].BatchNum < maxBatchNum {
maxBatchNumBatches = append(maxBatchNumBatches, tc.batches[i])
}
}
assertBatches(t, maxBatchNumBatches, fetchedBatches)
// slotNum
fetchedBatches = []testBatch{}
limit = 5
slotNum := tc.batches[len(tc.batches)/2].SlotNum
path = fmt.Sprintf("%s?slotNum=%d&limit=%d&fromItem=", endpoint, slotNum, limit)
err = doGoodReqPaginated(path, historydb.OrderAsc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
slotNumBatches := []testBatch{}
for i := 0; i < len(tc.batches); i++ {
if tc.batches[i].SlotNum == slotNum {
slotNumBatches = append(slotNumBatches, tc.batches[i])
}
}
assertBatches(t, slotNumBatches, fetchedBatches)
// forgerAddr
fetchedBatches = []testBatch{}
limit = 10
forgerAddr := tc.batches[len(tc.batches)/2].ForgerAddr
path = fmt.Sprintf("%s?forgerAddr=%s&limit=%d&fromItem=", endpoint, forgerAddr.String(), limit)
err = doGoodReqPaginated(path, historydb.OrderAsc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
forgerAddrBatches := []testBatch{}
for i := 0; i < len(tc.batches); i++ {
if tc.batches[i].ForgerAddr == forgerAddr {
forgerAddrBatches = append(forgerAddrBatches, tc.batches[i])
}
}
assertBatches(t, forgerAddrBatches, fetchedBatches)
// All, in reverse order
fetchedBatches = []testBatch{}
limit = 6
path = fmt.Sprintf("%s?limit=%d&fromItem=", endpoint, limit)
err = doGoodReqPaginated(path, historydb.OrderDesc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
flippedBatches := []testBatch{}
for i := len(tc.batches) - 1; i >= 0; i-- {
flippedBatches = append(flippedBatches, tc.batches[i])
}
assertBatches(t, flippedBatches, fetchedBatches)
// Mixed filters
fetchedBatches = []testBatch{}
limit = 1
maxBatchNum = tc.batches[len(tc.batches)-len(tc.batches)/4].BatchNum
minBatchNum = tc.batches[len(tc.batches)/4].BatchNum
path = fmt.Sprintf("%s?minBatchNum=%d&maxBatchNum=%d&limit=%d&fromItem=", endpoint, minBatchNum, maxBatchNum, limit)
err = doGoodReqPaginated(path, historydb.OrderAsc, &testBatchesResponse{}, appendIter)
assert.NoError(t, err)
minMaxBatchNumBatches := []testBatch{}
for i := 0; i < len(tc.batches); i++ {
if tc.batches[i].BatchNum < maxBatchNum && tc.batches[i].BatchNum > minBatchNum {
minMaxBatchNumBatches = append(minMaxBatchNumBatches, tc.batches[i])
}
}
assertBatches(t, minMaxBatchNumBatches, fetchedBatches)
// 400
// Invalid minBatchNum
path = fmt.Sprintf("%s?minBatchNum=%d", endpoint, -2)
err = doBadReq("GET", path, nil, 400)
assert.NoError(t, err)
// Invalid forgerAddr
path = fmt.Sprintf("%s?forgerAddr=%s", endpoint, "0xG0000001")
err = doBadReq("GET", path, nil, 400)
assert.NoError(t, err)
// 404
path = fmt.Sprintf("%s?slotNum=%d&minBatchNum=%d", endpoint, 1, 25)
err = doBadReq("GET", path, nil, 404)
assert.NoError(t, err)
}
func TestGetBatch(t *testing.T) {
endpoint := apiURL + "batches/"
for _, batch := range tc.batches {
fetchedBatch := testBatch{}
assert.NoError(
t, doGoodReq(
"GET",
endpoint+strconv.Itoa(int(batch.BatchNum)),
nil, &fetchedBatch,
),
)
assertBatch(t, batch, fetchedBatch)
}
// 400
assert.NoError(t, doBadReq("GET", endpoint+"foo", nil, 400))
// 404
assert.NoError(t, doBadReq("GET", endpoint+"99999", nil, 404))
}
func assertBatches(t *testing.T, expected, actual []testBatch) {
assert.Equal(t, len(expected), len(actual))
for i := 0; i < len(expected); i++ {
assertBatch(t, expected[i], actual[i])
}
}
func assertBatch(t *testing.T, expected, actual testBatch) {
assert.Equal(t, expected.Timestamp.Unix(), actual.Timestamp.Unix())
expected.Timestamp = actual.Timestamp
actual.ItemID = expected.ItemID
assert.Equal(t, expected, actual)
}

57
api/handlers.go
View File

@@ -178,49 +178,6 @@ func getExit(c *gin.Context) {
c.JSON(http.StatusOK, apiExits[0])
}
func getHistoryTxs(c *gin.Context) {
// Get query parameters
tokenID, addr, bjj, idx, err := parseAccountFilters(c)
if err != nil {
retBadReq(err, c)
return
}
// BatchNum
batchNum, err := parseQueryUint("batchNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
// TxType
txType, err := parseQueryTxType(c)
if err != nil {
retBadReq(err, c)
return
}
// Pagination
fromItem, order, limit, err := parsePagination(c)
if err != nil {
retBadReq(err, c)
return
}
// Fetch txs from historyDB
txs, pagination, err := h.GetHistoryTxs(
addr, bjj, tokenID, idx, batchNum, txType, fromItem, limit, order,
)
if err != nil {
retSQLErr(err, c)
return
}
// Build succesfull response
apiTxs := historyTxsToAPI(txs)
c.JSON(http.StatusOK, &historyTxsAPI{
Txs: apiTxs,
Pagination: pagination,
})
}
func getHistoryTx(c *gin.Context) {
// Get TxID
txID, err := parseParamTxID(c)
@@ -239,18 +196,6 @@ func getHistoryTx(c *gin.Context) {
c.JSON(http.StatusOK, apiTxs[0])
}
func getBatches(c *gin.Context) {
}
func getBatch(c *gin.Context) {
}
func getFullBatch(c *gin.Context) {
}
func getSlots(c *gin.Context) {
}
@@ -349,7 +294,7 @@ func getCoordinators(c *gin.Context) {
func getCoordinator(c *gin.Context) {
// Get bidderAddr
const name = "bidderAddr"
bidderAddr, err := parseEthAddr(c, name)
bidderAddr, err := parseParamEthAddr(name, c)
if err != nil {
retBadReq(err, c)

16
api/parsers.go
View File

@@ -311,13 +311,25 @@ func hezStringToBJJ(bjjStr, name string) (*babyjub.PublicKey, error) {
return bjj, nil
}
func parseEthAddr(c paramer, name string) (*ethCommon.Address, error) {
func parseQueryEthAddr(name string, c querier) (*ethCommon.Address, error) {
addrStr := c.Query(name)
if addrStr == "" {
return nil, nil
}
return parseEthAddr(addrStr)
}
func parseParamEthAddr(name string, c paramer) (*ethCommon.Address, error) {
addrStr := c.Param(name)
if addrStr == "" {
return nil, nil
}
return parseEthAddr(addrStr)
}
func parseEthAddr(ethAddrStr string) (*ethCommon.Address, error) {
var addr ethCommon.Address
err := addr.UnmarshalText([]byte(addrStr))
err := addr.UnmarshalText([]byte(ethAddrStr))
return &addr, err
}

6
api/parsers_test.go
View File

@@ -309,16 +309,16 @@ func TestParseEthAddr(t *testing.T) {
ethAddr := ethCommon.BigToAddress(big.NewInt(int64(123456)))
// Default
c.m[name] = ""
res, err := parseEthAddr(c, name)
res, err := parseQueryEthAddr(name, c)
assert.NoError(t, err)
assert.Nil(t, res)
// Incorrect
c.m[name] = "0x12345678"
_, err = parseEthAddr(c, name)
_, err = parseQueryEthAddr(name, c)
assert.Error(t, err)
// Correct
c.m[name] = ethAddr.String()
res, err = parseEthAddr(c, name)
res, err = parseQueryEthAddr(name, c)
assert.NoError(t, err)
assert.Equal(t, ethAddr, *res)
}

58
api/swagger.yml
View File

@@ -605,13 +605,13 @@ paths:
- name: minBatchNum
in: query
required: false
description: Include only `batchNum < minBatchNum` batches.
description: Include only `batchNum > minBatchNum` batches.
schema:
$ref: '#/components/schemas/BatchNum'
- name: maxBatchNum
in: query
required: false
description: Include only `batchNum > maxBatchNum` batches.
description: Include only `batchNum < maxBatchNum` batches.
schema:
type: number
- name: slotNum
@@ -1492,7 +1492,7 @@ components:
type: string
description: BigInt is an integer encoded as a string for numbers that are very large.
example: "8708856933496328593"
pattern: "^[0-9]$"
pattern: "^\\d+$"
FeeSelector:
type: integer
description: Index of the fee type to select, more info [here](https://idocs.hermez.io/#/spec/zkrollup/fee-table?id=transaction-fee-table).
@@ -1734,22 +1734,19 @@ components:
description: Token name.
example: "Dai"
CollectedFees:
type: array
description: Collected fees by the forger of the batch. A maximum of 64 different tokens can be used.
items:
type: object
properties:
tokenId:
$ref: '#/components/schemas/TokenId'
amount:
allOf:
- $ref: '#/components/schemas/BigInt'
- description: Ammount of collected tokens
- example: "53"
type: object
description: Collected fees by the forger of the batch, represented by a map of tokenId => amount. A maximum of 64 different tokens can be used.
additionalProperties:
type: string
example:
1234: "425632785672345647"
4321: "86538967235465432654352"
Batch:
type: object
description: Group of transactions forged in a coordinator and sent and validated in Ethereum.
properties:
itemId:
$ref: '#/components/schemas/ItemId'
batchNum:
$ref: '#/components/schemas/BatchNum'
ethereumBlockNum:
@@ -1784,12 +1781,27 @@ components:
- description: Root of the exit Merkle Tree associated to this batch.
- example: "2734657026572a8708d883"
forgeL1TransactionsNum:
allOf:
- $ref: '#/components/schemas/ToForgeL1TransactionsNum'
- description: Identifier that corresponds to the group of L1 transactions forged in the current batch.
- example: 5
type: integer
description: Identifier that corresponds to the group of L1 transactions forged in the current batch.
example: 5
nullable: true
slotNum:
$ref: '#/components/schemas/SlotNum'
additionalProperties: false
required:
- itemId
- batchNum
- ethereumBlockNum
- ethereumBlockHash
- timestamp
- forgerAddr
- collectedFees
- historicTotalCollectedFeesUSD
- stateRoot
- numAccounts
- exitRoot
- forgeL1TransactionsNum
- slotNum
FullBatch:
type: object
description: Group of transactions forged in a coordinator and sent and validated in Ethereum.
@@ -1801,6 +1813,10 @@ components:
description: List of forged transactions in the batch
items:
$ref: '#/components/schemas/HistoryTransaction'
additionalProperties: false
required:
- batch
- transactions
Hash:
type: string
description: hashed data
@@ -1821,6 +1837,10 @@ components:
$ref: '#/components/schemas/Batch'
pagination:
$ref: '#/components/schemas/PaginationInfo'
additionalProperties: false
required:
- batches
- pagination
Coordinator:
type: object
properties:

50
api/txshistory.go Normal file
View File

@@ -0,0 +1,50 @@
package api
import (
"net/http"
"github.com/gin-gonic/gin"
)
func getHistoryTxs(c *gin.Context) {
// Get query parameters
tokenID, addr, bjj, idx, err := parseAccountFilters(c)
if err != nil {
retBadReq(err, c)
return
}
// BatchNum
batchNum, err := parseQueryUint("batchNum", nil, 0, maxUint32, c)
if err != nil {
retBadReq(err, c)
return
}
// TxType
txType, err := parseQueryTxType(c)
if err != nil {
retBadReq(err, c)
return
}
// Pagination
fromItem, order, limit, err := parsePagination(c)
if err != nil {
retBadReq(err, c)
return
}
// Fetch txs from historyDB
txs, pagination, err := h.GetHistoryTxs(
addr, bjj, tokenID, idx, batchNum, txType, fromItem, limit, order,
)
if err != nil {
retSQLErr(err, c)
return
}
// Build succesfull response
apiTxs := historyTxsToAPI(txs)
c.JSON(http.StatusOK, &historyTxsAPI{
Txs: apiTxs,
Pagination: pagination,
})
}