Giter VIP home page Giter VIP logo

blockchain-analytics-api's Introduction

Blockchain analytics API

A Scala framework for the development of general-purpose analytics on blockchains, created by Livio Pompianu, Stefano Lande.

Our framework allows to combine data within the blockchain with data from the outside (e.g. exchange rates and tags). The workflow consists in two steps:

  1. construct a view of the blockchain and save it in a database;
  2. analyse the view by using the query language of the database.

The blockchains currently supported are Bitcoin and Ethereum. The DBMS currently supported are MongoDB and MySQL.

The library is dicussed in A general framework for blockchain analytics, in proceeding of the SERIAL workshop 2017.

More material is available in the project page.

The Scaladoc is uploaded on this repository in the doc folder.

Install prerequisites

Prerequisites depends on the target analyses. Generally speaking the framework needs at least one blockchain client and one DBMS.

  1. Blockchain clients:
  2. DBMS:
    • MongoDB (constructs a NoSQL view of the data)
    • MySQL (constructs a SQL view of the data)
    • PostgreSQL (constructs a SQL view of the data)
  3. Either
    • use an IDE for executing a Scala SBT project (we used IntelliJ IDEA) or
    • use the command line in place of an IDE (Install SBT)

Before building the project, execute the following commands:

git clone https://github.com/bitbart/bitcoinj.git
cd bitcoinj
git checkout segwit
mvn install -DskipTests
cd core
mvn install -DskipTests

ICO Analytics

In order to use the ICO class (created to retrieve ICOs data) you must require the respective API keys:

  1. EtherScan
    • It is sufficient to sign up and then go here
  2. ICOBench
  3. Ethplorer
    • There is a default, free key: freekey. If you need more data or highload of service, you can to get personal API key.

After doing these steps, do the following:

  1. Copy EtherScan key into EtherScanAPI.apiKey attribute
  2. Copy ICOBench private key and public key into ICOBenchAPI.privateKey and ICOBenchAPI.publicKey attributes respectively
  3. Copy Ethplorer key into EthplorerAPI.apiKey attribute

Install blockchain analytics API

  1. Execute the blockchain client in order to obtain a local copy of the target blockchain (this process may take several hours)
  2. Enable the client RPC calls.
    • In the Bitcoin Core case
      bitcoind -datadir=path/to/blockchain -server -rpcuser=user -rpcpassword=password -rpcserialversion=0
  3. Run a localhost instance of the DBMS on the default port.
  4. Clone this repository.
  5. From your IntelliJ welcome screen: select "Import Project" and open the build.sbt file from your repository directory.

Running

  1. Execute of one of the available examples. Either
    • open the file from your IDE and select run or
    • use the command line: from the root directory of the project, execute
      sbt "runMain tcs.examples.ClassName"

Our framework will build the selected database. Then you can query it for performing your analysis. For each available Scala script, we provide some default queries along with the resulting csv files.

Acknowledgments

The authors thank the following students of the Department of Mathematics and Computer Science of the University of Cagliari for their valuable contributions:

blockchain-analytics-api's People

Contributors

liviopompianu avatar ferruvich avatar stefanolande avatar alessiomanai avatar stefanochessa avatar sirbardo avatar chelo47951 avatar giancarlolelli avatar h1cham avatar francescopisu avatar cedoor avatar riccardomulas avatar asostrife avatar f-fanni avatar marcoguria avatar bitbart avatar pizza1994 avatar

Watchers

James Cloos avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.