Skip to content

Commit

Permalink
Merge pull request #303 from Bitcoin-com/stage
Browse files Browse the repository at this point in the history
v 2.2.5
  • Loading branch information
cgcardona authored Feb 16, 2019
2 parents 4b47b3f + 3c3f132 commit 6d41726
Show file tree
Hide file tree
Showing 9 changed files with 1,689 additions and 4,459 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,31 @@ Testnet available at [trest.bitcoin.com](https://trest.bitcoin.com)

You can also run an instance of REST for your own full node

### Prerequesites
### Prerequisites

#### NodeJS

Install nodejs's LTS. 8.11.4 at the time of writing.

https://nodejs.org/en/

#### build-essential package

If you encounter
```
gyp ERR! build error
gyp ERR! stack Error: not found: make
```

For Ubuntu
```
sudo apt-get install build-essential
```
For CENTOS
```
RUN yum install -y make gcc*
```

### Full node

Fire up a full Bitcoin Cash node and add the following to your `bitcoin.conf`.
Expand Down Expand Up @@ -86,11 +103,12 @@ Now you need to start REST and pass in the following environment variables
- ZEROMQ_PORT - The port on which you enabled ZeroMQ
- ZEROMQ_URL - The IP address of your full BCH node
- NETWORK - mainnet or testnet depending on which network you're using
- BITDB_URL - mainnet or testnet BITDB URL

Here's how the final command would look

```
BITCOINCOM_BASEURL=https://bch-insight.bitpay.com/api/ RPC_BASEURL=http://your.nodes.ip.address:8332/ RPC_PASSWORD=rpcPasssword RPC_USERNAME=rpcUsername ZEROMQ_PORT=28332 ZEROMQ_URL=your.nodes.ip.address NETWORK=mainnet npm run dev
BITCOINCOM_BASEURL=https://bch-insight.bitpay.com/api/ RPC_BASEURL=http://your.nodes.ip.address:8332/ RPC_PASSWORD=rpcPasssword RPC_USERNAME=rpcUsername ZEROMQ_PORT=28332 ZEROMQ_URL=your.nodes.ip.address BITDB_URL=https://bitdb.bitcoin.com/ NETWORK=mainnet npm run dev
```

Starting in the regtest mode (partly working since the bitcoincom_baseurl does not work with local nodes):
Expand Down
2 changes: 1 addition & 1 deletion dist/public/bitcoin-com-mainnet-rest-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -1091,7 +1091,7 @@
"openapi": "3.0.0",
"info": {
"description": "rest.bitcoin.com is the REST layer for Bitcoin.com's Cloud. More info: [developer.bitcoin.com/rest](https://developer.bitcoin.com/rest). Chatroom [geni.us/CashDev](http://geni.us/CashDev)",
"version": "2.2.4",
"version": "2.2.5",
"title": "REST",
"license": {
"name": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion dist/public/bitcoin-com-testnet-rest-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -1091,7 +1091,7 @@
"openapi": "3.0.0",
"info": {
"description": "trest.bitcoin.com is the REST layer for Bitcoin.com's Cloud. More info: [developer.bitcoin.com/rest](https://developer.bitcoin.com/rest). Chatroom [geni.us/CashDev](http://geni.us/CashDev)",
"version": "2.2.4",
"version": "2.2.5",
"title": "REST",
"license": {
"name": "MIT",
Expand Down
Loading

0 comments on commit 6d41726

Please sign in to comment.