Documentation ¶
Index ¶
- Constants
- Variables
- type IssuanceContract
- type IssuanceEntity
- type Transaction
- func (tx *Transaction) AddInput(ti *TxInput)
- func (tx *Transaction) AddOutput(to *TxOutput)
- func (tx *Transaction) Copy() *Transaction
- func (tx *Transaction) CountIssuances() (issuances, reissuances, total int)
- func (tx *Transaction) HasWitness() bool
- func (tx *Transaction) HashForSignature(inIndex int, prevoutScript []byte, hashType txscript.SigHashType) ([32]byte, error)
- func (tx *Transaction) HashForWitnessV0(inIndex int, prevoutScript []byte, value []byte, hashType txscript.SigHashType) [32]byte
- func (tx *Transaction) Serialize() ([]byte, error)
- func (tx *Transaction) SerializeSize(allowWitness, forSignature bool) int
- func (tx *Transaction) ToHex() (string, error)
- func (tx *Transaction) TxHash() chainhash.Hash
- func (tx *Transaction) VirtualSize() int
- func (tx *Transaction) Weight() int
- func (tx *Transaction) WitnessHash() chainhash.Hash
- type TxInput
- type TxIssuance
- type TxIssuanceExtended
- func NewTxIssuance(assetAmount uint64, tokenAmount uint64, precision uint, ...) (*TxIssuanceExtended, error)
- func NewTxIssuanceFromContractHash(contractHash []byte) *TxIssuanceExtended
- func NewTxIssuanceFromEntropy(entropy []byte) *TxIssuanceExtended
- func NewTxIssuanceFromInput(in *TxInput) (*TxIssuanceExtended, error)
- type TxOutput
- type TxWitness
Constants ¶
const ( WitnessScaleFactor = 4 DefaultSequence = 0xffffffff MinusOne = 4294967295 OutpointIndexMask = 0x3fffffff OutpointIssuanceFlag = (1 << 31) >> 0 OutpointPeginFlag = (1 << 30) >> 0 )
Variables ¶
var ( One = [32]byte{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, } Zero = [32]byte{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, } MaxConfidentialValue = []byte{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, } )
Functions ¶
This section is empty.
Types ¶
type IssuanceContract ¶
type IssuanceContract struct { Name string `json:"name"` Ticker string `json:"ticker"` Version uint `json:"version"` Precision uint `json:"precision"` PubKey string `json:"issuer_pubkey"` Entity IssuanceEntity `json:"entity"` }
IssuanceContract defines the structure of the Ricardian contract of the issuance
type IssuanceEntity ¶
type IssuanceEntity struct {
Domain string `json:"domain"`
}
IssuanceEntity defines one of the fields of the issuance contract
type Transaction ¶
type Transaction struct { Version int32 Flag int32 Locktime uint32 Inputs []*TxInput Outputs []*TxOutput }
Transaction defines an elements transaction message.
func NewTx ¶
func NewTx(version int32) *Transaction
NewTx returns a new elements tx message. The return instance has no transaction inputs or outputs. Also, the lock time is set to zero to indicate the transaction is valid immediately as opposed to some time in future.
func NewTxFromBuffer ¶
func NewTxFromBuffer(buf *bytes.Buffer) (*Transaction, error)
NewTxFromBuffer deserializes the given raw transaction in bytes and returns an instance of *Transaction.
func NewTxFromHex ¶
func NewTxFromHex(str string) (*Transaction, error)
NewTxFromHex deserializes the given transaction in hex format and returns an instance of *Transaction.
func (*Transaction) AddInput ¶
func (tx *Transaction) AddInput(ti *TxInput)
AddInput creates an input with the given hash and index and adds it to the transaction.
func (*Transaction) AddOutput ¶
func (tx *Transaction) AddOutput(to *TxOutput)
AddOutput adds an output to the transaction.
func (*Transaction) Copy ¶
func (tx *Transaction) Copy() *Transaction
Copy creates a deep copy of a transaction so that the original does not get modified when the copy is manipulated.
func (*Transaction) CountIssuances ¶
func (tx *Transaction) CountIssuances() (issuances, reissuances, total int)
CountIssuances returns the number issuances contained in the transaction as the number of issuances, reissuances and the total (their sum).
func (*Transaction) HasWitness ¶
func (tx *Transaction) HasWitness() bool
HasWitness returns wether the transaction contains witness data
func (*Transaction) HashForSignature ¶
func (tx *Transaction) HashForSignature( inIndex int, prevoutScript []byte, hashType txscript.SigHashType) ([32]byte, error)
HashForSignature returns the double sha256 hash of the serialization of the transaction in order to then produce a signature from it. The transaction is serialized in a different way depending on the hashType provided.
func (*Transaction) HashForWitnessV0 ¶
func (tx *Transaction) HashForWitnessV0(inIndex int, prevoutScript []byte, value []byte, hashType txscript.SigHashType) [32]byte
HashForWitnessV0 returns the double sha256 hash of the serialization of the transaction following the BIP-0143 specification. This hash should then be used to produce a witness signatures for the given inIndex input.
func (*Transaction) Serialize ¶
func (tx *Transaction) Serialize() ([]byte, error)
Serialize returns the serialization of the transaction.
func (*Transaction) SerializeSize ¶
func (tx *Transaction) SerializeSize(allowWitness, forSignature bool) int
SerializeSize returns the number of bytes it would take to serialize the the transaction.
func (*Transaction) ToHex ¶
func (tx *Transaction) ToHex() (string, error)
ToHex returns the serializarion of the transaction in hex enncoding format.
func (*Transaction) TxHash ¶
func (tx *Transaction) TxHash() chainhash.Hash
TxHash generates the Hash for the transaction.
func (*Transaction) VirtualSize ¶
func (tx *Transaction) VirtualSize() int
VirtualSize returns the total weight of a transaction excluding witnesses
func (*Transaction) Weight ¶
func (tx *Transaction) Weight() int
Weight returns the total weight in bytes of the transaction
func (*Transaction) WitnessHash ¶
func (tx *Transaction) WitnessHash() chainhash.Hash
WitnessHash generates the hash of the transaction serialized according to the new witness serialization defined in BIP0141 and BIP0144. The final output is used within the Segregated Witness commitment of all the witnesses within a block. If a transaction has no witness data, then the witness hash, is the same as its txid.
type TxInput ¶
type TxInput struct { Hash []byte Index uint32 Sequence uint32 Script []byte Witness TxWitness IsPegin bool PeginWitness TxWitness Issuance *TxIssuance IssuanceRangeProof []byte InflationRangeProof []byte }
TxInput defines an elements transaction input.
func NewTxInput ¶
NewTxInput returns a new input with given hash and index and a default max sequence number.
func (*TxInput) HasAnyIssuance ¶
HasAnyIssuance returns whether the input contains an issuance
func (*TxInput) HasConfidentialIssuance ¶
HasConfidentialIssuance returns whether the input contains a blinded issuance
func (*TxInput) HasIssuance ¶
HasIssuance returns wheter the input contains a pure asset issuance
func (*TxInput) HasReissuance ¶
HasReissuance returns wheter the input contains a reissuance of an asset
func (*TxInput) SerializeSize ¶
SerializeSize returns the number of bytes it would take to serialize the the transaction input.
type TxIssuance ¶
type TxIssuance struct { AssetBlindingNonce []byte AssetEntropy []byte AssetAmount []byte TokenAmount []byte }
TxIssuance defines the type for Issuance field in TxInput
func (*TxIssuance) HasTokenAmount ¶
func (issuance *TxIssuance) HasTokenAmount() bool
HasTokenAmount returns whether the token amount is defined for the issuance
func (*TxIssuance) IsReissuance ¶
func (issuance *TxIssuance) IsReissuance() bool
IsReissuance returns whether the issuance is an asset re-issuance
type TxIssuanceExtended ¶
type TxIssuanceExtended struct { TxIssuance Precision uint ContractHash []byte }
TxIssuanceExtended adds fields to the issuance type that are not encoded in the transaction
func NewTxIssuance ¶
func NewTxIssuance( assetAmount uint64, tokenAmount uint64, precision uint, contract *IssuanceContract, ) (*TxIssuanceExtended, error)
NewTxIssuance returns a new issuance instance
func NewTxIssuanceFromContractHash ¶
func NewTxIssuanceFromContractHash(contractHash []byte) *TxIssuanceExtended
NewTxIssuanceFromContractHash returns a new issuance instance from contract hash
func NewTxIssuanceFromEntropy ¶
func NewTxIssuanceFromEntropy(entropy []byte) *TxIssuanceExtended
NewTxIssuanceFromEntropy returns a new issuance instance from entropy
func NewTxIssuanceFromInput ¶
func NewTxIssuanceFromInput(in *TxInput) (*TxIssuanceExtended, error)
NewTxIssuanceFromInput returns the extended issuance for the given input
func (*TxIssuanceExtended) GenerateAsset ¶
func (issuance *TxIssuanceExtended) GenerateAsset() ([]byte, error)
GenerateAsset calculates the asset hash for the given issuance
func (*TxIssuanceExtended) GenerateEntropy ¶
func (issuance *TxIssuanceExtended) GenerateEntropy(inTxHash []byte, inTxIndex uint32) error
GenerateEntropy generates the entropy from which the hash of the asset and of the reissuance token are calculated
func (*TxIssuanceExtended) GenerateReissuanceToken ¶
func (issuance *TxIssuanceExtended) GenerateReissuanceToken(flag uint) ([]byte, error)
GenerateReissuanceToken calculates the asset hash for the given issuance
type TxOutput ¶
type TxOutput struct { Asset []byte Value []byte Script []byte Nonce []byte RangeProof []byte SurjectionProof []byte }
TxOutput defines an elements transaction output.
func NewTxOutput ¶
NewTxOutput returns a new output with given asset, value and script and a default 0 nonce.
func (*TxOutput) IsConfidential ¶
IsConfidential returns whether the output is a confidential one
func (*TxOutput) SerializeSize ¶
SerializeSize returns the number of bytes it would take to serialize the the transaction output.
type TxWitness ¶
type TxWitness [][]byte
TxWitness defines the witness for a TxIn. A witness is to be interpreted as a slice of byte slices, or a stack with one or many elements.
func (TxWitness) SerializeSize ¶
SerializeSize returns the number of bytes it would take to serialize the the transaction input's witness.