hxnet

README

hxnet-sdk

Hengxin Network SDK

Documentation

Index

• Constants
• Variables
• func IsSigVerificationErr(err error) bool
• type Address
  • func AddressFromKeyStone(addrStr string) (*Address, error)
  • func AddressFromString(s string) (*Address, error)
  • func NewAddress(public ...bool) (*Address, error)
  • func (a Address) GhostPrivateKey(mask crypto.PublicKey, outputIndex uint64) crypto.PrivateKey
  • func (a Address) GhostPublicKey(r crypto.PrivateKey, outputIndex uint64) crypto.PublicKey
  • func (a Address) KeyStore() string
  • func (a Address) MarshalJSON() ([]byte, error)
  • func (a Address) SignJWTToken(typ JWTKeyType) (string, error)
  • func (a Address) String() string
  • func (a *Address) UnmarshalJSON(b []byte) error
• type CosiSignature
• type HXSingingPrivateKey
• type HXSingingPublicKey
• type Input
• type JWTClaim
  • func ParseJWTToken(typ JWTKeyType, token string) (*JWTClaim, error)
• type JWTKeyType
• type Output
• type Script
  • func NewThresholdScript(threshold uint8) Script
  • func (s Script) MarshalJSON() ([]byte, error)
  • func (s Script) String() string
  • func (s *Script) UnmarshalJSON(b []byte) error
  • func (s Script) Validate(sum int) error
  • func (s Script) VerifyFormat() error
• type SigningMethodHX
  • func (k SigningMethodHX) Alg() string
  • func (k SigningMethodHX) Sign(signingString string, key interface{}) (string, error)
  • func (k SigningMethodHX) Verify(signingString, signature string, key interface{}) error
• type Snapshot
• type Transaction
  • func (t *Transaction) MsgpackMarshal() ([]byte, error)
  • func (t *Transaction) MsgpackMarshalPayload() ([]byte, error)
  • func (t *Transaction) TransactionHash() (crypto.Hash, error)
• type UTXO
• type UTXOReader

Constants

const (
	Operator0   = 0x00
	Operator64  = 0x40
	OperatorSum = 0xfe
	OperatorCmp = 0xff
)

const HXKeyStore = "HXKS"

const HXNetwork = "HX"

Symobl

Variables

var (
	ErrSigVerification = errors.New(errMsgVerificationFailed)
)

Functions

func IsSigVerificationErr

func IsSigVerificationErr(err error) bool

Types

type Address

type Address struct {
	PrivateSpendKey   crypto.PrivateKey
	PrivateViewKey    crypto.PrivateKey
	PrivateEncryptKey crypto.EPrivateKey

	PublicSpendKey   crypto.PublicKey
	PublicViewKey    crypto.PublicKey
	PublicEncryptKey crypto.EPublicKey
}

地址数据结构，由三对密钥构成，分别为 SpendKey，ViewKey，和EncryptKey

func AddressFromKeyStone

func AddressFromKeyStone(addrStr string) (*Address, error)

通过字符串生成用户地址 字符串格式

返回地址或者错误

func AddressFromString

func AddressFromString(s string) (*Address, error)

通过字符串生成用户地址 字符串格式

返回地址或者错误

func NewAddress

func NewAddress(public ...bool) (*Address, error)

生成新的地址， 地址有3对密钥构成，分别是 Spend Key、 View Key 和 Encrypt Key

Spend Key 和 View Key 主要是在恒信的区块链网络中使用
Ecrypt Key 主要作用是用于对 数据仓库中加密数据的密钥进行密钥交换

三个密钥都不可以泄漏

func (Address) GhostPrivateKey

func (a Address) GhostPrivateKey(mask crypto.PublicKey, outputIndex uint64) crypto.PrivateKey

使用签名方的 Private SpendKey 和 ViewKey 生成用来签名 Private Key

func (Address) GhostPublicKey

func (a Address) GhostPublicKey(r crypto.PrivateKey, outputIndex uint64) crypto.PublicKey

使用接受方的 SpendKey 和 ViewKey 生成用来转账的 Public Key

func (Address) KeyStore

func (a Address) KeyStore() string

func (Address) MarshalJSON

func (a Address) MarshalJSON() ([]byte, error)

生成地址的字符串

func (Address) SignJWTToken

func (a Address) SignJWTToken(typ JWTKeyType) (string, error)

{
    "iss": "HXxxxx", // 用户的Address
    "exp": 123, // 过期时间
    "iat": 123, // 当前时间
    "nc": "nonce", // 随机的nonce用于防重放
    "sig": "xxx" // 签名
}

func (Address) String

func (a Address) String() string

根据用户的地址生成对外的交易地址 地址的格式规定如下 Address： HX + Base58(Public Spend Key + Public View Key + Public EncryptKey + CRC)

func (*Address) UnmarshalJSON

func (a *Address) UnmarshalJSON(b []byte) error

通过字符串恢复地址 自己有公钥可用，私钥并没有什么用处

type CosiSignature

type CosiSignature struct {
	Signatures []crypto.Signature `json:"signatures,omitempty"`
	Mask       uint64             `json:"mask"`
}

type HXSingingPrivateKey

type HXSingingPrivateKey interface {
	Sign(message []byte) (*crypto.Signature, error)
}

type HXSingingPublicKey

type HXSingingPublicKey interface {
	Verify(message []byte, sig *crypto.Signature) bool
}

type Input

type Input struct {
	Hash    *crypto.Hash `json:"hash,omitempty"`
	Index   int          `json:"index"`
	Genesis []byte       `json:"-"`
	Deposit interface{}  `json:"-"`
	Mint    interface{}  `json:"-"`
}

type JWTClaim

type JWTClaim struct {
	jwt.StandardClaims

	Nonce     string   `json:"jti,omitempty"`
	Signature string   `json:"sig,omitempty"`
	Address   *Address `json:"-"`
}

func ParseJWTToken

func ParseJWTToken(typ JWTKeyType, token string) (*JWTClaim, error)

type JWTKeyType

type JWTKeyType int

const (
	JWTKeyTypeVK JWTKeyType = iota
	JWTKeyTypeSK
	JWTKeyTypeEK
)

type Output

type Output struct {
	Type   uint8          `json:"type"`
	Amount common.Integer `json:"amount"`
	Keys   []crypto.Key   `json:"keys,omitempty"`
	Script Script         `json:"script,omitempty"`
	Mask   crypto.Key     `json:"mask,omitempty"`
}

type Script

type Script []uint8

func NewThresholdScript

func NewThresholdScript(threshold uint8) Script

func (Script) MarshalJSON

func (s Script) MarshalJSON() ([]byte, error)

func (Script) String

func (s Script) String() string

func (*Script) UnmarshalJSON

func (s *Script) UnmarshalJSON(b []byte) error

func (Script) Validate

func (s Script) Validate(sum int) error

func (Script) VerifyFormat

func (s Script) VerifyFormat() error

type SigningMethodHX

type SigningMethodHX struct{}

func (SigningMethodHX) Alg

func (k SigningMethodHX) Alg() string

func (SigningMethodHX) Sign

func (k SigningMethodHX) Sign(signingString string, key interface{}) (string, error)

func (SigningMethodHX) Verify

func (k SigningMethodHX) Verify(signingString, signature string, key interface{}) error

type Snapshot

type Snapshot struct {
	Hash        string         `json:"hash"`
	Transaction *Transaction   `json:"transaction,omitempty"`
	Topology    int64          `json:"topology"`
	Timestamp   int64          `json:"timestamp"`
	Signature   *CosiSignature `json:"signature,omitempty"`
}

type Transaction

type Transaction struct {
	Hash       *crypto.Hash         `json:"hash,omitempty" msgpack:"-"`
	Version    uint8                `json:"version"`
	Asset      crypto.Hash          `json:"asset"`
	Inputs     []*Input             `json:"inputs"`
	Outputs    []*Output            `json:"outputs"`
	Extra      []byte               `json:"extra,omitempty"`
	Signatures [][]crypto.Signature `json:"signatures,omitempty" msgpack:",omitempty"`
	Snapshot   *crypto.Hash         `json:"snapshot,omitempty" msgpack:"-"`
}

func (*Transaction) MsgpackMarshal

func (t *Transaction) MsgpackMarshal() ([]byte, error)

func (*Transaction) MsgpackMarshalPayload

func (t *Transaction) MsgpackMarshalPayload() ([]byte, error)

func (*Transaction) TransactionHash

func (t *Transaction) TransactionHash() (crypto.Hash, error)

type UTXO

type UTXO struct {
	Input
	Output
	Lock crypto.Hash `json:"lock,omitempty"`
}

type UTXOReader

type UTXOReader interface {
	ReadUTXO(hash crypto.Hash, index int) (*UTXO, error)
}