itest

package
v0.6.7-alpha Latest Latest
Warning

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

 Go to latest Published: Apr 21, 2022 License: MIT Imports: 51 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// DefaultAutogenValidity is the default validity of a self-signed
	// certificate. The value corresponds to 14 months
	// (14 months * 30 days * 24 hours).
	DefaultAutogenValidity = 14 * 30 * 24 * time.Hour
)

Variables

This section is empty.

Functions

func CheckChannelPolicy 

func CheckChannelPolicy(policy, expectedPolicy *lnrpc.RoutingPolicy) error

CheckChannelPolicy checks that the policy matches the expected one.

func CopyFile 

func CopyFile(dest, src string) error

CopyFile copies the file src to dest.

func MakeOutpoint 

func MakeOutpoint(chanPoint *lnrpc.ChannelPoint) (wire.OutPoint, error)

MakeOutpoint returns the outpoint of the channel's funding transaction.

Types

type HarnessNode 

type HarnessNode struct {
	Cfg *LitNodeConfig

	// NodeID is a unique identifier for the node within a NetworkHarness.
	NodeID int

	RemoteLnd        *lntest.HarnessNode
	RemoteLndHarness *lntest.NetworkHarness

	// PubKey is the serialized compressed identity public key of the node.
	// This field will only be populated once the node itself has been
	// started via the start() method.
	PubKey    [33]byte
	PubKeyStr string

	lnrpc.LightningClient

	lnrpc.WalletUnlockerClient

	invoicesrpc.InvoicesClient

	// SignerClient cannot be embedded because the name collisions of the
	// methods SignMessage and VerifyMessage.
	SignerClient signrpc.SignerClient

	// RouterClient, WalletKitClient, WatchtowerClient cannot be embedded,
	// because a name collision would occur with LightningClient.
	RouterClient     routerrpc.RouterClient
	WalletKitClient  walletrpc.WalletKitClient
	Watchtower       watchtowerrpc.WatchtowerClient
	WatchtowerClient wtclientrpc.WatchtowerClientClient
	StateClient      lnrpc.StateClient
	// contains filtered or unexported fields
}

HarnessNode represents an instance of lnd running within our test network harness. Each HarnessNode instance also fully embeds an RPC client in order to pragmatically drive the node.

func (*HarnessNode) AddToLog 

func (hn *HarnessNode) AddToLog(format string, a ...interface{})

AddToLog adds a line of choice to the node's logfile. This is useful to interleave test output with output from the node.

func (*HarnessNode) AdminMacPath 

func (hn *HarnessNode) AdminMacPath() string

AdminMacPath returns the filepath to the admin.macaroon file for this node.

func (*HarnessNode) ChanBackupPath 

func (hn *HarnessNode) ChanBackupPath() string

ChanBackupPath returns the fielpath to the on-disk channel.backup file for this node.

func (*HarnessNode) ConnectRPC 

func (hn *HarnessNode) ConnectRPC(useMacs bool) (*grpc.ClientConn, error)

ConnectRPC uses the TLS certificate and admin macaroon files written by the lnd node to create a gRPC client connection.

func (*HarnessNode) ConnectRPCWithMacaroon 

func (hn *HarnessNode) ConnectRPCWithMacaroon(mac *macaroon.Macaroon) (
	*grpc.ClientConn, error)

ConnectRPCWithMacaroon uses the TLS certificate and given macaroon to create a gRPC client connection.

func (*HarnessNode) DBDir 

func (hn *HarnessNode) DBDir() string

DBDir returns the path for the directory holding channeldb file(s).

func (*HarnessNode) DBPath 

func (hn *HarnessNode) DBPath() string

DBPath returns the filepath to the channeldb database file for this node.

func (*HarnessNode) FetchNodeInfo 

func (hn *HarnessNode) FetchNodeInfo() error

FetchNodeInfo queries an unlocked node to retrieve its public key.

func (*HarnessNode) Init 

func (hn *HarnessNode) Init(ctx context.Context,
	initReq *lnrpc.InitWalletRequest) (*lnrpc.InitWalletResponse, error)

Init initializes a harness node by passing the init request via rpc. After the request is submitted, this method will block until a macaroon-authenticated RPC connection can be established to the harness node. Once established, the new connection is used to initialize the LightningClient and subscribes the HarnessNode to topology changes.

func (*HarnessNode) InitChangePassword 

func (hn *HarnessNode) InitChangePassword(ctx context.Context,
	chngPwReq *lnrpc.ChangePasswordRequest) (*lnrpc.ChangePasswordResponse,
	error)

InitChangePassword initializes a harness node by passing the change password request via RPC. After the request is submitted, this method will block until a macaroon-authenticated RPC connection can be established to the harness node. Once established, the new connection is used to initialize the LightningClient and subscribes the HarnessNode to topology changes.

func (*HarnessNode) InvoiceMacPath 

func (hn *HarnessNode) InvoiceMacPath() string

InvoiceMacPath returns the filepath to the invoice.macaroon file for this node.

func (*HarnessNode) Name 

func (hn *HarnessNode) Name() string

Name returns the name of this node set during initialization.

func (*HarnessNode) PrintErr 

func (hn *HarnessNode) PrintErr(format string, a ...interface{})

PrintErr prints an error to the console.

func (*HarnessNode) ReadMacPath 

func (hn *HarnessNode) ReadMacPath() string

ReadMacPath returns the filepath to the readonly.macaroon file for this node.

func (*HarnessNode) ReadMacaroon 

func (hn *HarnessNode) ReadMacaroon(macPath string, timeout time.Duration) (
	*macaroon.Macaroon, error)

ReadMacaroon waits a given duration for the macaroon file to be created. If the file is readable within the timeout, its content is de-serialized as a macaroon and returned.

func (*HarnessNode) SetExtraArgs 

func (hn *HarnessNode) SetExtraArgs(extraArgs []string)

SetExtraArgs assigns the ExtraArgs field for the node's configuration. The changes will take effect on restart.

func (*HarnessNode) String 

func (hn *HarnessNode) String() string

String gives the internal state of the node which is useful for debugging.

func (*HarnessNode) TLSCertStr 

func (hn *HarnessNode) TLSCertStr() string

TLSCertStr returns the path where the TLS certificate is stored.

func (*HarnessNode) TLSKeyStr 

func (hn *HarnessNode) TLSKeyStr() string

TLSKeyStr returns the path where the TLS key is stored.

func (*HarnessNode) Unlock 

func (hn *HarnessNode) Unlock(ctx context.Context,
	unlockReq *lnrpc.UnlockWalletRequest) error

Unlock attempts to unlock the wallet of the target HarnessNode. This method should be called after the restart of a HarnessNode that was created with a seed+password. Once this method returns, the HarnessNode will be ready to accept normal gRPC requests and harness command.

func (*HarnessNode) WaitForBalance 

func (hn *HarnessNode) WaitForBalance(expectedBalance btcutil.Amount, confirmed bool) error

WaitForBalance waits until the node sees the expected confirmed/unconfirmed balance within their wallet.

func (*HarnessNode) WaitForBlockchainSync 

func (hn *HarnessNode) WaitForBlockchainSync(ctx context.Context) error

WaitForBlockchainSync waits for the target node to be fully synchronized with the blockchain. If the passed context object has a set timeout, it will continually poll until the timeout has elapsed. In the case that the chain isn't synced before the timeout is up, this function will return an error.

func (*HarnessNode) WaitForChannelPolicyUpdate 

func (hn *HarnessNode) WaitForChannelPolicyUpdate(ctx context.Context,
	advertisingNode string, policy *lnrpc.RoutingPolicy,
	chanPoint *lnrpc.ChannelPoint, includeUnannounced bool) error

WaitForChannelPolicyUpdate will block until a channel policy with the target outpoint and advertisingNode is seen within the network.

func (*HarnessNode) WaitForNetworkChannelClose 

func (hn *HarnessNode) WaitForNetworkChannelClose(ctx context.Context,
	chanPoint *lnrpc.ChannelPoint) error

WaitForNetworkChannelClose will block until a channel with the target outpoint is seen as closed within the network. A channel is considered closed once a transaction spending the funding outpoint is seen within a confirmed block.

func (*HarnessNode) WaitForNetworkChannelOpen 

func (hn *HarnessNode) WaitForNetworkChannelOpen(ctx context.Context,
	chanPoint *lnrpc.ChannelPoint) error

WaitForNetworkChannelOpen will block until a channel with the target outpoint is seen as being fully advertised within the network. A channel is considered "fully advertised" once both of its directional edges has been advertised within the test Lightning Network.

func (*HarnessNode) WaitUntilStarted 

func (hn *HarnessNode) WaitUntilStarted(conn grpc.ClientConnInterface,
	timeout time.Duration) error

WaitUntilStarted waits until the wallet state flips from "WAITING_TO_START".

type LitNodeConfig 

type LitNodeConfig struct {
	*lntest.BaseNodeConfig

	LitArgs []string

	RemoteMode bool

	FaradayMacPath string
	LoopMacPath    string
	PoolMacPath    string
	LitTLSCertPath string

	UIPassword string
	LitDir     string
	FaradayDir string
	LoopDir    string
	PoolDir    string

	LitPort     int
	LitRESTPort int
}

func (*LitNodeConfig) GenArgs 

func (cfg *LitNodeConfig) GenArgs() []string

GenArgs generates a slice of command line arguments from the lightning node config struct.

func (*LitNodeConfig) GenerateListeningPorts 

func (cfg *LitNodeConfig) GenerateListeningPorts()

func (*LitNodeConfig) LitAddr 

func (cfg *LitNodeConfig) LitAddr() string

func (*LitNodeConfig) LitRESTAddr 

func (cfg *LitNodeConfig) LitRESTAddr() string

type NetworkHarness 

type NetworkHarness struct {

	// Miner is a reference to a running full node that can be used to create
	// new blocks on the network.
	Miner *lntest.HarnessMiner

	// BackendCfg houses the information necessary to use a node as LND
	// chain backend, such as rpc configuration, P2P information etc.
	BackendCfg lntest.BackendConfig

	// Alice and Bob are the initial seeder nodes that are automatically
	// created to be the initial participants of the test network.
	Alice *HarnessNode
	Bob   *HarnessNode
	// contains filtered or unexported fields
}

NetworkHarness is an integration testing harness for the lightning network. The harness by default is created with two active nodes on the network: Alice and Bob.

func NewNetworkHarness 

func NewNetworkHarness(m *lntest.HarnessMiner, b lntest.BackendConfig,
	litdBinary string) (*NetworkHarness, error)

NewNetworkHarness creates a new network test harness.

func (*NetworkHarness) AssertChannelExists 

func (n *NetworkHarness) AssertChannelExists(node *HarnessNode,
	chanPoint *wire.OutPoint, checks ...func(*lnrpc.Channel)) error

AssertChannelExists asserts that an active channel identified by the specified channel point exists from the point-of-view of the node. It takes an optional set of check functions which can be used to make further assertions using channel's values. These functions are responsible for failing the test themselves if they do not pass.

func (*NetworkHarness) CloseChannel 

func (n *NetworkHarness) CloseChannel(lnNode *HarnessNode,
	cp *lnrpc.ChannelPoint,
	force bool) (lnrpc.Lightning_CloseChannelClient, *chainhash.Hash, error)

CloseChannel attempts to close the channel indicated by the passed channel point, initiated by the passed lnNode. If the passed context has a timeout, an error is returned if that timeout is reached before the channel close is pending.

func (*NetworkHarness) ConnectNodes 

func (n *NetworkHarness) ConnectNodes(t *testing.T, a, b *HarnessNode)

ConnectNodes attempts to create a connection between nodes a and b.

func (*NetworkHarness) ConnectNodesPerm 

func (n *NetworkHarness) ConnectNodesPerm(t *testing.T,
	a, b *HarnessNode)

ConnectNodesPerm attempts to connect nodes a and b and sets node b as a peer that node a should persistently attempt to reconnect to if they become disconnected.

func (*NetworkHarness) DisconnectNodes 

func (n *NetworkHarness) DisconnectNodes(a, b *HarnessNode) error

DisconnectNodes disconnects node a from node b by sending RPC message from a node to b node

func (*NetworkHarness) DumpLogs 

func (n *NetworkHarness) DumpLogs(node *HarnessNode) (string, error)

DumpLogs reads the current logs generated by the passed node, and returns the logs as a single string. This function is useful for examining the logs of a particular node in the case of a test failure. Logs from lightning node being generated with delay - you should add time.Sleep() in order to get all logs.

func (*NetworkHarness) EnsureConnected 

func (n *NetworkHarness) EnsureConnected(t *testing.T, a, b *HarnessNode)

EnsureConnected will try to connect to two nodes, returning no error if they are already connected. If the nodes were not connected previously, this will behave the same as ConnectNodes. If a pending connection request has already been made, the method will block until the two nodes appear in each other's peers list, or until the 15s timeout expires.

func (*NetworkHarness) KillNode 

func (n *NetworkHarness) KillNode(node *HarnessNode) error

KillNode kills the node (but won't wait for the node process to stop).

func (*NetworkHarness) LookUpNodeByPub 

func (n *NetworkHarness) LookUpNodeByPub(pubStr string) (*HarnessNode, error)

LookUpNodeByPub queries the set of active nodes to locate a node according to its public key. The second value will be true if the node was found, and false otherwise.

func (*NetworkHarness) OpenChannel 

func (n *NetworkHarness) OpenChannel(srcNode, destNode *HarnessNode,
	p OpenChannelParams) (lnrpc.Lightning_OpenChannelClient, error)

OpenChannel attempts to open a channel between srcNode and destNode with the passed channel funding parameters. If the passed context has a timeout, then if the timeout is reached before the channel pending notification is received, an error is returned. The confirmed boolean determines whether we should fund the channel with confirmed outputs or not.

func (*NetworkHarness) OpenPendingChannel 

func (n *NetworkHarness) OpenPendingChannel(srcNode, destNode *HarnessNode,
	amt btcutil.Amount,
	pushAmt btcutil.Amount) (*lnrpc.PendingUpdate, error)

OpenPendingChannel attempts to open a channel between srcNode and destNode with the passed channel funding parameters. If the passed context has a timeout, then if the timeout is reached before the channel pending notification is received, an error is returned.

func (*NetworkHarness) ProcessErrors 

func (n *NetworkHarness) ProcessErrors() <-chan error

ProcessErrors returns a channel used for reporting any fatal process errors. If any of the active nodes within the harness' test network incur a fatal error, that error is sent over this channel.

func (*NetworkHarness) RegisterNode 

func (n *NetworkHarness) RegisterNode(node *HarnessNode)

RegisterNode records a new HarnessNode in the NetworkHarnesses map of known nodes. This method should only be called with nodes that have successfully retrieved their public keys via FetchNodeInfo.

func (*NetworkHarness) RestartNode 

func (n *NetworkHarness) RestartNode(node *HarnessNode, callback func() error,
	chanBackups ...*lnrpc.ChanBackupSnapshot) error

RestartNode attempts to restart a lightning node by shutting it down cleanly, then restarting the process. This function is fully blocking. Upon restart, the RPC connection to the node will be re-attempted, continuing iff the connection attempt is successful. If the callback parameter is non-nil, then the function will be executed after the node shuts down, but *before* the process has been started up again.

This method can be useful when testing edge cases such as a node broadcast and invalidated prior state, or persistent state recovery, simulating node crashes, etc. Additionally, each time the node is restarted, the caller can pass a set of SCBs to pass in via the Unlock method allowing them to restore channels during restart.

func (*NetworkHarness) RestartNodeNoUnlock 

func (n *NetworkHarness) RestartNodeNoUnlock(node *HarnessNode,
	callback func() error, wait bool) error

RestartNodeNoUnlock attempts to restart a lightning node by shutting it down cleanly, then restarting the process. In case the node was setup with a seed, it will be left in the unlocked state. This function is fully blocking. If the callback parameter is non-nil, then the function will be executed after the node shuts down, but *before* the process has been started up again.

func (*NetworkHarness) SendCoins 

func (n *NetworkHarness) SendCoins(t *testing.T, amt btcutil.Amount,
	target *HarnessNode)

SendCoins attempts to send amt satoshis from the internal mining node to the targeted lightning node using a P2WKH address. 6 blocks are mined after in order to confirm the transaction.

func (*NetworkHarness) SendCoinsUnconfirmed 

func (n *NetworkHarness) SendCoinsUnconfirmed(t *testing.T, amt btcutil.Amount,
	target *HarnessNode)

SendCoinsUnconfirmed sends coins from the internal mining node to the target lightning node using a P2WPKH address. No blocks are mined after, so the transaction remains unconfirmed.

func (*NetworkHarness) SetUp 

func (n *NetworkHarness) SetUp(t *testing.T,
	testCase string, lndArgs []string) error

SetUp starts the initial seeder nodes within the test harness. The initial node's wallets will be funded wallets with ten 1 BTC outputs each. Finally rpc clients capable of communicating with the initial seeder nodes are created. Nodes are initialized with the given extra command line flags, which should be formatted properly - "--arg=value".

func (*NetworkHarness) ShutdownNode 

func (n *NetworkHarness) ShutdownNode(node *HarnessNode) error

ShutdownNode stops an active lnd process and returns when the process has exited and any temporary directories have been cleaned up.

func (*NetworkHarness) Stop 

func (n *NetworkHarness) Stop()

Stop stops the test harness.

func (*NetworkHarness) StopNode 

func (n *NetworkHarness) StopNode(node *HarnessNode) error

StopNode stops the target node, but doesn't yet clean up its directories. This can be used to temporarily bring a node down during a test, to be later started up again.

func (*NetworkHarness) SuspendNode 

func (n *NetworkHarness) SuspendNode(node *HarnessNode) (func() error, error)

SuspendNode stops the given node and returns a callback that can be used to start it again.

func (*NetworkHarness) TearDown 

func (n *NetworkHarness) TearDown() error

TearDown tears down all active nodes within the test lightning network.

func (*NetworkHarness) WaitForChannelClose 

func (n *NetworkHarness) WaitForChannelClose(
	closeChanStream lnrpc.Lightning_CloseChannelClient) (*chainhash.Hash, error)

WaitForChannelClose waits for a notification from the passed channel close stream that the node has deemed the channel has been fully closed. If the passed context has a timeout, then if the timeout is reached before the notification is received then an error is returned.

func (*NetworkHarness) WaitForChannelOpen 

func (n *NetworkHarness) WaitForChannelOpen(
	openChanStream lnrpc.Lightning_OpenChannelClient) (*lnrpc.ChannelPoint, error)

WaitForChannelOpen waits for a notification that a channel is open by consuming a message from the past open channel stream. If the passed context has a timeout, then if the timeout is reached before the channel has been opened, then an error is returned.

type OpenChannelParams 

type OpenChannelParams struct {
	// Amt is the local amount being put into the channel.
	Amt btcutil.Amount

	// PushAmt is the amount that should be pushed to the remote when the
	// channel is opened.
	PushAmt btcutil.Amount

	// Private is a boolan indicating whether the opened channel should be
	// private.
	Private bool

	// SpendUnconfirmed is a boolean indicating whether we can utilize
	// unconfirmed outputs to fund the channel.
	SpendUnconfirmed bool

	// MinHtlc is the htlc_minimum_msat value set when opening the channel.
	MinHtlc lnwire.MilliSatoshi

	// RemoteMaxHtlcs is the remote_max_htlcs value set when opening the
	// channel, restricting the number of concurrent HTLCs the remote party
	// can add to a commitment.
	RemoteMaxHtlcs uint16

	// FundingShim is an optional funding shim that the caller can specify
	// in order to modify the channel funding workflow.
	FundingShim *lnrpc.FundingShim

	// SatPerVByte is the amount of satoshis to spend in chain fees per virtual
	// byte of the transaction.
	SatPerVByte btcutil.Amount

	// CommitmentType is the commitment type that should be used for the
	// channel to be opened.
	CommitmentType lnrpc.CommitmentType
}

OpenChannelParams houses the params to specify when opening a new channel.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.