From 6c542500502128683bbde508776ffcfb87d6877e Mon Sep 17 00:00:00 2001 From: San Yong <22216004+SanYongxie@users.noreply.github.com> Date: Thu, 10 Apr 2025 17:15:53 +0800 Subject: [PATCH 1/3] updated core balances, blocks, contracts docs --- models/doc_descriptions/core/balances.md | 20 ++++++++++---------- models/doc_descriptions/core/blocks.md | 18 ++---------------- models/doc_descriptions/core/contracts.md | 6 +++--- 3 files changed, 15 insertions(+), 29 deletions(-) diff --git a/models/doc_descriptions/core/balances.md b/models/doc_descriptions/core/balances.md index 9ca4b3356..54abfd382 100644 --- a/models/doc_descriptions/core/balances.md +++ b/models/doc_descriptions/core/balances.md @@ -26,7 +26,7 @@ This is an absolutely massive view, which is why filters must be applied if you This table contains the block level balance changes for both tokens (including ERC721s) and the native asset on this EVM blockchain for all wallets and contracts. If a token or the native asset is moved, we will read the balance of the involved wallets at that block, and carry forward the previous balance into the current record. Symbol, name, and price are joined where possible. ERC721s are included. -Please note - the underlying data for this is large. If you want your query to run quickly, please use filters as much as possible. Using at least `block_timestamp::date` as a filter will lead to optimal query performance. +Please note - the underlying data for this is large. If you want your query to run quickly, please use filters as much as possible. For optimal query performance, filter by `block_timestamp::date`. If you want to take this data and make it daily, you can do so with the query below. You must use a `block_timestamp::date` filter here at a minimum. Other filters will help query runtime. @@ -149,14 +149,14 @@ ORDER BY {% docs evm_has_decimal %} -Whether the token has a decimal or not, either TRUE or FALSE. +Boolean flag indicating whether token decimal information is available for this token (TRUE or FALSE). {% enddocs %} {% docs evm_has_price %} -Whether the token has an hourly price or not, either TRUE or FALSE. +Boolean flag indicating whether hourly price data for this token is available (TRUE or FALSE). {% enddocs %} @@ -190,14 +190,14 @@ The contract address of the token (null for native asset). {% docs evm_current_balances_current_bal_unadj %} -The current token or native asset balance for this address, without a decimal adjustment. +The current raw token or native asset balance for this address, without a decimal adjustment. {% enddocs %} {% docs evm_current_balances_current_bal %} -The decimal adjusted current token or native asset balance. +The current decimal adjusted token or native asset balance. {% enddocs %} @@ -218,35 +218,35 @@ The value of the tokens or native asset in USD, as of the most recently recorded {% docs evm_current_balances_symbol %} -The symbol of the token contract, or native asset. +The symbol of the token contract, or native asset. Please note this is not necessarily unique. {% enddocs %} {% docs evm_current_balances_token_name %} -The name of the token contract, or native asset. +The name of the token contract, or native asset. Please note this is not necessarily unique. {% enddocs %} {% docs evm_current_balances_decimals %} -The decimals for the token contract. +The number of decimal places specified by the token contract for representing token amounts. {% enddocs %} {% docs evm_current_balances_has_decimal %} -Whether the token has a decimal or not, either TRUE or FALSE. +Boolean flag indicating whether token decimal information is available for this token (TRUE or FALSE). {% enddocs %} {% docs evm_current_balances_has_price %} -Whether the token has an hourly price or not, either TRUE or FALSE. +Boolean flag indicating whether hourly price data for this token is available (TRUE or FALSE). {% enddocs %} diff --git a/models/doc_descriptions/core/blocks.md b/models/doc_descriptions/core/blocks.md index 4ccd92b63..6bbeda728 100644 --- a/models/doc_descriptions/core/blocks.md +++ b/models/doc_descriptions/core/blocks.md @@ -5,20 +5,6 @@ This table contains block level data for this EVM blockchain. This table can be {% enddocs %} -{% docs evm_block_header_json %} - -This JSON column contains the block header details. - -{% enddocs %} - - -{% docs evm_blockchain %} - -The blockchain on which transactions are being confirmed. - -{% enddocs %} - - {% docs evm_blocks_hash %} The hash of the block header for a given block. @@ -35,7 +21,7 @@ Block nonce is a value used during mining to demonstrate proof of work for a giv {% docs evm_difficulty %} -The effort required to mine the block. +The computational effort required to mine the block. {% enddocs %} @@ -56,7 +42,7 @@ Total gas limit provided by all transactions in the block. {% docs evm_gas_used %} -Total gas used in the block. +Total gas used by all transactions in the block. {% enddocs %} diff --git a/models/doc_descriptions/core/contracts.md b/models/doc_descriptions/core/contracts.md index 33f4b39f8..aa7fc144e 100644 --- a/models/doc_descriptions/core/contracts.md +++ b/models/doc_descriptions/core/contracts.md @@ -49,7 +49,7 @@ The symbol used to represent this contract. Please note this is not necessarily {% docs evm_creator_address %} -The address of the contract creator. +The address that deployed/created the contract (also known as the deployer address). {% enddocs %} @@ -68,13 +68,13 @@ Internal column. {% docs evm_token_convention %} -The token standard utilized by this contract. +The token standard implemented by the contract (e.g. ERC20, ERC721, ERC1155). {% enddocs %} {% docs evm_decimals %} -The decimals for the token contract. +The number of decimal places used by the token contract for representing token amounts {% enddocs %} From 6de83170146a778e8d8560d095aa816a8a058cbb Mon Sep 17 00:00:00 2001 From: San Yong <22216004+SanYongxie@users.noreply.github.com> Date: Tue, 15 Apr 2025 16:43:00 +0800 Subject: [PATCH 2/3] update core descriptions --- models/doc_descriptions/core/contract_abis.md | 4 +-- .../doc_descriptions/core/contract_reads.md | 10 +++---- models/doc_descriptions/core/contracts.md | 7 ----- .../doc_descriptions/core/decoded_traces.md | 4 +-- models/doc_descriptions/core/event_logs.md | 8 +++--- models/doc_descriptions/core/prices.md | 6 ++-- models/doc_descriptions/core/traces.md | 9 +----- models/doc_descriptions/core/transactions.md | 28 +++++++++---------- models/doc_descriptions/core/transfers.md | 4 +-- .../general/complete_general.md | 14 +--------- .../general/complete_labels.md | 2 +- .../governance/L1_submission_fields.md | 8 +++--- 12 files changed, 39 insertions(+), 65 deletions(-) diff --git a/models/doc_descriptions/core/contract_abis.md b/models/doc_descriptions/core/contract_abis.md index 6b0ddcc19..f7e0bb2b8 100644 --- a/models/doc_descriptions/core/contract_abis.md +++ b/models/doc_descriptions/core/contract_abis.md @@ -2,14 +2,14 @@ This table contains the contract ABIs that we have sourced from Etherscan, the community, or bytecode matched. This table is the source of ABIs used in the `core__ez_decoded_event_logs` table. We first try to source ABIs from Etherscan. If we cannot find an ABI on Etherscan, we will rely on user submissions. To add a contract to this table, please visit [here](https://science.flipsidecrypto.xyz/abi-requestor/). -If we are unable to locate an ABI for a contract from Etherscan or the community, we will try to find an ABI to use by matching the contract bytecode to a known contract bytecode we do have an ABI for. +If we are unable to locate an ABI for a contract from Etherscan or the community, we will try to find an ABI to use by matching the contract bytecode with known contracts. {% enddocs %} {% docs abi %} -The JSON ABI for the contract. +The ABI for the contract in JSON, defining the contract's functions and events. {% enddocs %} diff --git a/models/doc_descriptions/core/contract_reads.md b/models/doc_descriptions/core/contract_reads.md index 8d4f450e8..87f3acfea 100644 --- a/models/doc_descriptions/core/contract_reads.md +++ b/models/doc_descriptions/core/contract_reads.md @@ -7,14 +7,14 @@ This table contains contract reads for a variety of functions and contracts on t {% docs evm_contract_reads_contract_address %} -The address of the contract read. +The address of the smart contract being read. {% enddocs %} {% docs evm_contract_reads_block_number %} -The block number the contract address was read at. +The block number at which the contract read operation was performed. {% enddocs %} @@ -28,21 +28,21 @@ The function signature called by this read. See `dim_function_signatures` for te {% docs evm_contract_reads_function_input %} -The function inputs called in this read, if applicable. +The input parameters provided to the function call, if applicable. {% enddocs %} {% docs evm_read_output %} -The return of the contract call. +The raw output returned by the contract function call. {% enddocs %} {% docs evm_segmented_output %} -The return of the contract call, segmented into 64 character strings. +The raw output returned by the contract function call, segmented into 64 character strings. {% enddocs %} diff --git a/models/doc_descriptions/core/contracts.md b/models/doc_descriptions/core/contracts.md index aa7fc144e..e45a403ee 100644 --- a/models/doc_descriptions/core/contracts.md +++ b/models/doc_descriptions/core/contracts.md @@ -26,13 +26,6 @@ The unique address of the deployed contract. {% enddocs %} -{% docs evm_contracts_metadata %} - -This JSON column contains other relevant details for each contract. - -{% enddocs %} - - {% docs evm_contracts_name %} The name of the deployed contract. Please note this is not necessarily unique. diff --git a/models/doc_descriptions/core/decoded_traces.md b/models/doc_descriptions/core/decoded_traces.md index 408169b29..4d15d8268 100644 --- a/models/doc_descriptions/core/decoded_traces.md +++ b/models/doc_descriptions/core/decoded_traces.md @@ -14,14 +14,14 @@ The name of the function called in the trace. {% docs evm_decoded_input_data %} -Decoded input data for the trace. +The decoded input parameters provided to the function call in this trace. {% enddocs %} {% docs evm_decoded_output_data %} -Decoded output data for the trace. +The decoded output data from the function call in this trace. {% enddocs %} diff --git a/models/doc_descriptions/core/event_logs.md b/models/doc_descriptions/core/event_logs.md index 52c8e0cce..d2278c5da 100644 --- a/models/doc_descriptions/core/event_logs.md +++ b/models/doc_descriptions/core/event_logs.md @@ -20,7 +20,7 @@ The decoded event inputs for a given event. {% docs evm_event_removed %} -Whether the event has been removed from the transaction. +Boolean flag indicating whether the event has been removed from the transaction (TRUE or FALSE). {% enddocs %} @@ -34,7 +34,7 @@ This is the primary key for this table. This is a concatenation of the transacti {% docs evm_logs_contract_address %} -The address interacted with for a given event. +The address of the contract that emitted this event. {% enddocs %} @@ -48,7 +48,7 @@ The name of the contract or token, where possible. {% docs evm_logs_data %} -The un-decoded event data. +The raw (un-decoded) data contained in the event log. {% enddocs %} @@ -62,7 +62,7 @@ Transaction hash is a unique 66-character identifier that is generated when a tr {% docs evm_topics %} -The un-decoded event input topics. +The raw (un-decoded) event topics, which are indexed parameters of the event. {% enddocs %} diff --git a/models/doc_descriptions/core/prices.md b/models/doc_descriptions/core/prices.md index a4619d05f..8e7e8e69b 100644 --- a/models/doc_descriptions/core/prices.md +++ b/models/doc_descriptions/core/prices.md @@ -127,14 +127,14 @@ The unique identifier of the Blockchain, Network, or Platform for this asset. {% docs evm_prices_is_native %} -A flag indicating assets native to this EVM blockchain. +Boolean flag indicating whether the asset is native to this EVM blockchain (TRUE or FALSE). {% enddocs %} {% docs evm_prices_is_deprecated %} -A flag indicating if the asset is deprecated or no longer supported by the provider. +Boolean flag indicating whether the asset is deprecated or no longer supported by the provider (TRUE or FALSE). {% enddocs %} @@ -155,7 +155,7 @@ Deprecating soon! Please use the decimals column in `ez_asset_metadata` or join {% docs evm_prices_is_imputed %} -A flag indicating if the price was imputed, or derived, from the last arriving record. This is generally used for tokens with low-liquidity or inconsistent reporting. +Boolean flag indicating whether the price was imputed, or derived, from the last available record (TRUE or FALSE). Commonly used for low-liquidity tokens or those with inconsistent reporting. {% enddocs %} diff --git a/models/doc_descriptions/core/traces.md b/models/doc_descriptions/core/traces.md index c6b601e1f..acfa0a4e7 100644 --- a/models/doc_descriptions/core/traces.md +++ b/models/doc_descriptions/core/traces.md @@ -54,13 +54,6 @@ The gas used for this trace. {% enddocs %} -{% docs evm_traces_identifier %} - -This field represents the position and type of the trace within the transaction. - -{% enddocs %} - - {% docs evm_trace_index %} The index of the trace within the transaction. @@ -111,7 +104,7 @@ The type of internal transaction. Common trace types are `CALL`, `DELEGATECALL`, {% docs evm_trace_succeeded %} -The boolean value representing if the trace succeeded. +Boolean flag indicating whether the trace succeeded (TRUE or FALSE). {% enddocs %} diff --git a/models/doc_descriptions/core/transactions.md b/models/doc_descriptions/core/transactions.md index e521c0dab..f86ee565d 100644 --- a/models/doc_descriptions/core/transactions.md +++ b/models/doc_descriptions/core/transactions.md @@ -110,13 +110,6 @@ The position of the transaction within the block. {% enddocs %} -{% docs evm_tx_status %} - -Status of the transaction. - -{% enddocs %} - - {% docs evm_value %} The value transacted in the native asset. @@ -160,51 +153,52 @@ The s value of the transaction signature. {% docs evm_v %} -The v value of the transaction signature. +The v value of the transaction signature which represents the recovery identifier. {% enddocs %} + {% docs evm_tx_succeeded %} -Whether the transaction was successful, returned as a boolean. +Boolean flag indicating whether the transaction was successful (TRUE or FALSE). {% enddocs %} + {% docs evm_tx_fee_precise %} The precise amount of the transaction fee. This is returned as a string to avoid precision loss. {% enddocs %} + {% docs evm_tx_type %} The type of transaction. {% enddocs %} + {% docs evm_mint %} The minting event associated with the transaction {% enddocs %} + {% docs evm_source_hash %} The hash of the source transaction that created this transaction {% enddocs %} + {% docs evm_eth_value %} The eth value for the transaction {% enddocs %} -{% docs evm_chain_id %} - -The unique identifier for the chain the transaction was executed on. - -{% enddocs %} {% docs evm_l1_fee_precise_raw %} @@ -212,36 +206,42 @@ The raw l1 fee for the transaction, in Gwei. {% enddocs %} + {% docs evm_l1_fee_precise %} The precise l1 fee for the transaction, in Gwei. {% enddocs %} + {% docs evm_y_parity %} The y parity for the transaction. {% enddocs %} + {% docs evm_access_list %} The access list for the transaction. {% enddocs %} + {% docs evm_l1_base_fee_scalar %} The scalar l1 base fee for the transaction. {% enddocs %} + {% docs evm_l1_blob_base_fee %} The blob base fee for the transaction. {% enddocs %} + {% docs evm_l1_blob_base_fee_scalar %} The scalar blob base fee for the transaction. diff --git a/models/doc_descriptions/core/transfers.md b/models/doc_descriptions/core/transfers.md index 106c64189..555a52205 100644 --- a/models/doc_descriptions/core/transfers.md +++ b/models/doc_descriptions/core/transfers.md @@ -118,14 +118,14 @@ The sending address of this transfer. {% docs evm_transfer_has_decimal %} -Whether or not our contracts model contains the necessary decimal adjustment for this token. +Boolean flag indicating whether decimal information is available for this token (TRUE or FALSE). {% enddocs %} {% docs evm_transfer_has_price %} -Whether or not our prices model contains this hourly token price. +Boolean flag indicating whether hourly price data is available for this token (TRUE or FALSE). {% enddocs %} diff --git a/models/doc_descriptions/general/complete_general.md b/models/doc_descriptions/general/complete_general.md index 17d63f476..9ed959bb5 100644 --- a/models/doc_descriptions/general/complete_general.md +++ b/models/doc_descriptions/general/complete_general.md @@ -1,15 +1,3 @@ -{% docs evm_internal_column %} - -Deprecated. This column is no longer used. Please remove from your query by Jan. 10 2024. - -{% enddocs %} - -{% docs evm_amount_deprecation %} - -This column is being deprecated for standardization purposes on Jan. 10 2024. Please use the equivalent column without the native asset prefix. For example, use `amount` instead of `avax_amount`. - -{% enddocs %} - {% docs evm_block_number %} Also known as block height. The block number, which indicates the length of the blockchain, increases after the addition of each new block. @@ -18,7 +6,7 @@ Also known as block height. The block number, which indicates the length of the {% docs evm_block_timestamp %} -The date and time at which the block was produced. +The UTC date and time at which the block was produced. {% enddocs %} diff --git a/models/doc_descriptions/general/complete_labels.md b/models/doc_descriptions/general/complete_labels.md index d5b0e9d53..4bc8073fe 100644 --- a/models/doc_descriptions/general/complete_labels.md +++ b/models/doc_descriptions/general/complete_labels.md @@ -13,7 +13,7 @@ The labels table is a store of one-to-one address identifiers, or an address nam {% docs evm_project_name %} -The name of the project for this address. +The project or protocol name associated with this address {% enddocs %} diff --git a/models/doc_descriptions/governance/L1_submission_fields.md b/models/doc_descriptions/governance/L1_submission_fields.md index 828272ab6..05af8e2f6 100644 --- a/models/doc_descriptions/governance/L1_submission_fields.md +++ b/models/doc_descriptions/governance/L1_submission_fields.md @@ -18,7 +18,7 @@ The min block on the OP stack L2 chain this batch relates to. {% docs evm_batch_root %} -Root of the batch, either for submission or state on the OP stack L2 chain. +Merkle root hash of the batch data, used for either submission or state verification on the OP stack L2 chain. {% enddocs %} @@ -30,13 +30,13 @@ The Ethereum block number that contained the batch from the OP stack L2 chain. {% docs evm_l1_block_time %} -The timestamp of the Ethereum block that contained this batch from the OP stack L2 chain. +The UTC timestamp of the Ethereum block that contained this batch from the OP stack L2 chain {% enddocs %} {% docs evm_l1_fee %} -The L1 portion of fees paid. +The portion of transaction fees paid for L1 (Ethereum mainnet) operations. {% enddocs %} @@ -84,7 +84,7 @@ The L1 tx hash of when this block was submitted to L1. This column will be depre {% docs evm_prev_total_elements %} -Confirmed blocks prior to this batch on the OP stack L2 chain. +Total number of confirmed blocks on the OP stack L2 chain prior to this batch. {% enddocs %} From 78039520510623d72bb39367ef0e9414ddb7d4c5 Mon Sep 17 00:00:00 2001 From: San Yong <22216004+SanYongxie@users.noreply.github.com> Date: Tue, 22 Apr 2025 23:01:47 +0800 Subject: [PATCH 3/3] updated dex lending nft bridge schemas --- models/doc_descriptions/defi/bridge.md | 2 +- models/doc_descriptions/defi/dex.md | 22 ++-- models/doc_descriptions/defi/lending.md | 12 +- models/doc_descriptions/nft/nft.md | 156 ++++++++---------------- 4 files changed, 69 insertions(+), 123 deletions(-) diff --git a/models/doc_descriptions/defi/bridge.md b/models/doc_descriptions/defi/bridge.md index 0283b9ef8..7893a36e0 100644 --- a/models/doc_descriptions/defi/bridge.md +++ b/models/doc_descriptions/defi/bridge.md @@ -60,7 +60,7 @@ The address associated with the token that is being bridged. It provides a uniqu {% docs evm_bridge_token_symbol %} -The symbol representing the token being bridged. This provides a shorthand representation of the token. +The symbol representing the token being bridged (e.g. WETH, USDC). {% enddocs %} diff --git a/models/doc_descriptions/defi/dex.md b/models/doc_descriptions/defi/dex.md index 93724d245..f80edd5df 100644 --- a/models/doc_descriptions/defi/dex.md +++ b/models/doc_descriptions/defi/dex.md @@ -25,7 +25,7 @@ The block number at which this liquidity pool was created on the blockchain. {% docs evm_dex_creation_time %} -The timestamp of the block when this liquidity pool was created. +The UTC timestamp of the block when this liquidity pool was created. {% enddocs %} @@ -37,7 +37,7 @@ The transaction that created this liquidity pool contract. {% docs evm_dex_factory_address %} -The address that deployed this liquidity pool, where available. +The factory contract address that deployed this liquidity pool, where available. {% enddocs %} @@ -103,49 +103,49 @@ The contract address for the liquidity pool. {% docs evm_dex_pool_name %} -The name of the liquidity pool, where available. In some cases, the pool name is a concatenation of symbols or token addresses. +The name of the liquidity pool, where available. In some cases, the pool name is a concatenation of symbols or token addresses and may include other information such a tick spacing or fee tier. {% enddocs %} {% docs evm_dex_swaps_amount_in %} -The amount of tokens put into the swap. +The decimal-adjusted amount of tokens put into the swap. {% enddocs %} {% docs evm_dex_swaps_amount_in_unadj %} -The non-decimal adjusted amount of tokens put into the swap. +The raw amount of tokens input into the swap (not decimal-adjusted). {% enddocs %} {% docs evm_dex_swaps_amount_in_usd %} -The amount of tokens put into the swap converted to USD using the price of the token. +The USD value of tokens put into the swap, based on hourly token price. {% enddocs %} {% docs evm_dex_swaps_amount_out %} -The amount of tokens taken out of or received from the swap. +The decimal-adjusted amount of tokens taken out of or received from the swap. {% enddocs %} {% docs evm_dex_swaps_amount_out_unadj %} -The non-decimal adjusted amount of tokens taken out of or received from the swap. +The raw amount of tokens taken out of or received from the swap (not decimal-adjusted). {% enddocs %} {% docs evm_dex_swaps_amount_out_usd %} -The amount of tokens taken out of or received from the swap converted to USD using the price of the token. +The USD value of tokens taken out of or received from the swap, based on hourly token price. {% enddocs %} {% docs evm_dex_swaps_sender %} -The Router is the Sender in the swap function. +The router contract address that initiated the swap function. {% enddocs %} @@ -157,7 +157,7 @@ The symbol of the token sent for swap. {% docs evm_dex_swaps_symbol_out %} -The symbol of the token being swapped to. +The symbol of the token received from swap. {% enddocs %} diff --git a/models/doc_descriptions/defi/lending.md b/models/doc_descriptions/defi/lending.md index 24f9e42a6..4585bd01b 100644 --- a/models/doc_descriptions/defi/lending.md +++ b/models/doc_descriptions/defi/lending.md @@ -96,7 +96,7 @@ The amount of debt the user must cover, valued in USD. {% docs evm_complete_lending_depositor_address %} -The depositor's address. +The address of the user who initiated the deposit action. {% enddocs %} @@ -306,7 +306,7 @@ The total USD value of debt tokens, representing a debt to the protocol with a v {% docs evm_complete_lending_utilization_rate %} -The percentage of assets loaned out. +The percentage of total assets that are currently loaned out. {% enddocs %} @@ -318,7 +318,7 @@ Debt tokens are interest-accruing tokens that are minted and burned on borrow an {% docs evm_complete_lending_version %} -The contract version. Example: v1, v2 +The version of the lending protocol contract (e.g. v1, v2). {% enddocs %} @@ -348,7 +348,7 @@ The protocol's specific lending asset token. {% docs evm_complete_lending_borrower %} -Address that initiated the borrow event. +The address of the user who initiated the borrow action {% enddocs %} @@ -378,7 +378,7 @@ The symbol of the token associated with the lending action. {% docs evm_complete_lending_depositor %} -Address that initiated a deposit event. +The address of the user who initiated the deposit action {% enddocs %} @@ -414,6 +414,6 @@ The flashloaned token symbol. {% docs evm_borrower %} -It's the address of the user who is borrowing or repaying the loan, depending on the action. +The address of the user who initiated the borrow action. {% enddocs %} \ No newline at end of file diff --git a/models/doc_descriptions/nft/nft.md b/models/doc_descriptions/nft/nft.md index f78d4cdbf..81459bd75 100644 --- a/models/doc_descriptions/nft/nft.md +++ b/models/doc_descriptions/nft/nft.md @@ -1,48 +1,36 @@ -{% docs evm_nft_events_table_doc %} - -This table contains NFT sales on this EVM blockchain. More NFT marketplaces will be added over time. - -{% enddocs %} - {% docs evm_ez_nft_sales_table_doc %} -This table contains NFT sale events from various marketplaces. - -{% enddocs %} - -{% docs evm_ez_nft_mint_table_doc %} - -This table contains NFT mint events, defined as NFT transfers from a burn address to an address, on this EVM blockchain. +A convenience table that aggregates NFT sale events across multiple marketplaces, including platform fees, creator royalties, transaction currency, and USD price data where available. {% enddocs %} {% docs evm_ez_nft_transfer_table_doc %} -This table contains NFT transfer events on this EVM blockchain. +A convenience table that aggregates NFT transfer events on this EVM blockchain, including both ERC-721 and ERC-1155 token transfers. {% enddocs %} {% docs evm_lending_repayments_table_doc %} -This table contains repayment events for loans backed by collateralized NFTs on this EVM blockchain. Events in this table can be a full repayment either by the borrower to get their collateral back or by a new lender to repay the borrower's previous loan. The latter is labeled as refinance where the same borrower takes on a new loan from a new lender and repays the past loan. The NFT collateral is still locked in this scenario. +This table contains loan repayment events for loans backed by collateralized NFTs on this EVM blockchain. Events in this table can be a full repayment either by the borrower to get their collateral back or by a new lender to repay the borrower's previous loan. The latter is labeled as refinance where the same borrower takes on a new loan from a new lender and repays the past loan. The NFT collateral is still locked in this scenario. {% enddocs %} {% docs evm_nft_aggregator_name %} -The name of the aggregator platform where the sale took place. If the sale did not take place via an aggregator platform, then the value will be null. +The name of the aggregator platform used in the sale of the NFT. If the sale did not take place via an aggregator platform, then the value will be null. {% enddocs %} {% docs evm_nft_amount %} -The total amount, specified by the mint token address, used as payment to mint the specified number of NFTs corresponding to this token id. +The total amount in the specified token, used as payment to mint the specified number of NFTs corresponding to this token ID(s). This only includes tokens paid and payments in the native asset would return a null value. {% enddocs %} {% docs evm_nft_amount_usd %} -The USD value of amount. +The USD value of the total amount of tokens paid to mint the specified number of NFTs corresponding to this token ID(s), based on hourly token prices if available. {% enddocs %} @@ -54,7 +42,7 @@ The block number at which the NFT event occurred. {% docs evm_nft_blocktime %} -The block timestamp at which the NFT event occurred. +The UTC date and time at which the NFT event occurred. {% enddocs %} @@ -72,43 +60,43 @@ The decimal adjusted amount of fees paid to the NFT collection as royalty paymen {% docs evm_nft_creator_fee_usd %} -The amount of fees paid to the NFT collection as royalty payments for this NFT event in US dollars. +The USD value of the tokens paid to the NFT collection as royalty payments for this NFT event. {% enddocs %} {% docs evm_nft_currency_address %} -The token contract address for this NFT event. This will be the native asset for native transactions. +The contract address of the token used in this NFT event. This will be the native asset for native transactions. {% enddocs %} {% docs evm_nft_currency_symbol %} -The token symbol for this NFT event. +The symbol of the token used in this NFT event. {% enddocs %} {% docs evm_nft_quantity %} -The number of NFTs transferred in this event by token_id. All ERC-721 tokens will have a value of 1 while ERC-1155 tokens may have a value of 1 or greater. +The number of NFTs transferred in this event, counting distinct token IDs. All ERC-721 tokens will have a value of 1 while ERC-1155 tokens may have a value of 1 or greater. {% enddocs %} {% docs evm_nft_event_index %} -The event number within a transaction. +The order index of the event within a transaction. {% enddocs %} {% docs evm_nft_event_type %} -The type of NFT event in this transaction, either sale, bid_won, redeem, or mint. +The type of NFT event in this transaction: sale, bid_won, redeem, or mint. {% enddocs %} {% docs evm_nft_from_address %} -The sending address of the NFT in the transaction. +The address sending the NFT. {% enddocs %} @@ -120,49 +108,7 @@ The order of events within a single event index. This is primarily used for ERC1 {% docs evm_nft_metadata %} -The token metadata for this NFT. This may be blank for many NFTs. We are working to expand this field. - -{% enddocs %} - -{% docs evm_nft_mint_count %} - -The number of NFTs minted in this event. - -{% enddocs %} - -{% docs evm_nft_mint_price %} - -The price paid in the native asset to mint the NFT(s). - -{% enddocs %} - -{% docs evm_nft_mint_price_usd %} - -The price paid in US dollars to mint the NFT(s). - -{% enddocs %} - -{% docs evm_nft_mints_symbol %} - -The symbol of the token supplied to mint the NFT, if applicable. This field may not handle all edge cases. - -{% enddocs %} - -{% docs evm_nft_mints_token_address %} - -The contract address of the token supplied to mint the NFT, if applicable. This field may not handle all edge cases. - -{% enddocs %} - -{% docs evm_nft_mints_token_price %} - -The decimal adjusted amount of tokens supplied within the same transaction to mint the NFT. This field may not handle all edge cases. - -{% enddocs %} - -{% docs evm_nft_mints_token_price_usd %} - -The amount of tokens supplied in US dollars within the same transaction to mint the NFT. This field may not handle all edge cases. +The token metadata for this NFT. This may include token name, token description and image url when applicable. This may be blank for many NFTs and are working to expand this field. {% enddocs %} @@ -192,13 +138,13 @@ The to address of this transaction. In most cases, this is the exchange contract {% docs evm_nft_platform_address %} -The address of the exchange used for the transaction. +The contract address of the exchange platform used for the transaction. {% enddocs %} {% docs evm_nft_platform_exchange_version %} -The version of the exchange contract used for the transaction. +The version identifier of the exchange contract used for the transaction. {% enddocs %} @@ -210,13 +156,13 @@ The decimal adjusted amount of fees paid to the platform for this NFT event in t {% docs evm_nft_platform_fee_usd %} -The amount of fees paid to the platform for this NFT event in US dollars. There are cases where there are fees paid to multiple marketplaces. In those cases, the fee in the platform_fee column will only reflect the platform fee related to the platform exchange contract. +The USD value of fees paid to the platform for this NFT event. There are cases where there are fees paid to multiple marketplaces. In those cases, the fee in the platform_fee column will only reflect the platform fee related to the platform exchange contract. {% enddocs %} {% docs evm_nft_platform_name %} -The name of the exchange used for the trade. +The name of the exchange platform used for the transaction. {% enddocs %} @@ -228,7 +174,7 @@ The total price of the NFT, in the currency in which the transaction occurred an {% docs evm_nft_price_usd %} -The total price of the NFT in US dollars. This will be 0 for tokens without a decimal adjustment or hourly price. Please note that the price of the NFT, after subtracting total fees, may not represent the net amount paid to the seller in all cases. You may refer to the platform fee description for more info. +The USD value of total price of the NFT. This will be 0 for tokens without a decimal adjustment or hourly price. Please note that the price of the NFT, after subtracting total fees, may not represent the net amount paid to the seller in all cases. You may refer to the platform fee description for more info. {% enddocs %} @@ -264,25 +210,25 @@ The token ID for this NFT contract. {% docs evm_nft_total_fees %} -The total amount of fees paid relating to the NFT purchase in the transaction currency. This includes royalty payments to creators and platform fees. Please note, this does not include the gas fee. +The total amount of fees paid relating to the NFT purchase in the transaction currency, including creator royalty payments to creators and platform fees. Please note, this does not include the gas fee. {% enddocs %} {% docs evm_nft_total_fees_usd %} -The total amount of fees paid relating to the NFT purchase in US dollars. This includes royalty payments to creators and platform fees. Please note, this does not include the gas fee. +The USD value of fees paid relating to the NFT purchase in US dollars, including creator royalty payments to creators and platform fees. Please note, this does not include the gas fee. {% enddocs %} {% docs evm_nft_tx_fee %} -The gas fee for this transaction in the native asset. +The gas fee paid for this transaction in the native asset. {% enddocs %} {% docs evm_nft_tx_fee_usd %} -The gas fee for this transaction in US dollars. +The USD value of the gas fee paid for this transaction. {% enddocs %} @@ -294,7 +240,7 @@ The transaction hash for the NFT event. This is not necessarily unique in this t {% docs evm_nft_lending_liquidations_table_doc %} -This table contains liquidation events for loans backed by collateralized NFTs on this EVM blockchain. This typically means the lender of the loan closes the loan and receives the NFT collateral. +This table contains liquidation events for loans backed by collateralized NFTs on this EVM blockchain. This typically means the lender of the loan closes the loan and claims the NFT collateral due to loan default. {% enddocs %} @@ -330,37 +276,37 @@ The unique ID that can be used to represent a loan within the same platform. For {% docs evm_lender_address %} -The address that gives out a loan to the borrower. When a loan is issued, a promissory note (an ERC721) is issued to the lender. The lender can transfer this note to any address which makes any receiving address the new lender. +The address that provides the loan to the borrower. When a loan is issued, a promissory note (an ERC721) is issued to the lender. The lender can transfer this note to any address which makes any receiving address the new lender. {% enddocs %} {% docs evm_borrower_address %} -The address that receives the loan and has an NFT locked as collateral. +The address of the loan recipient, whose NFT is held as collateral. {% enddocs %} {% docs evm_nft_address %} -The address of the NFT used as collateral. +The contract address of the NFT used as collateral. {% enddocs %} {% docs evm_tokenid %} -The tokenId of the NFT used as collateral. +The token ID of the NFT used as collateral. {% enddocs %} {% docs evm_loan_token_address %} -The contract address of what the loan is denominated in. This could be either the native asset or other tokens. +The contract address of the loan currency (native asset or other tokens). {% enddocs %} {% docs evm_loan_token_symbol %} -The symbol of the loan token address. +The symbol of the loan currency. {% enddocs %} @@ -378,7 +324,7 @@ The principal amount of the loan taken with adjusted decimal places. {% docs evm_principal_usd %} -The principal amount of the loan taken in USD terms. +The USD value of the principal amount of the loan taken. {% enddocs %} @@ -390,7 +336,7 @@ The non-annualized rate charged by the lender on the principal amount of the loa {% docs evm_apr %} -The annualized interest rate denominated in percentage (%). +The annualized interest rate of the loan denominated in percentage (%). {% enddocs %} @@ -402,13 +348,13 @@ The type of loan terms, could be either a fixed loan or a perpetual loan. A fixe {% docs evm_loan_start_timestamp %} -The timestamp of when the loan offer is accepted. +The UTC timestamp of when the loan offer is accepted. {% enddocs %} {% docs evm_loan_due_timestamp %} -The timestamp of when the loan is due. For perpetual term loan, the value will be null. +The UTC timestamp of when the loan is due. For perpetual term loan, the value will be null. {% enddocs %} @@ -420,7 +366,7 @@ The tenure of the loan denominated in seconds. For perpetual term loan, the valu {% docs evm_lending_loans %} -This table contains NFT lending events for loans backed by collateralized NFTs on this EVM blockchain. This could be depositing an NFT and taking out a loan or using the Buy Now Pay Later (BNPL) feature to take a loan out of the newly bought NFT. This NFT will remain locked until the loan is cleared. +This table contains NFT lending events for loans backed by collateralized NFTs on this EVM blockchain. This could be depositing an NFT and taking out a loan or using the Buy Now Pay Later (BNPL) feature to take a loan out of the newly bought NFT. The NFT collateral remains locked until the loan is repaid. {% enddocs %} @@ -444,7 +390,7 @@ The total debt of the loan (principal amount plus interests) with adjusted decim {% docs evm_debt_usd %} -The total debt of the loan (principal amount plus interests) in USD terms. +The USD value of the total debt of the loan (principal amount plus interests). {% enddocs %} @@ -462,13 +408,13 @@ The fee charged by the lending platform with adjusted decimal places. {% docs evm_platform_fee_usd %} -The fee charged by the lending platform in USD terms. +The USD value of the fee charged by the lending platform. {% enddocs %} {% docs evm_mev_arbitrage %} -This table contains the financial metrics from NFT arbitrage transactions including cost, revenue and profits. +This table contains financial metrics for NFT arbitrage transactions, including purchase costs, sale revenues, and net profits. {% enddocs %} @@ -486,19 +432,19 @@ The contract address that the MEV searcher uses to execute mev transactions, tak {% docs evm_cost_usd %} -The total cost in USD to purchase the NFT(s) in the transaction. +The USD value of the total cost to purchase the NFT(s) in the transaction. {% enddocs %} {% docs evm_revenue_usd %} -The total revenue in USD from selling the NFT(s) and other related tokens in the transaction. +The USD value of the total revenue from selling the NFT(s) and other related tokens in the transaction. {% enddocs %} {% docs evm_miner_tip_usd %} -The total amount in USD sent to the block miner/builder as a tip to include the transaction in the block. +The USD value of the total amount sent to the block miner/builder as a tip to include the transaction in the block. {% enddocs %} @@ -534,49 +480,49 @@ The side of the trade that this event represents. This can be either buy or sell {% docs evm_dim_nft_collection_metadata %} -This table contains the metadata for popular NFT collections on this EVM blockchain. +This table contains the metadata for popular NFT collections on this EVM blockchain, which may include collection names, token traits, and other descriptive information. {% enddocs %} {% docs evm_nft_blockchain %} -Blockchain where the NFT metadata is retrieved from. +The source blockchain where the NFT metadata is retrieved from. {% enddocs %} {% docs evm_collection_name %} -The name for this NFT collection. +The name of this NFT collection. {% enddocs %} {% docs evm_tokenid_name %} -The name for this specific tokenId. This may be the same for all tokenIds within the same collection. +The name for this specific token ID. This may be the same for all token IDs within the same collection. {% enddocs %} {% docs evm_traits %} -The traits for this tokenId in a key-value pair format. +The traits for this token ID in a key-value pair format. {% enddocs %} {% docs evm_tokenid_description %} -The description for this specific tokenId. This may be the same for all tokenIds within the same collection. +The description for this specific token ID. This may be the same for all token IDs within the same collection. {% enddocs %} {% docs evm_tokenid_image_url %} -The url of the image for this tokenId. +The url of the image for this token ID. {% enddocs %} {% docs evm_nft_address_tokenid %} -The concatenation of NFT address and tokenId. +The concatenation of NFT address and token ID. {% enddocs %} @@ -588,6 +534,6 @@ The type of token and NFT transfer event, for example `erc721_Transfer`, `erc115 {% docs evm_nft_is_mint %} -Whether the event is a mint event. +Boolean flag indicating whether the event is a NFT mint event. {% enddocs %}