models

type AccessList []AccessTuple

type AccessListTx struct {
	ChainID    *big.Int        // destination chain ID
	Nonce      uint64          // nonce of sender account
	GasPrice   *big.Int        // wei per gas
	Gas        uint64          // gas limit
	To         *common.Address `rlp:"nil"` // nil means contract creation
	Value      *big.Int        // wei amount
	Data       []byte          // contract invocation input data
	AccessList AccessList      // EIP-2930 access list
	V, R, S    *big.Int        // signature values
}

type AccessTuple struct {
	Address     common.Address `json:"address"        gencodec:"required"`
	StorageKeys []common.Hash  `json:"storageKeys"    gencodec:"required"`
}

type Account struct {
	Addr            common.Address  `json:"address"`         // account address
	Nonce           uint64          `json:"nonce"`           // next transaction nonce
	Balance         *big.Int        `json:"balance"`         // basic currency, never be nil
	LocalCurrency   *big.Int        `json:"localCurrency"`   // local currency (if exist), could be nil
	StorageRoot     []byte          `json:"storageRoot"`     // storage for contract，Trie(key: Hash, value: Hash)
	CodeHash        []byte          `json:"codeHash"`        // hash of contract code
	LongStorageRoot []byte          `json:"longStorageRoot"` // more complex storage for contract, Trie(key: Hash, value: []byte)
	Creator         *common.Address `json:"creator"`         // the creator of the current contract account
	Flags           *big.Int        `json:"flags"`           // one bit for one flag
	Properties      []byte          `json:"properties"`      // properties in json format
}

type AccountDelta struct {
	Addr          common.Address
	Delta         *big.Int // Balance modification
	CurrencyDelta *big.Int // LocalCurrency modification (if has)
}

type AccountState interface {
	Address() common.Address
	GetAccount() *Account
}

type Accounts []*Account

type ActFailedResult struct {
	TxHash common.Hash
	Error  error
}

type ActResult interface {
	Receipt() *RRActReceipt
	String() string
}

type ActRptType byte

type AllCommEntries []*CommEntry

type AllCommEntry struct {
	ChainID  common.ChainID
	EpochNum common.EpochNum
	Comm     *EpochAllCommittee
}

type AttendanceRecord struct {
	Epoch       common.EpochNum // current epoch
	Attendance  *big.Int        // Indicates by bit whether the corresponding data block is empty, Attendance.Bit(BlockNum)==1 is normal block and ==0 is empty block
	DataNodes   common.NodeIDs  // List of datanode nodeid in ascending order
	Stats       []int           // Stats of alive data nodes
	AuditChains common.ChainIDs // since v3.2.1, auditing chains, same order in each slot in the Audits bits, created when AttendanceRecord creating, no modifying allowed
	Audits      *big.Int        // since v3.2.1, audition record, EpochLength*NumberOfChains bits
	// contains filtered or unexported fields
}

type AttendanceReportTxFilter struct{}

type AuditRequest struct {
	ChainId common.ChainID
	NodelId common.NodeID
	Height  common.Height
}

type AuditingMessage struct {
	ChainID   common.ChainID
	Height    common.Height
	BlockHash common.Hash
	Type      bool // true for audited, false for revealed
	Pas       *PubAndSig
}

type AuditorMsgsForDB struct {
	BlockHash common.Hash
	Pass      AuditorPass
}

type AuditorMsgsForDBs []*AuditorMsgsForDB

type AuditorPas struct {
	Type bool // true for audited, false for revealing
	Pas  *PubAndSig
}

type AuditorPass []*AuditorPas

type BlockBody struct {
	NextCommittee *Committee // election results of the next committee
	// Deprecated
	NCMsg             []*ElectMessage   // election requests for chains (in main chain)
	DeltaFroms        DeltaFroms        // deltas merged to current shard
	Txs               []*Transaction    // transactions
	TxsPas            []*PubAndSig      // signatures corresponding to packaged transactions
	Deltas            []*AccountDelta   // the delta generated by packaged transactions on current shard needs to be sent to other shards
	Hds               []*BlockSummary   // block summary reported by children chains
	Attendance        *AttendanceRecord // attendance table of the current epoch
	RewardReqs        RewardRequests    // self-proving reward request of each chain received on the main chain
	ElectingResults   ChainElectResults // Since v1.5.0, a list of election results, it's a preelection when Epoch.IsNil()==true, others are local election
	PreElectings      PreElectings      // Since v1.5.0, the list of preselections in progress, sorted by (expire, chainid)
	NextRealCommittee *Committee        // Since v1.5.0, when election finished, the result will be put into NextCommittee. If the election is failed, the current committee will continue to be used in the next epoch. At this time, the current committee needs to be written into this field, which can be brought with it when reporting.
	SeedFactor        SeedFactor        // Since v2.0.0, random factor of seed. since v3.2.1, used as the factor of generating seed
	Restarting        *RestartedComm    // Since v2.11.5, sub-chain restarting comm and its generation proof
	Rebooted          *RebootedComm     // Since v2.12.0, main chain rebooted comm and admin signatures
	RandomSig         []byte            // Since v3.2.0, placeholder in v2.14.2, random for chain, signature by proposer
	TxParams          [][]byte          // since v2.14.2, parameters generated by proposer for transactions
}

type BlockCursor struct {
	Height common.Height
	Hash   []byte
}

type BlockEMessage struct {
	BlockHeader *BlockHeader
	BlockBody   *BlockBody
	BlockPass   PubAndSigs
}

type BlockHeader struct {
	PreviousHash   common.Hash    `json:"previoushash" short:"Prev"` // the hash of the previous block header on current chain
	HashHistory    common.Hash    `json:"history" short:"History"`   // hash of the history tree of hash for each block recorded in height order
	ChainID        common.ChainID `json:"chainid"`                   // current chain id
	Height         common.Height  `json:"height"`                    // height of current block
	Empty          bool           `json:"empty"`                     // empty block
	ParentHeight   common.Height  `json:"-" short:"Parent"`          // height of parent height, is 0 if current is main chain
	ParentHash     *common.Hash   `json:"-" short:"PHash"`           // block hash of main chain block at ParentHeight, nil if current is main chain
	RewardAddress  common.Address `json:"-"`                         // reward to
	AttendanceHash *common.Hash   `json:"-" short:"Attendence"`      // The current epoch attendance record hash
	RewardedCursor *common.Height `json:"-" short:"Rewarded"`        // The last processed main chain height for rewarding, while the current chain is the reward chain

	CommitteeHash   *common.Hash   `json:"-" short:"Comm"`     // current epoch Committee member trie root hash
	ElectedNextRoot *common.Hash   `json:"-" short:"NextComm"` // root hash of the election result of next epoch committee members
	Seed            *common.Seed   `json:"seed" short:"Seed"`  // Current election seeds, only in the main chain. Since v3.2.1, never be nil in main chain, the seed for election.
	RREra           *common.EraNum `json:"-" short:"Era"`      // the era corresponding to the root of the current Required Reserve tree. When this value is inconsistent with the height of main chain, it indicates that a new RR tree needs to be calculated
	RRRoot          *common.Hash   `json:"-" short:"RRR"`      // root hash of the Required Reserve tree in current era. Only in the reward chain and the main chain
	RRNextRoot      *common.Hash   `json:"-" short:"RRN"`      // root hash of the Required Reserve tree in next era. Only in the reward chain and the main chain
	RRChangingRoot  *common.Hash   `json:"-" short:"RRC"`      // changes waiting to be processed in current era

	MergedDeltaRoot  *common.Hash `json:"mergeroot" short:"Merged"` // Root hash of the merged delta sent from other shards
	BalanceDeltaRoot *common.Hash `json:"deltaroot"`                // Root hash of the generated deltas by this block which needs to be sent to the other shards
	StateRoot        common.Hash  `json:"stateroot" short:"Root"`   // account on current chain state trie root hash
	ChainInfoRoot    *common.Hash `json:"-" short:"Chains"`         // for main chain only: all chain info trie root hash
	WaterlinesRoot   *common.Hash `json:"-" short:"Waterline"`      // since v2.3.0, the waterlines of other shards to current chain after the execution of this block. nil represent all zeros. Because the value of the previous block needs to be inherited when the block is empty, values after block execution recorded.
	VCCRoot          *common.Hash `json:"-" short:"VCC"`            // Root hash of transfer out check tree in business chain
	CashedRoot       *common.Hash `json:"-" short:"Cashed"`         // Root hash of transfer in check tree in business chain
	TransactionRoot  *common.Hash `json:"-" short:"TxRoot"`         // transactions in current block trie root hash
	ReceiptRoot      *common.Hash `json:"-" short:"Receipts"`       // receipts for transactions in current block trie root hash
	HdsRoot          *common.Hash `json:"-" short:"Hds"`            // if there's any child chain of current chain, this is the Merkle trie root hash generated by the reported block header information of the child chain in order

	TimeStamp uint64 `json:"timestamp"`

	ElectResultRoot *common.Hash   `json:"-" short:"ElectResult"` // Since v1.5.0, Election result hash root (including pre election and ordinary election, ordinary one has not been provided yet)
	PreElectRoot    *common.Hash   `json:"-" short:"PreElect"`    // Since v1.5.0, the root hash of current preelecting list sorted by (Expire, ChainID), only in the main chain
	FactorRoot      *common.Hash   `json:"-" short:"Factor"`      // since v2.0.0, seed random factor hash. Since v3.2.1, used for generating vrf seed by Hash(body.SeedFactor) at the first non-empty block after pbft.consts.SeedBlock.
	RRReceiptRoot   *common.Hash   `json:"-" short:"RRRpts"`      // since v2.10.12, in v2.11.0 receipts of RRActs applied in current block
	Version         uint16         `json:"-" short:"V"`           // since v2.10.12
	ConfirmedRoot   *common.Hash   `json:"-" short:"Confirmed"`   // since v2.11.3, trie root of all sub-confirmed infos
	RewardedEra     *common.EraNum `json:"-"`                     // since v2.12.0, record the next era that should issue the prize. If it is nil, it means that it is still in PoSv2, and the prize is issued according to epoch.
	BridgeRoot      *common.Hash   `json:"-" short:"Bridge"`      // since v3.1.0, placeholder in v2.14.2, bridge info root for main chain, bridge requests root for sub-chains
	RandomHash      *common.Hash   `json:"-" short:"Random"`      // since v3.2.0, placeholder in v2.14.2, used by PREVRANDAO opcode in EIP-4399, =signature(Hash(PreviousHash, Height), ProposerPrivateKey)
	SeedGenerated   bool           `json:"-"`                     // since v3.2.1, placeholder in v2.14.2, indicates whether a new round of seed is generated
	TxParamsRoot    *common.Hash   `json:"-"`                     // since v2.14.2, merkle hash root of tx parameters generated by proposer for the transaction
}

type BlockHeighter interface {
	GetHeight() common.Height
	Hash() common.Hash
}

type BlockHistoryProof trie.ProofChain

type BlockReport struct {
	ToChainId    common.ChainID
	BlockHeader  *BlockHeader    // the header of the reporting block
	NextComm     *EpochCommittee // next committee when election finished
	BlockPass    []*PubAndSig    // signatures of committee members who comfirmed reporting block. can be changed to aggregate signature in the future
	HistoryProof trie.ProofChain // the proof from the hash of last confirmed block to HistoryRoot of current block
	AuditPass    AuditorPass
}

type BlockRequest struct {
	ChainId common.ChainID
	Height  common.Height
	NodeId  common.NodeID
	RandNum int64
}

type BlockResponse struct {
	ToNodeId common.NodeID
	Block    *BlockEMessage
	RandNum  int64
}

type BlockSummary struct {
	ChainId   common.ChainID
	Height    common.Height
	BlockHash *common.Hash
	// since v1.5.0, the election result of the next committee whill be packaged together.
	// Because only the data and comm node will receive the report and record the next committee
	// of the sub chain. Since the new elected node has already been synchronizing the main chain,
	// it will not synchronize the data again, then it will not be able to synchronize all the sub
	// chain committee information, resulting in the nodes missing the corresponding information
	// when the new epoch begins.
	NextComm *EpochCommittee
	// V0's BlockSummary.Hash is same with blockhash, which can't reflect the location information
	// of the block, and can't complete the proof of cross chain. V1 adds chainid and height to hash
	Version uint16
	// since v2.11.0, record the continuity from the last confirmed block height on the sub-chain
	// to the current confirmed block
	// since v3.1.0, should be nil
	// since v3.2.6, used for proof NextComm.Hash() -> BlockHash
	Proofs trie.ProofChain
	// since v2.11.3, the size of a header is about 20 hashes, and one proof of a header content
	// is 6 hashes in the new version, so when there are more than 3 proofs (NextCommProof,
	// HisRootProof, ParentProof), use the header to replace the 3 sets of values and the proofs
	// is more cost-effective
	// since v3.2.1, deprecated
	// since v3.2.6, if sub-chain is the REWARD chain, use Header instead of (ChainID,Height,BlockHash)
	// 	for RREra/RRRoot/RRNextRoot
	Header *BlockHeader
	// since v2.11.0, record the audit result of the current block
	// since v3.1.0, should be nil
	// Deprecated
	AuditorPass AuditorPass
}

type BlockSummarys []*BlockSummary

type BlockValidateError struct {
	// contains filtered or unexported fields
}

type Bonus struct {
	Winner common.Address `json:"winner"` // bonus winner
	Val    *big.Int       `json:"value"`  // bonus value
}

type Bonuses []*Bonus

type BridgeExtra struct {
	// Type==0: process request, mint or transfer tx generated by request
	// type==1: update request status by response
	// type==2: remove processed requests
	// type==3: remove processed responses
	Type uint8 `json:"type"`
}

type BridgeInfo struct {
	MappingChain    common.ChainID
	MappingContract common.Address
	FromChain       common.ChainID
	FromContract    common.Address
	Type            TokenType
}

type BridgeInfos []*BridgeInfo

type BridgeReq struct {
	FromChain          common.ChainID  //
	FromContract       common.Address  // mapping contract if BURNING, main contract if TRANSFERING
	Height             common.Height   // the height of the block in which the requested transaction packed
	ToChain            common.ChainID  // bridge target chain
	ToContract         common.Address  // bridge target contract, get from BridgeInfo in main chain
	ToAccount          common.Address  // request user
	Nonce              uint64          // nonce of transaction generate this request
	Value              *big.Int        // value of erc20, amount of 721/1155
	TokenID            *big.Int        // not nil if Type is 721 or 1155
	Data               []byte          // used for mint1155
	TokenType          TokenType       // token type
	FromContractType   MappingType     // used to determine which method should be called when generating a withdraw transaction
	TargetContractType MappingType     // used to determine which method should be called when generating a proccess transaction, regardless of whether the BridgeInfo in the main chain has changed
	Status             BridgeReqStatus // 0: not responded, 1: process successful, 2: process failed
}

type BridgeReqExtra struct {
	Type    uint8          `json:"type"`    // Type==0: mint or transfer tx generated by request
	From    common.ChainID `json:"from"`    // from chain id
	Height  common.Height  `json:"height"`  // the height of the block where bridge request packed
	Account common.Address `json:"account"` // the requester of the bridge request
	Nonce   uint64         `json:"nonce"`   // the nonce of the tx of bridge request
}

type BridgeReqInfo struct {
	FromChain    *big.Int       `abi:"fromChain"`
	Height       *big.Int       `abi:"height"`
	Account      common.Address `abi:"account"`
	Nonce        *big.Int       `abi:"nonce"`
	ContractType *big.Int       `abi:"contractType"`
}

type BridgeReqStatus uint8

type BridgeResp struct {
	SourceChain common.ChainID // where the request generated
	ReqHeight   common.Height  // the height of from chain block where the request generated
	TargetChain common.ChainID // where the request processed and also where the response generated
	BlockHeight common.Height  // the height of block where the request processed
	Account     common.Address // request.ToAccount
	Nonce       uint64         // request.Nonce
	Status      uint8          // 0: failed, 1: succeed
}

type BridgeTargetNode struct {
	ToChainID  common.ChainID // the target chain of generated bridge requests, and the from chain of all processed requests
	ReqCursor  common.Height  // the last height of processed requests from ToChainID
	ReqRoot    []byte         // trie root of requests to ToChainID
	RespCursor common.Height  // the last height of processed responses from ToChainID
	RespRoot   []byte         // trie root of responses to ToChainID
}

type BridgeTargetNodeProofIndex int

type BridgeTxFilter struct{}

type BridgeUpdateReqParams struct {
	ReqHeight   uint64         `abi:"_reqHeight"`
	TargetChain uint32         `abi:"_targetChain"`
	RespHeight  uint64         `abi:"_respHeight"`
	Account     common.Address `abi:"_account"`
	Nonce       uint64         `abi:"_nonce"`
	Success     bool           `abi:"_success"`
}

type CancelCashCheckRequest struct {
	Check           *CashCheck      `json:"check"`           // cheque to be voided
	AbsenceChainID  common.ChainID  `json:"chain"`           // the target chain of the proof
	AbsenceHeight   common.Height   `json:"height"`          // block height of target chain which proof prove to
	ProofedHash     common.Hash     `json:"header"`          // the proof target hash of Proofs
	CCCProofs       trie.ProofChain `json:"absence"`         // CashedTrie's proof of non-existence of check
	Proofs          trie.ProofChain `json:"proofs"`          // from CashedTrie.Root Proof chain to the target of proof
	ConfirmedHeight common.Height   `json:"confirmedHeight"` // the main chain block height which confirmed target block header
}

type CashCheck struct {
	ParentChain  common.ChainID `json:"ParentChain"`  // parent of source chain
	IsShard      bool           `json:"IsShard"`      // whether the source chain is a sharding chain
	FromChain    common.ChainID `json:"FromChain"`    // id of source chain
	FromAddress  common.Address `json:"FromAddr"`     // address of source account
	Nonce        uint64         `json:"Nonce"`        // nonce of the tx to write the CashCheck
	ToChain      common.ChainID `json:"ToChain"`      // target chain id
	ToAddress    common.Address `json:"ToAddr"`       // address of the target account
	ExpireHeight common.Height  `json:"ExpireHeight"` // The expired height refers to that when the height of the target chain exceeds (excluding) this value, the check cannot be withdrawn and can only be returned
	UserLocal    bool           `json:"UseLocal"`     // true: local currency, false: basic currency, default is false
	Amount       *big.Int       `json:"Amount"`       // amount of the check
	CurrencyID   common.CoinID  `json:"CoinID"`       // Currency ID, new field, 0 when uselocal==false, currency ID when =true, and 0 for old version data
}

type CashRequest struct {
	Check           *CashCheck      `json:"check"`  // check information to be cashed
	ProofedChainID  common.ChainID  `json:"chain"`  // the target chain of the proof (main chain)
	ProofHeight     common.Height   `json:"height"` // proof from check hash to block.hash of source chain, and then to main chain block.hash. this is the corresponding main chain block height
	ProofHeaderHash common.Hash     `json:"header"` // block hash which height is specified by ProofHeight
	Proofs          trie.ProofChain `json:"proofs"` // proof of check
}

type ChainConfirmed struct {
	ChainID     common.ChainID   `json:"chainid"`
	Info        *ConfirmedInfo   `json:"info"`
	ReHistories RestartHistories `json:"restarts"`
}

type ChainConfirmeds []*ChainConfirmed

type ChainElectResult struct {
	ChainID    common.ChainID  // Election chain
	Epoch      common.EpochNum // The Epoch where the election took place, the value of the pre-election is NilEpoch
	Results    NodeResults
	LastHeight common.Height // since v2.11.5, last confirmed height of restarting sub-chain, 0 for normal and pre electing
	LastHash   *common.Hash  // since v2.11.5, last confirmed block hash of restarting sub-chain, nil for normal and pre electing
}