testcontainers

Documentation

Overview

Package testcontainers provides implementations of the privatebtc.NodeService and privatebtc.NodeHandler interfaces the using the https://github.com/testcontainers/testcontainers-go package.

Index

• type NodeHandler
  • func (c NodeHandler) Close() error
  • func (c NodeHandler) HostRPCPort() string
  • func (c NodeHandler) InternalIP() string
  • func (c NodeHandler) Name() string
• type NodeService
  • func (s *NodeService) CreateNodes(ctx context.Context, nodeRequests []privatebtc.CreateNodeRequest) ([]privatebtc.NodeHandler, error)

Types

type NodeHandler

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

NodeHandler represents a bitcoin node running in a docker container.

func (NodeHandler) Close

func (c NodeHandler) Close() error

Close terminates the container.

func (NodeHandler) HostRPCPort

func (c NodeHandler) HostRPCPort() string

HostRPCPort returns the host RPC port of the container.

func (NodeHandler) InternalIP

func (c NodeHandler) InternalIP() string

InternalIP returns the IP address of the container.

func (NodeHandler) Name

func (c NodeHandler) Name() string

Name returns the container name.

type NodeService

type NodeService struct {
	SlogHandler slog.Handler
	// contains filtered or unexported fields
}

NodeService is a testcontainers implementation of go-privatebtc.NodeService. It is used to create containers.

func (*NodeService) CreateNodes

func (s *NodeService) CreateNodes(
	ctx context.Context,
	nodeRequests []privatebtc.CreateNodeRequest,
) ([]privatebtc.NodeHandler, error)

CreateNodes creates bitcoin node containers in parallel.