v0.0.1

.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+package-lock.json

.env.example

@@ -0,0 +1,7 @@
+ROOT_PUBLIC_KEY='xpub.....'
+
+PORT=8888
+
+COIN_TYPE=0
+
+VERSION_BYTE=0x00

.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+.volumes/
+.vol/
+.env
+dev.js

Dockerfile

@@ -0,0 +1,15 @@
+FROM node:13
+
+WORKDIR /app
+
+ENV POST="8888"
+ENV COIN_TYPE="0"
+ENV VERSION_BYTE="0x00"
+
+RUN npm install -g nodemon
+
+COPY . /app
+
+RUN npm install
+
+ENTRYPOINT [ "node", "/app/src/index.js" ]

README.md

@@ -0,0 +1,91 @@
+# Spot - Bitcoin HD Wallet Billing Microservice
+
+Spot is a Bitcoin billing microservice that provides your infrastructure with an endpoint for generating an infinite amount of addresses to handle transactions between your application and users without the need for 3rd parties.
+
+- 🔑 **Secure By Design** - Spot only requires your public key.
+- ☁️ **Production Ready** - Stateless microservice designed for production.
+- 🌳 **HD Wallets** - Billing that implements [BIP 32 HD Wallets.](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
+- 🐳 **DockerHub** - Available on [Docker.](https://hub.docker.com/r/anthonybudd/spot)
+
+<p align="center">
+<img width="200" src="https://raw.githubusercontent.com/anthonybudd/spot/master/docs/img/qr-scan.gif"  alt="Scanning GIF">
+</p>
+
+## Quick Start
+To start a local instance of Spot you will first need to create a `ROOT_PUBLIC_KEY`. This is the public key for the root HD wallet, all accounts will be derived from this key. Once you have created a public key, pass it to the container as an ENV and run it using Docker.
+
+```sh
+export ROOT_PUBLIC_KEY=`node -e "console.log(require('hdkey').fromMasterSeed(Buffer.from(require('bip39').mnemonicToSeedSync(require('bip39').generateMnemonic()).toString('hex'), 'hex')).publicExtendedKey);"`
+
+docker run -p 8888:8888 --env ROOT_PUBLIC_KEY=$ROOT_PUBLIC_KEY anthonybudd/spot
+
+open http://localhost:8888/api/v1/generate/0/0/0.svg?amount=0.005
+```
+<sub><sup>⚠️ Do not use the above code to create production keys!</sub></sup>
+
+
+
+## REST API
+
+### `GET - /api/v1/generate/:account/:wallet/:address`
+
+Spot only has one endpoint that is used to generate the receiving address. 
+
+### Response
+By default the response will be a plain JSON object containing the address.
+
+```json
+{
+	"addresss": "13sDzEE3L8LeB3Af9SWiNxxY71ZjgqceHB",
+}
+```
+
+### Response - QR Codes
+To create a QR code of the address add the file extension `.png` or `.svg` to the endpoint, for example `/api/v1/generate/0/0/0.png`.
+
+If you would like to prompt the user to pay a specific amount when they scan the QR code use the query parameter `amount`, this value will be in BTC.  Example `/api/v1/generate/0/0/0.png?amount=0.0005`.
+
+
+<p align="center">
+<img width="200" src="https://raw.githubusercontent.com/anthonybudd/spot/master/docs/img/qr.png"  alt="QR Code Example">
+</p>
+<sub><sup>⚠️ Do not send Bitcoin here.</sub></sup>
+
+## Implementation
+Spot is a stateless microservice designed to be deployed along with the rest of your containers in your infrastructure. Your application will make an HTTP request to Spot to generate an address.
+
+To maximise security Spot does not use your private key. This means if your servers get hacked no sensitive information can be compromised. Even with these security measures you should never allow Spot to be publicly open to the internet.
+
+Each user will thier own corresponding Account in spot.
+
+In production you should only use one `address` for each transaction. So on the first transaction the derivation path will be `.../0/0/0`, the second will be  `.../0/0/1`, the third `.../0/0/2` and so on. 
+
+
+```
+ROOT_PUBLIC_KEY
+│  
+└─── Account 0
+│   └─── Chain 0
+│       │   Address 0: 1PYvjSG6sHzHbiw19DXsbRqe6tvEU8X294
+│       │   Address 1: 13uZtpZN8gQr7yypD5G5u4Y6sghiBBmAjC
+│       │   Address 2: 1M1cb4EWwRSeGwNCrTtVXiDKzkdPBznzdd
+│       │   ...
+│   
+└─── Account 1
+│   └─── Chain 0
+│       │   Address 0: 17mcx19MzsPAWx18f6RLsB8c66TDHR66aS
+│       │   Address 1: 19f3ExY2LuuYH8nxuP1pPSTaTFLjHYDXn5
+│       │   ...
+│...   
+```
+
+
+###  Example
+Below is a basic example of how Spot works in practice.
+1. A user incurs a charge on your website, such as a one-off payment or a monthly fee.
+2. The backend of your application will send a request to the Spot microservice `/api/v1/generate/:account/:wallet/:address`. 
+3. In your application you will need to prompt the user to send bitcoin to the address. You can use the QR code feature and the  `amount` param to return an image. For example `/api/v1/generate/0/0/15266.png?amount=0.0005`
+4. You will need to externally verify the payment and confirm that correct amount was sent using a Bitcoin full node or an API.
+
+### Why "Spot"?
+It's the furthest possible thing from Stripe.

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3.3"
+
+services:
+  spot:
+    build: .
+    entrypoint: "nodemon /app/src/index.js --watch /app"
+    container_name: spot
+    restart: always
+    ports:
+      - "8888:8888"
+    volumes:
+      - .:/app