starfish-core
v0.0.3
Published
Starfish Core
Downloads
6
Readme
starfish-server
A Peer to Peer Identity System, powered by Bitcoin.
- Official Website: https://starfish.computer
- Video Explanation: https://www.youtube.com/watch?v=fglt2jkVpQA
Introduction
- starfish-server is an implementation of the Starfish identity scheme, which takes the form of a node.js web server.
- starfish-desktop, a cross platform desktop app implementation (Mac, Windows, Linux) is powered by starfish-server. The desktop app wraps the starfish-server in an app format.
How starfish-server works
starfish-server is an implementation of the Starfish scheme that takes the form of a node.js module that runs as a web server at port 21000.
The web server receives POST requests at its /sign endpoint and signs the request message with its embedded wallet and returns the HTTP response.
As of v0.1.0, the response format looks like this:
{
"address": <The Signer Bitcoin Address>,
"sig": <The Signature>,
"message": <The message that was requested and signed>,
"ts": <The unix timestamp at which the signature was made>
}Using the node module
Install the module in your project:
npm install --save starfish-serverAnd then start the server:
const starfish = require('starfish-server')
starfishd({
db: <The Key Path for Starfish>
})It will start a /sign endpoint at port 21000.
If you make a POST request with a "message" attribute, it will sign the message and return the response.
<html>
<script>
fetch("http://localhost:21000/sign", {
method: 'post',
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
message: "Sign this message!"
})
}).then((res) => {
return res.json()
}).then((res) => {
console.log("Respons", res)
})
</script>
</html>Running as standalone
If you want to run starfish-server as a standalone app instead of a node module, you should first checkout the Starfish app, which wraps the starfish-server module in a cross platform app format that supports Mac, Windows, and Linux.
But if you must directly run starfish-server without running it as an app format, you can also do that. Just do:
npm install -g starfish-serverto install globally, and then run
starfish