bcblock.go

// Copyright (c) 2019 IoTeX Foundation
// This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no
// warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent
// permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache
// License 2.0 that can be found in the LICENSE file.

package bc

import (
	"context"
	"encoding/hex"
	"fmt"
	"strconv"

	"github.com/grpc-ecosystem/go-grpc-middleware/util/metautils"
	"github.com/spf13/cobra"
	"google.golang.org/grpc/status"

	"github.com/iotexproject/iotex-proto/golang/iotexapi"
	"github.com/iotexproject/iotex-proto/golang/iotextypes"

	"github.com/iotexproject/iotex-core/ioctl/config"
	"github.com/iotexproject/iotex-core/ioctl/output"
	"github.com/iotexproject/iotex-core/ioctl/util"
)

var (
	verbose bool
)

// Multi-language support
var (
	bcBlockCmdShorts = map[config.Language]string{
		config.English: "Get block from block chain",
		config.Chinese: "获取IoTeX区块链中的区块",
	}
	bcBlockCmdUses = map[config.Language]string{
		config.English: "block [HEIGHT|HASH] [--verbose]",
		config.Chinese: "block [高度|哈希] [--verbose]",
	}
	flagVerboseUsage = map[config.Language]string{
		config.English: "returns block info and all actions within this block.",
		config.Chinese: "返回区块信息和区块内的所有事务",
	}
)

// bcBlockCmd represents the bc Block command
var bcBlockCmd = &cobra.Command{
	Use:   config.TranslateInLang(bcBlockCmdUses, config.UILanguage),
	Short: config.TranslateInLang(bcBlockCmdShorts, config.UILanguage),
	Args:  cobra.MaximumNArgs(2),
	RunE: func(cmd *cobra.Command, args []string) error {
		cmd.SilenceUsage = true
		err := getBlock(args)
		return output.PrintError(err)
	},
}

func init() {
	bcBlockCmd.Flags().BoolVar(&verbose, "verbose", false, config.TranslateInLang(flagVerboseUsage, config.UILanguage))
}

type blockMessage struct {
	Node       string                `json:"node"`
	Block      *iotextypes.BlockMeta `json:"block"`
	ActionInfo []*actionInfo         `json:"actionInfo"`
}

type log struct {
	ContractAddress string   `json:"contractAddress"`
	Topics          []string `json:"topics"`
	Data            string   `json:"data"`
	BlkHeight       uint64   `json:"blkHeight"`
	ActHash         string   `json:"actHash"`
	Index           uint32   `json:"index"`
}

func convertLog(src *iotextypes.Log) *log {
	topics := make([]string, 0, len(src.Topics))
	for _, topic := range src.Topics {
		topics = append(topics, hex.EncodeToString(topic))
	}
	return &log{
		ContractAddress: src.ContractAddress,
		Topics:          topics,
		Data:            hex.EncodeToString(src.Data),
		BlkHeight:       src.BlkHeight,
		ActHash:         hex.EncodeToString(src.ActHash),
		Index:           src.Index,
	}
}

func convertLogs(src []*iotextypes.Log) []*log {
	logs := make([]*log, 0, len(src))
	for _, log := range src {
		logs = append(logs, convertLog(log))
	}
	return logs
}

type actionInfo struct {
	Version         uint32 `json:"version"`
	Nonce           uint64 `json:"nonce"`
	GasLimit        uint64 `json:"gasLimit"`
	GasPrice        string `json:"gasPrice"`
	SenderPubKey    string `json:"senderPubKey"`
	Signature       string `json:"signature"`
	Status          uint64 `json:"status"`
	BlkHeight       uint64 `json:"blkHeight"`
	ActHash         string `json:"actHash"`
	GasConsumed     uint64 `json:"gasConsumed"`
	ContractAddress string `json:"contractAddress"`
	Logs            []*log `json:"logs"`
}

type blocksInfo struct {
	Block    *iotextypes.Block
	Receipts []*iotextypes.Receipt
}

func (m *blockMessage) String() string {
	if output.Format == "" {
		message := fmt.Sprintf("Blockchain Node: %s\n%s\n%s", m.Node, output.JSONString(m.Block), output.JSONString(m.ActionInfo))
		return message
	}
	return output.FormatString(output.Result, m)
}

// getBlock get block from block chain
func getBlock(args []string) error {
	var (
		height      uint64
		err         error
		blockMeta   *iotextypes.BlockMeta
		blocksInfos []blocksInfo
	)
	isHeight := true
	if len(args) != 0 {
		if height, err = strconv.ParseUint(args[0], 10, 64); err != nil {
			isHeight = false
		}
	} else {
		chainMeta, err := GetChainMeta()
		if err != nil {
			return output.NewError(0, "failed to get chain meta", err)
		}
		height = chainMeta.Height
	}

	if isHeight {
		blockMeta, err = getBlockMetaByHeight(height)
	} else {
		blockMeta, err = getBlockMetaByHash(args[0])
	}
	if err != nil {
		return output.NewError(0, "failed to get block meta", err)
	}
	blockInfoMessage := blockMessage{
		Node:  config.ReadConfig.Endpoint,
		Block: blockMeta,
	}
	if verbose {
		blocksInfos, err = getActionInfoWithinBlock(blockMeta.Height)
		if err != nil {
			return output.NewError(0, "failed to get actions info", err)
		}
		for _, ele := range blocksInfos {
			for index, item := range ele.Block.Body.Actions {
				receipt := ele.Receipts[index]
				actionInfo := actionInfo{
					Version:         item.Core.Version,
					Nonce:           item.Core.Nonce,
					GasLimit:        item.Core.GasLimit,
					GasPrice:        item.Core.GasPrice,
					SenderPubKey:    hex.EncodeToString(item.SenderPubKey),
					Signature:       hex.EncodeToString(item.Signature),
					Status:          receipt.Status,
					BlkHeight:       receipt.BlkHeight,
					ActHash:         hex.EncodeToString(receipt.ActHash),
					GasConsumed:     receipt.GasConsumed,
					ContractAddress: receipt.ContractAddress,
					Logs:            convertLogs(receipt.Logs),
				}
				blockInfoMessage.ActionInfo = append(blockInfoMessage.ActionInfo, &actionInfo)
			}
		}
	}
	fmt.Println(blockInfoMessage.String())
	return nil
}

// getActionInfoByBlock gets action info by block hash with start index and action count
func getActionInfoWithinBlock(height uint64) ([]blocksInfo, error) {
	conn, err := util.ConnectToEndpoint(config.ReadConfig.SecureConnect && !config.Insecure)
	if err != nil {
		return nil, output.NewError(output.NetworkError, "failed to connect to endpoint", err)
	}
	defer conn.Close()
	cli := iotexapi.NewAPIServiceClient(conn)
	request := iotexapi.GetRawBlocksRequest{StartHeight: height, Count: 1, WithReceipts: true}
	ctx := context.Background()

	jwtMD, err := util.JwtAuth()
	if err == nil {
		ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
	}

	response, err := cli.GetRawBlocks(ctx, &request)
	if err != nil {
		sta, ok := status.FromError(err)
		if ok {
			return nil, output.NewError(output.APIError, sta.Message(), nil)
		}
		return nil, output.NewError(output.NetworkError, "failed to invoke GetRawBlocks api", err)
	}
	if len(response.Blocks) == 0 {
		return nil, output.NewError(output.APIError, "no actions returned", err)
	}
	var blockInfos []blocksInfo
	for _, ele := range response.Blocks {
		blockInfos = append(blockInfos, blocksInfo{Block: ele.Block, Receipts: ele.Receipts})
	}
	return blockInfos, nil

}

// getBlockMetaByHeight gets block metadata by height
func getBlockMetaByHeight(height uint64) (*iotextypes.BlockMeta, error) {
	conn, err := util.ConnectToEndpoint(config.ReadConfig.SecureConnect && !config.Insecure)
	if err != nil {
		return nil, output.NewError(output.NetworkError, "failed to connect to endpoint", err)
	}
	defer conn.Close()
	cli := iotexapi.NewAPIServiceClient(conn)
	request := &iotexapi.GetBlockMetasRequest{
		Lookup: &iotexapi.GetBlockMetasRequest_ByIndex{
			ByIndex: &iotexapi.GetBlockMetasByIndexRequest{
				Start: height,
				Count: 1,
			},
		},
	}
	ctx := context.Background()

	jwtMD, err := util.JwtAuth()
	if err == nil {
		ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
	}

	response, err := cli.GetBlockMetas(ctx, request)
	if err != nil {
		sta, ok := status.FromError(err)
		if ok {
			return nil, output.NewError(output.APIError, sta.Message(), nil)
		}
		return nil, output.NewError(output.NetworkError, "failed to invoke GetBlockMetas api", err)
	}
	if len(response.BlkMetas) == 0 {
		return nil, output.NewError(output.APIError, "no block returned", err)
	}
	return response.BlkMetas[0], nil
}

// getBlockMetaByHash gets block metadata by hash
func getBlockMetaByHash(hash string) (*iotextypes.BlockMeta, error) {
	conn, err := util.ConnectToEndpoint(config.ReadConfig.SecureConnect && !config.Insecure)
	if err != nil {
		return nil, output.NewError(output.NetworkError, "failed to connect to endpoint", err)
	}
	defer conn.Close()
	cli := iotexapi.NewAPIServiceClient(conn)
	request := &iotexapi.GetBlockMetasRequest{
		Lookup: &iotexapi.GetBlockMetasRequest_ByHash{
			ByHash: &iotexapi.GetBlockMetaByHashRequest{BlkHash: hash},
		},
	}
	ctx := context.Background()

	jwtMD, err := util.JwtAuth()
	if err == nil {
		ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
	}

	response, err := cli.GetBlockMetas(ctx, request)
	if err != nil {
		sta, ok := status.FromError(err)
		if ok {
			return nil, output.NewError(output.APIError, sta.Message(), nil)
		}
		return nil, output.NewError(output.NetworkError, "failed to invoke GetBlockMetas api", err)
	}
	if len(response.BlkMetas) == 0 {
		return nil, output.NewError(output.APIError, "no block returned", err)
	}
	return response.BlkMetas[0], nil
}