{"id":16560139,"url":"https://github.com/rustyrussell/lnprototest","last_synced_at":"2025-04-04T22:02:42.306Z","repository":{"id":39581023,"uuid":"271473905","full_name":"rustyrussell/lnprototest","owner":"rustyrussell","description":"Lightning BOLT Protocol Test Framework","archived":false,"fork":false,"pushed_at":"2025-03-11T16:49:27.000Z","size":708,"stargazers_count":65,"open_issues_count":17,"forks_count":23,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-28T21:01:51.965Z","etag":null,"topics":["bitcoin","lightning"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rustyrussell.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-11T06:53:37.000Z","updated_at":"2025-03-18T18:12:27.000Z","dependencies_parsed_at":"2023-02-14T06:45:51.871Z","dependency_job_id":"2cdb4a3a-7ae1-45e0-9394-d264df164208","html_url":"https://github.com/rustyrussell/lnprototest","commit_stats":{"total_commits":297,"total_committers":10,"mean_commits":29.7,"dds":0.6363636363636364,"last_synced_commit":"c9e78d9b9a544f6404918d8d0f7da19c823ea6c2"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyrussell%2Flnprototest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyrussell%2Flnprototest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyrussell%2Flnprototest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyrussell%2Flnprototest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rustyrussell","download_url":"https://codeload.github.com/rustyrussell/lnprototest/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256103,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","lightning"],"created_at":"2024-10-11T20:28:13.210Z","updated_at":"2025-04-04T22:02:42.289Z","avatar_url":"https://github.com/rustyrussell.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003elnprototest\u003c/h1\u003e\n\n  \u003cp\u003e\n    \u003cstrong\u003ea Testsuite for the Lightning Network Protocol\u003c/strong\u003e\n  \u003c/p\u003e\n\n  \u003ch4\u003e\n    \u003ca href=\"https://github.com/rustyrussell/lnprototest\"\u003eProject Homepage\u003c/a\u003e\n  \u003c/h4\u003e\n \n  \u003ca href=\"https://github.com/rustyrussell/lnprototest/actions\"\u003e\n    \u003cimg alt=\"GitHub Workflow Status (branch)\" src=\"https://img.shields.io/github/workflow/status/rustyrussell/lnprototest/Integration%20testing/master?style=flat-square\"/\u003e\n  \u003c/a\u003e\n  \n  \u003ca href=\"https://github.com/vincenzopalazzo/lnprototest/blob/vincenzopalazzo/styles/HACKING.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/doc-hacking-orange?style=flat-square\" /\u003e\n  \u003c/a\u003e\n\n\u003c/div\u003e\n\nlnprototest is a set of test helpers written in Python3, designed to\nmake it easy to write new tests when you propose changes to the\nlightning network protocol, as well as test existing implementations.\n\n## Install requirements\n\nTo install the necessary dependences\n\n```bash\npip3 install poetry\npoetry shell\npoetry install\n```\n\nWell, now we can run the test\n\n## Running test\n\nThe simplest way to run is with the \"dummy\" runner:\n\n\tmake check\n\nHere are some other useful pytest options:\n\n1. `-n8` to run 8-way parallel.\n2. `-x` to stop on the first failure.\n3. `--pdb` to enter the debugger on first failure.\n4. `--trace` to enter the debugger on every test.\n5. `-k foo` to only run tests with 'foo' in their name.\n6. `tests/test_bolt1-01-init.py` to only run tests in that file.\n7. `tests/test_bolt1-01-init.py::test_init` to only run that test.\n8. `--log-cli-level={LEVEL_NAME}` to enable the logging during the test execution.\n\n### Running Against A Real Node.\n\nThe more useful way to run is to use an existing implementation. So\nfar, core-lightning is supported.  You will need:\n\n1. `bitcoind` installed, and in your path.\n2. [`lightningd`](https://github.com/ElementsProject/lightning/) compiled with\n   `--enable-developer`. By default the source directory should be\n   `../lightning` relative to this directory, otherwise use\n   `export LIGHTNING_SRC=dirname`.\n3. Install any python requirements by\n   `pip3 install -r lnprototest/clightning/requirements.txt`.\n\nThen you can run\n\n\tmake check PYTEST_ARGS='--runner=lnprototest.clightning.Runner'\n\nor directly:\n\n    pytest --runner=lnprototest.clightning.Runner\n\n# Further Work\n\nIf you want to write new tests or new backends, see [HACKING.md](HACKING.md).\n\nLet's keep the sats flowing!\n\nRusty.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frustyrussell%2Flnprototest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frustyrussell%2Flnprototest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frustyrussell%2Flnprototest/lists"}