From 4709ded5c215343cc3d339b7b842648e925f28bc Mon Sep 17 00:00:00 2001 From: 0xnirmal Date: Sun, 15 Dec 2024 13:51:17 -0500 Subject: [PATCH 1/4] maybe fix README link --- apps/indexer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/indexer/README.md b/apps/indexer/README.md index 49467cf99..efb381f88 100644 --- a/apps/indexer/README.md +++ b/apps/indexer/README.md @@ -51,7 +51,7 @@ Tasks can be configured to report their execution to healthcheck endpoints autom ## Data Flow -![Index Data Flow](../indexer-flow.drawio.png) +![Index Data Flow](indexer-flow.drawio.png) ### **Step #1 - Download Blocks** From 312ab011c3788eebe4e98a2f51684dd916b0b10b Mon Sep 17 00:00:00 2001 From: 0xnirmal Date: Sun, 15 Dec 2024 13:52:43 -0500 Subject: [PATCH 2/4] maybe fix README pt 2 --- apps/indexer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/indexer/README.md b/apps/indexer/README.md index efb381f88..5d7b738a3 100644 --- a/apps/indexer/README.md +++ b/apps/indexer/README.md @@ -51,7 +51,7 @@ Tasks can be configured to report their execution to healthcheck endpoints autom ## Data Flow -![Index Data Flow](indexer-flow.drawio.png) +![Index Data Flow](/indexer-flow.drawio.png) ### **Step #1 - Download Blocks** From ca3eda137f5e137b7f9dc87d8dbd4b9199622035 Mon Sep 17 00:00:00 2001 From: 0xnirmal Date: Tue, 17 Dec 2024 11:29:54 -0500 Subject: [PATCH 3/4] add migration instructions --- apps/indexer/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/apps/indexer/README.md b/apps/indexer/README.md index 5d7b738a3..ebfb70ed5 100644 --- a/apps/indexer/README.md +++ b/apps/indexer/README.md @@ -53,6 +53,10 @@ Tasks can be configured to report their execution to healthcheck endpoints autom ![Index Data Flow](/indexer-flow.drawio.png) +## Database Migrations + +If you are running from an old database snapshot, you may need to run database migrations to ensure your schema is up to date. See [UPGRADE.md](./UPGRADE.md) for migration instructions. + ### **Step #1 - Download Blocks** Using our [nodeAccessor](./src/chain/nodeAccessor.ts) missing blocks are downloaded from RPC nodes. A list of rpc node is setup in the [chainDefinition](../shared/chainDefinitions.ts#L39) file and their status is then kept updated (earliest/latest available block, rate limiting, etc). The blocks are saved on disk inside a leveldb database (see [File Structure](#block-cache-structure)). From 522908321c2ed7aca4264d8736ae727707475e79 Mon Sep 17 00:00:00 2001 From: 0xnirmal Date: Tue, 17 Dec 2024 11:30:47 -0500 Subject: [PATCH 4/4] styling --- apps/indexer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/indexer/README.md b/apps/indexer/README.md index ebfb70ed5..9020c664c 100644 --- a/apps/indexer/README.md +++ b/apps/indexer/README.md @@ -53,7 +53,7 @@ Tasks can be configured to report their execution to healthcheck endpoints autom ![Index Data Flow](/indexer-flow.drawio.png) -## Database Migrations +### Database Migrations If you are running from an old database snapshot, you may need to run database migrations to ensure your schema is up to date. See [UPGRADE.md](./UPGRADE.md) for migration instructions.