From d27683f3c535f261bf0e6167536f992fdc8e4f0a Mon Sep 17 00:00:00 2001 From: Pablo Castellano Date: Mon, 22 Apr 2024 17:04:35 +0200 Subject: [PATCH] docs: review cli, cron and funding pages --- apps/docs/src/app/docs/clis/page.md | 20 ++++++------ .../src/app/docs/codebase-overview/page.md | 4 +-- apps/docs/src/app/docs/cron-jobs/page.md | 31 ------------------- apps/docs/src/app/docs/funding/page.md | 6 ++-- apps/docs/src/app/docs/installation/page.md | 4 +-- apps/docs/src/app/page.md | 6 ++-- 6 files changed, 22 insertions(+), 49 deletions(-) delete mode 100644 apps/docs/src/app/docs/cron-jobs/page.md diff --git a/apps/docs/src/app/docs/clis/page.md b/apps/docs/src/app/docs/clis/page.md index e29b4f500..b8edd5ef9 100644 --- a/apps/docs/src/app/docs/clis/page.md +++ b/apps/docs/src/app/docs/clis/page.md @@ -1,21 +1,21 @@ --- -title: Clis +title: Command line interface nextjs: metadata: - title: Clis - description: Blobscan clis + title: Command line interface + description: Blobscan CLI --- -Blobscan has the following clis: +Blobscan offers the following commands: - [`@blobscan/blob-propagation-jobs-cli`](https://github.com/Blobscan/blobscan/tree/next/clis/blob-propagation-jobs-cli): to run the blob propagation jobs. - [`@blobscan/stats-aggregation-cli`](https://github.com/Blobscan/blobscan/tree/next/clis/stats-aggregation-cli): to run the stats aggregation jobs. -## Blob propagation cli +## Blob propagation -You can use the blob propagation cli to propagate blobs across different storage systems. There are three commands available: `create`, `remove`, and `retry`. +You can use the blob propagation CLI to propagate blobs across different storage systems. There are three commands available: `create`, `remove`, and `retry`. -To run the cli, use the following command: +To run the CLI, use the following command: ```bash cd clis/blob-propagation-jobs-cli @@ -79,11 +79,11 @@ Options -b, --blobHash blob-hash Blob hash of the failed jobs to retry. ``` -## Stats aggregation cli +## Stats aggregation -You can use the stats aggregation cli to aggregate daily and overall stats. There are two commands available: `daily`, `overall`. +You can use the stats aggregation CLI to aggregate daily and overall stats. There are two commands available: `daily`, `overall`. -To run the cli, use the following command: +To run the CLI, use the following command: ```bash cd clis/stats-aggregation-cli diff --git a/apps/docs/src/app/docs/codebase-overview/page.md b/apps/docs/src/app/docs/codebase-overview/page.md index 75f99bea0..9fc037c81 100644 --- a/apps/docs/src/app/docs/codebase-overview/page.md +++ b/apps/docs/src/app/docs/codebase-overview/page.md @@ -34,9 +34,9 @@ Blobscan is composed of the following apps: |  [`@blobscan/web`](https://github.com/Blobscan/blobscan/tree/next/apps/web) | Nextjs app that contains the web app. | |  [`@blobscan/rest-api-server`](https://github.com/Blobscan/blobscan/tree/next/apps/rest-api-server) | Express app that contains the REST API. | -### Clis +### CLI -Blobscan has the following clis: +Blobscan has the following command line interfaces: | CLI | Description | | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | diff --git a/apps/docs/src/app/docs/cron-jobs/page.md b/apps/docs/src/app/docs/cron-jobs/page.md deleted file mode 100644 index 59b64bde7..000000000 --- a/apps/docs/src/app/docs/cron-jobs/page.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Cron jobs -nextjs: - metadata: - title: Cron jobs - description: Blobscan cron jobs ---- - -Blobscan requires two periodic tasks in order to recalculate the metrics and block statistics. - -There are multiple ways out there to run periodic jobs. You can simply use [crontab](https://linux.die.net/man/5/crontab) for that: - -```shell -crontab -e -``` - -Then add the following lines (adjust them to your case): - -```shell -5 0 * * * cd $HOME/blobscan && pnpm job:daily >> $HOME/cron.log -*/15 * * * * cd $HOME/blobscan && pnpm job:overall >> $HOME/cron.log -``` - -## Docker - -When using docker, simply prefix pnpm with `docker compose exec api`: - -```shell -5 0 * * * cd $HOME/blobscan && docker compose exec api pnpm job:daily >> $HOME/cron.log -*/15 * * * * cd $HOME/blobscan && docker compose exec api pnpm job:overall >> $HOME/cron.log -``` diff --git a/apps/docs/src/app/docs/funding/page.md b/apps/docs/src/app/docs/funding/page.md index 5bfd0e56c..13f4726aa 100644 --- a/apps/docs/src/app/docs/funding/page.md +++ b/apps/docs/src/app/docs/funding/page.md @@ -11,6 +11,8 @@ Blobscan was honored to be one of the [top finalists](https://twitter.com/ETHGlo We deeply appreciate and extend our heartfelt gratitude to each one of them: - [Ethereum Foundation](https://ethereum.foundation/): We were one of the winners of the [2022 Layer 2 Community Grants Program](https://blog.ethereum.org/2023/02/14/layer-2-grants-roundup#-data-visualization) receiving a grant of $100,000 USD. -- [Eth Swarm](https://www.ethswarm.org): We started a collaboration with Eth Swarm in 2023 to integrate their decentralized storage solution into Blobscan as a blob storage provider. -- [Optimism](https://optimism.io/): We were one of the recipients of the [2023 RetroPGF 2](https://optimism.mirror.xyz/Upn_LtV2-3SviXgX_PE_LyA7YI00jQyoM1yf55ltvvI) (Retroactive Public Goods Funding Round 2) receiving a total of 40K OP tokens. +- [Ethereum Swarm](https://www.ethswarm.org): We started a collaboration with Ethereum Swarm in 2023 to integrate their decentralized storage solution into Blobscan as a blob storage provider. We received 17k BZZ. +- [Optimism](https://optimism.io/): + - We were one of the recipients of the [2023 RetroPGF 2](https://optimism.mirror.xyz/Upn_LtV2-3SviXgX_PE_LyA7YI00jQyoM1yf55ltvvI) (Retroactive Public Goods Funding Round 2) receiving a total of 40K OP tokens. + - We were one of the recipients of the [2023 RetroPGF 3](https://optimism.mirror.xyz/37Bgum6MfTJWDuE41CH9RXSH5KBm_RCL5zsSFeRZl4E) (Retroactive Public Goods Funding Round 3) receiving a total of 100K OP tokens. - [Scroll](https://scroll.io): We received a total of 20K USDC from Scroll in 2023 to [support](https://twitter.com/ETH_Daily/status/1649761661069279233) our work. diff --git a/apps/docs/src/app/docs/installation/page.md b/apps/docs/src/app/docs/installation/page.md index 19d9a655f..91a4fc2bd 100644 --- a/apps/docs/src/app/docs/installation/page.md +++ b/apps/docs/src/app/docs/installation/page.md @@ -78,6 +78,6 @@ Check out the [blobscan-helm-charts](https://github.com/Blobscan/blobscan-helm-c Check out [Running locally](/docs/running-locally). -### Cron jobs +### Background jobs -Check out [Cronjobs](/docs/cron-jobs). +Check out [Background jobs](/docs/background-jobs). diff --git a/apps/docs/src/app/page.md b/apps/docs/src/app/page.md index 83b9a9b44..5cf328ae6 100644 --- a/apps/docs/src/app/page.md +++ b/apps/docs/src/app/page.md @@ -11,8 +11,10 @@ The architecture of Blobscan has the following components: - A frontend that allows navigating the data, having specific pages for blocks, transactions, addresses, and blobs. - An API that the indexer can talk to and contains shared logic with the frontend. - A blob storage manager with support for different storage providers to keep blob data available. -- A blob propagator for propagating blob data across various storage systems through sandboxed workers. -- A couple of clis for managing blobscan stats and blob propagation jobs. +- Blobscan uses [BullMQ](https://bullmq.io/) for processing jobs in the background, such as: + - Update charts + - Upload blobs in parallel to multiple storage services +- CLI tools for managing background jobs {% quick-links %}