Skip to content

Latest commit

 

History

History
121 lines (82 loc) · 7.84 KB

README.md

File metadata and controls

121 lines (82 loc) · 7.84 KB
Raw

Introduction

ShapeShift ShapeShift ShapeShift GitPOAP Badge CircleCI

Unchained is a multi-blockchain backend interface with three main goals:

  1. Provide a common interface to multiple blockchains
  2. Provide additional information not always accessible from the node directly
  3. Provide realtime updates about blockchain transactions (pending and confirmed)

Table Of Contents

Helpful Docs

Coin Stack Components

  • Node - coin specific node daemon providing historical blockchain data (ex. bitcoind, geth, etc)
  • Indexer - optional service that indexes transaction and balance history by address, or any other applicable information, if not provided by the node directly
  • API - provides a base set of functionality via REST and WebSocket that can be extended with coin specific logic

Architecture Diagrams

With Indexer No Indexer

Notes

  • The ethereum coinstack is used in all examples. If you wish to run a different coinstack, just replace ethereum with the coinstack name you wish to run
  • All paths are relative to the root unchained project directory (ex. unchained/[go|node]/{path})
  • All pulumi commands should be run in a pulumi/ directory (ex. pulumi/, coinstacks/ethereum/pulumi/)

Local Networking

We use traefik as a reverse-proxy to expose all of our docker containers. Traefik is exposed at port 80. Traefik Dashboard is exposed at port 8080

Traefik routes requests based on host name. which includes the coinstack name. For Example:

  • api.ethereum.localhost

Setup

  • Each language subdirectory has setup requirements before running a coinstack locally
    • Go - unchained/go
    • Node - unchained/node
  • Both go and node module have linter installed in git pre-commit hook. To set up the hook: 
    yarn

Docker-Compose Local Dev Instructions

Prerequisites

Running

  • Install node dependencies

    yarn

  • Start the reverse proxy and any common service (ex. hot reloading):

    docker-compose up -d

    Note: -d runs the containers in daemon (background) mode. If you want to see logs, -d can be omitted.

  • Start a coinstack:

    cd node/coinstacks/ethereum
cp sample.env .env // make sure to populate the .env file with valid API keys if required
docker-compose up

  • Visit http://api.ethereum.localhost/docs to view the OpenAPI documentation for the API

  • Tear down a coinstack (including docker volumes):

    cd node/coinstacks/ethereum && docker-compose down

Common Issues

  • If you are running Docker Desktop and see any SIGKILL errors, increase your resource limits in the Resources Tab.

  • Mac OS: when running one of the go coinstacks via docker-compose on, you might encounter an issue with the service failing to start indefinitely. This is due to Mac OS network security blocking the service from starting. To work around that issue, run the coinstack directly from CLI:

    cd go && go run cmd/cosmos/main.go -env=cmd/cosmos/.env

    This will trigger the security popup, allow the go process to make the network calls. Once you approve it, you can kill the process and restart docker-compose. The app should start immediately.

  • Mac OS: once you start a coinstack you should be able to access unchained in the browser without further config, but for CLI access to work you need to modify /etc/hosts and add a valid DNS entry:

    127.0.0.1 localhost api.cosmos.localhost // add a new alias for the coinstack