Feature/batchbuilder initfeature/sql-semaphore1
@ -0,0 +1,231 @@ |
|||||
|
package batchbuilder |
||||
|
|
||||
|
import ( |
||||
|
ethCommon "github.com/ethereum/go-ethereum/common" |
||||
|
"github.com/hermeznetwork/hermez-node/common" |
||||
|
"github.com/iden3/go-iden3-crypto/babyjub" |
||||
|
"github.com/iden3/go-merkletree" |
||||
|
"github.com/iden3/go-merkletree/db" |
||||
|
"github.com/iden3/go-merkletree/db/memory" |
||||
|
) |
||||
|
|
||||
|
// ConfigCircuit contains the circuit configuration
|
||||
|
type ConfigCircuit struct { |
||||
|
TxsMax uint64 |
||||
|
L1TxsMax uint64 |
||||
|
SMTLevelsMax uint64 |
||||
|
} |
||||
|
|
||||
|
// BatchBuilder implements the batch builder type, which contains the functionallities
|
||||
|
type BatchBuilder struct { |
||||
|
StateDB db.Storage // where the MTs will be stored by the Synchronizer
|
||||
|
idx uint64 |
||||
|
mt *merkletree.MerkleTree |
||||
|
configCircuits []ConfigCircuit |
||||
|
} |
||||
|
|
||||
|
// ConfigBatch contains the batch configuration
|
||||
|
type ConfigBatch struct { |
||||
|
CoordinatorAddress ethCommon.Address |
||||
|
} |
||||
|
|
||||
|
// NewBatchBuilder constructs a new BatchBuilder, and executes the bb.Reset
|
||||
|
// method
|
||||
|
func NewBatchBuilder(stateDB db.Storage, configCircuits []ConfigCircuit, batchNum int, idx, nLevels uint64) (*BatchBuilder, error) { |
||||
|
localMt, err := merkletree.NewMerkleTree(memory.NewMemoryStorage(), int(nLevels)) |
||||
|
if err != nil { |
||||
|
return nil, err |
||||
|
} |
||||
|
bb := BatchBuilder{ |
||||
|
StateDB: stateDB, |
||||
|
idx: idx, |
||||
|
mt: localMt, |
||||
|
configCircuits: configCircuits, |
||||
|
} |
||||
|
|
||||
|
err = bb.Reset(batchNum, idx, true) |
||||
|
return &bb, err |
||||
|
} |
||||
|
|
||||
|
// Reset tells the BatchBuilder to reset it's internal state to the required
|
||||
|
// `batchNum`. If `fromSynchronizer` is true, the BatchBuilder must take a
|
||||
|
// copy of the rollup state from the Synchronizer at that `batchNum`, otherwise
|
||||
|
// it can just roll back the internal copy.
|
||||
|
func (bb *BatchBuilder) Reset(batchNum int, idx uint64, fromSynchronizer bool) error { |
||||
|
// TODO
|
||||
|
return nil |
||||
|
} |
||||
|
|
||||
|
// BuildBatch takes the transactions and returns the common.ZKInputs of the next batch
|
||||
|
func (bb *BatchBuilder) BuildBatch(configBatch ConfigBatch, l1usertxs, l1coordinatortxs []common.L1Tx, l2txs []common.L2Tx, tokenIDs []common.TokenID) (*common.ZKInputs, error) { |
||||
|
for _, tx := range l1usertxs { |
||||
|
err := bb.processL1Tx(tx) |
||||
|
if err != nil { |
||||
|
return nil, err |
||||
|
} |
||||
|
} |
||||
|
for _, tx := range l1coordinatortxs { |
||||
|
err := bb.processL1Tx(tx) |
||||
|
if err != nil { |
||||
|
return nil, err |
||||
|
} |
||||
|
} |
||||
|
for _, tx := range l2txs { |
||||
|
switch tx.Type { |
||||
|
case common.TxTypeTransfer: |
||||
|
// go to the MT leaf of sender and receiver, and update
|
||||
|
// balance & nonce
|
||||
|
err := bb.applyTransfer(tx.Tx) |
||||
|
if err != nil { |
||||
|
return nil, err |
||||
|
} |
||||
|
case common.TxTypeExit: |
||||
|
// execute exit flow
|
||||
|
default: |
||||
|
} |
||||
|
} |
||||
|
|
||||
|
return nil, nil |
||||
|
} |
||||
|
|
||||
|
func (bb *BatchBuilder) processL1Tx(tx common.L1Tx) error { |
||||
|
switch tx.Type { |
||||
|
case common.TxTypeForceTransfer, common.TxTypeTransfer: |
||||
|
// go to the MT leaf of sender and receiver, and update balance
|
||||
|
// & nonce
|
||||
|
err := bb.applyTransfer(tx.Tx) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
case common.TxTypeCreateAccountDeposit: |
||||
|
// add new leaf to the MT, update balance of the MT leaf
|
||||
|
err := bb.applyCreateLeaf(tx) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
case common.TxTypeDeposit: |
||||
|
// update balance of the MT leaf
|
||||
|
err := bb.applyDeposit(tx, false) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
case common.TxTypeDepositAndTransfer: |
||||
|
// update balance in MT leaf, update balance & nonce of sender
|
||||
|
// & receiver
|
||||
|
err := bb.applyDeposit(tx, true) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
case common.TxTypeCreateAccountDepositAndTransfer: |
||||
|
// add new leaf to the merkletree, update balance in MT leaf,
|
||||
|
// update balance & nonce of sender & receiver
|
||||
|
err := bb.applyCreateLeaf(tx) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
err = bb.applyTransfer(tx.Tx) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
case common.TxTypeExit: |
||||
|
// execute exit flow
|
||||
|
default: |
||||
|
} |
||||
|
|
||||
|
return nil |
||||
|
} |
||||
|
|
||||
|
// applyCreateLeaf creates a new leaf in the leaf of the depositer, it stores
|
||||
|
// the deposit value
|
||||
|
func (bb *BatchBuilder) applyCreateLeaf(tx common.L1Tx) error { |
||||
|
leaf := common.Leaf{ |
||||
|
TokenID: tx.TokenID, |
||||
|
Nonce: 0, // TODO check w spec: always that a new leaf is created nonce is at 0
|
||||
|
Balance: tx.LoadAmount, |
||||
|
Sign: babyjub.PointCoordSign(tx.FromBJJ.X), |
||||
|
Ay: tx.FromBJJ.Y, |
||||
|
EthAddr: tx.FromEthAddr, |
||||
|
} |
||||
|
|
||||
|
v, err := leaf.HashValue() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
dbTx, err := bb.mt.DB().NewTx() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
err = bb.CreateBalance(dbTx, common.Idx(bb.idx+1), leaf) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
leafBytes, err := leaf.Bytes() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
dbTx.Put(v.Bytes(), leafBytes[:]) |
||||
|
|
||||
|
// if everything is fine, do dbTx & increment idx
|
||||
|
if err := dbTx.Commit(); err != nil { |
||||
|
return err |
||||
|
} |
||||
|
bb.idx = bb.idx + 1 |
||||
|
return nil |
||||
|
} |
||||
|
|
||||
|
// applyDeposit updates the balance in the leaf of the depositer, if andTransfer parameter is set to true, the method will also apply the Transfer of the L1Tx/DepositAndTransfer
|
||||
|
func (bb *BatchBuilder) applyDeposit(tx common.L1Tx, andTransfer bool) error { |
||||
|
dbTx, err := bb.mt.DB().NewTx() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
// deposit
|
||||
|
err = bb.UpdateBalance(dbTx, tx.FromIdx, tx.LoadAmount, false) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
// in case that the tx is a L1Tx>DepositAndTransfer
|
||||
|
if andTransfer { |
||||
|
// transact
|
||||
|
err = bb.UpdateBalance(dbTx, tx.FromIdx, tx.Tx.Amount, true) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
err = bb.UpdateBalance(dbTx, tx.ToIdx, tx.Tx.Amount, false) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
} |
||||
|
|
||||
|
if err := dbTx.Commit(); err != nil { |
||||
|
return err |
||||
|
} |
||||
|
return nil |
||||
|
} |
||||
|
|
||||
|
// applyTransfer updates the balance & nonce in the leaf of the sender, and the
|
||||
|
// balance in the leaf of the receiver
|
||||
|
func (bb *BatchBuilder) applyTransfer(tx common.Tx) error { |
||||
|
dbTx, err := bb.mt.DB().NewTx() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
// transact
|
||||
|
err = bb.UpdateBalance(dbTx, tx.FromIdx, tx.Amount, true) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
err = bb.UpdateBalance(dbTx, tx.ToIdx, tx.Amount, false) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
if err := dbTx.Commit(); err != nil { |
||||
|
return err |
||||
|
} |
||||
|
return nil |
||||
|
} |
@ -0,0 +1,29 @@ |
|||||
|
package batchbuilder |
||||
|
|
||||
|
import ( |
||||
|
"fmt" |
||||
|
"testing" |
||||
|
|
||||
|
"github.com/iden3/go-merkletree/db/memory" |
||||
|
"github.com/stretchr/testify/assert" |
||||
|
) |
||||
|
|
||||
|
// func genTxs(n int) common.Tx {
|
||||
|
// return common.Tx{}
|
||||
|
// }
|
||||
|
// func genL1Txs(n int) []common.L1Tx {
|
||||
|
//
|
||||
|
// return nil
|
||||
|
// }
|
||||
|
// func genL2Txs(n int) []common.L2Tx {
|
||||
|
//
|
||||
|
// return nil
|
||||
|
// }
|
||||
|
|
||||
|
func TestBatchBuilder(t *testing.T) { |
||||
|
stateDB := memory.NewMemoryStorage() |
||||
|
|
||||
|
bb, err := NewBatchBuilder(stateDB, nil, 0, 0, 32) |
||||
|
assert.Nil(t, err) |
||||
|
fmt.Println(bb) |
||||
|
} |
@ -0,0 +1,85 @@ |
|||||
|
package batchbuilder |
||||
|
|
||||
|
import ( |
||||
|
"math/big" |
||||
|
|
||||
|
"github.com/hermeznetwork/hermez-node/common" |
||||
|
"github.com/iden3/go-merkletree/db" |
||||
|
) |
||||
|
|
||||
|
// TODO next iteration move the methods of this file into StateDB, which Synchronizer will use in the disk DB, and BatchBuilder will use with the MemoryDB
|
||||
|
|
||||
|
// GetBalance returns the balance for a given Idx from the DB
|
||||
|
func (bb *BatchBuilder) GetBalance(tx db.Tx, idx common.Idx) (*common.Leaf, error) { |
||||
|
idxBytes := idx.Bytes() |
||||
|
vBytes, err := tx.Get(idxBytes[:]) |
||||
|
if err != nil { |
||||
|
return nil, err |
||||
|
} |
||||
|
var b [32 * common.NLEAFELEMS]byte |
||||
|
copy(b[:], vBytes) |
||||
|
leaf, err := common.LeafFromBytes(b) |
||||
|
if err != nil { |
||||
|
return nil, err |
||||
|
} |
||||
|
return leaf, nil |
||||
|
} |
||||
|
|
||||
|
// CreateBalance stores the Leaf into the Idx position in the MerkleTree, also adds db entry for the Leaf value
|
||||
|
func (bb *BatchBuilder) CreateBalance(tx db.Tx, idx common.Idx, leaf common.Leaf) error { |
||||
|
// store at the DB the key: v, and value: leaf.Bytes()
|
||||
|
v, err := leaf.HashValue() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
leafBytes, err := leaf.Bytes() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
// store the Leaf value
|
||||
|
tx.Put(v.Bytes(), leafBytes[:]) |
||||
|
// Add k & v into the MT
|
||||
|
err = bb.mt.Add(idx.BigInt(), v) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
return nil |
||||
|
} |
||||
|
|
||||
|
// UpdateBalance updates the balance of the leaf of a given Idx.
|
||||
|
// If sending==true: will substract the amount, if sending==false will add the ammount
|
||||
|
func (bb *BatchBuilder) UpdateBalance(tx db.Tx, idx common.Idx, amount *big.Int, sending bool) error { |
||||
|
leaf, err := bb.GetBalance(tx, idx) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
// TODO add checks that the numbers are correct and there is no missing value neither impossible values
|
||||
|
if sending { |
||||
|
leaf.Balance = new(big.Int).Sub(leaf.Balance, amount) |
||||
|
} else { |
||||
|
leaf.Balance = new(big.Int).Add(leaf.Balance, amount) |
||||
|
} |
||||
|
|
||||
|
// store at the DB the key: v, and value: leaf.Bytes()
|
||||
|
v, err := leaf.HashValue() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
leafBytes, err := leaf.Bytes() |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
// store the Leaf value
|
||||
|
tx.Put(v.Bytes(), leafBytes[:]) |
||||
|
// Add k & v into the MT
|
||||
|
err = bb.mt.Update(idx.BigInt(), v) |
||||
|
if err != nil { |
||||
|
return err |
||||
|
} |
||||
|
|
||||
|
return nil |
||||
|
} |
@ -0,0 +1,23 @@ |
|||||
|
package common |
||||
|
|
||||
|
import ( |
||||
|
"math/big" |
||||
|
"testing" |
||||
|
|
||||
|
"github.com/stretchr/testify/assert" |
||||
|
) |
||||
|
|
||||
|
func TestIdx(t *testing.T) { |
||||
|
i := Idx(100) |
||||
|
assert.Equal(t, big.NewInt(100), i.BigInt()) |
||||
|
|
||||
|
i = Idx(uint32(4294967295)) |
||||
|
assert.Equal(t, "4294967295", i.BigInt().String()) |
||||
|
|
||||
|
b := big.NewInt(4294967296) |
||||
|
i, err := IdxFromBigInt(b) |
||||
|
assert.NotNil(t, err) |
||||
|
assert.Equal(t, ErrNumOverflow, err) |
||||
|
assert.Equal(t, Idx(0), i) |
||||
|
|
||||
|
} |
@ -0,0 +1,56 @@ |
|||||
|
package common |
||||
|
|
||||
|
import ( |
||||
|
"math/big" |
||||
|
) |
||||
|
|
||||
|
type ZKInputs struct { |
||||
|
InitialIdx uint64 |
||||
|
OldStRoot Hash |
||||
|
FeePlanCoins *big.Int |
||||
|
FeeTotals *big.Int |
||||
|
PubEthAddress *big.Int |
||||
|
|
||||
|
ImStateRoot []Hash |
||||
|
ImExitRoot []Hash |
||||
|
|
||||
|
ImOnChainHash []Hash |
||||
|
ImOnChain []*big.Int |
||||
|
TxData []*big.Int |
||||
|
|
||||
|
FromIdx []uint64 |
||||
|
ToIdX []uint64 |
||||
|
ToAx []*big.Int |
||||
|
ToAy []*big.Int |
||||
|
ToEthAddr []*big.Int |
||||
|
FromEthAddr []*big.Int |
||||
|
FromAx []*big.Int |
||||
|
FromAy []*big.Int |
||||
|
|
||||
|
RqTxData []*big.Int |
||||
|
LoadAmount []*big.Int |
||||
|
|
||||
|
S []*big.Int |
||||
|
R8x []*big.Int |
||||
|
R8y []*big.Int |
||||
|
|
||||
|
Ax1 []*big.Int |
||||
|
Ay1 []*big.Int |
||||
|
Amount1 []*big.Int |
||||
|
Nonce1 []*big.Int |
||||
|
EthAddr1 []*big.Int |
||||
|
Siblings1 [][]*big.Int |
||||
|
IsOld01 []*big.Int `json:"isOld0_1"` |
||||
|
OldKey1 []*big.Int |
||||
|
OldValue1 []*big.Int |
||||
|
|
||||
|
Ax2 []*big.Int |
||||
|
Ay2 []*big.Int |
||||
|
Amount2 []*big.Int |
||||
|
Nonce2 []*big.Int |
||||
|
EthAddr2 []*big.Int |
||||
|
Siblings2 [][]*big.Int |
||||
|
IsOld02 []*big.Int `json:"isOld0_2"` |
||||
|
OldKey2 []*big.Int |
||||
|
OldValue2 []*big.Int |
||||
|
} |