Skip to content

APIS Blockchain-Indexed Services core applications

Notifications You must be signed in to change notification settings

lancesf/apis-core

 
 

Repository files navigation

The APIS Core

Visit TheApis Website and check out TheApis White Paper.

APIS is a middleware protocol for the functioning of a decentralized index and querying protocol, allowing for the mainstream growth of a fully decentralized fnance and decentralized web architecture. Current data index and querying solutions are either centrally architected, reliant on a party who at all times is subject to numerous performance and regulatory risks, or logically decentralized, thus requiring an in-depth knowledge of the public blockchain protocol layer and obscuring the majority of global developers from interacting with public blockchain infrastructure. APIS is architecturally decentralized, in that the providers of the endpointed data can be any actor joins the APIS network, but logically centralized, in that client-side developers will be able to reference common, frequented API formatting structures, namely RESTful and GraphQL endpoints, to query datasets generated by public blockchains.

Looking for our docker images? Download and run TheAPIS images directly from DockerHub

Build Status

TheAPIS JavaScript SDK

Follow us! Medium Twitter Facebook

Development

Setup

Clone the apis-core repository

git clone --depth=1 https://github.com/The-APIS/apis-core.git

Create the .env file at project root and run the build scripts. See .env-example for the list of environment variables and defaults.

cd apis-core/
cp .env-example .env

Run

TL;DR: Using task runner:

npm run build
npm run start

By service or chain:

# ex: run just the gateway
docker-compose up gateway

# ex: run all ethereum services
docker-compose up ethereum*

# ex: run all bitcoin services
docker-compose up bitcoin*

# ex: run everything
docker-compose up

Production

Run

npm run build-production
npm run start-production

Notes

See individual service README files (gateway is a good place to start)

License

Copyright 2021 APIS Foundation.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

APIS Blockchain-Indexed Services core applications

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 64.7%
  • Solidity 32.7%
  • Dockerfile 1.2%
  • HTML 0.7%
  • Shell 0.5%
  • SCSS 0.2%