vectors

Documentation

Index

• type BlockVectorRaw
• type ClaimVectorRaw
• type DepositVectorRaw
• type E2ETestVectors
  • func LoadE2ETestVectors(path string) ([]E2ETestVectors, error)
• type Leaf
• type MTClaimVectorRaw
• type MTRootVectorRaw
• type Tx

Types

type BlockVectorRaw

type BlockVectorRaw struct {
	BlockNumber uint64 `json:"blockNumber"`
	BlockHash   string `json:"blockHash"`
	ParentHash  string `json:"parentHash"`
	NetworkID   uint   `json:"networkID"`
}

BlockVectorRaw represents the block vector

type ClaimVectorRaw

type ClaimVectorRaw struct {
	Index              uint   `json:"index"`
	OriginalNetwork    uint   `json:"originNetwork"`
	Token              string `json:"token"`
	Amount             string `json:"amount"`
	DestinationNetwork uint   `json:"destNetwork"`
	DestinationAddress string `json:"destAddress"`
	BlockNumber        uint64 `json:"blockNumber"`
}

ClaimVectorRaw represents the claim vector

type DepositVectorRaw

type DepositVectorRaw struct {
	OriginalNetwork    uint   `json:"originNetwork"`
	TokenAddress       string `json:"tokenAddress"`
	Amount             string `json:"amount"`
	DestinationNetwork uint   `json:"destinationNetwork"`
	DestinationAddress string `json:"destinationAddress"`
	ExpectedHash       string `json:"leafValue"`
	CurrentHash        string `json:"currentLeafValue"`
	Metadata           string `json:"metadata"`
}

DepositVectorRaw represents the deposit vector

type E2ETestVectors

type E2ETestVectors struct {
	// TODO Define the field of the e2e test vector
	ID               uint            `json:"id"`
	BridgeDeployed   bool            `json:"bridgeDeployed"`
	ChainIDSequencer uint            `json:"chainIdSequencer"`
	DefaultChainID   uint            `json:"defaultChainId"`
	SequencerAddress common.Address  `json:"sequencerAddress"`
	SequencerPvtKey  string          `json:"sequencerPvtKey"`
	Genesis          []interface{}   `json:"genesis"`
	ExpectedOldRoot  common.Hash     `json:"expectedOldRoot"`
	Txs              []Tx            `json:"txs"`
	ExpectedNewRoot  common.Hash     `json:"expectedNewRoot"`
	ExpectedNewLeafs map[string]Leaf `json:"expectedNewLeafs"`
	BatchL2Data      string          `json:"batchL2Data"`
	GlobalExitRoot   common.Hash     `json:"globalExitRoot"`
	NewLocalExitRoot common.Hash     `json:"newLocalExitRoot"`
	InputHash        common.Hash     `json:"inputHash"`
	BatchHashData    common.Hash     `json:"batchHashData"`
	OldLocalExitRoot common.Hash     `json:"oldLocalExitRoot"`
	Timestamp        uint64          `json:"timestamp"`
}

E2ETestVectors holds the metadata needed to run a etherman test

func LoadE2ETestVectors

func LoadE2ETestVectors(path string) ([]E2ETestVectors, error)

LoadE2ETestVectors loads the calldata-test-vector.json

type Leaf

type Leaf struct {
	Balance argBigInt         `json:"balance"`
	Nonce   argBigInt         `json:"nonce"`
	Storage map[string]string `json:"storage"`
}

Leaf represents a mt leaf

type MTClaimVectorRaw

type MTClaimVectorRaw struct {
	Deposits     []DepositVectorRaw `json:"leafs"`
	Index        uint               `json:"index"`
	MerkleProof  []string           `json:"proof"`
	ExpectedRoot string             `json:"root"`
}

MTClaimVectorRaw represents the merkle proof

type MTRootVectorRaw

type MTRootVectorRaw struct {
	ExistingLeaves []string         `json:"previousLeafsValues"`
	CurrentRoot    string           `json:"currentRoot"`
	NewLeaf        DepositVectorRaw `json:"newLeaf"`
	NewRoot        string           `json:"newRoot"`
}

MTRootVectorRaw represents the root of Merkle Tree

type Tx

type Tx struct {
	ContractName string         `json:"contractName"`
	Function     string         `json:"function"`
	From         common.Address `json:"from"`
	To           common.Address `json:"to"`
	Nonce        uint64         `json:"nonce"`
	Value        argBigInt      `json:"value"`
	Params       []interface{}  `json:"params"`
	GasLimit     uint64         `json:"gasLimit"`
	GasPrice     argBigInt      `json:"gasPrice"`
	Data         string         `json:"data"`
	ChainID      uint64         `json:"chainId"`
	Reason       string         `json:"reason"`
	CustomRawTx  string         `json:"customRawTx"`
	RawTx        string         `json:"rawTx"`
}

Tx represents a transactions that will be applied during the test