{"id":19001417,"url":"https://github.com/bumi/blockstream_satellite","last_synced_at":"2025-04-22T17:46:43.221Z","repository":{"id":45108842,"uuid":"169792959","full_name":"bumi/blockstream_satellite","owner":"bumi","description":"ruby gem for the Blockstream Satellite API","archived":false,"fork":false,"pushed_at":"2023-01-20T20:28:59.000Z","size":21,"stargazers_count":4,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T00:34:27.721Z","etag":null,"topics":["bitcoin","blockstream","lightning","satellite","space"],"latest_commit_sha":null,"homepage":null,"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/bumi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-08T20:14:33.000Z","updated_at":"2022-01-23T10:58:58.000Z","dependencies_parsed_at":"2023-02-12T05:02:05.583Z","dependency_job_id":null,"html_url":"https://github.com/bumi/blockstream_satellite","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bumi%2Fblockstream_satellite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bumi%2Fblockstream_satellite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bumi%2Fblockstream_satellite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bumi%2Fblockstream_satellite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bumi","download_url":"https://codeload.github.com/bumi/blockstream_satellite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250290105,"owners_count":21406121,"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","blockstream","lightning","satellite","space"],"created_at":"2024-11-08T18:11:08.084Z","updated_at":"2025-04-22T17:46:43.187Z","avatar_url":"https://github.com/bumi.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Blockstream Satellite - with ruby to space and back\n\nRuby gem to interact with the [Blockstream Satellite](https://blockstream.com/satellite/) API.  \n\nTo learn more about the Blockstream Satellite check their [website](https://blockstream.com/satellite/) and [API documentation](https://blockstream.com/satellite-api/).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'blockstream_satellite'\n```\n\nOr install it yourself as:\n\n    $ gem install blockstream_satellite\n\n**Because of an [protobuf issue with Ruby 2.6](https://github.com/protocolbuffers/protobuf/issues/5161) a ruby version \u003c 2.6 is required**\n\n\n## Usage\n\n### Quick example\n\n```ruby\nrequire \"blockstream_satellite\"\n\norder = BlockstreamSatellite::Order.create(path: '/path/to/file')\nputs order.status # pending\norder.pay # sends the lightning payment using the configured lnd client; request is synchronous\n\nputs order.status # transmitting\norder.refresh\nputs order.status # sent\n```\n\n### Configuration\n\nIn order to be able to pay for the lightninig invoice you need to connect to you lightning node.  \n(By default the testnet cert and macaroon files are loaded from `~/.lnd` and `localhost:10009` is used)\n\n```ruby\nlnd_client = Lnrpc::Client.new({\n  credentials_path: '/path/to/tls.cert', \n  macaroon_path: '/path/to/admin.macaroon', \n  address: 'localhost:10009'\n})\nBlockstreamSatellite.lnd_client = lnd_client\n```\n\n### Creating an order\n\n`BlockstreamSatellite::Order.create` accepts the following parameters: \n\n* `path`: path to the file to transmit\n* `message`: message to transmit; can be used as an alternative `path`\n* `bid`: bid for the order. defaults to file size * 51\n\n```ruby\norder = BlockstreamSatellite::Order.create(path: '/path/to/file')\n```\n\n### Loading an order by UUID and auth_token\n\n```ruby\norder = BlockstreamSatellite::Order.get(uuid: 'uuid', auth_token: 'auth_token')\n```\n\n### Bump the bid for an order\n\n```ruby\norder = BlockstreamSatellite::Order.get(uuid: 'uuid', auth_token: 'auth_token')\norder.bump(1000)\n```\n\n### Pay for an order\n\n```ruby\norder = BlockstreamSatellite::Order.get(uuid: 'uuid', auth_token: 'auth_token')\n# or\norder = BlockstreamSatellite::Order.create(path: '/path/to/file')\n\norder.pay\nputs order.status\n```\n\n### Missing endpoints: \n\n* DELETE /order/:uuid\n* GET /orders/queued\n* GET /orders/sent\n* GET /subscribe/:channels\n\n## Status\n\nCurrently I consider this gem **experimental** and the codes needs cleanup and tests and docs are missing at this moment. \nWill try to get is stable soon! \n\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/bumi/blockstream_satellite.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbumi%2Fblockstream_satellite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbumi%2Fblockstream_satellite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbumi%2Fblockstream_satellite/lists"}