https://github.com/blockparty-sh/slpstream

https://github.com/blockparty-sh/slpstream

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/blockparty-sh/slpstream
• Owner: blockparty-sh
• Created: 2019-11-26T20:52:32.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:24:24.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T15:37:15.120Z (over 1 year ago)
• Language: JavaScript
• Size: 440 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## What is SLPStream?

SLPStream is a frontend API for GS++ that provides a streaming output of new transactions. Unlike [slpsockserve](https://github.com/fountainhead-cash/slpsockserve), SLPStream uses GS++ to for greater efficiency.

## Installation

### Prerequisite

For SLPSockserve to work you first need to go through the install process for [gs++](https://gs.fountainhead.cash), which will continually scan the blockchain for new transactions and blocks which will be streamed live over the SLPStream API.

### Setting up SLPStream

Clone this repository:

```

git clone https://github.com/fountainhead-cash/slpstream.git && cd slpstream

```

Install dependencies:

```

npm install

```

Configure SLPStream:

```

cp .env.example .env

$(EDITOR) .env

```

Start SLPStream

```

npm start

```

### Running as a daemon

Install PM2 using NPM

```

npm install pm2 -g

```

CD to install location and run bitd

```

pm2 start index.js

```