LBRYCommunity/rosetta-lbry
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Patrick O'Grady 2020-09-21 21:21:02 -07:00
parent 7bbb04c5a8
commit 0f2493158b
No known key found for this signature in database
GPG key ID: 8DE11C985C0C8D85
3 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Makefile
View file

@ -30,11 +30,6 @@ build-release:
docker build -t rosetta-bitcoin:$(version) .; docker build -t rosetta-bitcoin:$(version) .;
docker save rosetta-bitcoin:$(version) | gzip > rosetta-bitcoin-$(version).tar.gz; docker save rosetta-bitcoin:$(version) | gzip > rosetta-bitcoin-$(version).tar.gz;
pull-remote:
curl -L https://github.com/coinbase/rosetta-bitcoin/releases/latest/download/rosetta-bitcoin.tar.gz -o rosetta-bitcoin.tar.gz;
docker load --input rosetta-bitcoin.tar.gz;
rm rosetta-bitcoin.tar.gz;
run-mainnet-online: run-mainnet-online:
docker run -d --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/bitcoin-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 8333:8333 rosetta-bitcoin:latest docker run -d --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/bitcoin-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 8333:8333 rosetta-bitcoin:latest

31
README.md
View file

@ -34,47 +34,54 @@ As specified in the [Rosetta API Principles](https://www.rosetta-api.org/docs/au
all Rosetta implementations must be deployable via Docker and support running via either an all Rosetta implementations must be deployable via Docker and support running via either an
[`online` or `offline` mode](https://www.rosetta-api.org/docs/node_deployment.html#multiple-modes). [`online` or `offline` mode](https://www.rosetta-api.org/docs/node_deployment.html#multiple-modes).
**YOU MUST INSTALL DOCKER FOR THE FOLLOWING INSTRUCTIONS TO WORK. YOU CAN DOWNLOAD
DOCKER [HERE](https://www.docker.com/get-started).**
### Install ### Install
#### Pre-Built Running the following commands will create a Docker image called `rosetta-bitcoin:latest`.
You can download a pre-built Docker image from GitHub:
TODO: cast version as latest somehow? #### From GitHub
TODO: get latest from release info and then can do automatically? Could do another script... To download the pre-built Docker image from the latest release, run:
```text ```text
curl -L https://github.com/coinbase/rosetta-bitcoin/releases/latest/download/rosetta-bitcoin.tar.gz -o rosetta-bitcoin.tar.gz; curl -sSfL https://raw.githubusercontent.com/coinbase/rosetta-bitcoin/master/install.sh | sh -s
docker load --input rosetta-bitcoin.tar.gz;
rm rosetta-bitcoin.tar.gz;
``` ```
_This will print the image tag out that must be used for running in later steps._ _Do not try to install rosetta-bitcoin using GitHub Packages!_
#### From Source #### From Source
You can clone this repository and run the following command: After cloning this repository, run:
```text ```text
docker build -t rosetta-bitcoin:latest make build-local
``` ```
### Run ### Run
By default, running these commands will create a data directory at `<working directory>/bitcoin-data` Running the following commands will start a Docker container in
and start the `rosetta-bitcoin` server at port `8080`. [detached mode](https://docs.docker.com/engine/reference/run/#detached--d) with
a data directory at `<working directory>/bitcoin-data` and the Rosetta API accessible
at port `8080`.
#### Mainnet:Online #### Mainnet:Online
```text ```text
docker run -d --ulimit "nofile=100000:100000" -v "$(pwd)/bitcoin-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 8333:8333 rosetta-bitcoin:latest docker run -d --ulimit "nofile=100000:100000" -v "$(pwd)/bitcoin-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 8333:8333 rosetta-bitcoin:latest
``` ```
_If you cloned the repository, you can run `make run-mainnet-online`._
#### Mainnet:Offline #### Mainnet:Offline
```text ```text
docker run -d -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-bitcoin:latest docker run -d -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-bitcoin:latest
``` ```
_If you cloned the repository, you can run `make run-mainnet-offline`._
#### Testnet:Online #### Testnet:Online
```text ```text
docker run -d --ulimit "nofile=100000:100000" -v "$(pwd)/bitcoin-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 18333:18333 rosetta-bitcoin:latest docker run -d --ulimit "nofile=100000:100000" -v "$(pwd)/bitcoin-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 18333:18333 rosetta-bitcoin:latest
``` ```
_If you cloned the repository, you can run `make run-testnet-online`._
#### Testnet:Offline #### Testnet:Offline
```text ```text
docker run -d -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-bitcoin:latest docker run -d -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-bitcoin:latest
``` ```
_If you cloned the repository, you can run `make run-testnet-offline`._
## System Requirements ## System Requirements
`rosetta-bitcoin` has been tested on an [AWS c5.2xlarge instance](https://aws.amazon.com/ec2/instance-types/c5). `rosetta-bitcoin` has been tested on an [AWS c5.2xlarge instance](https://aws.amazon.com/ec2/instance-types/c5).

3
install.sh
View file

@ -45,8 +45,9 @@ execute() {
http_download "${tmpdir}/${TARBALL}" "${TARBALL_URL}" "" "1" http_download "${tmpdir}/${TARBALL}" "${TARBALL_URL}" "" "1"
docker load --input "${tmpdir}/${TARBALL}" docker load --input "${tmpdir}/${TARBALL}"
docker tag "rosetta-bitcoin:${TAG}" "rosetta-bitcoin:latest" docker tag "rosetta-bitcoin:${TAG}" "rosetta-bitcoin:latest"
log_info "installed rosetta-bitcoin:${TAG} and tagged as rosetta-bitcoin:latest" log_info "loaded rosetta-bitcoin:${TAG} and tagged as rosetta-bitcoin:latest"
rm -rf "${tmpdir}" rm -rf "${tmpdir}"
log_info "removed temporary directory ${tmpdir}"
} }
github_tag() { github_tag() {
log_info "checking GitHub for latest tag" log_info "checking GitHub for latest tag"