utils

Documentation

Index

• 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

Types

type GasPool

type GasPool uint64

GasPool tracks the amount of gasRemained available during execution of the transactions in a block. The zero value is a pool with zero gasRemained available.

func (*GasPool) AddGas

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

AddGas makes gasRemained available for execution.

func (*GasPool) Gas

func (gp *GasPool) Gas() uint64

Gas returns the amount of gasRemained 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 gasRemained is available and returns an error otherwise.