LAN support! Copy edits in Instructions to reflect

* Update to latest upstream, edits for Alpine Linux, update references to StartOS

* Update to latest upstream v0.5.2

.gitignore

@@ -3,3 +3,4 @@ image.tar
 scripts/*.js
 .DS_Store
 .vscode/
+docker-images/

Dockerfile

@@ -1,7 +1,6 @@
-FROM recksato/robosats-client
+FROM recksato/robosats-client:v0.5.3-alpha
-RUN apt-get update && apt-get install wget curl sudo bash tini -y \
+RUN apk add bash curl sudo tini wget yq; \
-        && wget https://github.com/mikefarah/yq/releases/download/v4.25.1/yq_linux_arm.tar.gz -O - |\
+    rm -f /var/cache/apk/*
-        tar xz && mv yq_linux_arm /usr/bin/yq
 
 ENV APP_HOST robosats.embassy
 ENV APP_PORT 12596
@@ -9,6 +8,5 @@ ENV TOR_PROXY_IP embassy
 ENV TOR_PROXY_PORT 9050
 
 ADD ./docker_entrypoint.sh /usr/local/bin/docker_entrypoint.sh
-ADD check-web.sh /usr/local/bin/check-web.sh
 RUN chmod a+x /usr/local/bin/*.sh
 RUN chmod a+x *.sh

Makefile

@@ -8,12 +8,13 @@ TS_FILES := $(shell find ./ -name \*.ts)
 all: verify
 
 verify: $(PKG_ID).s9pk
-	embassy-sdk verify s9pk $(PKG_ID).s9pk
+	start-sdk verify s9pk $(PKG_ID).s9pk
 
-install: all
+install: $(PKG_ID).s9pk
-	embassy-cli package install $(PKG_ID).s9pk
+	start-cli package install $(PKG_ID).s9pk
 
 clean:
+	rm -rf docker-images
 	rm -f image.tar
 	rm -f $(PKG_ID).s9pk
 	rm -f scripts/*.js
@@ -21,8 +22,13 @@ clean:
 scripts/embassy.js: $(TS_FILES)
 	deno bundle scripts/embassy.ts scripts/embassy.js
 
-image.tar: Dockerfile docker_entrypoint.sh
+docker-images/x86_64.tar: Dockerfile docker_entrypoint.sh
-	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 -o type=docker,dest=image.tar .
+	mkdir -p docker-images
+	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/amd64 --build-arg PLATFORM=amd64 -o type=docker,dest=docker-images/x86_64.tar .
 
-$(PKG_ID).s9pk: check-web.sh manifest.yaml instructions.md icon.png LICENSE scripts/embassy.js image.tar
+docker-images/aarch64.tar: Dockerfile docker_entrypoint.sh
-	embassy-sdk pack
+	mkdir -p docker-images
+	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 --build-arg PLATFORM=arm64 -o type=docker,dest=docker-images/aarch64.tar .
+
+$(PKG_ID).s9pk: manifest.yaml instructions.md LICENSE icon.png scripts/embassy.js docker-images/aarch64.tar docker-images/x86_64.tar
+	start-sdk pack

README.md

@@ -1,18 +1,16 @@
 # Wrapper for RoboSats
-
+A simple and private Lightning P2P exchange you can use directly from StartOS.
-RoboSats is a simple and private bitcoin exchange
 
 ## Dependencies
-
 - [docker](https://docs.docker.com/get-docker)
 - [docker-buildx](https://docs.docker.com/buildx/working-with-buildx/)
 - [yq](https://mikefarah.gitbook.io/yq)
 - [deno](https://deno.land/)
 - [make](https://www.gnu.org/software/make/)
-- [embassy-sdk](https://github.com/Start9Labs/embassy-os/tree/master/backend)
+- [start-sdk](https://github.com/Start9Labs/start-os/tree/master/backend)
 
 ## Build enviroment
-Prepare your EmbassyOS build enviroment. In this example we are using Ubuntu 20.04.
+Prepare your StartOS build enviroment. In this example we are using Ubuntu 20.04.
 
 1. Install docker
 ```
@@ -31,11 +29,12 @@ docker run --privileged --rm linuxkit/binfmt:v0.8
 ```
 4. Install yq
 ```
-sudo snap install yq
+wget https://github.com/mikefarah/yq/releases/download/${VERSION}/${BINARY}.tar.gz -O - |\
+  tar xz && mv ${BINARY} /usr/bin/yq
 ```
 5. Install deno
 ```
-sudo snap install deno
+cargo install deno
 ```
 6. Install essentials build packages
 ```
@@ -47,17 +46,16 @@ curl https://sh.rustup.rs -sSf | sh
 # Choose nr 1 (default install)
 source $HOME/.cargo/env
 ```
-8. Build and install embassy-sdk
+8. Build and install start-sdk
 ```
-cd ~/ && git clone --recursive https://github.com/Start9Labs/embassy-os.git
+cd ~/ && git clone --recursive https://github.com/Start9Labs/start-os.git
-cd embassy-os/backend/
+cd start-os/backend/
 ./install-sdk.sh
-embassy-sdk init
+start-sdk init
 ```
 Now you are ready to build your **robosats** service
 
 ## Cloning
-
 Clone the project locally. 
 
 ```
@@ -66,26 +64,23 @@ cd robosats-wrapper
 ```
 
 ## Building
-
+To build the service, run the following command:
-To build the **Hello World** service, run the following command:
 
 ```
 make
 ```
 
-## Installing (on Embassy)
+## Installing (on Start9 servers)
-
 Run the following commands to determine successful install:
-> :information_source: Change embassy-q1w2e3r4.local to your Embassy address
+> :information_source: Change <SERVER-NAME>.local to your Start9 server address
 
 ```
-embassy-cli auth login
+start-cli auth login
-#Enter your embassy password
+#Enter your Start9 server master password
-embassy-cli --host https://embassy-q1w2e3r4.local package install robosats.s9pk
+start-cli --host https://<SERVER-NAME>.local package install robosats.s9pk
 ```
-**Tip:** You can also install the robosats.s9pk using **Sideload Service** under the **Embassy > SETTINGS** section.
+**Tip:** You can also install the robosats.s9pk using **Sideload Service** under the **System > Settings** section.
 ## Verify Install
-
+Go to your Start9 server's Services page, select RoboSats, configure and start the service.
-Go to your Embassy Services page, select **Hello World**, configure and start the service.
 
 **Done!** 

check-web.sh

@@ -1,13 +0,0 @@
-#!/bin/bash
-
-DURATION=$(</dev/stdin)
-if (($DURATION <= 5500)); then
-    exit 60
-else
-    curl --silent --fail robosats.embassy:12596 &>/dev/null
-    WEB_RES=$?
-    if [ $WEB_RES != 0 ]; then
-        echo "RoboSats UI is unreachable, please wait" >&2
-        exit 61
-    fi
-fi

docker_entrypoint.sh

@@ -3,4 +3,4 @@
 set -ea
 
 echo "Starting RoboSats..."
-exec tini -s ./robosats-client.sh 
+exec tini ./robosats-client.sh 

instructions.md

@@ -1,12 +1,10 @@
 # Welcome to RoboSats!
+A simple and private Lightning P2P exchange you can use directly from StartOS.
 
-A simple and private bitcoin exchange you can use right here on your Embassy.
+You can find a quick start guide, tutorial videos, and detailed documentation at [Learn RoboSats](https://learn.robosats.com/).
-
+## Basic Use
-You can find detailed documentation on how to use RoboSats by [Clicking here](https://learn.robosats.com/)
-## Basic Usage Instructions
-
 1. Open RoboSats by using the `LAUNCH UI` button.
-2. For the first time using RoboSats, you will be provided a robot token. 
-3. You can save this token on the RoboSats service config screen if you need to persist your session.
 
-**Note: It is strongly recommended to use a new robot every time when using RoboSats.**
+2. For the first time using RoboSats, you will be provided a robot token (a unique, transient identifier) - you can create as many of these as you'd like.
+
+    **IMPORTANT: Robots are saved in your "Garage."  It is strongly recommended to use a new robot every time you start a new exchange!  Please be aware that your Robot Garage will be different on the Tor (`.onion`) and LAN (`.local`) interfaces.  Be sure to follow your trade to completion on the same interface, as it will not be synced between the two.**

manifest.yaml

@@ -1,29 +1,23 @@
-# Example written in yaml (toml and json are also acceptable)
-
-# The package identifier used by the OS. This must be unique amongst all other known packages
 id: robosats 
- # A human readable service title
 title: "RoboSats"
-# Service version - accepts up to four digits, where the last confirms to revisions necessary for EmbassyOS - see documentation: https://github.com/Start9Labs/emver-rs. This value will change with each release of the service. 
+version: 0.5.3
-version: 0.1.0
+release-notes: |
-# Release notes for the update - can be a string, paragraph or URL
+  * Updated to v0.5.3-alpha [Release Notes](https://github.com/RoboSats/robosats/releases/tag/v0.5.3-alpha)
-release-notes: "Initial Release for EmabssyOS"
+  * IMPORTANT: Versions previous to v0.5.1 will no longer be compatible
-# The type of license for the project. Include the LICENSE in the root of the project directory. A license is required for a Start9 package.
+  * Remove old naming conventions
+  * Remove redundant config option (replaced by Robot Garage in UI)
 license: mit
-# The Start9 wrapper repository URL for the package. This repo contains the manifest file (this), any scripts necessary for configuration, backups, actions, or health checks (more below). This key must exist. But could be embedded into the source repository. 
+wrapper-repo: "https://github.com/kn0wmad/robosats-wrapper"
-wrapper-repo: "https://github.com/Start9Labs/robosats-wrapper"
-# The original project repository URL. There is no upstream repo in this example
 upstream-repo: "https://github.com/Reckless-Satoshi/robosats"
-# URL to the support site / channel for the project. This key can be omitted if none exists, or it can link to the original project repository issues.
 support-site: "https://github.com/Reckless-Satoshi/robosats/issues"
-# URL to the marketing site for the project. This key can be omitted if none exists, or it can link to the original project repository. 
 marketing-site: "https://learn.robosats.com/"
+donation-url: "https://learn.robosats.com/contribute/donate/"
 # The series of commands to build the project into an s9pk for arm64/v8. In this case we are using a Makefile with the simple build command "make".
 build: ["make"]
-# Human readable descriptors for the service. These are used throughout the EmbassyOS user interface, primarily in the marketplace.
+# Human readable descriptors for the service. These are used throughout the StartOS user interface, primarily in the marketplace.
 description:
   # This is the first description visible to the user in the marketplace.
-  short: A simple and private bitcoin exchange
+  short: A simple and private p2p bitcoin exchange
   # This description will display with additional details in the service's individual marketplace page
   long: |
     RoboSats is a simple and private way to exchange bitcoin for national currencies. Robosats simplifies the peer-to-peer user experience and uses lightning hold invoices to minimize custody and trust requirements. The deterministically generated avatars help users stick to best privacy practices.
@@ -35,40 +29,23 @@ assets:
   icon: icon.png
   # Default = INSTRUCTIONS.md
   instructions: instructions.md
-  # Default = image.tar
-  docker-images: image.tar
 # The main action for initializing the service. Currently, the only type of action available is docker.
 main:
-  # Docker is currently the only action implementation
   type: docker
-  # Identifier for the main image volume, which will be used when other actions need to mount to this volume.
   image: main
-  # The executable binary for starting the initialization action. For docker actions, this is typically a "docker_entrypoint.sh" file. See the Dockerfile and the docker_entrypoint.sh in this project for additional details.
+  entrypoint: docker_entrypoint.sh
-  entrypoint: "docker_entrypoint.sh"
-  # Any arguments that should be passed into the entrypoint executable 
   args: []
-  # Specifies where to mount the data volume(s), if there are any. Mounts for pointer dependency volumes are also denoted here. These are necessary if data needs to be read from / written to these volumes. 
   mounts:
-    # Specifies where on the service's file system its persistence directory should be mounted prior to service startup
     main: /root
 # Health checks 
 health-checks: 
-  main:
+  web-ui:
     name: Web Interface
-    success-message: The RoboSats UI is ready to visit in a web browser
+    success-message: The RoboSats UI is ready
-    type: docker
-    image: main
-    entrypoint: check-web.sh
-    args: []
-    io-format: json
-    inject: true
-config:
-  get:
     type: script
-  set:
+config: ~
-    type: script
+# properties: 
-properties: 
+#   type: script
-  type: script
 # This denotes any data, asset, or pointer volumes that should be connected when the "docker run" command is invoked
 volumes:
   # This is the image where files from the project asset directory will go
@@ -81,12 +58,15 @@ interfaces:
     # A human readable name for display in the UI
     name: User Interface
     # A descriptive description of what the interface does
-    description: A simple user interface that is expected to display the text "Hello Word"
+    description: Your RoboSats UI addresses
     tor-config:
     # Port mappings are from the external port to the internal container port
       port-mapping:
         80: "12596"
-    # Port mappings are from the external port to the internal container port
+    lan-config:
+        443: 
+          ssl: true
+          internal: 12596
     # Denotes if the service has a user interface to display
     ui: true
     # Denotes the protocol specifications used by this interface
@@ -94,9 +74,7 @@ interfaces:
       - tcp
       - http
 dependencies: {}
-alerts:
+# alerts:
-  start: |
-    ATTENTION: Your browser must have Tor support to use this service.
 # Specifies how backups should be run for this service. The default EmbassyOS provided option is to use the duplicity backup library on a system image (compat)
 backup:
   create:
@@ -129,8 +107,8 @@ backup:
     args:
       - duplicity
       - restore
-      - /root/data
       - /mnt/backup
+      - /root/data
     mounts:
       BACKUP: "/mnt/backup"
       main: "/root/data"

prepare.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# install yq
+wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/bin/yq &&\
+    chmod +x /usr/bin/yq
+
+# install deno
+cargo install deno

scripts/deps.ts

@@ -1 +1 @@
-export * from "https://deno.land/x/embassyd_sdk@v0.3.1.1.2/mod.ts";
+export * from "https://deno.land/x/embassyd_sdk@v0.3.3.0.9/mod.ts";

scripts/embassy.ts

@@ -1,4 +1,5 @@
 export { setConfig } from "./procedures/setConfig.ts";
 export { getConfig } from "./procedures/getConfig.ts";
-export { properties } from "./procedures/properties.ts";
+// export { properties } from "./procedures/properties.ts";
 export { migration } from "./procedures/migrations.ts";
+export { health } from "./procedures/healthChecks.ts";

scripts/procedures/getConfig.ts

@@ -1,4 +1,4 @@
-// To utilize the default config system built, this file is required. It defines the *structure* of the configuration file. These structured options display as changeable UI elements within the "Config" section of the service details page in the Embassy UI.
+// To utilize the default config system built, this file is required. It defines the *structure* of the configuration file. These structured options display as changeable UI elements within the "Config" section of the service details page in the StartOS UI.
 
 import { compat, types as T } from "../deps.ts";
 
@@ -21,12 +21,4 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
         "target": "lan-address",
         "interface": "main",
     },
-    "rs-hash": {
-        "type": "string",
-        "name": "Robosats Unique Token",
-        "description": "This is just a place that you can store your unique token if you choose.  This is the nym identity that is randomly generated at boot for you on each startup.",
-        "nullable": true,
-        "copyable": true,
-        "masked": false,
-    }
 });

scripts/procedures/healthChecks.ts

@@ -0,0 +1,5 @@
+import { types as T, healthUtil } from "../deps.ts";
+
+export const health: T.ExpectedExports.health = {
+  "web-ui": healthUtil.checkWebUrl("http://robosats.embassy:12596/selfhosted")
+}

scripts/procedures/migrations.ts

@@ -1,4 +1,4 @@
 import { compat, types as T } from "../deps.ts";
 
 export const migration: T.ExpectedExports.migration = compat.migrations
-    .fromMapping({}, "0.1.0" );
+    .fromMapping({}, "0.5.3" );

scripts/procedures/properties.ts

@@ -1,3 +0,0 @@
-import { compat, types as T } from "../deps.ts";
-
-export const properties: T.ExpectedExports.properties = compat.properties;