Skip to content

Commit 191bfb1

Browse files
committed
Format .md files
1 parent e303d72 commit 191bfb1

File tree

9 files changed

+66
-30
lines changed

9 files changed

+66
-30
lines changed

CHANGELOG.md

+31
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
## Current
22

33
### Features
4+
45
- [#5968](https://github.com/blockscout/blockscout/pull/5968) - Add call type in the response of txlistinternal API method
56
- [#5860](https://github.com/blockscout/blockscout/pull/5860) - Integrate rust verifier micro-service ([blockscout-rs/verifier](https://github.com/blockscout/blockscout-rs/tree/main/verification))
67
- [#6001](https://github.com/blockscout/blockscout/pull/6001) - Add ETHEREUM_JSONRPC_DISABLE_ARCHIVE_BALANCES env var that filters requests and query node only if the block quantity is "latest"
78

89
### Fixes
10+
911
- [#6017](https://github.com/blockscout/blockscout/pull/6017) - Move "contract interaction" and "Add chain to MM" env vars to runtime
1012
- [#6012](https://github.com/blockscout/blockscout/pull/6012) - Fix display of estimated addresses counter on the main page
1113
- [#5978](https://github.com/blockscout/blockscout/pull/5978) - Allow timestamp param in the log of eth_getTransactionReceipt method
@@ -24,6 +26,32 @@
2426
- [#5948](https://github.com/blockscout/blockscout/pull/5948) - Fix unexpected messages in `CoinBalanceOnDemand`
2527

2628
### Chore
29+
30+
- [#5939](https://github.com/blockscout/blockscout/pull/5939) - Bump sweetalert2 from 11.4.26 to 11.4.27 in /apps/block_scout_web/assets
31+
- [#5938](https://github.com/blockscout/blockscout/pull/5938) - Bump xss from 1.0.13 to 1.0.14 in /apps/block_scout_web/assets
32+
- [#5743](https://github.com/blockscout/blockscout/pull/5743) - Fixing tracer not found #5729
33+
- [#5952](https://github.com/blockscout/blockscout/pull/5952) - Bump sweetalert2 from 11.4.27 to 11.4.28 in /apps/block_scout_web/assets
34+
- [#5955](https://github.com/blockscout/blockscout/pull/5955) - Bump ex_doc from 0.28.4 to 0.28.5
35+
- [#5956](https://github.com/blockscout/blockscout/pull/5956) - Bump bcrypt_elixir from 2.3.1 to 3.0.1
36+
- [#5964](https://github.com/blockscout/blockscout/pull/5964) - Bump sweetalert2 from 11.4.28 to 11.4.29 in /apps/block_scout_web/assets
37+
- [#5966](https://github.com/blockscout/blockscout/pull/5966) - Bump sass from 1.54.4 to 1.54.5 in /apps/block_scout_web/assets
38+
- [#5967](https://github.com/blockscout/blockscout/pull/5967) - Bump @babel/core from 7.18.10 to 7.18.13 in /apps/block_scout_web/assets
39+
- [#5973](https://github.com/blockscout/blockscout/pull/5973) - Bump prometheus from 4.9.0 to 4.9.1
40+
- [#5974](https://github.com/blockscout/blockscout/pull/5974) - Bump cldr_utils from 2.19.0 to 2.19.1
41+
- [#5884](https://github.com/blockscout/blockscout/pull/5884) - Bump nimble_csv from 1.1.0 to 1.2.0
42+
- [#5984](https://github.com/blockscout/blockscout/pull/5984) - Bump jest from 28.1.3 to 29.0.0 in /apps/block_scout_web/assets
43+
- [#5983](https://github.com/blockscout/blockscout/pull/5983) - Bump core-js from 3.24.1 to 3.25.0 in /apps/block_scout_web/assets
44+
- [#5981](https://github.com/blockscout/blockscout/pull/5981) - Bump eslint-plugin-promise from 6.0.0 to 6.0.1 in /apps/block_scout_web/assets
45+
- [#5982](https://github.com/blockscout/blockscout/pull/5982) - Bump jest-environment-jsdom from 28.1.3 to 29.0.0 in /apps/block_scout_web/assets
46+
- [#5987](https://github.com/blockscout/blockscout/pull/5987) - Bump jest from 29.0.0 to 29.0.1 in /apps/block_scout_web/assets
47+
- [#5988](https://github.com/blockscout/blockscout/pull/5988) - Bump jest-environment-jsdom from 29.0.0 to 29.0.1 in /apps/block_scout_web/assets
48+
- [#5989](https://github.com/blockscout/blockscout/pull/5989) - Bump jquery from 3.6.0 to 3.6.1 in /apps/block_scout_web/assets
49+
- [#5990](https://github.com/blockscout/blockscout/pull/5990) - Bump web3modal from 1.9.8 to 1.9.9 in /apps/block_scout_web/assets
50+
- [#6004](https://github.com/blockscout/blockscout/pull/6004) - Bump luxon from 3.0.1 to 3.0.3 in /apps/block_scout_web/assets
51+
- [#6005](https://github.com/blockscout/blockscout/pull/6005) - Bump ex_cldr from 2.33.1 to 2.33.2
52+
- [#6006](https://github.com/blockscout/blockscout/pull/6006) - Bump eslint from 8.22.0 to 8.23.0 in /apps/block_scout_web/assets
53+
- [#6015](https://github.com/blockscout/blockscout/pull/6015) - Bump @fortawesome/fontawesome-free from 6.1.2 to 6.2.0 in /apps/block_scout_web/assets
54+
- [#6021](https://github.com/blockscout/blockscout/pull/6021) - Bump sass from 1.54.5 to 1.54.7 in /apps/block_scout_web/assets
2755
- [#6018](https://github.com/blockscout/blockscout/pull/6018) - Update chromedriver version
2856
- [#5836](https://github.com/blockscout/blockscout/pull/5836) - Bump comeonin from 4.1.2 to 5.3.3
2957
- [#5869](https://github.com/blockscout/blockscout/pull/5869) - Bump reduce-reducers from 0.4.3 to 1.0.4 in /apps/block_scout_web/assets
@@ -96,14 +124,17 @@
96124
## 4.1.7-beta
97125

98126
### Features
127+
99128
- [#5783](https://github.com/blockscout/blockscout/pull/5783) - Allow to setup multiple ranges of blocks to index
100129

101130
### Fixes
131+
102132
- [#5799](https://github.com/blockscout/blockscout/pull/5799) - Fix address_tokens_usd_sum function
103133
- [#5798](https://github.com/blockscout/blockscout/pull/5798) - Copy explorer node_modules to result image
104134
- [#5797](https://github.com/blockscout/blockscout/pull/5797) - Fix flickering token tooltip
105135

106136
### Chore
137+
107138
- [#5796](https://github.com/blockscout/blockscout/pull/5796) - Add job for e2e tests on every push to master + fix job "Merge 'master' to specific branch after release"
108139

109140
## 4.1.6-beta

ISSUE_TEMPLATE.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
### Environment
44

5+
* Deployment type (Manual/Docker/Docker-compose):
56
* Elixir & Erlang/OTP versions (`elixir -version`):
7+
* Node JS version (`node -v`):
68
* Operating System:
7-
* Blockscout Version/branch:
9+
* Blockscout Version/branch/commit:
810

911
### Steps to reproduce
1012

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<p align="center">Blockchain Explorer for inspecting and analyzing EVM Chains.</p>
33
<div align="center">
44

5-
[![Blockscout](https://github.com/blockscout/blockscout/workflows/Blockscout/badge.svg?branch=master)](https://github.com/blockscout/blockscout/actions)
5+
[![Blockscout](https://github.com/blockscout/blockscout/workflows/Blockscout/badge.svg?branch=master)](https://github.com/blockscout/blockscout/actions)
66

77
</div>
88

@@ -20,22 +20,21 @@ Currently available full-featured block explorers (Etherscan, Etherchain, Blockc
2020

2121
## Supported Projects
2222

23-
BlockScout supports a number of projects. Hosted instances include POA Network, Gnosis Chain, Ethereum Classic, Sokol & Kovan testnets, and other EVM chains.
23+
BlockScout supports a number of projects. Hosted instances include POA Network, Gnosis Chain, Ethereum Classic, Sokol & Kovan testnets, and other EVM chains.
2424

2525
- [List of hosted mainnets, testnets, and additional chains using BlockScout](https://docs.blockscout.com/for-projects/supported-projects)
2626
- [Hosted instance versions](https://docs.blockscout.com/about/use-cases/hosted-blockscout)
2727

28-
2928
## Getting Started
3029

3130
See the [project documentation](https://docs.blockscout.com/) for instructions:
31+
3232
- [Requirements](https://docs.blockscout.com/for-developers/information-and-settings/requirements)
3333
- [Ansible deployment](https://docs.blockscout.com/for-developers/ansible-deployment)
3434
- [Manual deployment](https://docs.blockscout.com/for-developers/manual-deployment)
3535
- [ENV variables](https://docs.blockscout.com/for-developers/information-and-settings/env-variables)
3636
- [Configuration options](https://docs.blockscout.com/for-developers/configuration-options)
3737

38-
3938
## Acknowledgements
4039

4140
We would like to thank the [EthPrize foundation](http://ethprize.io/) for their funding support.

apps/block_scout_web/README.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,33 @@ This is a tool for inspecting and analyzing the POA Network blockchain from a we
88
* Elixir 1.9+
99
* Postgres 10.3
1010

11-
1211
## Required Accounts
1312

1413
* Github for code storage
1514

16-
1715
## Setup Instructions
1816

1917
### Development
2018

2119
To get BlockScout Web interface up and running locally:
2220

23-
* Setup `../explorer`
24-
* Install Node.js dependencies with `$ cd assets && npm install && cd ..`
25-
* Start Phoenix with `$ mix phx.server` (This can be run from this directory or the project root: the project root is recommended.)
21+
* Setup `../explorer`
22+
* Install Node.js dependencies with `$ cd assets && npm install && cd ..`
23+
* Start Phoenix with `$ mix phx.server` (This can be run from this directory or the project root: the project root is recommended.)
2624

2725
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
2826

2927
You can also run IEx (Interactive Elixir): `$ iex -S mix phx.server` (This can be run from this directory or the project root: the project root is recommended.)
3028

3129
### Testing
3230

33-
* Build the assets: `cd assets && npm run build`
34-
* Format the Elixir code: `mix format`
35-
* Lint the Elixir code: `mix credo --strict`
36-
* Run the dialyzer: `mix dialyzer --halt-exit-status`
37-
* Check the Elixir code for vulnerabilities: `mix sobelow --config`
38-
* Update translations templates and translations and check there are no uncommitted changes: `mix gettext.extract --merge`
39-
* Lint the JavaScript code: `cd assets && npm run eslint`
40-
31+
* Build the assets: `cd assets && npm run build`
32+
* Format the Elixir code: `mix format`
33+
* Lint the Elixir code: `mix credo --strict`
34+
* Run the dialyzer: `mix dialyzer --halt-exit-status`
35+
* Check the Elixir code for vulnerabilities: `mix sobelow --config`
36+
* Update translations templates and translations and check there are no uncommitted changes: `mix gettext.extract --merge`
37+
* Lint the JavaScript code: `cd assets && npm run eslint`
4138

4239
## Internationalization
4340

apps/ethereum_jsonrpc/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,3 @@ def deps do
8383
]
8484
end
8585
```
86-

apps/explorer/README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,32 @@
22

33
This is a tool for inspecting and analyzing the POA Network blockchain.
44

5-
65
## Machine Requirements
76

87
* Erlang/OTP 21+
98
* Elixir 1.9+
109
* Postgres 10.3
1110

12-
1311
## Required Accounts
1412

1513
* Github for code storage
1614

17-
1815
## Setup Instructions
1916

2017
### Development
2118

2219
To get BlockScout up and running locally:
2320

24-
* Install dependencies with `$ mix do deps.get, local.rebar, deps.compile, compile`
25-
* Create and migrate your database with `$ mix ecto.create && mix ecto.migrate`
26-
* Run IEx (Interactive Elixir) to access the index and explore: `$ iex -S mix`
21+
* Install dependencies with `$ mix do deps.get, local.rebar, deps.compile, compile`
22+
* Create and migrate your database with `$ mix ecto.create && mix ecto.migrate`
23+
* Run IEx (Interactive Elixir) to access the index and explore: `$ iex -S mix`
2724

2825
### Testing
2926

30-
* Format the Elixir code: `$ mix format`
31-
* Lint the Elixir code: `$ mix credo --strict`
32-
* Run the dialyzer: `mix dialyzer --halt-exit-status`
33-
* Check the Elixir code for vulnerabilities: `$ mix sobelow --config`
27+
* Format the Elixir code: `$ mix format`
28+
* Lint the Elixir code: `$ mix credo --strict`
29+
* Run the dialyzer: `mix dialyzer --halt-exit-status`
30+
* Check the Elixir code for vulnerabilities: `$ mix sobelow --config`
3431

3532
### Benchmarking
3633

apps/indexer/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,34 @@ Some data has to be extracted from already fetched data, and there're several tr
2424
- `address_token_balances`: creates token balance entities for futher fetching, based on detected token transfers
2525
- `blocks`: extracts block signer hash from additional data for Clique chains
2626

27-
2827
### Root fetchers
2928

3029
- `pending_transaction`: fetches pending transactions (i.e. not yet collated into a block) every second (`pending_transaction_interval`)
3130
- `block/realtime`: listens for new blocks from websocket and polls node for new blocks, imports new ones one by one
3231
- `block/catchup`: gets unfetched ranges of blocks, imports them in batches
3332

3433
Both block fetchers retrieve/extract the blocks themselves and the following additional data:
34+
3535
- `block_second_degree_relations`
3636
- `transactions`
3737
- `logs`
3838
- `token_transfers`
3939
- `addresses`
4040

4141
The following stubs for further async fetching are inserted as well:
42+
4243
- `block_rewards`
4344
- `address_coin_balances`
4445
- `address_token_balances`
4546
- `tokens`
4647

4748
Realtime fetcher also immediately fetches from the node:
49+
4850
- current balances for `addresses`
4951
- `address_coin_balances`
5052

5153
The following async fetchers are launched for importing missing data:
54+
5255
- `replaced_transaction`
5356
- `block_reward`
5457
- `uncle_block`
@@ -62,6 +65,7 @@ The following async fetchers are launched for importing missing data:
6265

6366
These are responsible for fetching additional block data not retrieved in root fetchers.
6467
Most of them are based off `BufferedTask`, and the basic algorithm goes like this:
68+
6569
1. Make an initial streaming request to database to fetch identifiers of all existing unfetched items.
6670
2. Accept new identifiers for fetching via `async_fetch()` method.
6771
3. Split identifier in batches and run tasks on `TaskSupervisor` according to `max_batch_size` and `max_concurrency` settings.
@@ -80,6 +84,7 @@ Most of them are based off `BufferedTask`, and the basic algorithm goes like thi
8084
- `contract_code`: for `transactions` with non-null `created_contract_address_hash` and null `created_contract_code_indexed_at`
8185

8286
Additionally:
87+
8388
- `token_updater` is run every 2 days to update token metadata
8489
- `coin_balance_on_demand` is triggered from web UI to ensure address balance is as up-to-date as possible
8590

docker-compose/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,26 @@
33
Runs BlockScout locally in Docker container with usage [docker-compose](https://github.com/docker/compose).
44

55
## Prerequisites
6+
67
- Docker v20.10+
78
- Docker-compose 2.x.x+
89
- Running Ethereum JSON RPC client
910

1011
## Building Docker containers from source
12+
1113
```
1214
docker-compose up --build
1315
```
1416

1517
This command uses by-default `docker-compose.yml`, which build the explorer into Docker image and runs 2 Docker containers:
18+
1619
- one for the database. Postgres 13.x, which will be available at port 7432 on localhost
1720
- and the BlockScout explorer at http://localhost:4000
1821

1922
## Configs for different Ethereum clients
23+
2024
Also, the repo contains built-in configs for different clients without need to build the image
25+
2126
- Ganache: `docker-compose -f docker-compose-no-build-ganache.yml up -d`
2227
- HardHat network: `docker-compose -f docker-compose-no-build-hardhat-network.yml up -d`
2328
- Geth: `docker-compose -f docker-compose-no-build-geth.yml up -d`

docker-compose/docker-compose.yml

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ services:
1515
blockscout:
1616
depends_on:
1717
- db
18+
image: blockscout/blockscout:${DOCKER_TAG:-latest}
1819
build:
1920
context: ..
2021
dockerfile: ./docker/Dockerfile

0 commit comments

Comments
 (0)