gnidan / trueblocks-dappnode

TrueBlocks DAppNode package

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TrueBlocks DAppNode Package

Building

As long as dappnode/DAppNodeSDK#258 is not merged, we have to use forked DAppNodeSDK to build the package:

git clone https://github.com/dszlachta/DAppNodeSDK.git
cd DAppNodeSDK
git checkout dszlachta/fix_wizard_target_service_schema
yarn
yarn build

# Go back to this directory
cd ../trueblocks-dappnode
../DAppNodeSDK/dist/dappnodesdk.js build

Description

This DAppNode package contains both TrueBlocks-Core, a tool providing decentralized indexing and address monitoring/exploring. See official repo for more information. There are two primary requirements:

  1. An Etherscan API Key
    • This key is used to download contract ABI data
  2. An Ethereum endpoint capable of trace_ calls (Erigon, OpenEthereum, Nethermind?)

For everything else it is generally recommended to just run with these defaults:

  • Enable scraper
  • Bootstrap bloom filters
  • Do not download entire index

The scraper will fill in the missing gaps from the bloom filters and continually update the chain data from your endpoint.

The Bloom Filters are what allow quick searching of the appearance data, it's downloaded from IPFS and consumes around 3GB of storage.

The full index can be downloaded, but it will consume somewhere around 80GB of storage. However, it will make initial queries to new addresses much faster.

Configuration

After installing this package, go to [configure.trueblocks.public.dappnode] to add or remove chains and change settings. When you configure it for a first time, you do not need to restart the package.

Exposing Publicly

It is highly recommended that you don't expose TrueBlocks publicly. It is intended for decentralized single user use. But, you do you.

This API has destructive options. You should block the following:

  • HTTP DELETE method
    • Any HTTP DELETE call is destructive
  • /scrape
    • This API can turn your scraper on and off, ideally you don't want someone to be able to do this.

About

TrueBlocks DAppNode package

License:GNU General Public License v3.0


Languages

Language:HTML 77.8%Language:Go 17.6%Language:Dockerfile 3.0%Language:Shell 1.5%