IUtility.go

/*
 *
 *    This file is part of go-palletone.
 *    go-palletone is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *    go-palletone is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *    You should have received a copy of the GNU General Public License
 *    along with go-palletone.  If not, see <http://www.gnu.org/licenses/>.
 * /
 *
 *  * @author PalletOne core developer <dev@pallet.one>
 *  * @date 2018-2019
 *
 */

package adaptor

//IUtility 钱包相关的API接口,区块链相关API接口
type IUtility interface {
	//创建一个新的私钥
	NewPrivateKey(input *NewPrivateKeyInput) (*NewPrivateKeyOutput, error)
	//根据私钥创建公钥
	GetPublicKey(input *GetPublicKeyInput) (*GetPublicKeyOutput, error)
	//根据Key创建地址
	GetAddress(key *GetAddressInput) (*GetAddressOutput, error)
	//获得原链的地址和PalletOne的地址的映射
	GetPalletOneMappingAddress(addr *GetPalletOneMappingAddressInput) (*GetPalletOneMappingAddressOutput, error)
	//计算一条消息的Hash值
	HashMessage(input *HashMessageInput) (*HashMessageOutput, error)
	//对一条消息进行签名
	SignMessage(input *SignMessageInput) (*SignMessageOutput, error)
	//对签名进行验证
	VerifySignature(input *VerifySignatureInput) (*VerifySignatureOutput, error)
	//对一条交易进行签名，并返回签名结果
	SignTransaction(input *SignTransactionInput) (*SignTransactionOutput, error)
	//将未签名的原始交易与签名进行绑定，返回一个签名后的交易
	BindTxAndSignature(input *BindTxAndSignatureInput) (*BindTxAndSignatureOutput, error)
	//根据交易内容，计算交易Hash
	CalcTxHash(input *CalcTxHashInput) (*CalcTxHashOutput, error)
	//将签名后的交易广播到网络中,如果发送交易需要手续费，指定最多支付的手续费
	SendTransaction(input *SendTransactionInput) (*SendTransactionOutput, error)
	//根据交易ID获得交易的基本信息
	GetTxBasicInfo(input *GetTxBasicInfoInput) (*GetTxBasicInfoOutput, error)
	//查询获得一个区块的信息
	GetBlockInfo(input *GetBlockInfoInput) (*GetBlockInfoOutput, error)
}
type NewPrivateKeyInput struct {
	//随机数的种子，如果不指定，则使用默认实现
	RandomSeed []byte `json:"random_seed"`
	Extra      []byte `json:"extra"`
}
type NewPrivateKeyOutput struct {
	PrivateKey []byte `json:"private_key"`
	Extra      []byte `json:"extra"`
}
type GetPublicKeyInput struct {
	PrivateKey []byte `json:"private_key"`
	Extra      []byte `json:"extra"`
}
type GetPublicKeyOutput struct {
	PublicKey []byte `json:"public_key"`
	Extra     []byte `json:"extra"`
}
type GetAddressInput struct {
	Key   []byte `json:"key"`
	Extra []byte `json:"extra"`
}
type GetAddressOutput struct {
	Address string `json:"address"`
	Extra   []byte `json:"extra"`
}
type GetPalletOneMappingAddressInput struct {
	PalletOneAddress  string `json:"palletone_address"`
	ChainAddress      string `json:"chain_address"`
	MappingDataSource string `json:"mapping_data_source"` //映射地址数据查询的地方，以太坊就是一个合约地址
	Extra             []byte `json:"extra"`
}
type GetPalletOneMappingAddressOutput struct {
	PalletOneAddress string `json:"palletone_address"`
	ChainAddress     string `json:"chain_address"`
	Extra            []byte `json:"extra"`
}
type HashMessageInput struct {
	Message []byte `json:"message"`
	Extra   []byte `json:"extra"`
}
type HashMessageOutput struct {
	Hash  []byte `json:"hash"`
	Extra []byte `json:"extra"`
}
type SignMessageInput struct {
	PrivateKey []byte `json:"private_key"`
	Message    []byte `json:"message"`
	Extra      []byte `json:"extra"`
}
type SignMessageOutput struct {
	Signature []byte `json:"signature"`
	Extra     []byte `json:"extra"`
}
type VerifySignatureInput struct {
	Message   []byte `json:"message"`
	Signature []byte `json:"signature"`
	PublicKey []byte `json:"public_key"`
	Extra     []byte `json:"extra"`
}
type VerifySignatureOutput struct {
	Pass  bool   `json:"pass"`
	Extra []byte `json:"extra"`
}
type SignTransactionInput struct {
	PrivateKey  []byte `json:"private_key"`
	Transaction []byte `json:"transaction"`
	//BTC： 如果Input只有1个，那么可以为空，如果是多个，那么必须使用Extra指定InputIndex
	Extra []byte `json:"extra"`
}
type SignTransactionOutput struct {
	Signature []byte `json:"signature"`
	SignedTx  []byte `json:"signed_tx"`
	//BTC： 与Input的Extra相同
	Extra []byte `json:"extra"`
}
type BindTxAndSignatureInput struct {
	//未签名的交易
	Transaction []byte `json:"transaction"`
	//多个签名
	Signatures [][]byte `json:"signatures"`
	SignedTxs  [][]byte `json:"signed_txs"`
	//BTC：如果是单签地址付出，那么Extra是公钥，如果是多签地址付出，那么Extra是RedeemScript
	//ETH: 暂时用不到
	Extra []byte `json:"extra"`
}
type BindTxAndSignatureOutput struct {
	SignedTx []byte `json:"signed_tx"`
	Extra    []byte `json:"extra"`
}
type CalcTxHashInput struct {
	Transaction []byte `json:"transaction"`
	Extra       []byte `json:"extra"`
}
type CalcTxHashOutput struct {
	Hash  []byte `json:"hash"`
	Extra []byte `json:"extra"`
}
type SendTransactionInput struct {
	Transaction []byte       `json:"transaction"`
	Fee         *AmountAsset `json:"fee"`
	Extra       []byte       `json:"extra"`
}
type SendTransactionOutput struct {
	TxID  []byte `json:"tx_id"`
	Extra []byte `json:"extra"`
}
type GetTxBasicInfoInput struct {
	TxID  []byte `json:"tx_id"`
	Extra []byte `json:"extra"`
}
type GetTxBasicInfoOutput struct {
	Tx    TxBasicInfo `json:"transaction"`
	Extra []byte      `json:"extra"`
}
type GetBlockInfoInput struct {
	Latest  bool   `json:"latest"`   //true表示查询最新区块
	Height  uint64 `json:"height"`   //根据高度查询区块
	BlockID []byte `json:"block_id"` //根据Hash查询区块
	Extra   []byte `json:"extra"`
}
type GetBlockInfoOutput struct {
	Block BlockInfo `json:"block"`
	Extra []byte    `json:"extra"`
}