common

Documentation

Index

• Constants
• Variables
• func CopyBytes(b []byte) (copiedBytes []byte)
• func NewReceipt(root []byte, failed bool, cumulativeGasUsed uint64) *types.Receipt
• func ReceiptHash(receipt *types.Receipt) (hash types.Hash)
• type GasPool
  • func (gp *GasPool) AddGas(amount uint64) *GasPool
  • func (gp *GasPool) Gas() uint64
  • func (gp *GasPool) String() string
  • func (gp *GasPool) SubGas(amount uint64) error
• type Log

Constants

const (
	// ReceiptStatusFailed is the status code of a transaction if execution failed.
	ReceiptStatusFailed = uint64(0)

	// ReceiptStatusSuccessful is the status code of a transaction if execution succeeded.
	ReceiptStatusSuccessful = uint64(1)
)

Variables

var (
	// ErrGasLimitReached is returned by the gas pool if the amount of gas required
	// by a transaction is higher than what's left in the block.
	ErrGasLimitReached           = errors.New("gas reached limit")
	ErrInsufficientBalanceForGas = errors.New("insufficient balance to pay for gas")
)

Functions

func CopyBytes

func CopyBytes(b []byte) (copiedBytes []byte)

func NewReceipt

func NewReceipt(root []byte, failed bool, cumulativeGasUsed uint64) *types.Receipt

NewReceipt creates a barebone transaction receipt, copying the init fields.

func ReceiptHash

func ReceiptHash(receipt *types.Receipt) (hash types.Hash)

compute hash of receipt

Types

type GasPool

type GasPool uint64

func (*GasPool) AddGas

func (gp *GasPool) AddGas(amount uint64) *GasPool

AddGas makes gas available for execution.

func (*GasPool) Gas

func (gp *GasPool) Gas() uint64

Gas returns the amount of gas remaining in the pool.

func (*GasPool) String

func (gp *GasPool) String() string

func (*GasPool) SubGas

func (gp *GasPool) SubGas(amount uint64) error

SubGas deducts the given amount from the pool if enough gas is available and returns an error otherwise.

type Log

type Log struct {
	// Consensus fields:
	// address of the contract that generated the event
	Address types.Address `json:"address" gencodec:"required"`
	// list of topics provided by the contract.
	Topics []types.Hash `json:"topics" gencodec:"required"`
	// supplied by the contract, usually ABI-encoded
	Data []byte `json:"data" gencodec:"required"`

	// Derived fields. These fields are filled in by the node
	// but not secured by consensus.
	// block in which the transaction was included
	BlockNumber uint64 `json:"blockNumber"`
	// hash of the transaction
	TxHash types.Hash `json:"transactionHash" gencodec:"required"`
	// index of the transaction in the block
	TxIndex uint `json:"transactionIndex" gencodec:"required"`
	// hash of the block in which the transaction was included
	BlockHash types.Hash `json:"blockHash"`
	// index of the log in the receipt
	Index uint `json:"logIndex" gencodec:"required"`

	// The Removed field is true if this log was reverted due to a chain reorganisation.
	// You must pay attention to this field if you receive logs through a filter query.
	Removed bool `json:"removed"`
}