Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trueblocks/trueblocks-explorer
https://github.com/trueblocks/trueblocks-explorer
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/trueblocks/trueblocks-explorer
- Owner: TrueBlocks
- License: gpl-3.0
- Created: 2020-08-22T14:43:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-22T20:37:26.000Z (3 months ago)
- Last Synced: 2024-12-25T02:07:54.897Z (10 days ago)
- Language: TypeScript
- Size: 7.18 MB
- Stars: 67
- Watchers: 6
- Forks: 22
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TrueBlocks Explorer
IMPORTANT NOTE: THIS REPO IS NO LONGER MAINTAINED. THE FUNCTIONALITY FORMERLY PROVIDED BY THIS REPO HAS BEEN MOVED TO [TRUEBLOCKS BROWSE](https://github.com/TrueBlocks/trueblocks-browse). PLEASE USE THAT REPO INSTEAD.
[](https://quickblocks.io/)
[](https://github.com/TrueBlocks/trueblocks-explorer)
[](https://reactjs.org/)
TrueBlocks lets you explore the Ethereum blockchain in a fully-local and therefore fully-private way. This repo provides an example of a frontend application for the TrueBlocks backend: [TrueBlocks core](https://github.com/TrueBlocks/trueblocks-core).
## Prerequisites
Prior to proceeding, you must [install the TrueBlocks Core](http://github.com/TrueBlocks/trueblocks-core) on your local machine.
## Installing
Assuming you have the TrueBlocks core properly installed and can successfully run the following command:
```shell
chifra --version
```
Next, you need to either build or download the Unchained Index. See this document: https://trueblocks.io/docs/install/get-the-index/
Once you have the index, you can run the TrueBlocks local API server with:
```shell
chifra serve
```
### Installing the TrueBlocks Account Explorer
In order to use the TrueBlocks Explorer (which is pre-alpha software at this point), do this from the top of your development folder:
```shell
git clone [email protected]:TrueBlocks/trueblocks-explorer.git
cd trueblocks-explorer
cp .env.example .env
yarn install
yarn start
```
The Explorer application should automatically open your browser to `localhost:1234`.
## NPM Scripts
- `compile | compile:ui | compile:electron` compile TypeScript into JavaScript, usually before packing new Electron bundle
- `develop | develop:ui | develop:electron` run development server for UI and opens the app in Electron.
- `test | test:e2e` run unit or E2E tests
## Requirements
- **Note:** In order for the TrueBlocks to work, you must have access to an Ethereum RPC endpoint that provides both an archive node and trace data. An excellent choice for this is [Erigon](https://github.com/ledgerwatch/erigon). TrueBlocks defaults to an RPC endpoint at http://localhost:8545, but you may use any endpoint (Infura, Quiknodes, for example). Performance will be _greatly reduced_ if you use a remote server. A good solution to this problem is [dAppNode](https://dappnode.io/) or [Ava.do](https://ava.do/) platforms which allow you to install and run both Erigon and (soon) [the TrueBlocks docker version](http://github.com/TrueBlocks/trueblocks-docker).
## Getting Data from the API
The TrueBlocks Explorer uses the API provided by `chifra serve` to access data from the blockchain. Assuming everything is installed correctly and you've started the API server in a separate window, you should be able to access the API from a command line.
```shell
curl "http://localhost:8080/blocks?blocks=4001001&uniq"
```
will show every appearance of an address in block 4,001,001. This is the same data you'll get from the command line with `chifra blocks --uniq`. In general, the command line and the API endpoints provide the exact same options.
### Change data formats.
By default, everything the API returns is JSON.
However, you can change this by adding the options `&fmt=txt` or `&fmt=csv` to your request. This is sometimes useful in a data science environment (such as 'R') where you want differently formatted data. All `chifra` commands support the `fmt` options.
### More information
For information on all aspects of the TrueBlocks project, please see the website: https://trueblocks.io
## Contributing
We love contributors. Please see information about our [work flow](https://github.com/TrueBlocks/trueblocks-core/blob/develop/docs/BRANCHING.md) before proceeding.
1. Fork this repository into your own repo.
2. Create a branch: `git checkout -b `.
3. Make changes to your local branch and commit them to your forked repo: `git commit -m ''`
4. Push back to the original branch: `git push origin TrueBlocks/trueblocks-core`
5. 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](https://trueblocks.io).
## List of Contributors
Thanks to the following people who have contributed to this project:
- **Thomas Jay Rush** - [tjayrush](https://github.com/tjayrush)
- **Ed Mazurek** - [wildmolasses](https://github.com/wildmolasses)
- **Dawid Szlachta** - [dszlachta](https://github.com/dszlachta)