README.md

ethhole

How the token flows

Usage

yarn install
yarn start

How its made

How it's made

1. Collect Layer 2 / Sidechain bridges contracts
2. Collect TVL and token allocation of production Layer 2 (Loopring, ZkSwap, zkSync...) and Sidechain bridges contracts through Covalent API (with Deno script)
3. Get protocol and stake balance by Zapper API
4. Auto daily update data via github action
5. Build website (react, hookrouter, tailwind) with leaderboard and the Sankey flow chart for quick glance
6. Build per project page to show bridges and use Treemap diagrams to show its token composition
7. Show ETH or USD based TVL
8. Show emerging Layer 2 projects with the strict mode

Fetch Data

Install deno from https://deno.land/#installation

deno run --allow-net --allow-write scripts/fetch_data.js --key [COVALENT_API_KEY]

Get covalent API key from https://www.covalenthq.com/platform/#/auth/register/

Data Format

In src/data Layer 2 and side chain bridge contracts balances are list by date.

The format is

projectName: {
    tvl: // in eth
    bridges: [
        {
            address,
            quote_currency, // eth
            chain_id,
            items: [
                {
                    contract_ticker_symbol,
                    balance,
                    quote, // value
                }
            ]
        }
    ]
}

Can explorer data with JSON viewer, ex http://jsonviewer.stack.hu/

Contribution

To add new contracts https://github.com/gasolin/ethhole/blob/main/src/helpers/bridge_contracts.js

To do analytics https://github.com/gasolin/ethhole/blob/main/src/data/

To suggest https://github.com/gasolin/ethhole/issues

Credit

Event

• Initial version made during Scaling Ethereum Hackthon

Contracts

• Bridges balance fetched through Covalent API
• Protocol and Staked balance fetched through Zapper API
• Collected plenty of Layer 2 contract addresses from L2BEAT
• Also referred DefiLlama, DefiPulse, Blockscan, and @eliasimos / Bridge Away at Dune Analytics

Design

• UI style based on Tail-kit
• Original icon design from freepik

License

MIT License