utils.go

package gobtcsign

import (
	"bytes"
	"encoding/hex"
	"math"

	"github.com/btcsuite/btcd/btcjson"
	"github.com/btcsuite/btcd/btcutil"
	"github.com/btcsuite/btcd/chaincfg"
	"github.com/btcsuite/btcd/chaincfg/chainhash"
	"github.com/btcsuite/btcd/rpcclient"
	"github.com/btcsuite/btcd/txscript"
	"github.com/btcsuite/btcd/wire"
	"github.com/pkg/errors"
)

// GetTxHash 通过签名后的交易信息获得交易哈希
// 这个函数非常重要能够让你在发交易前就能知道哈希，这样就能在交易发出前就把信息存在数据库里，当交易发出后就可以去链上查找这笔交易
// 避免出现发了交易以后找不到的问题
// 理论上所有的链都能在交易发出以前就得到交易哈希，以方便程序员写出逻辑严密的代码，比如高并发和高可用情况下的收发交易
// 否则就很不好用，因此在做其它链时要多找找教程，在自己设计链时也要优先考虑提供这个功能
func GetTxHash(msgTx *wire.MsgTx) string {
	return msgTx.TxHash().String()
}

// CvtMsgTxToHex 把go语言消息体转换为btc链上通用的hex字符串
func CvtMsgTxToHex(msgTx *wire.MsgTx) (string, error) {
	outTo := bytes.NewBuffer(make([]byte, 0, msgTx.SerializeSize()))
	if err := msgTx.Serialize(outTo); err != nil {
		return "", errors.WithMessage(err, "wrong serialize")
	}
	txHex := hex.EncodeToString(outTo.Bytes())
	return txHex, nil
}

// NewMsgTxFromHex 通过交易信息的hex字符串，再反序列化出交易消息体
func NewMsgTxFromHex(txHex string) (*wire.MsgTx, error) {
	data, err := hex.DecodeString(txHex)
	if err != nil {
		return nil, errors.WithMessage(err, "wrong decode data")
	}
	var msgTx = &wire.MsgTx{}
	err = msgTx.Deserialize(bytes.NewReader(data))
	if err != nil {
		return nil, errors.WithMessage(err, "wrong deserialize")
	}
	return msgTx, nil
}

// GetAddressPkScript 根据地址字符串生成对应的公钥脚本（PkScript），地址和公钥脚本是一对一的
// 这个函数很重要，因为某些（少数的）函数的参数需要地址信息，而某些（多数的）函数需要公钥脚本信息
func GetAddressPkScript(addressString string, netParams *chaincfg.Params) ([]byte, error) {
	address, err := btcutil.DecodeAddress(addressString, netParams)
	if err != nil {
		return nil, errors.WithMessage(err, "wrong decode-address")
	}
	pkScript, err := txscript.PayToAddrScript(address)
	if err != nil {
		return nil, errors.WithMessage(err, "wrong get-pk-script")
	}
	return pkScript, nil
}

func MustNewAddress(addressString string, netParams *chaincfg.Params) btcutil.Address {
	address, err := btcutil.DecodeAddress(addressString, netParams)
	if err != nil {
		panic(errors.WithMessage(err, "wrong decode-address"))
	}
	return address
}

func MustGetPkScript(address btcutil.Address) []byte {
	pkScript, err := txscript.PayToAddrScript(address)
	if err != nil {
		panic(errors.WithMessage(err, "wrong get-pk-script"))
	}
	return pkScript
}

func MustNewOutPoint(srcTxHash string, utxoIndex uint32) *wire.OutPoint {
	//which tx the utxo from.
	utxoHash, err := chainhash.NewHashFromStr(srcTxHash)
	if err != nil {
		panic(errors.WithMessagef(err, "wrong param utxo-from-tx-hash=%s", srcTxHash))
	}
	return wire.NewOutPoint(
		utxoHash,  //这个是收到 utxo 的交易哈希，即 utxo 是从哪里来的，配合位置索引序号构成唯一索引，就能确定是花的哪个utxo
		utxoIndex, //这个是收到 utxo 的输出位置，比如一个交易中有多个输出，这里要选择输出的位置
	)
}

// NewInputOuts 因为 SignParam 的成员里有 []*wire.TxOut 类型的前置输出字段
// 但教程常用的是 pkScripts [][]byte 和 amounts []int64 两个属性
// 因此这里写个转换逻辑
func NewInputOuts(pkScripts [][]byte, amounts []int64) []*wire.TxOut {
	size := max(len(pkScripts), len(amounts)) // must same size. so use the max size
	outs := make([]*wire.TxOut, 0, size)
	for idx := 0; idx < size; idx++ {
		outs = append(outs, wire.NewTxOut(amounts[idx], pkScripts[idx]))
	}
	return outs
}

func NewInputOutsV2(pkScripts [][]byte, amounts []btcutil.Amount) []*wire.TxOut {
	size := max(len(pkScripts), len(amounts)) // must same size. so use the max size
	outs := make([]*wire.TxOut, 0, size)
	for idx := 0; idx < size; idx++ {
		outs = append(outs, wire.NewTxOut(int64(amounts[idx]), pkScripts[idx]))
	}
	return outs
}

// GetMsgTxVSize 获得【签名后的】交易的大小，结果是 v-size 的，而且和链上的值相同
func GetMsgTxVSize(msgTx *wire.MsgTx) int {
	return int(math.Ceil(float64(3*msgTx.SerializeSizeStripped()+msgTx.SerializeSize()) / 4))
}

func GetRawTransaction(client *rpcclient.Client, txHash string) (*btcjson.TxRawResult, error) {
	oneHash, err := chainhash.NewHashFromStr(txHash)
	if err != nil {
		return nil, errors.WithMessage(err, "wrong param-tx-hash")
	}
	return client.GetRawTransactionVerbose(oneHash)
}