structure

type BestState struct {
	Hash            string           `json:"hash"`             // The hash of the block.
	Height          int32            `json:"height"`           // The height of the block.
	Bits            uint32           `json:"bits"`             // The difficulty bits of the block.
	BlockSize       uint64           `json:"block_size"`       // The size of the block.
	BlockWeight     uint64           `json:"block_weight"`     // The weight of the block.
	NumTxns         uint64           `json:"num_txns"`         // The number of txns in the block.
	TotalTxns       uint64           `json:"total_txns"`       // The total number of txns in the chain.
	MedianTimestamp common.Timestamp `json:"median_timestamp"` // Median time as per CalcPastMedianTime.
}

type EventOrphan struct {
	SnapshotID      string           `json:"snapshot_id"`
	Type            EventType        `json:"event_type_orphan"`
	OrphanBlockHash string           `json:"orphan_block_hash"`
	Timestamp       common.Timestamp `json:"timestamp"` // Revision 开始时间戳
}

type EventType int

type Revision struct {
	SnapshotID string       `json:"snapshot_id"`
	Type       RevisionType `json:"revision_type"` // 代表区块同步过程的一个阶段

	InitTimestamp common.Timestamp `json:"init_timestamp"` // Revision 开始时间戳
	InitData      RevisionData     `json:"init_data"`      // 根据 Tag 不同获取不同的数据，在 Revision 开始和时输出

	FinalTimestamp common.Timestamp `json:"final_timestamp"` // Revision 生效时间，结合 Timestamp 和 CommitTimestamp 确定 Revision 持续时间
	FinalData      RevisionData     `json:"final_data"`      // 根据 Tag 不同获取不同的数据，在 Revision 结束时输出
}

type RevisionData interface{}

type RevisionDataBlockReceiveFinal struct {
	OK bool `json:"ok"`
}

type RevisionDataBlockReceiveInit struct {
	PeerIPAddr      string `json:"peer_ip_addr"` // ipv4 or ipv6
	MinerWalletAddr string `json:"miner_wallet_addr"`
}

type RevisionDataBlockVerifyFinal struct {
	OK bool `json:"ok"`
}

type RevisionDataBlockVerifyInit struct {
	Hash       string `json:"hash"`
	ParentHash string `json:"parent_hash"`
	Height     int32  `json:"height"`
	NumTxns    uint64 `json:"num_txns"`

	Version        int32  `json:"version"`
	Bits           uint32 `json:"bits"`
	MerkleRootHash string `json:"merkle_root_hash"`
	Nonce          uint32 `json:"nonce"`
}

type RevisionDataChainSwapFinal struct {
	ForkParentBlockHash string `json:"fork_parent_block_hash"`
	ForkBlockHash       string `json:"fork_block_hash"`

	OK bool `json:"ok"`
}

type RevisionDataChainSwapInit struct {
	OldBestBlockHash string `json:"old_best_block_hash"`
	NewBestBlockHash string `json:"new_best_block_hash"`
}

type RevisionDataChainVerifyFinal struct {
}

type RevisionDataChainVerifyInit struct {
}

type RevisionDataMainChainExtendFinal struct {
}

type RevisionDataMainChainExtendInit struct {
}

type RevisionDataOrphanExtendFinal struct {
}

type RevisionDataOrphanExtendInit struct {
}

type RevisionDataOrphanProcessFinal struct {
}

type RevisionDataOrphanProcessInit struct {
}

type RevisionDataSideChainExtendFinal struct {
	ForkBlockHash string `json:"fork_block_hash"`

	OK bool `json:"ok"`
}

type RevisionDataSideChainExtendInit struct {
	ForkParentBlockHash string `json:"fork_parent_block_hash"`
}

type RevisionType int

type Snapshot struct {
	// for all snapshot
	ID                string           `json:"snapshot_id"` // 19+1+2+1+10：init timestamp string + chain id + chain height
	TargetChainID     string           `json:"target_chain_id"`
	TargetChainHeight int32            `json:"target_chain_height"`
	Type              SnapshotType     `json:"snapshot_type"`
	Timestamp         common.Timestamp `json:"timestamp"`
	State             *BestState       `json:"state"` // 当前先用 any，目前不包括任何信息，后面可以加

	// for init and final snapshot
	BlockHash       string         `json:"block_hash"`
	IsOrphan        bool           `json:"is_orphan"`
	RevisionList    []*Revision    `json:"revision_list"`
	EventOrphanList []*EventOrphan `json:"event_orphan_list"`
}

type SnapshotType int