network

Documentation

Index

• Variables
• type Atomic
  • func NewAtomic(h common.AppHandler) Atomic
• type Config
• type LockedTxVerifier
  • func NewLockedTxVerifier(lock sync.Locker, txVerifier TxVerifier) *LockedTxVerifier
  • func (l *LockedTxVerifier) VerifyTx(tx *txs.Tx) error
• type Network
  • func New(ctx *snow.Context, parser txs.Parser, txVerifier TxVerifier, ...) (*Network, error)
  • func (n *Network) AppGossip(ctx context.Context, nodeID ids.NodeID, msgBytes []byte) error
  • func (n *Network) IssueTxFromRPC(tx *txs.Tx) error
  • func (n *Network) IssueTxFromRPCWithoutVerification(tx *txs.Tx) error
  • func (n *Network) PullGossip(ctx context.Context)
  • func (n *Network) PushGossip(ctx context.Context)
• type TxVerifier

Variables

var DefaultConfig = Config{
	MaxValidatorSetStaleness:                    time.Minute,
	TargetGossipSize:                            20 * units.KiB,
	PushGossipNumValidators:                     100,
	PushGossipNumPeers:                          0,
	PushRegossipNumValidators:                   10,
	PushRegossipNumPeers:                        0,
	PushGossipDiscardedCacheSize:                16384,
	PushGossipMaxRegossipFrequency:              30 * time.Second,
	PushGossipFrequency:                         500 * time.Millisecond,
	PullGossipPollSize:                          1,
	PullGossipFrequency:                         1500 * time.Millisecond,
	PullGossipThrottlingPeriod:                  10 * time.Second,
	PullGossipThrottlingLimit:                   2,
	ExpectedBloomFilterElements:                 8 * 1024,
	ExpectedBloomFilterFalsePositiveProbability: .01,
	MaxBloomFilterFalsePositiveProbability:      .05,
}

Types

type Atomic

type Atomic interface {
	common.AppHandler

	Set(common.AppHandler)
}

func NewAtomic

func NewAtomic(h common.AppHandler) Atomic

type Config

type Config struct {
	// MaxValidatorSetStaleness limits how old of a validator set the network
	// will use for peer sampling and rate limiting.
	MaxValidatorSetStaleness time.Duration `json:"max-validator-set-staleness"`
	// TargetGossipSize is the number of bytes that will be attempted to be
	// sent when pushing transactions and when responded to transaction pull
	// requests.
	TargetGossipSize int `json:"target-gossip-size"`
	// PushGossipNumValidators is the number of validators to push transactions
	// to in the first round of gossip.
	PushGossipNumValidators int `json:"push-gossip-num-validators"`
	// PushGossipNumPeers is the number of peers to push transactions to in the
	// first round of gossip.
	PushGossipNumPeers int `json:"push-gossip-num-peers"`
	// PushRegossipNumValidators is the number of validators to push
	// transactions to after the first round of gossip.
	PushRegossipNumValidators int `json:"push-regossip-num-validators"`
	// PushRegossipNumPeers is the number of peers to push transactions to after
	// the first round of gossip.
	PushRegossipNumPeers int `json:"push-regossip-num-peers"`
	// PushGossipDiscardedCacheSize is the number of txIDs to cache to avoid
	// pushing transactions that were recently dropped from the mempool.
	PushGossipDiscardedCacheSize int `json:"push-gossip-discarded-cache-size"`
	// PushGossipMaxRegossipFrequency is the limit for how frequently a
	// transaction will be push gossiped.
	PushGossipMaxRegossipFrequency time.Duration `json:"push-gossip-max-regossip-frequency"`
	// PushGossipFrequency is how frequently rounds of push gossip are
	// performed.
	PushGossipFrequency time.Duration `json:"push-gossip-frequency"`
	// PullGossipPollSize is the number of validators to sample when performing
	// a round of pull gossip.
	PullGossipPollSize int `json:"pull-gossip-poll-size"`
	// PullGossipFrequency is how frequently rounds of pull gossip are
	// performed.
	PullGossipFrequency time.Duration `json:"pull-gossip-frequency"`
	// PullGossipThrottlingPeriod is how large of a window the throttler should
	// use.
	PullGossipThrottlingPeriod time.Duration `json:"pull-gossip-throttling-period"`
	// PullGossipThrottlingLimit is the number of pull querys that are allowed
	// by a validator in every throttling window.
	PullGossipThrottlingLimit int `json:"pull-gossip-throttling-limit"`
	// ExpectedBloomFilterElements is the number of elements to expect when
	// creating a new bloom filter. The larger this number is, the larger the
	// bloom filter will be.
	ExpectedBloomFilterElements int `json:"expected-bloom-filter-elements"`
	// ExpectedBloomFilterFalsePositiveProbability is the expected probability
	// of a false positive after having inserted ExpectedBloomFilterElements
	// into a bloom filter. The smaller this number is, the larger the bloom
	// filter will be.
	ExpectedBloomFilterFalsePositiveProbability float64 `json:"expected-bloom-filter-false-positive-probability"`
	// MaxBloomFilterFalsePositiveProbability is used to determine when the
	// bloom filter should be refreshed. Once the expected probability of a
	// false positive exceeds this value, the bloom filter will be regenerated.
	// The smaller this number is, the more frequently that the bloom filter
	// will be regenerated.
	MaxBloomFilterFalsePositiveProbability float64 `json:"max-bloom-filter-false-positive-probability"`
}

type LockedTxVerifier

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

func NewLockedTxVerifier

func NewLockedTxVerifier(lock sync.Locker, txVerifier TxVerifier) *LockedTxVerifier

func (*LockedTxVerifier) VerifyTx

func (l *LockedTxVerifier) VerifyTx(tx *txs.Tx) error

type Network

type Network struct {
	*p2p.Network
	// contains filtered or unexported fields
}

func New

func New(
	ctx *snow.Context,
	parser txs.Parser,
	txVerifier TxVerifier,
	mempool mempool.Mempool,
	appSender common.AppSender,
	registerer prometheus.Registerer,
	config Config,
) (*Network, error)

func (*Network) AppGossip

func (n *Network) AppGossip(ctx context.Context, nodeID ids.NodeID, msgBytes []byte) error

func (*Network) IssueTxFromRPC

func (n *Network) IssueTxFromRPC(tx *txs.Tx) error

IssueTxFromRPC attempts to add a tx to the mempool, after verifying it. If the tx is added to the mempool, it will attempt to push gossip the tx to random peers in the network.

If the tx is already in the mempool, mempool.ErrDuplicateTx will be returned. If the tx is not added to the mempool, an error will be returned.

func (*Network) IssueTxFromRPCWithoutVerification

func (n *Network) IssueTxFromRPCWithoutVerification(tx *txs.Tx) error

IssueTxFromRPCWithoutVerification attempts to add a tx to the mempool, without first verifying it. If the tx is added to the mempool, it will attempt to push gossip the tx to random peers in the network.

If the tx is already in the mempool, mempool.ErrDuplicateTx will be returned. If the tx is not added to the mempool, an error will be returned.

func (*Network) PullGossip

func (n *Network) PullGossip(ctx context.Context)

func (*Network) PushGossip

func (n *Network) PushGossip(ctx context.Context)

type TxVerifier

type TxVerifier interface {
	// VerifyTx verifies that the transaction should be issued into the mempool.
	VerifyTx(tx *txs.Tx) error
}