update to startos template

.gitignore

@@ -0,0 +1,5 @@
+*.s9pk
+scripts/*.js
+.DS_Store
+.vscode/
+docker-images/

.gitmodules

@@ -0,0 +1,10 @@
+
+[submodule "mutiny-web"]
+	path = mutiny-web
+	url = https://github.com/MutinyWallet/mutiny-web.git
+[submodule "ln-websocket-proxy"]
+	path = ln-websocket-proxy
+	url = https://github.com/MutinyWallet/ln-websocket-proxy
+[submodule "vss-rs"]
+	path = vss-rs
+	url = https://github.com/MutinyWallet/vss-rs

Dockerfile

@@ -2,17 +2,21 @@ FROM rust:1.72.0-bookworm AS rust-builder
 
 WORKDIR /build
 
-RUN apt update && apt install -y git python3 make build-essential clang cmake libsnappy-dev openssl libpq-dev pkg-config libc6
+RUN apt update && apt install -y git python3 make build-essential clang cmake libsnappy-dev openssl libpq-dev pkg-config libc6 git
 
 # Install vss-rs
-RUN git clone -b v0.1.0 https://github.com/MutinyWallet/vss-rs
+# removing this and using submodules instead -- Dread
+# RUN git clone -b v0.1.0 https://github.com/MutinyWallet/vss-rs
 WORKDIR /build/vss-rs
+COPY ./vss-rs .
 RUN cargo build --release
 
 WORKDIR /build
 # Install ln-websocket-proxy
-RUN git clone -b v0.3.1 https://github.com/MutinyWallet/ln-websocket-proxy
+# removing this and using submodules instead -- Dread
+# RUN git clone -b v0.3.1 https://github.com/MutinyWallet/ln-websocket-proxy
 WORKDIR /build/ln-websocket-proxy
+COPY ./ln-websocket-proxy .
 RUN cargo build --release --features="server"
 
 # Use Node.js for building the site
@@ -24,7 +28,9 @@ WORKDIR /app
 
 RUN apt update && apt install -y git python3 make build-essential
 
-RUN git clone --b v0.4.21 https://github.com/MutinyWallet/mutiny-web .
+# removing this and using submodules instead -- Dread
+# RUN git clone --b v0.4.21 https://github.com/MutinyWallet/mutiny-web .
+COPY ./mutiny-web .
 
 # This is the cooler way to run pnpm these days (no need to npm install it)
 RUN corepack enable
@@ -44,10 +50,10 @@ ARG VITE_SELFHOSTED="true"
 RUN pnpm install --frozen-lockfile
 
 # IDK why but it gets mad if you don't do this
-RUN git config --global --add safe.directory /app
+# RUN git config --global --add safe.directory /app
 
 # Build the static site
-RUN pnpm run build
+# RUN pnpm run build
 
 FROM nginx:bookworm
 
@@ -58,16 +64,14 @@ COPY --from=rust-builder /build/vss-rs/target/release/vss-rs /app/vss-rs
 COPY --from=rust-builder /build/ln-websocket-proxy/target/release/ln_websocket_proxy /app/ln-websocket-proxy
 
 # Copy static assets
-COPY --from=web-builder /app/dist/public /usr/share/nginx/html
+# COPY --from=web-builder /app/dist/public /usr/share/nginx/html
 
 COPY nginx.conf /etc/nginx/conf.d/default.conf
-COPY docker_entrypoint.sh /app/docker_entrypoint.sh
+ADD ./docker_entrypoint.sh /usr/local/bin/docker_entrypoint.sh
 
 EXPOSE 80
 
 STOPSIGNAL SIGINT
 
 ENV DATABASE_URL="postgres://postgres:docker@localhost/vss"
 ENV SELF_HOST="true"
-
-CMD ["/app/docker_entrypoint.sh"]

Makefile

@@ -8,21 +8,69 @@ 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
+	@echo " Done!"
+	@echo "   Filesize: $(shell du -h $(PKG_ID).s9pk) is ready"
 
 install:
-	embassy-cli package install $(PKG_ID).s9pk
+ifeq (,$(wildcard ~/.embassy/config.yaml))
+	@echo; echo "You must define \"host: http://start-server-name.local\" in ~/.embassy/config.yaml config file first"; echo
+else
+	start-cli package install $(PKG_ID).s9pk
+endif
 
 clean:
-	rm -f image.tar
+	rm -rf docker-images
 	rm -f $(PKG_ID).s9pk
 	rm -f scripts/*.js
+	rm -f image.tar
+
+clean-manifest:
+	@sed -i '' '/^[[:blank:]]*#/d;s/#.*//' manifest.yaml
+	@echo; echo "Comments successfully removed from manifest.yaml file."; echo
+
+# BEGIN REBRANDING
+rebranding:
+	@read -p "Enter new package ID name (must be a single word): " NEW_PKG_ID; \
+	read -p "Enter new package title: " NEW_PKG_TITLE; \
+	find . \( -name "*.md" -o -name ".gitignore" -o -name "manifest.yaml" -o -name "*Service.yml" \) -type f -not -path "./mutiny-startos/*" -exec sed -i '' -e "s/mutiny-startos/$$NEW_PKG_ID/g; s/Mutiny/$$NEW_PKG_TITLE/g" {} +; \
+	echo; echo "Rebranding complete."; echo "	New package ID name is:	$$NEW_PKG_ID"; \
+	echo "	New package title is:	$$NEW_PKG_TITLE"; \
+	sed -i '' -e '/^# BEGIN REBRANDING/,/^# END REBRANDING/ s/^#*/#/' Makefile
+	@echo; echo "Note: Rebranding code has been commented out in Makefile"; echo
+# END REBRANDING
 
 scripts/embassy.js: $(TS_FILES)
 	deno bundle scripts/embassy.ts scripts/embassy.js
 
-image.tar: Dockerfile docker_entrypoint.sh
-	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 -o type=docker,dest=image.tar .
+arm:
+	@rm -f docker-images/x86_64.tar
+	ARCH=aarch64 $(MAKE)
+
+x86:
+	@rm -f docker-images/aarch64.tar
+	ARCH=x86_64 $(MAKE)
+
+docker-images/aarch64.tar: Dockerfile docker_entrypoint.sh 
+ifeq ($(ARCH),x86_64)
+else
+	mkdir -p docker-images
+	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --build-arg ARCH=aarch64 --platform=linux/arm64 -o type=docker,dest=docker-images/aarch64.tar .
+endif
+
+docker-images/x86_64.tar: Dockerfile docker_entrypoint.sh 
+ifeq ($(ARCH),aarch64)
+else
+	mkdir -p docker-images
+	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --build-arg ARCH=x86_64 --platform=linux/amd64 -o type=docker,dest=docker-images/x86_64.tar .
+endif
 
-$(PKG_ID).s9pk: manifest.yaml instructions.md icon.png LICENSE scripts/embassy.js image.tar
-	embassy-sdk pack
+$(PKG_ID).s9pk: manifest.yaml instructions.md icon.png LICENSE scripts/embassy.js docker-images/aarch64.tar docker-images/x86_64.tar
+ifeq ($(ARCH),aarch64)
+	@echo "start-sdk: Preparing aarch64 package ..."
+else ifeq ($(ARCH),x86_64)
+	@echo "start-sdk: Preparing x86_64 package ..."
+else
+	@echo "start-sdk: Preparing Universal Package ..."
+endif
+	@start-sdk pack

README.md

@@ -0,0 +1,117 @@
+# Wrapper for Mutiny 
+
+Mutiny Wallet is a lightning wallet that runs in the web. Mutiny is unlike other lightning apps on Start9, it is not a
+server that you run on your Embassy. Instead, it is a web app that you can access from any device on your local network.
+This means that you can access your wallet from your phone, tablet, or laptop.
+
+This repository creates the `s9pk` package that is installed to run `Mutiny` on [StartOS](https://github.com/Start9Labs/start-os/). Learn more about service packaging in the [Developer Docs](https://start9.com/latest/developer-docs/).
+
+## Dependencies
+
+Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging [documentation](https://github.com/Start9Labs/service-pipeline#development-environment).
+
+- [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/)
+- [start-sdk](https://github.com/Start9Labs/start-os/tree/master/backend)
+
+## Build environment
+Prepare your StartOS build environment. In this example we are using Ubuntu 20.04.
+1. Install docker
+```
+curl -fsSL https://get.docker.com | bash
+sudo usermod -aG docker "$USER"
+exec sudo su -l $USER
+```
+2. Set buildx as the default builder
+```
+docker buildx install
+docker buildx create --use
+```
+3. Enable cross-arch emulated builds in docker
+```
+docker run --privileged --rm linuxkit/binfmt:v0.8
+```
+4. Install yq
+```
+sudo snap install yq
+```
+5. Install deno
+```
+sudo snap install deno
+```
+6. Install essentials build packages
+```
+sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates
+```
+7. Install Rust
+```
+curl https://sh.rustup.rs -sSf | sh
+# Choose nr 1 (default install)
+source $HOME/.cargo/env
+```
+8. Build and install start-sdk
+```
+cd ~/ && git clone --recursive https://github.com/Start9Labs/start-os.git --branch sdk
+cd start-os/backend/
+./install-sdk.sh
+start-sdk init
+```
+Now you are ready to build the `mutiny` package!
+
+## Cloning
+
+Clone the project locally:
+
+```
+git clone https://github.com/benthecarman/mutiny-startos.git
+cd mutiny-startos
+git submodule update --init --recursive
+```
+
+## Building
+
+To build the `mutiny` package for all platforms using start-sdk, run the following command:
+
+```
+make
+```
+
+To build the `mutiny` package for a single platform using start-sdk, run:
+
+```
+# for amd64
+make x86
+```
+or
+```
+# for arm64
+make arm
+```
+
+## Installing (on StartOS)
+
+Run the following commands to determine successful install:
+> :information_source: Change server-name.local to your Start9 server address
+
+```
+start-cli auth login
+# Enter your StartOS password
+start-cli --host https://server-name.local package install mutiny.s9pk
+```
+
+If you already have your `start-cli` config file setup with a default `host`, you can install simply by running:
+
+```
+make install
+```
+
+> **Tip:** You can also install the mutiny.s9pk using **Sideload Service** under the **System > Manage** section.
+
+### Verify Install
+
+Go to your StartOS Services page, select **Mutiny**, configure and start the service. Then, verify its interfaces are accessible.
+
+**Done!** 

docker_entrypoint.sh

@@ -6,6 +6,11 @@ RUST_LOG=debug
   POSTGRES_DATADIR="/var/lib/postgresql/15"
   POSTGRES_CONFIG="/etc/postgresql/15"
 
+  # Pulling this in from Dockerfile
+  # IDK why but it gets mad if you don't do this
+  git config --global --add safe.directory /app
+  pnpm run build
+
   #Start and Configure PostgreSQL
   echo 'Starting PostgreSQL database server for the first time...'
   chown -R postgres:postgres $POSTGRES_DATADIR

instructions.md

@@ -8,3 +8,5 @@ This comes pre-packaged with VSS and the websocket proxy, so everything you need
 
 The only external dependency is esplora, which is used to get blockchain data. This can be configured in the settings
 page if you have your own esplora instance running.
+
+## Additional instructions TBD

manifest.yml → manifest.yaml

@@ -11,7 +11,7 @@ release-notes: "Initial release"
 # 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.
 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/Start9Labs/hello-world-wrapper"
+wrapper-repo: "https://github.com/benthecarman/mutiny-startos"
 # The original project repository URL. There is no upstream repo in this example
 upstream-repo: "https://github.com/MutinyWallet/mutiny-web"
 # 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.
@@ -85,12 +85,12 @@ interfaces:
     tor-config:
       # Port mappings are from the external port to the internal container port
       port-mapping:
-        80: "80"
+        80: "8080"
     # Port mappings are from the external port to the internal container port
     lan-config:
       443:
         ssl: true
-        internal: 80
+        internal: 8080
     # Denotes if the service has a user interface to display
     ui: true
     # Denotes the protocol specifications used by this interface

scripts/deps.ts

@@ -0,0 +1,2 @@
+export * from "https://deno.land/x/[email protected]/mod.ts";
+export * from "https://deno.land/x/[email protected]/util.ts";

scripts/embassy.ts

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

scripts/procedures/getConfig.ts

@@ -0,0 +1,5 @@
+// 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";
+
+export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({});

scripts/procedures/main.ts

@@ -0,0 +1,7 @@
+import { types as T, util } from "../deps.ts";
+
+export const main = async (effects: T.Effects) => {
+  // args defaulted to [] - not necessary to include if empty
+  await effects.runDaemon({ command: "docker_entrypoint.sh", args: [] }).wait();
+  return util.ok;
+}

scripts/procedures/migrations.ts

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

scripts/procedures/properties.ts

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

scripts/procedures/setConfig.ts

@@ -0,0 +1,5 @@
+// This is where any configuration rules related to the configuration would go. These ensure that the user can only create a valid config.
+
+import { compat, } from "../deps.ts";
+
+export const setConfig = compat.setConfig;