3 Commits

7 changed files with 31 additions and 41 deletions

View File

@ -1,4 +1,4 @@
FROM recksato/robosats-client:v0.5.2-alpha
FROM recksato/robosats-client:v0.5.3-alpha
RUN apk add bash curl sudo tini wget yq; \
rm -f /var/cache/apk/*

View File

@ -8,10 +8,10 @@ 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: $(PKG_ID).s9pk
embassy-cli package install $(PKG_ID).s9pk
start-cli package install $(PKG_ID).s9pk
clean:
rm -rf docker-images
@ -31,4 +31,4 @@ docker-images/aarch64.tar: Dockerfile docker_entrypoint.sh
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
start-sdk pack

View File

@ -1,5 +1,5 @@
# Wrapper for RoboSats
RoboSats is a simple and private bitcoin exchange
A simple and private Lightning P2P exchange you can use directly from StartOS.
## Dependencies
- [docker](https://docs.docker.com/get-docker)
@ -7,7 +7,7 @@ RoboSats is a simple and private bitcoin exchange
- [yq](https://mikefarah.gitbook.io/yq)
- [deno](https://deno.land/)
- [make](https://www.gnu.org/software/make/)
- [embassy-sdk](https://github.com/Start9Labs/start-os/tree/master/backend)
- [start-sdk](https://github.com/Start9Labs/start-os/tree/master/backend)
## Build enviroment
Prepare your StartOS build enviroment. In this example we are using Ubuntu 20.04.
@ -46,12 +46,12 @@ 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/start-os.git
cd start-os/backend/
./install-sdk.sh
embassy-sdk init
start-sdk init
```
Now you are ready to build your **robosats** service
@ -75,9 +75,9 @@ Run the following commands to determine successful install:
> :information_source: Change <SERVER-NAME>.local to your Start9 server address
```
embassy-cli auth login
start-cli auth login
#Enter your Start9 server master password
embassy-cli --host https://<SERVER-NAME>.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 **System > Settings** section.
## Verify Install

View File

@ -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 detailed documentation on how to use RoboSats by [Clicking here](https://learn.robosats.com/)
## Basic Usage Instructions
You can find a quick start guide, tutorial videos, and detailed documentation at [Learn RoboSats](https://learn.robosats.com/).
## Basic Use
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.**

View File

@ -1,8 +1,11 @@
id: robosats
title: "RoboSats"
version: 0.5.2
version: 0.5.3
release-notes: |
* Updated to v0.5.2-alpha [Release Notes](https://github.com/Reckless-Satoshi/robosats/releases/tag/v0.5.2-alpha)
* Updated to v0.5.3-alpha [Release Notes](https://github.com/RoboSats/robosats/releases/tag/v0.5.3-alpha)
* IMPORTANT: Versions previous to v0.5.1 will no longer be compatible
* Remove old naming conventions
* Remove redundant config option (replaced by Robot Garage in UI)
license: mit
wrapper-repo: "https://github.com/kn0wmad/robosats-wrapper"
upstream-repo: "https://github.com/Reckless-Satoshi/robosats"
@ -14,7 +17,7 @@ build: ["make"]
# 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.
@ -38,13 +41,9 @@ main:
health-checks:
web-ui:
name: Web Interface
success-message: The RoboSats UI is ready to visit in a web browser
type: script
config:
get:
type: script
set:
success-message: The RoboSats UI is ready
type: script
config: ~
# properties:
# type: script
# This denotes any data, asset, or pointer volumes that should be connected when the "docker run" command is invoked
@ -59,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
@ -72,9 +74,7 @@ interfaces:
- tcp
- http
dependencies: {}
alerts:
start: |
ATTENTION: Your browser must have Tor support to use this service.
# alerts:
# 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:

View File

@ -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,
}
});

View File

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