{"id":29560913,"url":"https://github.com/decred/dcrlnlpd","last_synced_at":"2025-07-18T15:39:22.542Z","repository":{"id":39797069,"uuid":"494087536","full_name":"decred/dcrlnlpd","owner":"decred","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-16T12:02:56.000Z","size":254,"stargazers_count":5,"open_issues_count":2,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-09-16T13:51:27.700Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decred.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2022-05-19T13:39:48.000Z","updated_at":"2024-09-16T12:02:59.000Z","dependencies_parsed_at":"2023-12-12T18:40:37.440Z","dependency_job_id":"3e5229c1-2e08-42ac-843b-738b30945d11","html_url":"https://github.com/decred/dcrlnlpd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/decred/dcrlnlpd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrlnlpd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrlnlpd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrlnlpd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrlnlpd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decred","download_url":"https://codeload.github.com/decred/dcrlnlpd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrlnlpd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265787585,"owners_count":23828458,"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":[],"created_at":"2025-07-18T15:39:21.999Z","updated_at":"2025-07-18T15:39:22.528Z","avatar_url":"https://github.com/decred.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DCR LN Liquidity Provider Daemon\n\nThis service allows running a Lightning Network Liquidity Provider in the Decred\nnetwork.\n\nThis LP allows remote clients to request the node associated to the LP to open\nan LN channel back to the requesting client. This allows the requesting client\nto have some inbound bandwidth to receive LN payments.\n\nTo create the channel, the LP charges some amount, specified as a percentage\nof the desired channel size.\n\n\u003e :warning: **NOTE**: This software takes control of the _outbound_ channels\ncreated by this node, such that it will close any channels that do not conform\nto its policy, even ones not created by it (e.g. manually created channels).\nSee below for a discussion on the closing policy.\n\n## Building \u0026 Running\n\nRequires Go 1.17+. Download the code, then run\n\n```\n$ go install .\n$ dcrlnlpd\n```\n\n## Configuration\n\nA default config file is created in `~/.dcrlnlpd/dcrlnlpd.conf` if it does not\nexist. CLI parameters can be found by running `-h/--help`.\n\n### Channel Closing Policy\n\nThe policy to decide whether to close a channel is:\n\n```\n  (totalSentAtoms / lifetime) \u003e= (requiredSentAtoms / requiredInterval)\n```\n\nThis policy is evaluated every `closepolicy.checkinterval` (default:\n1 hour) and only for channels which have a lifetime greater than\n`closepolicy.minchanlifetime`.\n\nWhat this means is that every time the check is evaluated, every channel\nmust have had some minimum amount of atoms sent through it, otherwise it is\nclosed.\n\nWith the default settings, the channel must have had at least 0.001 DCR sent\nthrough it every 24 hours, otherwise it will be closed. This policy is easily\ntweaked by changing the appropriate config entries.\n\n## Client\n\nA client implementation is available in the `github.com/decred/dcrlnlpd/client`\npackage. A CLI client is also provided in the `cmd/client` subdir.\n\nAn example invocation of the CLI client is the following:\n\n```\ngo run ./cmd/client/ \\\n  --lnrpchost localhost:20100 \\\n  --lntlscertpath ~/dcrlndsimnetnodes/dcrlnd1/tls.cert \\\n  --lnmacaroonpath ~/dcrlndsimnetnodes/dcrlnd1/chain/decred/simnet/admin.macaroon \\\n  --addr http://localhost:29130 \\\n  --chansize 0.001\n```\n\n## License\n\ndcrlnlpd is licensed under the [copyfree](http://copyfree.org) ISC License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdcrlnlpd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecred%2Fdcrlnlpd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdcrlnlpd/lists"}