Skip to content
Official repository with source code for satoshis.place 🎨 ⚑
JavaScript Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
db-init Koalala Oct 10, 2019
packages Koalala Oct 10, 2019
scripts Koalala Oct 10, 2019
.env.sample Koalala Oct 10, 2019
.gitignore Koalala Oct 10, 2019
API.md Koalala Oct 10, 2019
LICENSE Koalala Oct 10, 2019
README.md remove notes on .env Oct 10, 2019
docker-compose.override.yml Koalala Oct 10, 2019
docker-compose.yml Koalala Oct 10, 2019

README.md

Satoshi's Place

This is the official repository containing the source code for satoshis.place.

Satoshi's place is a Lightning Network Application (LApp) launched in May 2018 with the purpose of showcasing the viability of running a service that accepts instant, permissionless, near-free microtransactions through Bitcoin's Lightning Network.

It consists of a collaborative art board where each pixel costs 1 satoshi to paint. Pixels can be drawn over an unlimited amount of times.

What is this for?

It's up to you. You can learn from it, hack it, extend it, run your own version of it, etc... The software is released with an MIT license and meant as a gift to the lightning community in the run-up to the first ever Lightning Conference in 2019.

Preparation

You'll need an instance of c-lightning with lightning-charge setup somewhere you can access. Follow the c-lightning instructions here and the lightning charge instructions here.

In order to setup the database for satoshis-place, you'll need mongo-tools installed in your system, if you're on linux (debian) use sudo apt install mongo-tools, if Mac or otherwise follow these instructions.

You also need docker installed in your system. Follow these instructions.

Setup

  1. Clone the repository and run cd satoshis.place.
  2. Enter connection details in .env (see .env.sample for a template).
  3. Run docker-compose up -d.
  4. Run sh scripts/bootstrap.sh.
  5. Open the application in http://localhost:3000.

You might need to wait a couple of seconds for the application to build before the webpage shows. Check the logs by running docker-compose logs -f. If you see a cheeky monkey Listening on *:3001 πŸ™‰ and a bunch of PING ... and PONG ... it should be good to go!

You can use the SIMULATE_PAYMENTS env setting to automatically execute orders by setting it to yes (requires restart of the api). This will allow you to draw on the canvas without having to make a lightning payment.

Testnet

To use testnet, simply setup your c-lightning node to use testnet, update the connection details if required and set the TESTNET env setting to yes.

API

The API for this application is also exposed and can be interacted with directly, the documentation for this can be found here.

Questions?

Any questions or suggestions feel free to open an issue in this repository or reach out to me via twitter at @LightningK0ala.

You can’t perform that action at this time.