hermez-node/txselector/txselector.go
txselector/txselector.goRaw
1package txselector
2
3// current: very simple version of TxSelector
4
5import (
6 "fmt"
7 "math/big"
8 "sort"
9
10 ethCommon "github.com/ethereum/go-ethereum/common"
11 "github.com/hermeznetwork/hermez-node/common"
12 "github.com/hermeznetwork/hermez-node/db/kvdb"
13 "github.com/hermeznetwork/hermez-node/db/l2db"
14 "github.com/hermeznetwork/hermez-node/db/statedb"
15 "github.com/hermeznetwork/hermez-node/log"
16 "github.com/hermeznetwork/hermez-node/txprocessor"
17 "github.com/hermeznetwork/tracerr"
18 "github.com/iden3/go-iden3-crypto/babyjub"
19)
20
21// txs implements the interface Sort for an array of Tx
22type txs []common.PoolL2Tx
23
24func (t txs) Len() int {
25 return len(t)
26}
27func (t txs) Swap(i, j int) {
28 t[i], t[j] = t[j], t[i]
29}
30func (t txs) Less(i, j int) bool {
31 return t[i].AbsoluteFee > t[j].AbsoluteFee
32}
33
34// CoordAccount contains the data of the Coordinator account, that will be used
35// to create new transactions of CreateAccountDeposit type to add new TokenID
36// accounts for the Coordinator to receive the fees.
37type CoordAccount struct {
38 Addr ethCommon.Address
39 BJJ babyjub.PublicKeyComp
40 AccountCreationAuth []byte // signature in byte array format
41}
42
43// SelectionConfig contains the parameters of configuration of the selection of
44// transactions for the next batch
45type SelectionConfig struct {
46 // MaxL1UserTxs is the maximum L1-user-tx for a batch
47 MaxL1UserTxs uint64
48
49 // TxProcessorConfig contains the config for ProcessTxs
50 TxProcessorConfig txprocessor.Config
51}
52
53// TxSelector implements all the functionalities to select the txs for the next
54// batch
55type TxSelector struct {
56 l2db *l2db.L2DB
57 localAccountsDB *statedb.LocalStateDB
58
59 coordAccount *CoordAccount
60}
61
62// NewTxSelector returns a *TxSelector
63func NewTxSelector(coordAccount *CoordAccount, dbpath string,
64 synchronizerStateDB *statedb.StateDB, l2 *l2db.L2DB) (*TxSelector, error) {
65 localAccountsDB, err := statedb.NewLocalStateDB(
66 statedb.Config{
67 Path: dbpath,
68 Keep: kvdb.DefaultKeep,
69 Type: statedb.TypeTxSelector,
70 NLevels: 0,
71 },
72 synchronizerStateDB) // without merkletree
73 if err != nil {
74 return nil, tracerr.Wrap(err)
75 }
76
77 return &TxSelector{
78 l2db: l2,
79 localAccountsDB: localAccountsDB,
80 coordAccount: coordAccount,
81 }, nil
82}
83
84// LocalAccountsDB returns the LocalStateDB of the TxSelector
85func (txsel *TxSelector) LocalAccountsDB() *statedb.LocalStateDB {
86 return txsel.localAccountsDB
87}
88
89// Reset tells the TxSelector to get it's internal AccountsDB
90// from the required `batchNum`
91func (txsel *TxSelector) Reset(batchNum common.BatchNum, fromSynchronizer bool) error {
92 return tracerr.Wrap(txsel.localAccountsDB.Reset(batchNum, fromSynchronizer))
93}
94
95func (txsel *TxSelector) getCoordIdx(tokenID common.TokenID) (common.Idx, error) {
96 return txsel.localAccountsDB.GetIdxByEthAddrBJJ(txsel.coordAccount.Addr,
97 txsel.coordAccount.BJJ, tokenID)
98}
99
100// coordAccountForTokenID creates a new L1CoordinatorTx to create a new
101// Coordinator account for the given TokenID in the case that the account does
102// not exist yet in the db, and does not exist a L1CoordinatorTx to creat that
103// account in the given array of L1CoordinatorTxs. If a new Coordinator account
104// needs to be created, a new L1CoordinatorTx will be returned from this
105// function. After calling this method, if the l1CoordinatorTx is added to the
106// selection, positionL1 must be increased 1.
107func (txsel *TxSelector) coordAccountForTokenID(l1CoordinatorTxs []common.L1Tx,
108 tokenID common.TokenID, positionL1 int) (*common.L1Tx, int, error) {
109 // check if CoordinatorAccount for TokenID is already pending to create
110 if checkAlreadyPendingToCreate(l1CoordinatorTxs, tokenID,
111 txsel.coordAccount.Addr, txsel.coordAccount.BJJ) {
112 return nil, positionL1, nil
113 }
114 _, err := txsel.getCoordIdx(tokenID)
115 if tracerr.Unwrap(err) == statedb.ErrIdxNotFound {
116 // create L1CoordinatorTx to create new CoordAccount for
117 // TokenID
118 l1CoordinatorTx := common.L1Tx{
119 Position: positionL1,
120 UserOrigin: false,
121 FromEthAddr: txsel.coordAccount.Addr,
122 FromBJJ: txsel.coordAccount.BJJ,
123 TokenID: tokenID,
124 Amount: big.NewInt(0),
125 DepositAmount: big.NewInt(0),
126 Type: common.TxTypeCreateAccountDeposit,
127 }
128
129 return &l1CoordinatorTx, positionL1, nil
130 }
131 if err != nil {
132 return nil, positionL1, tracerr.Wrap(err)
133 }
134 // CoordAccount for TokenID already exists
135 return nil, positionL1, nil
136}
137
138// GetL2TxSelection returns the L1CoordinatorTxs and a selection of the L2Txs
139// for the next batch, from the L2DB pool.
140// It returns: the CoordinatorIdxs used to receive the fees of the selected
141// L2Txs. An array of bytearrays with the signatures of the
142// AccountCreationAuthorization of the accounts of the users created by the
143// Coordinator with L1CoordinatorTxs of those accounts that does not exist yet
144// but there is a transactions to them and the authorization of account
145// creation exists. The L1UserTxs, L1CoordinatorTxs, PoolL2Txs that will be
146// included in the next batch.
147func (txsel *TxSelector) GetL2TxSelection(selectionConfig *SelectionConfig) ([]common.Idx,
148 [][]byte, []common.L1Tx, []common.PoolL2Tx, []common.PoolL2Tx, error) {
149 coordIdxs, accCreationAuths, _, l1CoordinatorTxs, l2Txs, discardedL2Txs, err :=
150 txsel.GetL1L2TxSelection(selectionConfig, []common.L1Tx{})
151 return coordIdxs, accCreationAuths, l1CoordinatorTxs, l2Txs, discardedL2Txs, tracerr.Wrap(err)
152}
153
154// GetL1L2TxSelection returns the selection of L1 + L2 txs.
155// It returns: the CoordinatorIdxs used to receive the fees of the selected
156// L2Txs. An array of bytearrays with the signatures of the
157// AccountCreationAuthorization of the accounts of the users created by the
158// Coordinator with L1CoordinatorTxs of those accounts that does not exist yet
159// but there is a transactions to them and the authorization of account
160// creation exists. The L1UserTxs, L1CoordinatorTxs, PoolL2Txs that will be
161// included in the next batch.
162func (txsel *TxSelector) GetL1L2TxSelection(selectionConfig *SelectionConfig,
163 l1UserTxs []common.L1Tx) ([]common.Idx, [][]byte, []common.L1Tx,
164 []common.L1Tx, []common.PoolL2Tx, []common.PoolL2Tx, error) {
165 // WIP.0: the TxSelector is not optimized and will need a redesign. The
166 // current version is implemented in order to have a functional
167 // implementation that can be used asap.
168 //
169 // WIP.1: this method uses a 'cherry-pick' of internal calls of the
170 // StateDB, a refactor of the StateDB to reorganize it internally is
171 // planned once the main functionallities are covered, with that
172 // refactor the TxSelector will be updated also.
173
174 // get pending l2-tx from tx-pool
175 l2TxsRaw, err := txsel.l2db.GetPendingTxs()
176 if err != nil {
177 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
178 }
179
180 txselStateDB := txsel.localAccountsDB.StateDB
181 tp := txprocessor.NewTxProcessor(txselStateDB, selectionConfig.TxProcessorConfig)
182
183 // Process L1UserTxs
184 for i := 0; i < len(l1UserTxs); i++ {
185 // assumption: l1usertx are sorted by L1Tx.Position
186 _, _, _, _, err := tp.ProcessL1Tx(nil, &l1UserTxs[i])
187 if err != nil {
188 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
189 }
190 }
191
192 // discardedL2Txs contains an array of the L2Txs that have not been selected in this Batch
193 var discardedL2Txs []common.PoolL2Tx
194
195 var l1CoordinatorTxs []common.L1Tx
196 positionL1 := len(l1UserTxs)
197 var accAuths [][]byte
198
199 // sort l2TxsRaw (cropping at MaxTx at this point)
200 l2Txs0 := txsel.getL2Profitable(l2TxsRaw, selectionConfig.TxProcessorConfig.MaxTx)
201
202 noncesMap := make(map[common.Idx]common.Nonce)
203 var l2Txs []common.PoolL2Tx
204 // iterate over l2Txs
205 // - if tx.TokenID does not exist at CoordsIdxDB
206 // - create new L1CoordinatorTx creating a CoordAccount, for
207 // Coordinator to receive the fee of the new TokenID
208 for i := 0; i < len(l2Txs0); i++ {
209 accSender, err := tp.StateDB().GetAccount(l2Txs0[i].FromIdx)
210 if err != nil {
211 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
212 }
213 l2Txs0[i].TokenID = accSender.TokenID
214 // populate the noncesMap used at the next iteration
215 noncesMap[l2Txs0[i].FromIdx] = accSender.Nonce
216
217 // if TokenID does not exist yet, create new L1CoordinatorTx to
218 // create the CoordinatorAccount for that TokenID, to receive
219 // the fees. Only in the case that there does not exist yet a
220 // pending L1CoordinatorTx to create the account for the
221 // Coordinator for that TokenID
222 var newL1CoordTx *common.L1Tx
223 newL1CoordTx, positionL1, err =
224 txsel.coordAccountForTokenID(l1CoordinatorTxs,
225 accSender.TokenID, positionL1)
226 if err != nil {
227 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
228 }
229 if newL1CoordTx != nil {
230 // if there is no space for the L1CoordinatorTx, discard the L2Tx
231 if len(l1CoordinatorTxs) >= int(selectionConfig.MaxL1UserTxs)-len(l1UserTxs) {
232 // discard L2Tx, and update Info parameter of
233 // the tx, and add it to the discardedTxs array
234 l2Txs0[i].Info = "Tx not selected because the L2Tx depends on a " +
235 "L1CoordinatorTx and there is not enough space for L1Coordinator"
236 discardedL2Txs = append(discardedL2Txs, l2Txs0[i])
237 continue
238 }
239 // increase positionL1
240 positionL1++
241 l1CoordinatorTxs = append(l1CoordinatorTxs, *newL1CoordTx)
242 accAuths = append(accAuths, txsel.coordAccount.AccountCreationAuth)
243 }
244 l2Txs = append(l2Txs, l2Txs0[i])
245 }
246
247 var validTxs []common.PoolL2Tx
248 // iterate over l2TxsRaw
249 // - check Nonces
250 // - check enough Balance for the Amount+Fee
251 // - if needed, create new L1CoordinatorTxs for unexisting ToIdx
252 // - keep used accAuths
253 // - put the valid txs into validTxs array
254 for i := 0; i < len(l2Txs); i++ {
255 enoughBalance, balance, feeAndAmount := tp.CheckEnoughBalance(l2Txs[i])
256 if !enoughBalance {
257 // not valid Amount with current Balance. Discard L2Tx,
258 // and update Info parameter of the tx, and add it to
259 // the discardedTxs array
260 l2Txs[i].Info = fmt.Sprintf("Tx not selected due to not enough Balance at the sender. "+
261 "Current sender account Balance: %s, Amount+Fee: %s",
262 balance.String(), feeAndAmount.String())
263 discardedL2Txs = append(discardedL2Txs, l2Txs[i])
264 continue
265 }
266 // check if Nonce is correct
267 nonce := noncesMap[l2Txs[i].FromIdx]
268 if l2Txs[i].Nonce == nonce {
269 noncesMap[l2Txs[i].FromIdx]++
270 } else {
271 // not valid Nonce at tx. Discard L2Tx, and update Info
272 // parameter of the tx, and add it to the discardedTxs
273 // array
274 l2Txs[i].Info = fmt.Sprintf("Tx not selected due to not current Nonce. "+
275 "Tx.Nonce: %d, Account.Nonce: %d", l2Txs[i].Nonce, nonce)
276 discardedL2Txs = append(discardedL2Txs, l2Txs[i])
277 continue
278 }
279
280 // If tx.ToIdx>=256, tx.ToIdx should exist to localAccountsDB,
281 // if so, tx is used. If tx.ToIdx==0, for an L2Tx will be the
282 // case of TxToEthAddr or TxToBJJ, check if
283 // tx.ToEthAddr/tx.ToBJJ exist in localAccountsDB, if yes tx is
284 // used; if not, check if tx.ToEthAddr is in
285 // AccountCreationAuthDB, if so, tx is used and L1CoordinatorTx
286 // of CreateAccountAndDeposit is created. If tx.ToIdx==1, is a
287 // Exit type and is used.
288 if l2Txs[i].ToIdx == 0 { // ToEthAddr/ToBJJ case
289 validL2Tx, l1CoordinatorTx, accAuth, err :=
290 txsel.processTxToEthAddrBJJ(validTxs, selectionConfig,
291 len(l1UserTxs), l1CoordinatorTxs, positionL1, l2Txs[i])
292 if err != nil {
293 log.Debugw("txsel.processTxToEthAddrBJJ", "err", err)
294 // Discard L2Tx, and update Info parameter of
295 // the tx, and add it to the discardedTxs array
296 l2Txs[i].Info = fmt.Sprintf("Tx not selected (in processTxToEthAddrBJJ) due to %s",
297 err.Error())
298 discardedL2Txs = append(discardedL2Txs, l2Txs[i])
299 continue
300 }
301 if l1CoordinatorTx != nil {
302 // If ToEthAddr == 0xff.. this means that we
303 // are handling a TransferToBJJ, which doesn't
304 // require an authorization because it doesn't
305 // contain a valid ethereum address.
306 // Otherwise only create the account if we have
307 // the corresponding authorization
308 if validL2Tx.ToEthAddr == common.FFAddr {
309 accAuths = append(accAuths, common.EmptyEthSignature)
310 l1CoordinatorTxs = append(l1CoordinatorTxs, *l1CoordinatorTx)
311 positionL1++
312 } else if accAuth != nil {
313 accAuths = append(accAuths, accAuth.Signature)
314 l1CoordinatorTxs = append(l1CoordinatorTxs, *l1CoordinatorTx)
315 positionL1++
316 }
317 }
318 if validL2Tx != nil {
319 validTxs = append(validTxs, *validL2Tx)
320 }
321 } else if l2Txs[i].ToIdx >= common.IdxUserThreshold {
322 receiverAcc, err := txsel.localAccountsDB.GetAccount(l2Txs[i].ToIdx)
323 if err != nil {
324 // tx not valid
325 log.Debugw("invalid L2Tx: ToIdx not found in StateDB",
326 "ToIdx", l2Txs[i].ToIdx)
327 // Discard L2Tx, and update Info parameter of
328 // the tx, and add it to the discardedTxs array
329 l2Txs[i].Info = fmt.Sprintf("Tx not selected due to tx.ToIdx not found in StateDB. "+
330 "ToIdx: %d", l2Txs[i].ToIdx)
331 discardedL2Txs = append(discardedL2Txs, l2Txs[i])
332 continue
333 }
334 if l2Txs[i].ToEthAddr != common.EmptyAddr {
335 if l2Txs[i].ToEthAddr != receiverAcc.EthAddr {
336 log.Debugw("invalid L2Tx: ToEthAddr does not correspond to the Account.EthAddr",
337 "ToIdx", l2Txs[i].ToIdx, "tx.ToEthAddr",
338 l2Txs[i].ToEthAddr, "account.EthAddr", receiverAcc.EthAddr)
339 // Discard L2Tx, and update Info
340 // parameter of the tx, and add it to
341 // the discardedTxs array
342 l2Txs[i].Info = fmt.Sprintf("Tx not selected because ToEthAddr "+
343 "does not correspond to the Account.EthAddr. "+
344 "tx.ToIdx: %d, tx.ToEthAddr: %s, account.EthAddr: %s",
345 l2Txs[i].ToIdx, l2Txs[i].ToEthAddr, receiverAcc.EthAddr)
346 discardedL2Txs = append(discardedL2Txs, l2Txs[i])
347 continue
348 }
349 }
350 if l2Txs[i].ToBJJ != common.EmptyBJJComp {
351 if l2Txs[i].ToBJJ != receiverAcc.BJJ {
352 log.Debugw("invalid L2Tx: ToBJJ does not correspond to the Account.BJJ",
353 "ToIdx", l2Txs[i].ToIdx, "tx.ToEthAddr", l2Txs[i].ToBJJ,
354 "account.BJJ", receiverAcc.BJJ)
355 // Discard L2Tx, and update Info
356 // parameter of the tx, and add it to
357 // the discardedTxs array
358 l2Txs[i].Info = fmt.Sprintf("Tx not selected because tx.ToBJJ "+
359 "does not correspond to the Account.BJJ. "+
360 "tx.ToIdx: %d, tx.ToEthAddr: %s, tx.ToBJJ: %s, account.BJJ: %s",
361 l2Txs[i].ToIdx, l2Txs[i].ToEthAddr, l2Txs[i].ToBJJ, receiverAcc.BJJ)
362 discardedL2Txs = append(discardedL2Txs, l2Txs[i])
363 continue
364 }
365 }
366
367 // Account found in the DB, include the l2Tx in the selection
368 validTxs = append(validTxs, l2Txs[i])
369 } else if l2Txs[i].ToIdx == common.Idx(1) {
370 // valid txs (of Exit type)
371 validTxs = append(validTxs, l2Txs[i])
372 }
373 }
374
375 // Process L1CoordinatorTxs
376 for i := 0; i < len(l1CoordinatorTxs); i++ {
377 _, _, _, _, err := tp.ProcessL1Tx(nil, &l1CoordinatorTxs[i])
378 if err != nil {
379 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
380 }
381 }
382
383 // get CoordIdxsMap for the TokenIDs
384 coordIdxsMap := make(map[common.TokenID]common.Idx)
385 for i := 0; i < len(validTxs); i++ {
386 // get TokenID from tx.Sender
387 accSender, err := tp.StateDB().GetAccount(validTxs[i].FromIdx)
388 if err != nil {
389 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
390 }
391 tokenID := accSender.TokenID
392
393 coordIdx, err := txsel.getCoordIdx(tokenID)
394 if err != nil {
395 // if err is db.ErrNotFound, should not happen, as all
396 // the validTxs.TokenID should have a CoordinatorIdx
397 // created in the DB at this point
398 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
399 }
400 coordIdxsMap[tokenID] = coordIdx
401 }
402
403 var coordIdxs []common.Idx
404 tp.AccumulatedFees = make(map[common.Idx]*big.Int)
405 for _, idx := range coordIdxsMap {
406 tp.AccumulatedFees[idx] = big.NewInt(0)
407 coordIdxs = append(coordIdxs, idx)
408 }
409 // sort CoordIdxs
410 sort.SliceStable(coordIdxs, func(i, j int) bool {
411 return coordIdxs[i] < coordIdxs[j]
412 })
413
414 // get most profitable L2-tx
415 maxL2Txs := int(selectionConfig.TxProcessorConfig.MaxTx) -
416 len(l1UserTxs) - len(l1CoordinatorTxs)
417
418 selectedL2Txs := validTxs
419 if len(validTxs) > maxL2Txs {
420 selectedL2Txs = selectedL2Txs[:maxL2Txs]
421 }
422 var finalL2Txs []common.PoolL2Tx
423 for i := 0; i < len(selectedL2Txs); i++ {
424 _, _, _, err = tp.ProcessL2Tx(coordIdxsMap, nil, nil, &selectedL2Txs[i])
425 if err != nil {
426 // the error can be due not valid tx data, or due other
427 // cases (such as StateDB error). At this initial
428 // version of the TxSelector, we discard the L2Tx and
429 // log the error, assuming that this will be iterated
430 // in a near future.
431 log.Error(err)
432 // Discard L2Tx, and update Info parameter of the tx,
433 // and add it to the discardedTxs array
434 selectedL2Txs[i].Info = fmt.Sprintf("Tx not selected (in ProcessL2Tx) due to %s", err.Error())
435 discardedL2Txs = append(discardedL2Txs, selectedL2Txs[i])
436 continue
437 }
438 finalL2Txs = append(finalL2Txs, selectedL2Txs[i])
439 }
440
441 // distribute the AccumulatedFees from the processed L2Txs into the
442 // Coordinator Idxs
443 for idx, accumulatedFee := range tp.AccumulatedFees {
444 cmp := accumulatedFee.Cmp(big.NewInt(0))
445 if cmp == 1 { // accumulatedFee>0
446 // send the fee to the Idx of the Coordinator for the TokenID
447 accCoord, err := txsel.localAccountsDB.GetAccount(idx)
448 if err != nil {
449 log.Errorw("Can not distribute accumulated fees to coordinator account: No coord Idx to receive fee", "idx", idx)
450 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
451 }
452 accCoord.Balance = new(big.Int).Add(accCoord.Balance, accumulatedFee)
453 _, err = txsel.localAccountsDB.UpdateAccount(idx, accCoord)
454 if err != nil {
455 log.Error(err)
456 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
457 }
458 }
459 }
460
461 err = tp.StateDB().MakeCheckpoint()
462 if err != nil {
463 return nil, nil, nil, nil, nil, nil, tracerr.Wrap(err)
464 }
465
466 return coordIdxs, accAuths, l1UserTxs, l1CoordinatorTxs, finalL2Txs, discardedL2Txs, nil
467}
468
469// processTxsToEthAddrBJJ process the common.PoolL2Tx in the case where
470// ToIdx==0, which can be the tx type of ToEthAddr or ToBJJ. If the receiver
471// does not have an account yet, a new L1CoordinatorTx of type
472// CreateAccountDeposit (with 0 as DepositAmount) is created and added to the
473// l1CoordinatorTxs array, and then the PoolL2Tx is added into the validTxs
474// array.
475func (txsel *TxSelector) processTxToEthAddrBJJ(validTxs []common.PoolL2Tx,
476 selectionConfig *SelectionConfig, nL1UserTxs int, l1CoordinatorTxs []common.L1Tx,
477 positionL1 int, l2Tx common.PoolL2Tx) (*common.PoolL2Tx, *common.L1Tx,
478 *common.AccountCreationAuth, error) {
479 // if L2Tx needs a new L1CoordinatorTx of CreateAccount type, and a
480 // previous L2Tx in the current process already created a
481 // L1CoordinatorTx of this type, in the DB there still seem that needs
482 // to create a new L1CoordinatorTx, but as is already created, the tx
483 // is valid
484 if checkAlreadyPendingToCreate(l1CoordinatorTxs, l2Tx.TokenID, l2Tx.ToEthAddr, l2Tx.ToBJJ) {
485 return &l2Tx, nil, nil, nil
486 }
487
488 var l1CoordinatorTx *common.L1Tx
489 var accAuth *common.AccountCreationAuth
490 if l2Tx.ToEthAddr != common.EmptyAddr && l2Tx.ToEthAddr != common.FFAddr {
491 // case: ToEthAddr != 0x00 neither 0xff
492 if l2Tx.ToBJJ != common.EmptyBJJComp {
493 // case: ToBJJ!=0:
494 // if idx exist for EthAddr&BJJ use it
495 _, err := txsel.localAccountsDB.GetIdxByEthAddrBJJ(l2Tx.ToEthAddr,
496 l2Tx.ToBJJ, l2Tx.TokenID)
497 if err == nil {
498 // account for ToEthAddr&ToBJJ already exist,
499 // there is no need to create a new one.
500 // tx valid, StateDB will use the ToIdx==0 to define the AuxToIdx
501 return &l2Tx, nil, nil, nil
502 }
503 // if not, check if AccountCreationAuth exist for that
504 // ToEthAddr
505 accAuth, err = txsel.l2db.GetAccountCreationAuth(l2Tx.ToEthAddr)
506 if err != nil {
507 // not found, l2Tx will not be added in the selection
508 return nil, nil, nil, tracerr.Wrap(fmt.Errorf("invalid L2Tx: ToIdx not found in StateDB, neither ToEthAddr found in AccountCreationAuths L2DB. ToIdx: %d, ToEthAddr: %s",
509 l2Tx.ToIdx, l2Tx.ToEthAddr.Hex()))
510 }
511 if accAuth.BJJ != l2Tx.ToBJJ {
512 // if AccountCreationAuth.BJJ is not the same
513 // than in the tx, tx is not accepted
514 return nil, nil, nil, tracerr.Wrap(fmt.Errorf("invalid L2Tx: ToIdx not found in StateDB, neither ToEthAddr & ToBJJ found in AccountCreationAuths L2DB. ToIdx: %d, ToEthAddr: %s, ToBJJ: %s",
515 l2Tx.ToIdx, l2Tx.ToEthAddr.Hex(), l2Tx.ToBJJ.String()))
516 }
517 } else {
518 // case: ToBJJ==0:
519 // if idx exist for EthAddr use it
520 _, err := txsel.localAccountsDB.GetIdxByEthAddr(l2Tx.ToEthAddr, l2Tx.TokenID)
521 if err == nil {
522 // account for ToEthAddr already exist,
523 // there is no need to create a new one.
524 // tx valid, StateDB will use the ToIdx==0 to define the AuxToIdx
525 return &l2Tx, nil, nil, nil
526 }
527 // if not, check if AccountCreationAuth exist for that ToEthAddr
528 accAuth, err = txsel.l2db.GetAccountCreationAuth(l2Tx.ToEthAddr)
529 if err != nil {
530 // not found, l2Tx will not be added in the selection
531 return nil, nil, nil, tracerr.Wrap(fmt.Errorf("invalid L2Tx: ToIdx not found in StateDB, neither ToEthAddr found in AccountCreationAuths L2DB. ToIdx: %d, ToEthAddr: %s",
532 l2Tx.ToIdx, l2Tx.ToEthAddr))
533 }
534 }
535 // create L1CoordinatorTx for the accountCreation
536 l1CoordinatorTx = &common.L1Tx{
537 Position: positionL1,
538 UserOrigin: false,
539 FromEthAddr: accAuth.EthAddr,
540 FromBJJ: accAuth.BJJ,
541 TokenID: l2Tx.TokenID,
542 Amount: big.NewInt(0),
543 DepositAmount: big.NewInt(0),
544 Type: common.TxTypeCreateAccountDeposit,
545 }
546 } else if l2Tx.ToEthAddr == common.FFAddr && l2Tx.ToBJJ != common.EmptyBJJComp {
547 // if idx exist for EthAddr&BJJ use it
548 _, err := txsel.localAccountsDB.GetIdxByEthAddrBJJ(l2Tx.ToEthAddr, l2Tx.ToBJJ,
549 l2Tx.TokenID)
550 if err == nil {
551 // account for ToEthAddr&ToBJJ already exist, (where ToEthAddr==0xff)
552 // there is no need to create a new one.
553 // tx valid, StateDB will use the ToIdx==0 to define the AuxToIdx
554 return &l2Tx, nil, nil, nil
555 }
556 // if idx don't exist for EthAddr&BJJ, coordinator can create a
557 // new account without L1Authorization, as ToEthAddr==0xff
558 // create L1CoordinatorTx for the accountCreation
559 l1CoordinatorTx = &common.L1Tx{
560 Position: positionL1,
561 UserOrigin: false,
562 FromEthAddr: l2Tx.ToEthAddr,
563 FromBJJ: l2Tx.ToBJJ,
564 TokenID: l2Tx.TokenID,
565 Amount: big.NewInt(0),
566 DepositAmount: big.NewInt(0),
567 Type: common.TxTypeCreateAccountDeposit,
568 }
569 }
570 if len(l1CoordinatorTxs) >= int(selectionConfig.MaxL1UserTxs)-nL1UserTxs {
571 // L2Tx discarded
572 return nil, nil, nil, tracerr.Wrap(fmt.Errorf("L2Tx discarded due to no available slots " +
573 "for L1CoordinatorTx to create a new account for receiver of L2Tx"))
574 }
575
576 return &l2Tx, l1CoordinatorTx, accAuth, nil
577}
578
579func checkAlreadyPendingToCreate(l1CoordinatorTxs []common.L1Tx, tokenID common.TokenID,
580 addr ethCommon.Address, bjj babyjub.PublicKeyComp) bool {
581 for i := 0; i < len(l1CoordinatorTxs); i++ {
582 if l1CoordinatorTxs[i].FromEthAddr == addr &&
583 l1CoordinatorTxs[i].TokenID == tokenID &&
584 l1CoordinatorTxs[i].FromBJJ == bjj {
585 return true
586 }
587 }
588 return false
589}
590
591// getL2Profitable returns the profitable selection of L2Txssorted by Nonce
592func (txsel *TxSelector) getL2Profitable(l2Txs []common.PoolL2Tx, max uint32) []common.PoolL2Tx {
593 sort.Sort(txs(l2Txs))
594 if len(l2Txs) < int(max) {
595 return l2Txs
596 }
597 l2Txs = l2Txs[:max]
598
599 // sort l2Txs by Nonce. This can be done in many different ways, what
600 // is needed is to output the l2Txs where the Nonce of l2Txs for each
601 // Account is sorted, but the l2Txs can not be grouped by sender Account
602 // neither by Fee. This is because later on the Nonces will need to be
603 // sequential for the zkproof generation.
604 sort.SliceStable(l2Txs, func(i, j int) bool {
605 return l2Txs[i].Nonce < l2Txs[j].Nonce
606 })
607
608 return l2Txs
609}