diff --git a/README.md b/README.md index 47ac800..c5761d4 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,12 @@ # bch-api +This is a node.js JavaScript REST API server using Express.js. The purpose of this code is to create a REST API server that provides a common interface for working with a Bitcoin Cash full node and various indexers. See [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) to learn about the 'Cash Stack'. Visit [FullStack.cash](https://fullstack.cash), sign up for a free account, and use this REST API right away with the [bch-js](https://github.com/christroutner/bch-js) JavaScript library. -[![Build Status](https://travis-ci.org/christroutner/bch-api.svg?branch=master)](https://travis-ci.org/christroutner/bch-api) +This repository is intended to be paired with [bch-js](https://github.com/christroutner/bch-js), an npm JavaScript library for building Bitcoin Cash apps. -This is a fork and alternative implementation of -the [rest.bitcoin.com](https://github.com/Bitcoin-com/rest.bitcoin.com) repository. -The purpose of this code is to create a REST API server that provides a common -interface for working with a Bitcoin Cash full node and various indexers. See [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) to learn about the 'Cash Stack'. Visit [FullStack.cash](https://fullstack.cash), sign up for a free account, and use this REST API right away with the [bch-js](https://github.com/christroutner/bch-js) JavaScript library. +![Cash Stack Network Diagram](./generic-network-diagram.png) -This repository is intended to be paired with [bch-js](https://github.com/christroutner/bch-js), -an npm JavaScript library, and an alternative implementation -of [BITBOX SDK](https://github.com/Bitcoin-com/bitbox-sdk). - -Both bch-api and bch-js are part of the -[full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer). +Both bch-api and bch-js are part of the [full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer). - [API Documentation](https://fullstack.cash/documentation) - [Example Code](https://fullstack.cash/examples) diff --git a/generic-network-diagram.png b/generic-network-diagram.png new file mode 100644 index 0000000..a30866c Binary files /dev/null and b/generic-network-diagram.png differ diff --git a/start-dev-example.sh b/start-dev-example.sh index 5034068..3168208 100755 --- a/start-dev-example.sh +++ b/start-dev-example.sh @@ -20,4 +20,11 @@ export FULCRUM_PORT=50002 export TOKENSECRET=somelongpassword +# So that bch-api can call bch-js locally. +export LOCAL_RESTURL=http://127.0.0.1:3000/v3/ + +# slp-api alternative SLP validator. +export SLP_API_URL=http://10.0.0.5:5001/ + + npm start