messagepool

package
v0.9.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2021 License: Apache-2.0, MIT Imports: 44 Imported by: 1

Documentation

Index

Constants

View Source
const MaxBlocks = 15
View Source
const MinGasPremium = 100e3
View Source
const RbfDenom = 256

Variables

View Source
var (
	ReplaceByFeeRatioDefault  = 1.25
	MemPoolSizeLimitHiDefault = 30000
	MemPoolSizeLimitLoDefault = 20000
	PruneCooldownDefault      = time.Minute
	GasLimitOverestimation    = 1.25

	ConfigKey = datastore.NewKey("/mpool/config")
)
View Source
var (
	ErrMessageTooBig = errors.New("message too big")

	ErrMessageValueTooHigh = errors.New("cannot send more filecoin than will ever exist")

	ErrNonceTooLow = errors.New("message nonce too low")

	ErrGasFeeCapTooLow = errors.New("gas fee cap too low")

	ErrNotEnoughFunds = errors.New("not enough funds to execute transaction")

	ErrInvalidToAddr = errors.New("message had invalid to address")

	ErrSoftValidationFailure  = errors.New("validation failure")
	ErrRBFTooLowPremium       = errors.New("replace by fee has too low GasPremium")
	ErrTooManyPendingMessages = errors.New("too many pending messages for actor")
	ErrNonceGap               = errors.New("unfulfilled nonce gap")
)
View Source
var (
	HeadChangeCoalesceMinDelay      = 2 * time.Second
	HeadChangeCoalesceMaxDelay      = 6 * time.Second
	HeadChangeCoalesceMergeInterval = time.Second
)
View Source
var MaxActorPendingMessages = 1000
View Source
var MaxBlockMessages = 16000
View Source
var MaxNonceGap = uint64(4)
View Source
var MaxUntrustedActorPendingMessages = 10
View Source
var RepublishBatchDelay = 100 * time.Millisecond

Functions

func CapGasFee

func CapGasFee(mff DefaultMaxFeeFunc, msg *types.Message, sendSepc *types.MessageSendSpec)

func ComputeMinRBF

func ComputeMinRBF(curPrem abi.TokenAmount) abi.TokenAmount

Types

type DefaultMaxFeeFunc

type DefaultMaxFeeFunc func() (abi.TokenAmount, error)

type MessagePool

type MessagePool struct {
	GetMaxFee DefaultMaxFeeFunc
	// contains filtered or unexported fields
}

func New

func New(api Provider,
	ds repo.Datastore,
	forkParams *config.ForkUpgradeConfig,
	netName string,
	gp gasPredictor,
	ap actorProvider,
	j journal.Journal,
) (*MessagePool, error)

func (*MessagePool) Add

func (mp *MessagePool) Add(m *types.SignedMessage) error

func (*MessagePool) Clear

func (mp *MessagePool) Clear(local bool)

func (*MessagePool) Close

func (mp *MessagePool) Close() error

func (*MessagePool) DeleteByAdress

func (mp *MessagePool) DeleteByAdress(address address.Address) error

func (*MessagePool) GasEstimateFeeCap

func (mp *MessagePool) GasEstimateFeeCap(
	ctx context.Context,
	msg *types.UnsignedMessage,
	maxqueueblks int64,
	tsk types.TipSetKey,
) (tbig.Int, error)

func (*MessagePool) GasEstimateGasLimit

func (mp *MessagePool) GasEstimateGasLimit(ctx context.Context, msgIn *types.UnsignedMessage, tsk types.TipSetKey) (int64, error)

func (*MessagePool) GasEstimateGasPremium

func (mp *MessagePool) GasEstimateGasPremium(
	ctx context.Context,
	nblocksincl uint64,
	sender address.Address,
	gaslimit int64,
	_ types.TipSetKey,
) (tbig.Int, error)

func (*MessagePool) GasEstimateMessageGas

func (mp *MessagePool) GasEstimateMessageGas(ctx context.Context, msg *types.Message, spec *types.MessageSendSpec, _ types.TipSetKey) (*types.Message, error)

func (*MessagePool) GetConfig

func (mp *MessagePool) GetConfig() *MpoolConfig

func (*MessagePool) GetNonce

func (mp *MessagePool) GetNonce(addr address.Address) (uint64, error)

func (*MessagePool) HeadChange

func (mp *MessagePool) HeadChange(revert []*types.TipSet, apply []*types.TipSet) error

func (*MessagePool) MessagesForBlocks

func (mp *MessagePool) MessagesForBlocks(blks []*types.BlockHeader) ([]*types.SignedMessage, error)

func (*MessagePool) MultipleSelectMessages added in v0.9.4

func (mp *MessagePool) MultipleSelectMessages(ts *types.TipSet, tqs []float64) (msgss [][]*types.SignedMessage, err error)

select the message multiple times and try not to repeat it each time

func (*MessagePool) Pending

func (mp *MessagePool) Pending() ([]*types.SignedMessage, *types.TipSet)

func (*MessagePool) PendingFor

func (mp *MessagePool) PendingFor(a address.Address) ([]*types.SignedMessage, *types.TipSet)

func (*MessagePool) Prune

func (mp *MessagePool) Prune()

func (*MessagePool) PublishMsgForWallet

func (mp *MessagePool) PublishMsgForWallet(addr address.Address) error

func (*MessagePool) Push

func (mp *MessagePool) Push(m *types.SignedMessage) (cid.Cid, error)

func (*MessagePool) PushUntrusted

func (mp *MessagePool) PushUntrusted(m *types.SignedMessage) (cid.Cid, error)

this method is provided for the gateway to push messages. differences from Push:

  • strict checks are enabled
  • extra strict add checks are used when adding the messages to the msgSet that means: no nonce gaps, at most 10 pending messages for the actor

func (*MessagePool) RecoverSig

func (mp *MessagePool) RecoverSig(msg *types.UnsignedMessage) *types.SignedMessage

func (*MessagePool) Remove

func (mp *MessagePool) Remove(from address.Address, nonce uint64, applied bool)

func (*MessagePool) SelectMessages

func (mp *MessagePool) SelectMessages(ts *types.TipSet, tq float64) (msgs []*types.SignedMessage, err error)

func (*MessagePool) SetConfig

func (mp *MessagePool) SetConfig(cfg *MpoolConfig) error

func (*MessagePool) Updates

func (mp *MessagePool) Updates(ctx context.Context) (<-chan MpoolUpdate, error)

func (*MessagePool) VerifyMsgSig

func (mp *MessagePool) VerifyMsgSig(m *types.SignedMessage) error

type MessagePoolEvt

type MessagePoolEvt struct {
	Action   string
	Messages []MessagePoolEvtMessage
	Error    error `json:",omitempty"`
}

MessagePoolEvt is the journal entry for message pool events.

type MessagePoolEvtMessage

type MessagePoolEvtMessage struct {
	types.UnsignedMessage

	CID cid.Cid
}

type MpoolChange

type MpoolChange int
const (
	MpoolAdd MpoolChange = iota
	MpoolRemove
)

type MpoolConfig

type MpoolConfig struct {
	PriorityAddrs          []address.Address
	SizeLimitHigh          int
	SizeLimitLow           int
	ReplaceByFeeRatio      float64
	PruneCooldown          time.Duration
	GasLimitOverestimation float64
}

func DefaultConfig

func DefaultConfig() *MpoolConfig

func (*MpoolConfig) Clone

func (mc *MpoolConfig) Clone() *MpoolConfig

type MpoolLocker

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

func NewMpoolLocker

func NewMpoolLocker() *MpoolLocker

func (*MpoolLocker) TakeLock

func (ml *MpoolLocker) TakeLock(ctx context.Context, a address.Address) (func(), error)

type MpoolUpdate

type MpoolUpdate struct {
	Type    MpoolChange
	Message *types.SignedMessage
}

type Provider

type Provider interface {
	ChainHead() (*types.TipSet, error)
	ChainTipSet(types.TipSetKey) (*types.TipSet, error)
	SubscribeHeadChanges(func(rev, app []*types.TipSet) error) *types.TipSet
	PutMessage(m types.ChainMsg) (cid.Cid, error)
	PubSubPublish(string, []byte) error
	GetActorAfter(address.Address, *types.TipSet) (*types.Actor, error)
	StateAccountKey(context.Context, address.Address, *types.TipSet) (address.Address, error)
	MessagesForBlock(block2 *types.BlockHeader) ([]*types.UnsignedMessage, []*types.SignedMessage, error)
	MessagesForTipset(*types.TipSet) ([]types.ChainMsg, error)
	LoadTipSet(tsk types.TipSetKey) (*types.TipSet, error)
	ChainComputeBaseFee(ctx context.Context, ts *types.TipSet) (tbig.Int, error)
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL