Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RyanMilb/service-satellite-broadcast
Service for MESG that allows users to
https://github.com/RyanMilb/service-satellite-broadcast
Last synced: 2 months ago
JSON representation
Service for MESG that allows users to
- Host: GitHub
- URL: https://github.com/RyanMilb/service-satellite-broadcast
- Owner: RyanMilb
- License: mit
- Created: 2019-02-17T05:49:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-08T10:54:53.000Z (about 4 years ago)
- Last Synced: 2024-04-18T23:38:31.071Z (2 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome - Blockstream Satellite - Send a message from space with blockstream. (Notification)
README
# blockstream-satillite-api
Takes a message, up to 10kb, and relays it from the blockstream satillite.
# Contents
- [Installation](#Installation)
- [Definitions](#Definitions)
- [Events](#Events)
- [invoice-generated](#invoice-generated)
- [Tasks](#Tasks)
- [fetchInvoice](#fetchinvoice)
# Installation
## MESG Core
This service requires [MESG Core](https://github.com/mesg-foundation/core) to be installed first.
You can install MESG Core by running the following command or [follow the installation guide](https://docs.mesg.com/guide/start-here/installation.html).
```bash
bash <(curl -fsSL https://mesg.com/install)
```
## Service
Download the source code of this service, and then in the service's folder, run the following command:
```bash
mesg-core service deploy
```
# Definitions
# Events
## invoice-generated
Event key: `invoice-generated`
Example of it being used below:
```
MESG.executeTask({
serviceID: 'satillite-mesg-service',
taskKey: 'fetchInvoice',
inputData: JSON.stringify({ // The input data that task needs
message: "",
senderid: ""
})
})
```
This will emit an 'invoice generated event' which will include a testnet lightning invoice that needs to be paid for the service to complete its broadcast
```
MESG.listenEvent({
serviceID: 'satillite-mesg-service',
eventFilter: 'invoice-generated' // The event we want to listen
}).on('data', event => {
const invoiceData = JSON.parse(event.eventData)
const data = JSON.stringify({ // The input data that task needs
apikey: '',//Leaving my API key here. Generate your own here https://dev.opennode.co/
invoice: invoiceData.invoice || "EMPTY INVOICE",
invoiceId: invoiceData.invoiceid || "0"
});
console.log('invoice generated detected, sending data: ' + data)
MESG.executeTask({
serviceID: 'lightning-service',
taskKey: 'payInvoice',
inputData: data
}).catch((err) => console.log(err.message))
.then((result) => console.log('Invoice Paid Successfully, Message sent from space!'))
}).on('error', (err) => console.log(err.message))
```
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **authtoken** | `authtoken` | `String` | |
| **invoice** | `invoice` | `String` | |
| **invoiceid** | `invoiceid` | `String` | |
| **uuid** | `uuid` | `String` | |
# Tasks
## fetchInvoice
Task key: `fetchInvoice`
### Inputs
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **message** | `message` | `String` | |
| **senderid** | `senderid` | `String` | |
### Outputs
#### failure
Output key: `failure`
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **message** | `message` | `String` | |
#### success
Output key: `success`
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **status** | `status` | `String` | |