trueblocks-core

The main repository for the TrueBlocks system

https://github.com/trueblocks/trueblocks-core

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.9%) to scientific vocabulary

Keywords

blockchain command-line-tools ethereum indexing

Keywords from Contributors

optim solidity ovm rollup l2-scaling cryptography static-analysis argument-parser speaker-encoder interactive

Last synced: 6 months ago · JSON representation

Repository

The main repository for the TrueBlocks system

Basic Info

Host: GitHub
Owner: TrueBlocks
License: gpl-3.0
Language: Go
Default Branch: master
Homepage: https://trueblocks.io
Size: 643 MB

Statistics

Stars: 1,078
Watchers: 12
Forks: 219
Open Issues: 27
Releases: 69

Topics

blockchain command-line-tools ethereum indexing

Created almost 9 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

README.md

If you have an existing installation, complete applicable Migrations before proceeding.

TrueBlocks / Unchained Index

GitHub repo size

Table of Contents

Introduction
Installing
Command line
Chifra Serve
Troubleshooting
The unchained index
Docker version
Documentation
Linting
Contributing
Contact
List of Contributors

Introduction

TrueBlocks improves access to blockchain data for EVM-compatible chains (particularly Ethereum mainnet) while remaining entirely local.

Features:

chifra init and chifra scrape which builds the Unchained Index, an index of address appearances that provides lightning-fast access to transactional histories,
An optional binary cache, which speeds up queries to the RPC by orders of magnitude,
Enhanced command-line options enabling much better access to chain data for data scientists and analysts. For example, easily extract all logs produced by a smart contract or view all ERC-20 holdings for an account, etc.,
Advanced tools for producing reconciled "bank statements" and accounting export for any token including ETH.
An infinite number of other things restricted only by your imagination.

Installing

Please see the installation instructions on our website.

Searching account histories

While optional, you most likely want to use the Unchained Index to search account histories. To do so, get the index.

Account explorer

You may use the command line, of course, to access data, but you may also wish to run an API server:

[shell] chifra daemon

Use curl to pull data or use it to drive our "pre-beta" Account Explorer. See installing the explorer. The API provides the identical tools and options as the command line and it documented here.

Command line

The TrueBlocks command-line tool is called chifra. This gives you access to all the other tools:

[shell] chifra --help

Get more help on any sub-command with chifra <cmd> --help. Full documentation is available on our website.

Chifra Serve

One of chifra's command line tools is called serve. This tool provides a simple API mimicking the command line. It is intended to be used only for single user environments.

To start the server, run:

[shell] chifra server

Chifra was built for the command line, a fact we purposefully take advantage of to ensure continued operation on small machines. As such, this tool is not intended to serve multiple end users in a cloud-based server environment. This is by design. Be forewarned.

Get more help on any sub-command with chifra <cmd> --help. Full documentation is available on our website.

Getting data

Let's look at the first subcommand, called status.

[shell] chifra status

If you get a bunch of data, congratulations, your installation is working. Try this command which shows every 10th block between the first and the 100,000th:

[shell] chifra blocks 0-100000:10

You should see a long stream of data. Kill the display with Control+C.

See the entire list of chifra commands with chifra --help.

Troubleshooting

Depending on your setup, you may get the following error message when you run some chifra commands:

[shell] Warning: A request to your Ethereum node (http://localhost:8545) resulted in the following error [Could not connect to server]. Specify a valid rpcProvider by editing $rootPath/trueblocks.toml.

Edit the file as instructed. You may find helpful answers on our FAQ.

See our blog for a lot of useful articles on getting started and using TrueBlocks.

If you continue to have trouble, join our discord discussion

The unchained index

The primary data structure produced by TrueBlocks is an index of address appearances called the Unchained Index. This index provides very quick access to transaction histories for any address.

You may either build the entire index from scratch (requires an EVM-compatible tracing/archive node) or you may download a snapshot of the index build from there.

This process is described in the article Indexing Addresses.

Docker version

Our official docker version is in a separate repo. Please see that repo for more information on running with Docker.

Documentation

The documenation is stored in the ./docs folder of this repo. See our website for the best available documentation.

Linting

Our build process requires the code you submit to be linted.

In order to that, you must install the GoLang linters. See this page for more information.

To install the primary linter (called golangci-lint), run this command:

[shell] curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.53.3

Verify the installation with golangci-lint --version. You should see something like this:

[shell] golangci-lint has version 1.50.1 built from <commit> on <date>

Next, run golangci-lint linters. Your system should have at least the default list to properly lint your submission.

```[shell]

golangci-lint linters

``` You are encouraged to use additional linters. If you do, and you think they're useful, please suggest that we add it to our build process.

Contributing

A chart showing the number of stars on our repo over time.

We love contributors. Please see information about our workflow before proceeding.

Fork this repository into your own repo.
Create a branch: git checkout -b <branch_name>.
Make changes to your local branch and commit them to your forked repo: git commit -m '<commit_message>'
Push back to the original branch: git push origin TrueBlocks/trueblocks-core
Create the pull request.

Contact

If you have questions, comments, or complaints, please join the discussion on our discord server which is linked from our website.

List of Contributors

Thanks to the following people who have contributed to this project:

Owner

Name: TrueBlocks, LLC
Login: TrueBlocks
Kind: organization
Email: jrush@quickblocks.io
Location: Philadelphia, PA, USA

Twitter: trueblocks
Repositories: 38
Profile: https://github.com/TrueBlocks

Web 3.0 Native Desktop Applications on Ethereum

GitHub Events

Total

Create event: 81
Release event: 19
Issues event: 80
Watch event: 39
Delete event: 56
Issue comment event: 58
Push event: 451
Pull request review event: 1
Gollum event: 7
Pull request event: 137
Fork event: 22

Last Year

Create event: 81
Release event: 19
Issues event: 80
Watch event: 39
Delete event: 56
Issue comment event: 58
Push event: 451
Pull request review event: 1
Gollum event: 7
Pull request event: 137
Fork event: 22

Committers

Last synced: 12 months ago

All Time

Total Commits: 9,791
Total Committers: 60
Avg Commits per committer: 163.183
Development Distribution Score (DDS): 0.236

Past Year

Commits: 632
Committers: 17
Avg Commits per committer: 37.176
Development Distribution Score (DDS): 0.119

Top Committers

Name	Email	Commits
tjayrush	j**h@q**o	7,477
Thomas Jay Rush	j**h@g**m	1,605
Dawid Szlachta	g**t@m**v	365
Carlos	c**n@y**s	131
wildmolasses	c**s@g**m	32
Matt Dodson	m**r@g**m	25
dependabot[bot]	4****]	24
doylet	d**i@s**m	19
Mihai	m**a@g**m	11
Carlos Rodriguez	c**s@M**l	11
johhonn	3****n	9
omahs	7****s	7
Dawid Szlachta	d**s@f**m	7
root	r**t@q**o	6
Maks	s**6@g**m	4
Cole Helbling	c**g@d**s	3
BardinPetr	b**r@g**m	3
Artur Jablonski	a**l@g**m	3
ArielTM	a**m@g**m	3
Skylar Ray	1****y	2
Srdzank	s**v@y**m	2
perama-v	8****v	2
weijiekoh	w****h	2
Meriam Zandi	m**i@w**l	2
user1	u**1@i**n	1
jrush	j**h@l**n	1
jrush	j**h@j**n	1
Tim Wijnhoven	t**n@s**l	1
Thomas Jay Rush	j**h@w**l	1
Thomas Jay Rush	T****h	1
and 30 more...

Committer Domains (Top 20 + Academic)

quickblocks.io: 2 foxmail.com: 2 greathill.com: 1 makingprogress.dev: 1 yahoo.es: 1 simplelogin.com: 1 fr24.com: 1 determinate.systems: 1 imac.lan: 1 linux.lan: 1 jrushs-mbp.lan: 1 searchresult.nl: 1 email.cn: 1 quiknode.io: 1 126.com: 1 uwevoelker.de: 1 collis.io: 1 refu.co: 1 vorotnikov.me: 1 animus.rs: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 248
Total pull requests: 269
Average time to close issues: 4 months
Average time to close pull requests: 2 days
Total issue authors: 23
Total pull request authors: 33
Average comments per issue: 1.49
Average comments per pull request: 0.3
Merged pull requests: 189
Bot issues: 0
Bot pull requests: 18

Past Year

Issues: 28
Pull requests: 123
Average time to close issues: about 2 months
Average time to close pull requests: 4 days
Issue authors: 7
Pull request authors: 25
Average comments per issue: 0.46
Average comments per pull request: 0.34
Merged pull requests: 73
Bot issues: 0
Bot pull requests: 11

View more stats

Top Authors

Issue Authors

tjayrush (277)
dszlachta (8)
dreadedhamish (5)
sambacha (3)
Pfed-prog (3)
cevatbostancioglu (2)
bonze82 (1)
walrusmustgo (1)
meijiesky (1)
Yiin (1)
dependabot[bot] (1)
acmLL (1)
Abraham21 (1)
normalnormie (1)
Rouge-Trader (1)

Pull Request Authors

tjayrush (397)
dependabot[bot] (33)
dszlachta (25)
racerole (4)
sambacha (4)
Doy-lee (4)
wakamex (3)
pkucode (3)
romashka-btc (2)
dedyshkaPexto (2)
threehonor (2)
XxAlex74xX (2)
dannbbb1 (2)
gnidan (2)
VitalikBerashvili (2)

Top Labels

Issue Labels

enhancement (132) bug (61) TA-delayed (32) TC-tools:names (23) TC-apps:cmd (22) TC-apps:chunks (19) TC-apps:export (19) TC-apps:scrape (18) TC-tools:slurp (12) Tx-streaming (8) TC-apps:list (8) TC-apps:monitors (8) TX-renderCtx (7) TX-accounting (7) TB-build (7) TC-tools:transactions (7) TC-tools:abis (6) TC-API (6) how-to / idea (5) TS-SDK (5) TX-caching (5) TC-apps:init (5) TC-tools:blocks (5) TC-apps:status (5) TC-apps:monitors-watch (5) Epic (3) TX-scraper-bug (3) priority-blocking (2) priority (2) TC-tools:state (2)