arnaucube
arnaucube/hermez-nodePublic Self-hosted repository
hermez-node/db/statedb/utils.go
db/statedb/utils.goRaw
  1package statedb
  2
  3import (
  4	"bytes"
  5	"fmt"
  6	"math/big"
  7
  8	ethCommon "github.com/ethereum/go-ethereum/common"
  9	"github.com/hermeznetwork/hermez-node/common"
 10	"github.com/hermeznetwork/hermez-node/log"
 11	"github.com/hermeznetwork/tracerr"
 12	"github.com/iden3/go-iden3-crypto/babyjub"
 13	"github.com/iden3/go-merkletree"
 14)
 15
 16func concatEthAddrTokenID(addr ethCommon.Address, tokenID common.TokenID) []byte {
 17	var b []byte
 18	b = append(b, addr.Bytes()...)
 19	b = append(b[:], tokenID.Bytes()[:]...)
 20	return b
 21}
 22func concatEthAddrBJJTokenID(addr ethCommon.Address, pk babyjub.PublicKeyComp, tokenID common.TokenID) []byte {
 23	pkComp := pk
 24	var b []byte
 25	b = append(b, addr.Bytes()...)
 26	b = append(b[:], pkComp[:]...)
 27	b = append(b[:], tokenID.Bytes()[:]...)
 28	return b
 29}
 30
 31// setIdxByEthAddrBJJ stores the given Idx in the StateDB as follows:
 32// - key: Eth Address, value: idx
 33// - key: EthAddr & BabyJubJub PublicKey Compressed, value: idx
 34// If Idx already exist for the given EthAddr & BJJ, the remaining Idx will be
 35// always the smallest one.
 36func (s *StateDB) setIdxByEthAddrBJJ(idx common.Idx, addr ethCommon.Address, pk babyjub.PublicKeyComp, tokenID common.TokenID) error {
 37	oldIdx, err := s.GetIdxByEthAddrBJJ(addr, pk, tokenID)
 38	if err == nil {
 39		// EthAddr & BJJ already have an Idx
 40		// check which Idx is smaller
 41		// if new idx is smaller, store the new one
 42		// if new idx is bigger, don't store and return, as the used one will be the old
 43		if idx >= oldIdx {
 44			log.Debug("StateDB.setIdxByEthAddrBJJ: Idx not stored because there already exist a smaller Idx for the given EthAddr & BJJ")
 45			return nil
 46		}
 47	}
 48
 49	// store idx for EthAddr & BJJ assuming that EthAddr & BJJ still don't
 50	// have an Idx stored in the DB, and if so, the already stored Idx is
 51	// bigger than the given one, so should be updated to the new one
 52	// (smaller)
 53	tx, err := s.db.NewTx()
 54	if err != nil {
 55		return tracerr.Wrap(err)
 56	}
 57	idxBytes, err := idx.Bytes()
 58	if err != nil {
 59		return tracerr.Wrap(err)
 60	}
 61	// store Addr&BJJ-idx
 62	k := concatEthAddrBJJTokenID(addr, pk, tokenID)
 63	err = tx.Put(append(PrefixKeyAddrBJJ, k...), idxBytes[:])
 64	if err != nil {
 65		return tracerr.Wrap(err)
 66	}
 67
 68	// store Addr-idx
 69	k = concatEthAddrTokenID(addr, tokenID)
 70	err = tx.Put(append(PrefixKeyAddr, k...), idxBytes[:])
 71	if err != nil {
 72		return tracerr.Wrap(err)
 73	}
 74	err = tx.Commit()
 75	if err != nil {
 76		return tracerr.Wrap(err)
 77	}
 78	return nil
 79}
 80
 81// GetIdxByEthAddr returns the smallest Idx in the StateDB for the given
 82// Ethereum Address. Will return common.Idx(0) and error in case that Idx is
 83// not found in the StateDB.
 84func (s *StateDB) GetIdxByEthAddr(addr ethCommon.Address, tokenID common.TokenID) (common.Idx, error) {
 85	k := concatEthAddrTokenID(addr, tokenID)
 86	b, err := s.db.Get(append(PrefixKeyAddr, k...))
 87	if err != nil {
 88		return common.Idx(0), tracerr.Wrap(fmt.Errorf("GetIdxByEthAddr: %s: ToEthAddr: %s, TokenID: %d",
 89			ErrToIdxNotFound, addr.Hex(), tokenID))
 90	}
 91	idx, err := common.IdxFromBytes(b)
 92	if err != nil {
 93		return common.Idx(0), tracerr.Wrap(fmt.Errorf("GetIdxByEthAddr: %s: ToEthAddr: %s, TokenID: %d",
 94			err, addr.Hex(), tokenID))
 95	}
 96	return idx, nil
 97}
 98
 99// GetIdxByEthAddrBJJ returns the smallest Idx in the StateDB for the given
100// Ethereum Address AND the given BabyJubJub PublicKey. If `addr` is the zero
101// address, it's ignored in the query.  If `pk` is nil, it's ignored in the
102// query.  Will return common.Idx(0) and error in case that Idx is not found in
103// the StateDB.
104func (s *StateDB) GetIdxByEthAddrBJJ(addr ethCommon.Address, pk babyjub.PublicKeyComp, tokenID common.TokenID) (common.Idx, error) {
105	if !bytes.Equal(addr.Bytes(), common.EmptyAddr.Bytes()) && pk == common.EmptyBJJComp {
106		// ToEthAddr
107		// case ToEthAddr!=0 && ToBJJ=0
108		return s.GetIdxByEthAddr(addr, tokenID)
109	} else if !bytes.Equal(addr.Bytes(), common.EmptyAddr.Bytes()) && pk != common.EmptyBJJComp {
110		// case ToEthAddr!=0 && ToBJJ!=0
111		k := concatEthAddrBJJTokenID(addr, pk, tokenID)
112		b, err := s.db.Get(append(PrefixKeyAddrBJJ, k...))
113		if err != nil {
114			return common.Idx(0), tracerr.Wrap(fmt.Errorf("GetIdxByEthAddrBJJ: %s: ToEthAddr: %s, ToBJJ: %s, TokenID: %d", ErrToIdxNotFound, addr.Hex(), pk, tokenID))
115		}
116		idx, err := common.IdxFromBytes(b)
117		if err != nil {
118			return common.Idx(0), tracerr.Wrap(fmt.Errorf("GetIdxByEthAddrBJJ: %s: ToEthAddr: %s, ToBJJ: %s, TokenID: %d", err, addr.Hex(), pk, tokenID))
119		}
120		return idx, nil
121	}
122	// rest of cases (included case ToEthAddr==0) are not possible
123	return common.Idx(0), tracerr.Wrap(fmt.Errorf("GetIdxByEthAddrBJJ: Not found, %s: ToEthAddr: %s, ToBJJ: %s, TokenID: %d", ErrGetIdxNoCase, addr.Hex(), pk, tokenID))
124}
125
126func (s *StateDB) getTokenIDsFromIdxs(idxs []common.Idx) (map[common.TokenID]common.Idx, error) {
127	m := make(map[common.TokenID]common.Idx)
128	for i := 0; i < len(idxs); i++ {
129		a, err := s.GetAccount(idxs[i])
130		if err != nil {
131			return nil, tracerr.Wrap(fmt.Errorf("getTokenIDsFromIdxs error on GetAccount with Idx==%d: %s", idxs[i], err.Error()))
132		}
133		m[a.TokenID] = idxs[i]
134	}
135	return m, nil
136}
137
138func siblingsToZKInputFormat(s []*merkletree.Hash) []*big.Int {
139	b := make([]*big.Int, len(s))
140	for i := 0; i < len(s); i++ {
141		b[i] = s[i].BigInt()
142	}
143	return b
144}
145
146// BJJCompressedTo256BigInts returns a [256]*big.Int array with the bit
147// representation of the babyjub.PublicKeyComp
148func BJJCompressedTo256BigInts(pkComp babyjub.PublicKeyComp) [256]*big.Int {
149	var r [256]*big.Int
150	b := pkComp[:]
151
152	for i := 0; i < 256; i++ {
153		if b[i/8]&(1<<(i%8)) == 0 {
154			r[i] = big.NewInt(0)
155		} else {
156			r[i] = big.NewInt(1)
157		}
158	}
159
160	return r
161}
162
163// formatAccumulatedFees returns an array of [nFeeAccounts]*big.Int containing
164// the balance of each FeeAccount, taken from the 'collectedFees' map, in the
165// order of the 'orderTokenIDs'
166func formatAccumulatedFees(collectedFees map[common.TokenID]*big.Int, orderTokenIDs []*big.Int) []*big.Int {
167	accFeeOut := make([]*big.Int, len(orderTokenIDs))
168	for i := 0; i < len(orderTokenIDs); i++ {
169		tokenID := common.TokenIDFromBigInt(orderTokenIDs[i])
170		if _, ok := collectedFees[tokenID]; ok {
171			accFeeOut[i] = new(big.Int).Set(collectedFees[tokenID])
172		} else {
173			accFeeOut[i] = big.NewInt(0)
174		}
175	}
176	return accFeeOut
177}