gasprice

Documentation

Index

• Variables
• func DefaultFn(config *params.ChainConfig) func(*big.Int) *big.Int
• type Config
• type Oracle
  • func NewOracle(backend OracleBackend, params Config) *Oracle
  • func (gpo *Oracle) SuggestPrice(ctx context.Context) (*big.Int, error)
• type OracleBackend

Variables

var (
	// Deprecated: use DefaultFn
	Default         = new(big.Int).SetUint64(2 * params.Shannon)
	DefaultMaxPrice = big.NewInt(500000 * params.Shannon)
)

Functions

func DefaultFn

func DefaultFn(config *params.ChainConfig) func(*big.Int) *big.Int

DefaultFn returns a function to return the default gas price at a given block.

Types

type Config

type Config struct {
	Blocks     int
	Percentile int
	Default    *big.Int `toml:",omitempty"` // nil for default/dynamic
	MaxPrice   *big.Int `toml:",omitempty"`
}

type Oracle

type Oracle struct {
	// contains filtered or unexported fields
}

Oracle recommends gas prices based on the content of recent blocks. Suitable for both light and full clients.

func NewOracle

func NewOracle(backend OracleBackend, params Config) *Oracle

NewOracle returns a new gasprice oracle which can recommend suitable gasprice for newly created transaction.

func (*Oracle) SuggestPrice

func (gpo *Oracle) SuggestPrice(ctx context.Context) (*big.Int, error)

SuggestPrice returns a gasprice so that newly created transaction can have a very high chance to be included in the following blocks.

type OracleBackend

type OracleBackend interface {
	HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
	BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
	ChainConfig() *params.ChainConfig
}

OracleBackend includes all necessary background APIs for oracle.