Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix readme repo links #24

Merged
merged 2 commits into from
Sep 26, 2023
Merged

chore: fix readme repo links #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc97002
chore: fix readme repo links
Romsters Sep 26, 2023
2fe8dcd
chore: add swagger json link to readme
Romsters Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Overview

`zkSync Era Block Explorer API` is a block explorer API for zkSync Era blockchain.
The service provides API for retrieving structured zkSync Era blockchain data. It must be connected to the [Block explorer Worker](https://github.com/matter-labs/block-explorer-worker) database.
The service provides API for retrieving structured zkSync Era blockchain data. It must be connected to the [Block explorer Worker](/packages/worker) database.

There are 2 sets of endpoints the service provides. All the endpoints under `/api/*` are designed for external direct usage. These endpoints are similar to [Etherscan API](https://docs.etherscan.io) endpoints. The development of these endpoints is in progress, so more of them will be added soon. The other set of endpoints (other than `/api/*`) is designed to be used by the front-end [App](/packages/app) only and is not meant to be used externally. Once all the new `/api/*` endpoints are developed all the other endpoints (other than `/api/*`) will be deprecated and removed.

Expand All @@ -19,7 +19,7 @@ $ npm install
cp .env.example .env
```
- Set up env variables for Worker Postgres database connection. By default it points to `postgres://postgres:postgres@localhost:5432/block-explorer`.
You need to have a running Worker database, for instructions on how to run the worker service see [Block explorer Worker](https://github.com/matter-labs/block-explorer-worker). Set the following env variables to point the service to your worker database:
You need to have a running Worker database, for instructions on how to run the worker service see [Block explorer Worker](/packages/worker). Set the following env variables to point the service to your worker database:
- `DATABASE_URL`
- `DATABASE_REPLICA_URL_<<replica_index>>`
- `DATABASE_CONNECTION_IDLE_TIMEOUT_MS`
Expand Down Expand Up @@ -59,7 +59,7 @@ $ npm run test:cov
```

## Docs
Locally Swagger docs are available at http://localhost:3000/docs.
Locally Swagger docs are available at http://localhost:3000/docs. JSON version - http://localhost:3000/docs-json.

## Development

Expand Down
2 changes: 1 addition & 1 deletion packages/worker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# zkSync Era Block Explorer Worker
## Overview

`zkSync Era Block Explorer Worker` is an indexer service for zkSync Era blockchain data. The purpose of the service is to read the data from the blockchain in real time, transform it and fill in it's database with the data in a way that makes it easy to read by the [Block explorer API](https://github.com/matter-labs/block-explorer-api).
`zkSync Era Block Explorer Worker` is an indexer service for zkSync Era blockchain data. The purpose of the service is to read the data from the blockchain in real time, transform it and fill in it's database with the data in a way that makes it easy to read by the [Block explorer API](/packages/api).

## Installation

Expand Down