12 Commits

Author SHA1 Message Date
fc34714068 Update/v0.5.2 (#16)
* Update to latest upstream, edits for Alpine Linux, update references to StartOS

* Update to latest upstream v0.5.2
2023-09-11 15:20:28 -06:00
792eb41501 Update to latest upstream, edits for Alpine Linux, update references to StartOS (#14) 2023-05-31 10:17:11 -06:00
e0c5ca2546 Update to v0.5.0 upstream, update migration, update README, add prepare.sh (#13) 2023-05-11 09:45:45 -06:00
f5769c6f17 Bump version/release notes for donation address 2023-04-11 15:19:10 -06:00
bf4f47850d Add donation page (#12) 2023-04-11 14:37:22 -06:00
4d1e7d76e8 Update to v0.4.3 (#11) 2023-04-10 17:41:46 -06:00
dd9d49b3b1 Update/v0.4.1 (#9)
* Update to v0.4.1

* Minor fixes, prepped for beta v0.4.1~1

* Minor fixes, ready for beta v0.4.1~1
2023-03-14 22:20:43 -06:00
889aba3519 Update to v0.4.1 (#8) 2023-03-13 08:46:52 -06:00
442d82accd 0.4.0 update (#7)
* Init 0.4.0 update

* Stop DDOSing Robosats coordinator with hcks
2023-03-09 15:35:33 -07:00
ccf000b094 update upstream to 0.3.3 (#6)
Co-authored-by: islandbitcoin <dread@start9.com>
2023-01-16 14:01:15 -05:00
d5167fd691 feat/x86 (#5)
* refactored for x86_64 architecture

* removed check-web.sh

* Fix backup restore

Co-authored-by: islandbitcoin <dread@start9.com>
Co-authored-by: Chris Guida <chrisguida@gmail.com>
2022-12-07 13:28:42 -07:00
1d0626e288 Update README.md 2022-10-04 14:03:14 -06:00
14 changed files with 59 additions and 83 deletions

1
.gitignore vendored
View File

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

View File

@ -1,7 +1,6 @@
FROM recksato/robosats-client
RUN apt-get update && apt-get install wget curl sudo bash tini -y \
&& wget https://github.com/mikefarah/yq/releases/download/v4.25.1/yq_linux_arm.tar.gz -O - |\
tar xz && mv yq_linux_arm /usr/bin/yq
FROM recksato/robosats-client:v0.5.2-alpha
RUN apk add bash curl sudo tini wget yq; \
rm -f /var/cache/apk/*
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

View File

@ -10,10 +10,11 @@ all: verify
verify: $(PKG_ID).s9pk
embassy-sdk verify s9pk $(PKG_ID).s9pk
install: all
install: $(PKG_ID).s9pk
embassy-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 buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 -o type=docker,dest=image.tar .
docker-images/x86_64.tar: Dockerfile docker_entrypoint.sh
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
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
embassy-sdk pack

View File

@ -1,18 +1,16 @@
# Wrapper for RoboSats
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)
- [embassy-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
```
@ -49,15 +48,14 @@ source $HOME/.cargo/env
```
8. Build and install embassy-sdk
```
cd ~/ && git clone --recursive https://github.com/Start9Labs/embassy-os.git
cd embassy-os/backend/
cd ~/ && git clone --recursive https://github.com/Start9Labs/start-os.git
cd start-os/backend/
./install-sdk.sh
embassy-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 **Hello World** service, run the following command:
To build the 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
#Enter your embassy password
embassy-cli --host https://embassy-q1w2e3r4.local package install robosats.s9pk
#Enter your Start9 server master password
embassy-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 Embassy Services page, select **Hello World**, configure and start the service.
Go to your Start9 server's Services page, select RoboSats, configure and start the service.
**Done!**

View File

@ -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

View File

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

View File

@ -1,26 +1,17 @@
# 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.1.0
# Release notes for the update - can be a string, paragraph or URL
release-notes: "Initial Release for EmabssyOS"
# 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.
version: 0.5.2
release-notes: |
* Updated to v0.5.2-alpha [Release Notes](https://github.com/Reckless-Satoshi/robosats/releases/tag/v0.5.2-alpha)
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/robosats-wrapper"
# The original project repository URL. There is no upstream repo in this example
wrapper-repo: "https://github.com/kn0wmad/robosats-wrapper"
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
@ -35,40 +26,27 @@ 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"
# Any arguments that should be passed into the entrypoint executable
entrypoint: docker_entrypoint.sh
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
type: docker
image: main
entrypoint: check-web.sh
args: []
io-format: json
inject: true
type: script
config:
get:
type: script
set:
type: script
properties:
type: script
# properties:
# 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
@ -129,8 +107,8 @@ backup:
args:
- duplicity
- restore
- /root/data
- /mnt/backup
- /root/data
mounts:
BACKUP: "/mnt/backup"
main: "/root/data"

8
prepare.sh Executable file
View File

@ -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

View File

@ -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";

View File

@ -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";

View File

@ -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";

View File

@ -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")
}

View File

@ -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.2" );

View File

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