6573428e11
This implements the getchaintips JSON-RPC and updates the associated JSON-RPC API documentation accordingly. It should be noted that until the entire block index is loaded into memory, the chain tips tracking currently only works with tips that have been seen since the daemon was started.
106 lines
3.0 KiB
Go
106 lines
3.0 KiB
Go
// Copyright (c) 2018 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package blockchain
|
|
|
|
import (
|
|
"bytes"
|
|
"sort"
|
|
|
|
"github.com/decred/dcrd/dcrjson"
|
|
)
|
|
|
|
// nodeHeightSorter implements sort.Interface to allow a slice of nodes to
|
|
// be sorted by height in ascending order.
|
|
type nodeHeightSorter []*blockNode
|
|
|
|
// Len returns the number of nodes in the slice. It is part of the
|
|
// sort.Interface implementation.
|
|
func (s nodeHeightSorter) Len() int {
|
|
return len(s)
|
|
}
|
|
|
|
// Swap swaps the nodes at the passed indices. It is part of the
|
|
// sort.Interface implementation.
|
|
func (s nodeHeightSorter) Swap(i, j int) {
|
|
s[i], s[j] = s[j], s[i]
|
|
}
|
|
|
|
// Less returns whether the node with index i should sort before the node with
|
|
// index j. It is part of the sort.Interface implementation.
|
|
func (s nodeHeightSorter) Less(i, j int) bool {
|
|
// To ensure stable order when the heights are the same, fall back to
|
|
// sorting based on hash.
|
|
if s[i].height == s[j].height {
|
|
return bytes.Compare(s[i].hash[:], s[j].hash[:]) < 0
|
|
}
|
|
return s[i].height < s[j].height
|
|
}
|
|
|
|
// ChainTips returns information, in JSON-RPC format, about all of the currently
|
|
// known chain tips in the block index.
|
|
func (b *BlockChain) ChainTips() []dcrjson.GetChainTipsResult {
|
|
b.index.RLock()
|
|
var chainTips []*blockNode
|
|
for _, nodes := range b.index.chainTips {
|
|
chainTips = append(chainTips, nodes...)
|
|
}
|
|
b.index.RUnlock()
|
|
|
|
b.chainLock.Lock()
|
|
bestTip := b.bestNode
|
|
b.chainLock.Unlock()
|
|
|
|
// Generate the results sorted by descending height.
|
|
sort.Sort(sort.Reverse(nodeHeightSorter(chainTips)))
|
|
results := make([]dcrjson.GetChainTipsResult, len(chainTips))
|
|
for i, tip := range chainTips {
|
|
// Find the fork point in order calculate the branch length later.
|
|
fork := tip
|
|
for fork != nil && !fork.inMainChain {
|
|
fork = fork.parent
|
|
}
|
|
|
|
result := &results[i]
|
|
result.Height = tip.height
|
|
result.Hash = tip.hash.String()
|
|
result.BranchLen = tip.height - fork.height
|
|
|
|
// Determine the status of the chain tip.
|
|
//
|
|
// active:
|
|
// The current best chain tip.
|
|
//
|
|
// invalid:
|
|
// The block or one of its ancestors is invalid.
|
|
//
|
|
// headers-only:
|
|
// The block or one of its ancestors does not have the full block data
|
|
// available which also means the block can't be validated or
|
|
// connected.
|
|
//
|
|
// valid-fork:
|
|
// The block is fully validated which implies it was probably part of
|
|
// main chain at one point and was reorganized.
|
|
//
|
|
// valid-headers:
|
|
// The full block data is available and the header is valid, but the
|
|
// block was never validated which implies it was probably never part
|
|
// of the main chain.
|
|
tipStatus := b.index.NodeStatus(tip)
|
|
if tip == bestTip {
|
|
result.Status = "active"
|
|
} else if tipStatus.KnownInvalid() {
|
|
result.Status = "invalid"
|
|
} else if !tipStatus.HaveData() {
|
|
result.Status = "headers-only"
|
|
} else if tipStatus.KnownValid() {
|
|
result.Status = "valid-fork"
|
|
} else {
|
|
result.Status = "valid-headers"
|
|
}
|
|
}
|
|
return results
|
|
}
|