Documentation ¶
Index ¶
- func IntrinsicGas(clauses ...*Clause) (uint64, error)
- type BlockRef
- type Builder
- func (b *Builder) BlockRef(br BlockRef) *Builder
- func (b *Builder) Build() *Transaction
- func (b *Builder) ChainTag(tag byte) *Builder
- func (b *Builder) Clause(c *Clause) *Builder
- func (b *Builder) DependsOn(txID *luckyshare.Bytes32) *Builder
- func (b *Builder) Expiration(exp uint32) *Builder
- func (b *Builder) Features(feat Features) *Builder
- func (b *Builder) Gas(gas uint64) *Builder
- func (b *Builder) GasPriceCoef(coef uint8) *Builder
- func (b *Builder) Nonce(nonce uint64) *Builder
- type Clause
- func (c *Clause) Data() []byte
- func (c *Clause) DecodeRLP(s *rlp.Stream) error
- func (c *Clause) EncodeRLP(w io.Writer) error
- func (c *Clause) IsCreatingContract() bool
- func (c *Clause) String() string
- func (c *Clause) To() *luckyshare.Address
- func (c *Clause) Value() *big.Int
- func (c *Clause) WithData(data []byte) *Clause
- func (c *Clause) WithValue(value *big.Int) *Clause
- type Event
- type Events
- type Features
- type Output
- type Receipt
- type Receipts
- type Transaction
- func (t *Transaction) BlockRef() (br BlockRef)
- func (t *Transaction) ChainTag() byte
- func (t *Transaction) Clauses() []*Clause
- func (t *Transaction) DecodeRLP(s *rlp.Stream) error
- func (t *Transaction) Delegator() (*luckyshare.Address, error)
- func (t *Transaction) DelegatorSigningHash(origin luckyshare.Address) (hash luckyshare.Bytes32)
- func (t *Transaction) DependsOn() *luckyshare.Bytes32
- func (t *Transaction) EncodeRLP(w io.Writer) error
- func (t *Transaction) EvaluateWork(origin luckyshare.Address) func(nonce uint64) *big.Int
- func (t *Transaction) Expiration() uint32
- func (t *Transaction) Features() Features
- func (t *Transaction) Gas() uint64
- func (t *Transaction) GasPrice(baseGasPrice *big.Int) *big.Int
- func (t *Transaction) GasPriceCoef() uint8
- func (t *Transaction) Hash() (hash luckyshare.Bytes32)
- func (t *Transaction) ID() (id luckyshare.Bytes32)
- func (t *Transaction) IntrinsicGas() (uint64, error)
- func (t *Transaction) IsExpired(blockNum uint32) bool
- func (t *Transaction) Nonce() uint64
- func (t *Transaction) Origin() (luckyshare.Address, error)
- func (t *Transaction) OverallGasPrice(baseGasPrice *big.Int, provedWork *big.Int) *big.Int
- func (t *Transaction) ProvedWork(headBlockNum uint32, getBlockID func(uint32) (luckyshare.Bytes32, error)) (*big.Int, error)
- func (t *Transaction) Signature() []byte
- func (t *Transaction) SigningHash() (hash luckyshare.Bytes32)
- func (t *Transaction) Size() metric.StorageSize
- func (t *Transaction) String() string
- func (t *Transaction) TestFeatures(supported Features) error
- func (t *Transaction) UnprovedWork() (w *big.Int)
- func (t *Transaction) WithSignature(sig []byte) *Transaction
- type Transactions
- type Transfer
- type Transfers
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IntrinsicGas ¶
IntrinsicGas calculate intrinsic gas cost for tx with such clauses.
Types ¶
type BlockRef ¶
type BlockRef [8]byte
BlockRef is block reference.
func NewBlockRef ¶
NewBlockRef create block reference with block number.
func NewBlockRefFromID ¶
func NewBlockRefFromID(blockID luckyshare.Bytes32) (br BlockRef)
NewBlockRefFromID create block reference from block id.
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder to make it easy to build transaction.
func (*Builder) DependsOn ¶
func (b *Builder) DependsOn(txID *luckyshare.Bytes32) *Builder
DependsOn set depended tx.
func (*Builder) Expiration ¶
Expiration set expiration.
func (*Builder) GasPriceCoef ¶
GasPriceCoef set gas price coef.
type Clause ¶
type Clause struct {
// contains filtered or unexported fields
}
Clause is the basic execution unit of a transaction.
func NewClause ¶
func NewClause(to *luckyshare.Address) *Clause
NewClause create a new clause instance.
func (*Clause) IsCreatingContract ¶
IsCreatingContract return if this clause is going to create a contract.
type Event ¶
type Event struct { // address of the contract that generated the event Address luckyshare.Address // list of topics provided by the contract. Topics []luckyshare.Bytes32 // supplied by the contract, usually ABI-encoded Data []byte }
Event represents a contract event log. These events are generated by the LOG opcode and stored/indexed by the node.
type Features ¶
type Features uint32
Features bitset contains tx features.
const ( // DelegationFeature See VIP-191 for more detail. (https://github.com/vechain/VIPs/blob/master/vips/VIP-191.md) DelegationFeature Features = 1 )
func (Features) IsDelegated ¶
IsDelegated returns whether tx is delegated.
func (*Features) SetDelegated ¶
SetDelegated set tx delegated flag.
type Output ¶
type Output struct { // events produced by the clause Events Events // transfer occurred in clause Transfers Transfers }
Output output of clause execution.
type Receipt ¶
type Receipt struct { // gas used by this tx GasUsed uint64 // the one who paid for gas GasPayer luckyshare.Address // energy paid for used gas Paid *big.Int // energy reward given to block proposer Reward *big.Int // if the tx reverted Reverted bool // outputs of clauses in tx Outputs []*Output }
Receipt represents the results of a transaction.
type Receipts ¶
type Receipts []*Receipt
Receipts slice of receipts.
func (Receipts) RootHash ¶
func (rs Receipts) RootHash() luckyshare.Bytes32
RootHash computes merkle root hash of receipts.
type Transaction ¶
type Transaction struct {
// contains filtered or unexported fields
}
Transaction is an immutable tx type.
func (*Transaction) BlockRef ¶
func (t *Transaction) BlockRef() (br BlockRef)
BlockRef returns block reference, which is first 8 bytes of block hash.
func (*Transaction) Clauses ¶
func (t *Transaction) Clauses() []*Clause
Clauses returns caluses in tx.
func (*Transaction) DecodeRLP ¶
func (t *Transaction) DecodeRLP(s *rlp.Stream) error
DecodeRLP implements rlp.Decoder
func (*Transaction) Delegator ¶
func (t *Transaction) Delegator() (*luckyshare.Address, error)
Delegator returns delegator address who would like to pay for gas fee.
func (*Transaction) DelegatorSigningHash ¶
func (t *Transaction) DelegatorSigningHash(origin luckyshare.Address) (hash luckyshare.Bytes32)
DelegatorSigningHash returns hash of tx components for delegator to sign, by assuming originator address. According to VIP-191, it's identical to tx id.
func (*Transaction) DependsOn ¶
func (t *Transaction) DependsOn() *luckyshare.Bytes32
DependsOn returns depended tx hash.
func (*Transaction) EncodeRLP ¶
func (t *Transaction) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder
func (*Transaction) EvaluateWork ¶
func (t *Transaction) EvaluateWork(origin luckyshare.Address) func(nonce uint64) *big.Int
EvaluateWork try to compute work when tx origin assumed.
func (*Transaction) Expiration ¶
func (t *Transaction) Expiration() uint32
Expiration returns expiration in unit block. A valid transaction requires: blockNum in [blockRef.Num... blockRef.Num + Expiration]
func (*Transaction) GasPrice ¶
func (t *Transaction) GasPrice(baseGasPrice *big.Int) *big.Int
GasPrice returns gas price. gasPrice = baseGasPrice + baseGasPrice * gasPriceCoef / 255
func (*Transaction) GasPriceCoef ¶
func (t *Transaction) GasPriceCoef() uint8
GasPriceCoef returns gas price coef. gas price = bgp + bgp * gpc / 255.
func (*Transaction) Hash ¶
func (t *Transaction) Hash() (hash luckyshare.Bytes32)
Hash returns hash of tx. Unlike ID, it's the hash of RLP encoded tx.
func (*Transaction) ID ¶
func (t *Transaction) ID() (id luckyshare.Bytes32)
ID returns id of tx. ID = hash(signingHash, origin). It returns zero Bytes32 if origin not available.
func (*Transaction) IntrinsicGas ¶
func (t *Transaction) IntrinsicGas() (uint64, error)
IntrinsicGas returns intrinsic gas of tx.
func (*Transaction) IsExpired ¶
func (t *Transaction) IsExpired(blockNum uint32) bool
IsExpired returns whether the tx is expired according to the given blockNum.
func (*Transaction) Origin ¶
func (t *Transaction) Origin() (luckyshare.Address, error)
Origin extract address of tx originator from signature.
func (*Transaction) OverallGasPrice ¶
OverallGasPrice calculate overall gas price. overallGasPrice = gasPrice + baseGasPrice * wgas/gas.
func (*Transaction) ProvedWork ¶
func (t *Transaction) ProvedWork(headBlockNum uint32, getBlockID func(uint32) (luckyshare.Bytes32, error)) (*big.Int, error)
ProvedWork returns proved work. Unproved work will be considered as proved work if block ref is do the prefix of a block's ID, and tx delay is less equal to MaxTxWorkDelay.
func (*Transaction) Signature ¶
func (t *Transaction) Signature() []byte
Signature returns signature.
func (*Transaction) SigningHash ¶
func (t *Transaction) SigningHash() (hash luckyshare.Bytes32)
SigningHash returns hash of tx excludes signature.
func (*Transaction) Size ¶
func (t *Transaction) Size() metric.StorageSize
Size returns size in bytes when RLP encoded.
func (*Transaction) String ¶
func (t *Transaction) String() string
func (*Transaction) TestFeatures ¶
func (t *Transaction) TestFeatures(supported Features) error
TestFeatures test if the tx is compatible with given supported features. An error returned if it is incompatible.
func (*Transaction) UnprovedWork ¶
func (t *Transaction) UnprovedWork() (w *big.Int)
UnprovedWork returns unproved work of this tx. It returns 0, if tx is not signed.
func (*Transaction) WithSignature ¶
func (t *Transaction) WithSignature(sig []byte) *Transaction
WithSignature create a new tx with signature set. For delegated tx, sig is joined with signatures of originator and delegator.
type Transactions ¶
type Transactions []*Transaction
Transactions a slice of transactions.
func (Transactions) RootHash ¶
func (txs Transactions) RootHash() luckyshare.Bytes32
RootHash computes merkle root hash of transactions.
type Transfer ¶
type Transfer struct { Sender luckyshare.Address Recipient luckyshare.Address Amount *big.Int }
Transfer token transfer log.