{"id":15464374,"url":"https://github.com/icebaker/lighstorm","last_synced_at":"2025-10-05T01:39:17.167Z","repository":{"id":65708402,"uuid":"597867980","full_name":"icebaker/lighstorm","owner":"icebaker","description":"API for interacting with a Lightning Node.","archived":false,"fork":false,"pushed_at":"2023-04-05T00:44:34.000Z","size":5260,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-26T01:39:19.959Z","etag":null,"topics":["bitcoin","grpc","lightning","lightning-network","lnd","ruby"],"latest_commit_sha":null,"homepage":"https://icebaker.github.io/lighstorm","language":"Ruby","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/icebaker.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":"2023-02-05T21:32:21.000Z","updated_at":"2024-11-23T11:29:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"8c964dc8-3658-44d9-885a-7d4aa5977991","html_url":"https://github.com/icebaker/lighstorm","commit_stats":{"total_commits":35,"total_committers":2,"mean_commits":17.5,"dds":0.4,"last_synced_commit":"726c1af5f69987c1a1771696ee547e92d31f07e7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/icebaker/lighstorm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icebaker%2Flighstorm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icebaker%2Flighstorm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icebaker%2Flighstorm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icebaker%2Flighstorm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/icebaker","download_url":"https://codeload.github.com/icebaker/lighstorm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icebaker%2Flighstorm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278399622,"owners_count":25980329,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","grpc","lightning","lightning-network","lnd","ruby"],"created_at":"2024-10-02T00:34:49.909Z","updated_at":"2025-10-05T01:39:17.152Z","avatar_url":"https://github.com/icebaker.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lighstorm [![Gem Version](https://badge.fury.io/rb/lighstorm.svg)](https://badge.fury.io/rb/lighstorm) ![RSpec Tests Status](https://github.com/icebaker/lighstorm/actions/workflows/ruby-rspec-tests.yml/badge.svg)\n\n\u003e ⚠️ Warning: Early-stage, breaking changes are expected.\n\nAPI for interacting with a [Lightning Node](https://lightning.network).\n\n![Lighstorm text written stylized with an illustration of a Graph connecting two Nodes.](https://raw.githubusercontent.com/icebaker/assets/main/lighstorm/lighstorm.png)\n\n```ruby\nLighstorm::Lightning::Channel.mine.first.myself.node.alias\n```\n\n## Index\n\n- [About](#about)\n- [Usage](#usage)\n  - [Documentation](https://icebaker.github.io/lighstorm)\n  - [Tutorials and Articles](#tutorials-and-articles)\n- [Development](https://icebaker.github.io/lighstorm/#/README?id=development)\n\n## About\n\n_Lighstorm_ is an opinionated abstraction layer on top of the [lnd-client](https://github.com/icebaker/lnd-client).\n\nIt brings an [_object-oriented_](https://en.wikipedia.org/wiki/Object-oriented_programming) approach for interacting with a [Lightning Node](https://github.com/lightningnetwork/lnd), influenced by the [Active Record Pattern](https://www.martinfowler.com/eaaCatalog/activeRecord.html) and [Active Record Models](https://guides.rubyonrails.org/active_record_basics.html) conventions.\n\nHowever, despite the fluidity of _Object Orientation_ being desired in its public interface, internally, most of its code is structured following the [_Hexagonal Architecture_](https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)) and [_Functional Programming_](https://en.wikipedia.org/wiki/Functional_programming) principles.\n\nIt aims to be intuitive to use while being highly **reliable**, as it deals with people's money, and easily testable since its [tests](https://icebaker.github.io/lighstorm/#/README?id=testing) are the foundation for its reliability.\n\nAlthough it tries to stay close to [Lightning's terminologies](https://docs.lightning.engineering/the-lightning-network/overview), it brings its own vocabulary and [data modeling](https://icebaker.github.io/lighstorm/#/README?id=data-modeling), optimizing for [programmer happiness](https://rubyonrails.org/doctrine#optimize-for-programmer-happiness).\n\n## Usage\n\nAdd to your `Gemfile`:\n\n```ruby\ngem 'lighstorm', '~\u003e 0.0.16'\n```\n\n```ruby\nrequire 'lighstorm'\n\n# lndconnect\nLighstorm.connect!(\n  'lndconnect://127.0.0.1:10009?cert=MIICJz...JBEERQ\u0026macaroon=AgEDbG...45ukJ4'\n)\n\n# File Path\nLighstorm.connect!(\n  address: '127.0.0.1:10009',\n  certificate_path: '/lnd/tls.cert',\n  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon'\n)\n\nputs Lighstorm.version # =\u003e 0.0.16\n\nLighstorm::Lightning::Node.myself.alias # =\u003e icebaker/old-stone\n\nLighstorm::Lightning::Invoice.create(\n  description: 'Coffee',\n  amount: { millisatoshis: 1_000 },\n  payable: 'once'\n)\n\nLighstorm::Lightning::Invoice.decode('lnbc20m1pv...qqdhhwkj').pay\n\nLighstorm::Lightning::Invoice.decode('lnbc20m1pv...qqdhhwkj').pay(\n  fee: { maximum: { millisatoshis: 1000 } }\n)\n\nLighstorm::Satoshis.new(\n  millisatoshis: 75_621_650\n).satoshis # =\u003e 75_621\n```\n\nCheck the [full documentation](https://icebaker.github.io/lighstorm).\n\n## Tutorials and Articles\n\n- [Getting Started with Lightning Payments in Ruby](https://mirror.xyz/icebaker.eth/4RUF8umW_KRfVWHHvC2jz0c7YJqzv3RUUvLN-Mln5IU)\n\n## Development\n\nCheck the [development documentation](https://icebaker.github.io/lighstorm/#/README?id=development).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficebaker%2Flighstorm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficebaker%2Flighstorm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficebaker%2Flighstorm/lists"}