Skip to content

Commit

Permalink
docs (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
drethereum authored Jun 17, 2024
1 parent d66cec0 commit 9875f3d
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 8 deletions.
5 changes: 0 additions & 5 deletions models/doc_descriptions/transfers/base_transfer_table_doc.md

This file was deleted.

17 changes: 17 additions & 0 deletions models/doc_descriptions/transfers/evm_transfers_table_doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{% docs evm_fact_token_transfers_table_doc %}

This fact-based table contains emitted event logs for ERC-20 Token Transfers (e.g. `Transfer`: topic_0 = `0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef`). The contract address is the token transferred, and the raw amount field is the amount of tokens transferred. The values in this table are not decimal adjusted, instead please use `core.dim_contracts` or `core.ez_token_transfers` to reference decimals or decimal adjusted values. This table does not contain ERC-721 and ERC-1155 token transfers, instead please use `nft.ez_nft_transfers`. Additionally, this table does not contain transfers of the chain's native asset, instead please use `core.ez_native_transfers`.

{% enddocs %}

{% docs evm_ez_token_transfers_table_doc %}

This convenience table contains emitted event logs for ERC-20 Token Transfers (e.g. `Transfer`: topic_0 = `0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef`), including decimal adjusted values, usd values, and other helpful token metadata where available for each transfer event. The contract address is the token transferred, and the raw amount field is the amount of tokens transferred. Note, this table does not contain ERC-721 and ERC-1155 token transfers, instead please use `nft.ez_nft_transfers`. Additionally, this table does not contain transfers of the chain's native asset, instead please use `core.ez_native_transfers`.

{% enddocs %}

{% docs evm_ez_native_transfers_table_doc %}

This convenience table contains all transfers for the chain's native asset, sourced from internal traces (`core.fact_traces`), and includes decimal adjusted and usd values where available. The origin addresses correspond to the to and from addresses in the `core.fact_transactions` table. Note, this table does not contain ERC-721 and ERC-1155 token transfers, instead please use `nft.ez_nft_transfers`.

{% enddocs %}
2 changes: 1 addition & 1 deletion models/gold/core/core__ez_native_transfers.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2
models:
- name: core__ez_native_transfers
description: '{{ doc("base_ez_eth_transfers_table_doc") }}'
description: '{{ doc("evm_ez_native_transfers_table_doc") }}'

columns:
- name: TX_HASH
Expand Down
2 changes: 1 addition & 1 deletion models/gold/core/core__ez_token_transfers.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2
models:
- name: core__ez_token_transfers
description: '{{ doc("base_transfer_table_doc") }}'
description: '{{ doc("evm_ez_token_transfers_table_doc") }}'

columns:
- name: BLOCK_NUMBER
Expand Down
2 changes: 1 addition & 1 deletion models/gold/core/core__fact_token_transfers.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2
models:
- name: core__fact_token_transfers
description: '{{ doc("base_transfer_table_doc") }}'
description: '{{ doc("evm_fact_token_transfers_table_doc") }}'

columns:
- name: BLOCK_NUMBER
Expand Down

0 comments on commit 9875f3d

Please sign in to comment.