Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bithyve/bithyve-wrapper
A server instance that wraps around electrs
https://github.com/bithyve/bithyve-wrapper
bitcoin bithyve electrs go hexa
Last synced: about 1 month ago
JSON representation
A server instance that wraps around electrs
- Host: GitHub
- URL: https://github.com/bithyve/bithyve-wrapper
- Owner: bithyve
- License: gpl-3.0
- Created: 2019-04-30T13:15:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-16T07:32:39.000Z (over 2 years ago)
- Last Synced: 2024-06-19T04:24:23.029Z (6 months ago)
- Topics: bitcoin, bithyve, electrs, go, hexa
- Language: Go
- Homepage:
- Size: 191 KB
- Stars: 6
- Watchers: 6
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BitHyve Wrapper
BitHyve wrapper is a server instance that wraps around [electrs](https://github.com/Blockstream/electrs) to provide some additional functionality on top of electrs as required by [hexa](https://github.com/bithyve/hexa)
## Prerequisites for running BitHyve Wrappe
BitHyve Wrapper requires **electrs** (https://github.com/Blockstream/electrs) and electrs requires a **Bitcoin Core** (v0.16+)
**Bitcoin Core daemon**
Bitcoin Core can be downloaded from https://bitcoincore.org/en/download/
Detailed instructions on installing, configuring and running Bitcoin Core as daemon are available here https://bitcoin.org/en/full-node
**Electrs**
Electrs can be installed from https://github.com/Blockstream/electrs
Please follow the instructions here https://github.com/Blockstream/electrs#installing--indexing for help in installing and setting up electrs.
## Installing and running BitHyve Wrapper
1. Install golang (replace 1.15.4 with your favorite version)
```
wget https://dl.google.com/go/go1.15.4.linux-amd64.tar.gz
sudo tar -xvf go1.15.4.linux-amd64.tar.gz
sudo mv go /usr/bin/
```
2. Update path
```
export GOROOT=/usr/bin/go
export GOPATH=$HOME/go
export PATH=$GOPATH/bin:$GOROOT/bin:$PATH
```
3. Download and build
```
go get github.com/bithyve/bithyve-wrapper
cd ~/go/src/github.com/bithyve/bithyve-wrapper
go get ./...
go build
```
4. Run the wrapper
- Before running the wrapper please ensure that Bitcoin Core daemon and electrs have been setup and and are running as these are required for BitHyve Wrapper.
- You would need to know the ip number of the machine/server runnig the BitHyand port number where you are running
```
sudo screen -SL wrapper ./bithyve-wrapper -m
```
5. Ensure your server accepts http traffic
```
sudo screen -SL socat80 socat tcp-listen:80,reuseaddr,fork tcp:localhost:3001
```