xdpos API getV2Block (#227)

consensus/XDPoS/api.go

@@ -16,12 +16,14 @@
 package XDPoS
 
 import (
+	"encoding/base64"
 	"math/big"
 
 	"github.com/XinFinOrg/XDPoSChain/common"
 	"github.com/XinFinOrg/XDPoSChain/consensus"
 	"github.com/XinFinOrg/XDPoSChain/consensus/XDPoS/utils"
 	"github.com/XinFinOrg/XDPoSChain/core/types"
+	"github.com/XinFinOrg/XDPoSChain/rlp"
 	"github.com/XinFinOrg/XDPoSChain/rpc"
 )
 
@@ -31,6 +33,17 @@ type API struct {
 	chain consensus.ChainReader
 	XDPoS *XDPoS
 }
+
+type V2BlockInfo struct {
+	Hash       common.Hash
+	Round      types.Round
+	Number     *big.Int
+	ParentHash common.Hash
+	Committed  bool
+	EncodedRLP string
+	Error      string
+}
+
 type NetworkInformation struct {
 	NetworkId                  *big.Int
 	XDCValidatorAddress        common.Address
@@ -96,6 +109,89 @@ func (api *API) GetLatestCommittedBlockHeader() *types.BlockInfo {
 	return api.XDPoS.EngineV2.GetLatestCommittedBlockInfo()
 }
 
+func (api *API) GetV2BlockByHeader(header *types.Header, uncle bool) *V2BlockInfo {
+	committed := false
+	latestCommittedBlock := api.XDPoS.EngineV2.GetLatestCommittedBlockInfo()
+	if latestCommittedBlock == nil {
+		return &V2BlockInfo{
+			Hash:  header.Hash(),
+			Error: "can not find latest committed block from consensus",
+		}
+	}
+	if header.Number.Uint64() <= latestCommittedBlock.Number.Uint64() {
+		committed = true && !uncle
+	}
+
+	round, err := api.XDPoS.EngineV2.GetRoundNumber(header)
+
+	if err != nil {
+		return &V2BlockInfo{
+			Hash:  header.Hash(),
+			Error: err.Error(),
+		}
+	}
+
+	encodeBytes, err := rlp.EncodeToBytes(header)
+	if err != nil {
+		return &V2BlockInfo{
+			Hash:  header.Hash(),
+			Error: err.Error(),
+		}
+	}
+
+	block := &V2BlockInfo{
+		Hash:       header.Hash(),
+		ParentHash: header.ParentHash,
+		Number:     header.Number,
+		Round:      round,
+		Committed:  committed,
+		EncodedRLP: base64.StdEncoding.EncodeToString(encodeBytes),
+	}
+	return block
+}
+
+func (api *API) GetV2BlockByNumber(number *rpc.BlockNumber) *V2BlockInfo {
+	var header *types.Header
+	if number == nil || *number == rpc.LatestBlockNumber {
+		header = api.chain.CurrentHeader()
+	} else if *number == rpc.CommittedBlockNumber {
+		hash := api.XDPoS.EngineV2.GetLatestCommittedBlockInfo().Hash
+		header = api.chain.GetHeaderByHash(hash)
+	} else {
+		header = api.chain.GetHeaderByNumber(uint64(number.Int64()))
+	}
+
+	if header == nil {
+		return &V2BlockInfo{
+			Number: big.NewInt(number.Int64()),
+			Error:  "can not find block from this number",
+		}
+	}
+
+	uncle := false
+	return api.GetV2BlockByHeader(header, uncle)
+}
+
+// Confirm V2 Block Committed Status
+func (api *API) GetV2BlockByHash(blockHash common.Hash) *V2BlockInfo {
+	header := api.chain.GetHeaderByHash(blockHash)
+	if header == nil {
+		return &V2BlockInfo{
+			Hash:  blockHash,
+			Error: "can not find block from this hash",
+		}
+	}
+
+	// confirm this is on the main chain
+	chainHeader := api.chain.GetHeaderByNumber(header.Number.Uint64())
+	uncle := false
+	if header.Hash() != chainHeader.Hash() {
+		uncle = true
+	}
+
+	return api.GetV2BlockByHeader(header, uncle)
+}
+
 func (api *API) NetworkInformation() NetworkInformation {
 	info := NetworkInformation{}
 	info.NetworkId = api.chain.Config().ChainId

eth/api_backend.go

@@ -82,7 +82,7 @@ func (b *EthApiBackend) HeaderByNumber(ctx context.Context, blockNr rpc.BlockNum
 	// Otherwise resolve and return the block
 	if blockNr == rpc.LatestBlockNumber {
 		return b.eth.blockchain.CurrentBlock().Header(), nil
-	} else if blockNr == rpc.ConfirmedBlockNumber {
+	} else if blockNr == rpc.CommittedBlockNumber {
 		if b.eth.chainConfig.XDPoS == nil {
 			return nil, errors.New("PoW does not support confirmed block lookup")
 		}
@@ -110,7 +110,7 @@ func (b *EthApiBackend) BlockByNumber(ctx context.Context, blockNr rpc.BlockNumb
 	// Otherwise resolve and return the block
 	if blockNr == rpc.LatestBlockNumber {
 		return b.eth.blockchain.CurrentBlock(), nil
-	} else if blockNr == rpc.ConfirmedBlockNumber {
+	} else if blockNr == rpc.CommittedBlockNumber {
 		if b.eth.chainConfig.XDPoS == nil {
 			return nil, errors.New("PoW does not support confirmed block lookup")
 		}

internal/jsre/deps/web3.js

@@ -3696,7 +3696,7 @@ var outputBigNumberFormatter = function (number) {
 };
 
 var isPredefinedBlockNumber = function (blockNumber) {
-    return blockNumber === 'latest' || blockNumber === 'pending' || blockNumber === 'earliest';
+    return ['latest','pending','earliest','committed'].indexOf(blockNumber) >= 0;
 };
 
 var inputDefaultBlockNumberFormatter = function (blockNumber) {

internal/web3ext/web3ext.go

@@ -139,8 +139,12 @@ web3._extend({
 			params: 1
 		}),
 		new web3._extend.Method({
-			name: 'getLatestCommittedBlockInfo',
-			call: 'XDPoS_getLatestCommittedBlockHeader'
+			name: 'getV2Block',
+			call: function (args) {
+				return (web3._extend.utils.isString(args[0]) && args[0].indexOf('0x') === 0) ? "XDPoS_getV2BlockByHash" : "XDPoS_getV2BlockByNumber";
+			},
+			params: 1,
+			inputFormatter: [web3._extend.formatters.inputBlockNumberFormatter]
 		}),
 	],
 	properties: [

rpc/types.go

@@ -120,7 +120,7 @@ type BlockNumber int64
 type EpochNumber int64
 
 const (
-	ConfirmedBlockNumber = BlockNumber(-3)
+	CommittedBlockNumber = BlockNumber(-3)
 	PendingBlockNumber   = BlockNumber(-2)
 	LatestBlockNumber    = BlockNumber(-1)
 	EarliestBlockNumber  = BlockNumber(0)
@@ -128,7 +128,7 @@ const (
 )
 
 // UnmarshalJSON parses the given JSON fragment into a BlockNumber. It supports:
-// - "latest", "earliest", "pending" and "confirmed" as string arguments
+// - "latest", "earliest", "pending" and "committed" as string arguments
 // - the block number
 // Returned errors:
 // - an invalid block number error when the given argument isn't a known strings
@@ -145,8 +145,8 @@ func (bn *BlockNumber) UnmarshalJSON(data []byte) error {
 	case "pending":
 		*bn = PendingBlockNumber
 		return nil
-	case "confirmed":
-		*bn = ConfirmedBlockNumber
+	case "committed":
+		*bn = CommittedBlockNumber
 		return nil
 	}
 

rpc/types_test.go

@@ -43,9 +43,10 @@ func TestBlockNumberJSONUnmarshal(t *testing.T) {
 		11: {`"pending"`, false, PendingBlockNumber},
 		12: {`"latest"`, false, LatestBlockNumber},
 		13: {`"earliest"`, false, EarliestBlockNumber},
-		14: {`someString`, true, BlockNumber(0)},
-		15: {`""`, true, BlockNumber(0)},
-		16: {``, true, BlockNumber(0)},
+		14: {`"committed"`, false, CommittedBlockNumber},
+		15: {`someString`, true, BlockNumber(0)},
+		16: {`""`, true, BlockNumber(0)},
+		17: {``, true, BlockNumber(0)},
 	}
 
 	for i, test := range tests {