1package common
  2
  3import (
  4	"bytes"
  5	"database/sql/driver"
  6	"encoding/hex"
  7	"errors"
  8	"fmt"
  9	"math/big"
 10	"strings"
 11
 12	ethCommon "github.com/ethereum/go-ethereum/common"
 13	"github.com/hermeznetwork/tracerr"
 14	"github.com/iden3/go-iden3-crypto/babyjub"
 15)
 16
 17const (
 18	// TXIDPrefixL1UserTx is the prefix that determines that the TxID is
 19	// for a L1UserTx
 20	//nolinter:gomnd
 21	TxIDPrefixL1UserTx = byte(0)
 22
 23	// TXIDPrefixL1CoordTx is the prefix that determines that the TxID is
 24	// for a L1CoordinatorTx
 25	//nolinter:gomnd
 26	TxIDPrefixL1CoordTx = byte(1)
 27
 28	// TxIDPrefixL2Tx is the prefix that determines that the TxID is for a
 29	// L2Tx (or PoolL2Tx)
 30	//nolinter:gomnd
 31	TxIDPrefixL2Tx = byte(2)
 32
 33	// TxIDLen is the length of the TxID byte array
 34	TxIDLen = 12
 35)
 36
 37// TxID is the identifier of a Hermez network transaction
 38type TxID [TxIDLen]byte
 39
 40// Scan implements Scanner for database/sql.
 41func (txid *TxID) Scan(src interface{}) error {
 42	srcB, ok := src.([]byte)
 43	if !ok {
 44		return tracerr.Wrap(fmt.Errorf("can't scan %T into TxID", src))
 45	}
 46	if len(srcB) != TxIDLen {
 47		return tracerr.Wrap(fmt.Errorf("can't scan []byte of len %d into TxID, need %d", len(srcB), TxIDLen))
 48	}
 49	copy(txid[:], srcB)
 50	return nil
 51}
 52
 53// Value implements valuer for database/sql.
 54func (txid TxID) Value() (driver.Value, error) {
 55	return txid[:], nil
 56}
 57
 58// String returns a string hexadecimal representation of the TxID
 59func (txid TxID) String() string {
 60	return "0x" + hex.EncodeToString(txid[:])
 61}
 62
 63// NewTxIDFromString returns a string hexadecimal representation of the TxID
 64func NewTxIDFromString(idStr string) (TxID, error) {
 65	txid := TxID{}
 66	idStr = strings.TrimPrefix(idStr, "0x")
 67	decoded, err := hex.DecodeString(idStr)
 68	if err != nil {
 69		return TxID{}, tracerr.Wrap(err)
 70	}
 71	if len(decoded) != TxIDLen {
 72		return txid, tracerr.Wrap(errors.New("Invalid idStr"))
 73	}
 74	copy(txid[:], decoded)
 75	return txid, nil
 76}
 77
 78// MarshalText marshals a TxID
 79func (txid TxID) MarshalText() ([]byte, error) {
 80	return []byte(txid.String()), nil
 81}
 82
 83// UnmarshalText unmarshals a TxID
 84func (txid *TxID) UnmarshalText(data []byte) error {
 85	idStr := string(data)
 86	id, err := NewTxIDFromString(idStr)
 87	if err != nil {
 88		return tracerr.Wrap(err)
 89	}
 90	*txid = id
 91	return nil
 92}
 93
 94// TxType is a string that represents the type of a Hermez network transaction
 95type TxType string
 96
 97const (
 98	// TxTypeExit represents L2->L1 token transfer.  A leaf for this account appears in the exit tree of the block
 99	TxTypeExit TxType = "Exit"
100	// TxTypeTransfer represents L2->L2 token transfer
101	TxTypeTransfer TxType = "Transfer"
102	// TxTypeDeposit represents L1->L2 transfer
103	TxTypeDeposit TxType = "Deposit"
104	// TxTypeCreateAccountDeposit represents creation of a new leaf in the state tree (newAcconut) + L1->L2 transfer
105	TxTypeCreateAccountDeposit TxType = "CreateAccountDeposit"
106	// TxTypeCreateAccountDepositTransfer represents L1->L2 transfer + L2->L2 transfer
107	TxTypeCreateAccountDepositTransfer TxType = "CreateAccountDepositTransfer"
108	// TxTypeDepositTransfer TBD
109	TxTypeDepositTransfer TxType = "DepositTransfer"
110	// TxTypeForceTransfer TBD
111	TxTypeForceTransfer TxType = "ForceTransfer"
112	// TxTypeForceExit TBD
113	TxTypeForceExit TxType = "ForceExit"
114	// TxTypeTransferToEthAddr TBD
115	TxTypeTransferToEthAddr TxType = "TransferToEthAddr"
116	// TxTypeTransferToBJJ TBD
117	TxTypeTransferToBJJ TxType = "TransferToBJJ"
118)
119
120// Tx is a struct used by the TxSelector & BatchBuilder as a generic type generated from L1Tx & PoolL2Tx
121type Tx struct {
122	// Generic
123	IsL1        bool      `meddler:"is_l1"`
124	TxID        TxID      `meddler:"id"`
125	Type        TxType    `meddler:"type"`
126	Position    int       `meddler:"position"`
127	FromIdx     Idx       `meddler:"from_idx"`
128	ToIdx       Idx       `meddler:"to_idx"`
129	Amount      *big.Int  `meddler:"amount,bigint"`
130	AmountFloat float64   `meddler:"amount_f"`
131	TokenID     TokenID   `meddler:"token_id"`
132	USD         *float64  `meddler:"amount_usd"`
133	BatchNum    *BatchNum `meddler:"batch_num"`     // batchNum in which this tx was forged. If the tx is L2, this must be != 0
134	EthBlockNum int64     `meddler:"eth_block_num"` // Ethereum Block Number in which this L1Tx was added to the queue
135	// L1
136	ToForgeL1TxsNum *int64             `meddler:"to_forge_l1_txs_num"` // toForgeL1TxsNum in which the tx was forged / will be forged
137	UserOrigin      *bool              `meddler:"user_origin"`         // true if the tx was originated by a user, false if it was aoriginated by a coordinator. Note that this differ from the spec for implementation simplification purpposes
138	FromEthAddr     ethCommon.Address  `meddler:"from_eth_addr"`
139	FromBJJ         *babyjub.PublicKey `meddler:"from_bjj"`
140	LoadAmount      *big.Int           `meddler:"load_amount,bigintnull"`
141	LoadAmountFloat *float64           `meddler:"load_amount_f"`
142	LoadAmountUSD   *float64           `meddler:"load_amount_usd"`
143	// L2
144	Fee    *FeeSelector `meddler:"fee"`
145	FeeUSD *float64     `meddler:"fee_usd"`
146	Nonce  *Nonce       `meddler:"nonce"`
147}
148
149func (tx *Tx) String() string {
150	buf := bytes.NewBufferString("")
151	fmt.Fprintf(buf, "Type: %s, ", tx.Type)
152	fmt.Fprintf(buf, "FromIdx: %s, ", tx.FromIdx)
153	if tx.Type == TxTypeTransfer ||
154		tx.Type == TxTypeDepositTransfer ||
155		tx.Type == TxTypeCreateAccountDepositTransfer {
156		fmt.Fprintf(buf, "ToIdx: %s, ", tx.ToIdx)
157	}
158	if tx.Type == TxTypeDeposit ||
159		tx.Type == TxTypeDepositTransfer ||
160		tx.Type == TxTypeCreateAccountDepositTransfer {
161		fmt.Fprintf(buf, "LoadAmount: %d, ", tx.LoadAmount)
162	}
163	if tx.Type != TxTypeDeposit {
164		fmt.Fprintf(buf, "Amount: %s, ", tx.Amount)
165	}
166	if tx.Type == TxTypeTransfer ||
167		tx.Type == TxTypeDepositTransfer ||
168		tx.Type == TxTypeCreateAccountDepositTransfer {
169		fmt.Fprintf(buf, "Fee: %d, ", tx.Fee)
170	}
171	fmt.Fprintf(buf, "TokenID: %d", tx.TokenID)
172
173	return buf.String()
174}
175
176// L1Tx returns a *L1Tx from the Tx
177func (tx *Tx) L1Tx() (*L1Tx, error) {
178	return &L1Tx{
179		TxID:            tx.TxID,
180		ToForgeL1TxsNum: tx.ToForgeL1TxsNum,
181		Position:        tx.Position,
182		UserOrigin:      *tx.UserOrigin,
183		FromIdx:         tx.FromIdx,
184		FromEthAddr:     tx.FromEthAddr,
185		FromBJJ:         tx.FromBJJ,
186		ToIdx:           tx.ToIdx,
187		TokenID:         tx.TokenID,
188		Amount:          tx.Amount,
189		LoadAmount:      tx.LoadAmount,
190		EthBlockNum:     tx.EthBlockNum,
191		Type:            tx.Type,
192		BatchNum:        tx.BatchNum,
193	}, nil
194}