mock

README

What is this?

This is a helper library by entropy that hopes to imitate some of the functionality of polar for continuous integration. Right now this supports creating btcd and lnd nodes and funding them. Channel support is planned soon. You can check out an example in lnd_test. This also supports mocking bolt11 invoices

Note:

This library was open sourced as a dependency for another project. While this is functional, documentation may be lacking for a bit.

Documentation

Overview

utilities for mocking lightning interactions within docker

Index

• Constants
• Variables
• func MockLndInvoiceMain(t *testing.T) (encoded string, decoded *zpay32.Invoice)
• type LightningMocker
  • func NewLightningMocker() LightningMocker
  • func (c LightningMocker) CreateBtcdContainer() (id string, err error)
  • func (c LightningMocker) CreateLndContainer(name string) (id string, err error)
  • func (c LightningMocker) CreateVolumes() error
  • func (c LightningMocker) RecreateBtcdContainerMining(containerId string, miningAddress string) (id string, err error)
  • func (c LightningMocker) Teardown() error

Constants

const MiningAddressName = "MINING_ADDRESS"

Variables

var EnvArgs = []string{
	"RPCUSER",
	"RPCPASS",
	"NETWORK=simnet",
	"DEBUG",
}

var HostnameCmd = []string{"hostname", "-i"}

var Volumes = []string{"shared", "bitcoin", "lnd"}

Functions

func MockLndInvoiceMain

func MockLndInvoiceMain(t *testing.T) (encoded string, decoded *zpay32.Invoice)

create a mock lnd invoice on mainnet

Types

type LightningMocker

type LightningMocker struct {
	docker.Client
}

func NewLightningMocker

func NewLightningMocker() LightningMocker

func (LightningMocker) CreateBtcdContainer

func (c LightningMocker) CreateBtcdContainer() (id string, err error)

func (LightningMocker) CreateLndContainer

func (c LightningMocker) CreateLndContainer(name string) (id string, err error)

func (LightningMocker) CreateVolumes

func (c LightningMocker) CreateVolumes() error

idempotently create volumes

func (LightningMocker) RecreateBtcdContainerMining

func (c LightningMocker) RecreateBtcdContainerMining(containerId string, miningAddress string) (id string, err error)

recreate the btcd container with the correct mining address TODO reduce redundant code here

func (LightningMocker) Teardown

func (c LightningMocker) Teardown() error