Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nbd-wtf/lnunit

C# Lightning Networking Unit Testing Library
https://github.com/nbd-wtf/lnunit

bitcoin csharp csharp-library lightning lightning-network lnd lnd-node regtest

Last synced: about 1 month ago
JSON representation

C# Lightning Networking Unit Testing Library

Host: GitHub
URL: https://github.com/nbd-wtf/lnunit
Owner: nbd-wtf
License: mit
Created: 2024-03-22T21:49:33.000Z (8 months ago)
Default Branch: master
Last Pushed: 2024-09-23T12:01:22.000Z (about 2 months ago)
Last Synced: 2024-10-12T14:21:37.169Z (about 1 month ago)
Topics: bitcoin, csharp, csharp-library, lightning, lightning-network, lnd, lnd-node, regtest
Language: C#
Homepage:
Size: 481 KB
Stars: 4
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        #  ![Logo](images/AILogo_LNUnit_small.png) LNUnit

--- 

LNUnit is a unit-testing framework for Bitcoin Lightning network systems. It provides an easy-to-use interface for

developers to write tests that check the functionality and performance of their Lightning network applications.

[![Build & Tested](https://github.com/nbd-wtf/LNUnit/actions/workflows/dotnet.yml/badge.svg)](https://github.com/nbd-wtf/LNUnit/actions/workflows/dotnet.yml)

[![Deploy Nuget Package](https://github.com/nbd-wtf/LNUnit/actions/workflows/nuget.yml/badge.svg)](https://github.com/nbd-wtf/LNUnit/actions/workflows/nuget.yml)

| Package   | Version                                                                                                                                     |

|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|

| `LNUnit.LND` | [![NuGet version (LNUnit.LND)](https://img.shields.io/nuget/v/LNUnit.LND.svg?style=flat-square)](https://www.nuget.org/packages/LNUnit.LND) |

| `LNUnit` |   [![NuGet version (LNUnit)](https://img.shields.io/nuget/v/LNUnit.svg?style=flat-square)](https://www.nuget.org/packages/LNUnit)           |

## Features

---

- Support for Bitcoin Lightning network systems (LND more to come)

- Test cases can be written in C#

- Automated test discovery

- Test fixtures for setting up and tearing down test environments

- Integration with NUnit for continuous integration and coverage reporting

- Channel Acceptor

- HTLC Interception

- MIT License

## Notes

---

#### MacOS Users

To run the containerized tests we need to connect directly to the docker containers, but if you're using MacOS you won't be able to, thanks to the way Docker for Mac is implemented.

We're using [Docker Mac Net Connect](https://github.com/chipmk/docker-mac-net-connect) due to it's simplicity. Just run:

```sh

# Install via Homebrew

$ brew install chipmk/tap/docker-mac-net-connect

# Run the service and register it to launch at boot

$ sudo brew services start chipmk/tap/docker-mac-net-connect

```