Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
uses: astral-sh/setup-uv@v5

- name: Install markdownlint-cli
run: npm install -g markdownlint-cli
run: npm install -g markdownlint-cli@0.47.0

- name: Install project
run: make install
Expand Down
2 changes: 1 addition & 1 deletion docs/10.supported-networks/16.ethereum.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Explorer: [Etherscan](https://etherscan.io/)
| datasource | status | URLs |
| -----------------:|:-------- | -------------------------------------------------------------------------------- |
| **evm.subsquid** | 🟢 works | `https://v2.archive.subsquid.io/network/ethereum-mainnet` |
| **evm.etherscan** | 🟢 works | `https://api.etherscan.io/v2/api?chainId=1` |
| **evm.etherscan** | 🟢 works | `https://api.etherscan.io/v2/api?chainId=1` |
| **evm.node** | 🟢 works | `https://eth-mainnet.g.alchemy.com/v2` <br> `wss://eth-mainnet.g.alchemy.com/v2` |

### Ethereum Goerli
Expand Down
8 changes: 4 additions & 4 deletions docs/10.supported-networks/8.blast.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Explorer: [Blast Explorer](https://blastexplorer.io/)

### Blast Sepolia

| datasource | status | URLs |
| -----------------:|:-------- | ------------------------------------------------------------------------------ |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/blast-sepolia` |
| datasource | status | URLs |
| -----------------:|:------------- | ------------------------------------------------------------------------- |
| **evm.subsquid** | 🤔 not tested | `https://v2.archive.subsquid.io/network/blast-sepolia` |
| **evm.etherscan** | 🤔 not tested | `https://api.routescan.io/v2/network/testnet/evm/168587773/etherscan/api` |
| **evm.node** | 🤔 not tested | |
| **evm.node** | 🤔 not tested | |
2 changes: 1 addition & 1 deletion docs/5.advanced/_env_table.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable first-line-h1 -->
<!-- markdownlint-disable first-line-h1 table-column-style -->
| name | description |
|-|-|
| `DIPDUP_DEBUG` | Enable debug logging and additional checks |
Expand Down
2 changes: 1 addition & 1 deletion docs/5.advanced/_metrics_table.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable first-line-h1 -->
<!-- markdownlint-disable first-line-h1 table-column-style -->
| name | description | type |
|-|-|-|
| dipdup_datasource_head_updated_timestamp | Timestamp of the last head update | Gauge |
Expand Down
28 changes: 28 additions & 0 deletions docs/7.references/1.cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ description: "Command-line interface reference"
<dt>/_____//_// .___//_____/ __,_// .___/</dt><dd><p>/_/ /_/</p>
</dd>
</dl>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand Down Expand Up @@ -78,6 +79,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## config

<p>Commands to manage DipDup configuration.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>config<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -87,6 +89,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Dump environment variables used in DipDup config.</p>
<p>If variable is not set, default value will be used.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>config<span class="w"> </span>env<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand Down Expand Up @@ -122,6 +125,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Print config after resolving all links and, optionally, templates.</p>
<p>WARNING: Avoid sharing output with 3rd-parties when <cite>–unsafe</cite> flag set - it may contain secrets!</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>config<span class="w"> </span><span class="nb">export</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand Down Expand Up @@ -151,6 +155,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## hasura

<p>Commands related to Hasura integration.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>hasura<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -159,6 +164,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### configure

<p>Configure Hasura GraphQL Engine to use with DipDup.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>hasura<span class="w"> </span>configure<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -177,6 +183,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Generate project tree, typeclasses and callback stubs.</p>
<p>This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>init<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>PATH
</pre></div>
</div>
Expand Down Expand Up @@ -224,6 +231,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## mcp

<p>Commands related to MCP integration.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>mcp<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -232,6 +240,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### run

<p>Run MCP server.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>mcp<span class="w"> </span>run<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -243,6 +252,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Migrate project to the new spec version.</p>
<p>If you’re getting <cite>MigrationRequiredError</cite> after updating DipDup, this command will fix imports and type annotations to match the current <cite>spec_version</cite>. Review and commit changes after running it.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>migrate<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -259,6 +269,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## new

<p>Create a new project interactively.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>new<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand Down Expand Up @@ -299,6 +310,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## package

<p>Inspect and manage project package.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>package<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -307,6 +319,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### tree

<p>Draw package tree.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>package<span class="w"> </span>tree<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -316,6 +329,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### verify

<p>Verify project package.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>package<span class="w"> </span>verify<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -326,6 +340,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## report

<p>Manage crash and performance reports.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>report<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -334,6 +349,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### ls

<p>List reports.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>report<span class="w"> </span>ls<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -343,6 +359,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### rm

<p>Remove report(s).</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>report<span class="w"> </span>rm<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>ID<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -366,6 +383,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### show

<p>Show report.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>report<span class="w"> </span>show<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>ID
</pre></div>
</div>
Expand All @@ -384,6 +402,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Run the indexer.</p>
<p>Execution can be gracefully interrupted with <cite>Ctrl+C</cite> or <cite>SIGINT</cite> signal.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>run<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -393,6 +412,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## schema

<p>Commands to manage database schema.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>schema<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -401,6 +421,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### approve

<p>Continue to use existing schema after reindexing was triggered.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>schema<span class="w"> </span>approve<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -411,6 +432,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Print SQL schema including scripts from <cite>sql/on_reindex</cite>.</p>
<p>This command may help you debug inconsistency between project models and expected SQL schema.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>schema<span class="w"> </span><span class="nb">export</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -421,6 +443,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Prepare database schema for running DipDup.</p>
<p>This command creates tables based on your models, then executes <cite>sql/on_reindex</cite> to finish preparation - the same things DipDup does when run on a clean database.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>schema<span class="w"> </span>init<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -431,6 +454,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG

<p>Drop all database tables, functions and views.</p>
<p>WARNING: This action is irreversible! All indexed data will be lost!</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>schema<span class="w"> </span>wipe<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -454,6 +478,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
## self

<p>Commands to manage local DipDup installation.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>self<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
Expand All @@ -462,6 +487,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### install

<p>Install DipDup for the current user.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>self<span class="w"> </span>install<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand Down Expand Up @@ -514,6 +540,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### uninstall

<p>Uninstall DipDup for the current user.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>self<span class="w"> </span>uninstall<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand All @@ -530,6 +557,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
### update

<p>Update DipDup for the current user.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>self<span class="w"> </span>update<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
Expand Down
Loading