swamp

Documentation

Index

• Constants
• func DefaultConfig() *testnode.Config
• func FillBlocks(ctx context.Context, cctx testnode.Context, accounts []string, ...) chan error
• type Option
  • func WithBlockTime(t time.Duration) Option
• type Swamp
  • func NewSwamp(t *testing.T, options ...Option) *Swamp
  • func (s *Swamp) Connect(t *testing.T, peerA, peerB *nodebuilder.Node)
  • func (s *Swamp) DefaultTestConfig(tp node.Type) *nodebuilder.Config
  • func (s *Swamp) Disconnect(t *testing.T, peerA, peerB *nodebuilder.Node)
  • func (s *Swamp) GetCoreBlockHashByHeight(ctx context.Context, height int64) libhead.Hash
  • func (s *Swamp) MustNewNodeWithStore(tp node.Type, store nodebuilder.Store, options ...fx.Option) *nodebuilder.Node
  • func (s *Swamp) NewBridgeNode(options ...fx.Option) *nodebuilder.Node
  • func (s *Swamp) NewFullNode(options ...fx.Option) *nodebuilder.Node
  • func (s *Swamp) NewLightNode(options ...fx.Option) *nodebuilder.Node
  • func (s *Swamp) NewNodeWithConfig(nodeType node.Type, cfg *nodebuilder.Config, options ...fx.Option) *nodebuilder.Node
  • func (s *Swamp) NewNodeWithStore(tp node.Type, store nodebuilder.Store, options ...fx.Option) (*nodebuilder.Node, error)
  • func (s *Swamp) SetBootstrapper(t *testing.T, bootstrappers ...*nodebuilder.Node)
  • func (s *Swamp) StopNode(ctx context.Context, nd *nodebuilder.Node)
  • func (s *Swamp) Validators(t *testing.T) (*types.ValidatorSet, types.PrivValidator)
  • func (s *Swamp) WaitTillHeight(ctx context.Context, height int64) libhead.Hash

Constants

const DefaultTestTimeout = time.Minute * 5

DefaultTestTimeout should be used as the default timeout on all the Swamp tests. It's generously set to 5 minutes to give enough time for CI.

Functions

func DefaultConfig

func DefaultConfig() *testnode.Config

DefaultConfig creates a celestia-app instance with a block time of around 100ms

func FillBlocks

func FillBlocks(ctx context.Context, cctx testnode.Context, accounts []string, bsize, blocks int) chan error

FillBlocks produces the given amount of contiguous blocks with customizable size. The returned channel reports when the process is finished.

Types

type Option

type Option func(*testnode.Config)

Option for modifying Swamp's Config.

func WithBlockTime

func WithBlockTime(t time.Duration) Option

WithBlockTime sets a custom interval for block creation.

type Swamp

type Swamp struct {
	Network       mocknet.Mocknet
	Bootstrappers []ma.Multiaddr

	ClientContext testnode.Context
	Accounts      []string
	// contains filtered or unexported fields
}

Swamp represents the main functionality that is needed for the test-case: - Network to link the nodes - CoreClient to share between Bridge nodes - Slices of created Bridge/Full/Light Nodes - trustedHash taken from the CoreClient and shared between nodes

func NewSwamp

func NewSwamp(t *testing.T, options ...Option) *Swamp

NewSwamp creates a new instance of Swamp.

func (*Swamp) Connect

func (s *Swamp) Connect(t *testing.T, peerA, peerB *nodebuilder.Node)

Connect allows to connect peers after hard disconnection.

func (*Swamp) DefaultTestConfig

func (s *Swamp) DefaultTestConfig(tp node.Type) *nodebuilder.Config

DefaultTestConfig creates a test config with the access to the core node for the tp

func (*Swamp) Disconnect

func (s *Swamp) Disconnect(t *testing.T, peerA, peerB *nodebuilder.Node)

Disconnect allows to break a connection between two peers without any possibility to re-establish it. Order is very important here. We have to unlink peers first, and only after that call disconnect. This is hard disconnect and peers will not be able to reconnect. In order to reconnect peers again, please use swamp.Connect

func (*Swamp) GetCoreBlockHashByHeight

func (s *Swamp) GetCoreBlockHashByHeight(ctx context.Context, height int64) libhead.Hash

GetCoreBlockHashByHeight returns a tendermint block's hash by provided height

func (*Swamp) MustNewNodeWithStore

func (s *Swamp) MustNewNodeWithStore(
	tp node.Type,
	store nodebuilder.Store,
	options ...fx.Option,
) *nodebuilder.Node

MustNewNodeWithStore creates a new instance of Node with predefined Store.

func (*Swamp) NewBridgeNode

func (s *Swamp) NewBridgeNode(options ...fx.Option) *nodebuilder.Node

NewBridgeNode creates a new instance of a BridgeNode providing a default config and a mockstore to the MustNewNodeWithStore method

func (*Swamp) NewFullNode

func (s *Swamp) NewFullNode(options ...fx.Option) *nodebuilder.Node

NewFullNode creates a new instance of a FullNode providing a default config and a mockstore to the MustNewNodeWithStore method

func (*Swamp) NewLightNode

func (s *Swamp) NewLightNode(options ...fx.Option) *nodebuilder.Node

NewLightNode creates a new instance of a LightNode providing a default config and a mockstore to the MustNewNodeWithStore method

func (*Swamp) NewNodeWithConfig

func (s *Swamp) NewNodeWithConfig(nodeType node.Type, cfg *nodebuilder.Config, options ...fx.Option) *nodebuilder.Node

func (*Swamp) NewNodeWithStore

func (s *Swamp) NewNodeWithStore(
	tp node.Type,
	store nodebuilder.Store,
	options ...fx.Option,
) (*nodebuilder.Node, error)

NewNodeWithStore creates a new instance of Node with predefined Store.

func (*Swamp) SetBootstrapper

func (s *Swamp) SetBootstrapper(t *testing.T, bootstrappers ...*nodebuilder.Node)

SetBootstrapper sets the given bootstrappers as the "bootstrappers" for the Swamp test suite. Every new full or light node created on the suite afterwards will automatically add the suite's bootstrappers as trusted peers to their config. NOTE: Bridge nodes do not automatically add the bootstrappers as trusted peers. NOTE: Use `MustNewNodeWithStore` to avoid this automatic configuration.

func (*Swamp) StopNode

func (s *Swamp) StopNode(ctx context.Context, nd *nodebuilder.Node)

StopNode stops the node and removes from Swamp. TODO(@Wondertan): For clean and symmetrical API, we may want to add StartNode.

func (*Swamp) Validators

func (s *Swamp) Validators(t *testing.T) (*types.ValidatorSet, types.PrivValidator)

Validators retrieves keys from the app node in order to build the validators.

func (*Swamp) WaitTillHeight

func (s *Swamp) WaitTillHeight(ctx context.Context, height int64) libhead.Hash

WaitTillHeight holds the test execution until the given amount of blocks has been produced by the CoreClient.