external-models/models/doc_descriptions/general/__overview__.md
2024-05-17 20:34:18 +07:00

8.7 KiB

{% docs overview %}

Welcome to the Flipside Crypto External Models Documentation!

What does this documentation cover?

The documentation included here details the design of the External tables and views available via Flipside Crypto. The models in the External database leverage non-Flipside curated datasets and APIs. While Flipside has the ability to host these datasets, we do not have authority over the data quality or structure of the outputs. For more information on how these models are built, please see the github repository.

Token Flow: Starknet

Note: These tables ceased updating on Feburary 4th, 2024.

Token Flow Documentation

DefiLlama

DefiLlama Documentation

DeepNFTValue

DeepNFTValue Documentation

Snapshot

Snapshot Documentation

Flashbots

Flashbots Documentation

Token Lists

Token Lists Documentation

LayerZero

LayerZero Sybil Reporting Documentation

Helpful User-Defined Functions (UDFs)

UDFs are custom functions built by the Flipside team that can be used in your queries to make your life easier.

Please visit LiveQuery Functions Overview for a full list of helpful UDFs.

Data Model Overview

EXTERNAL is our blockchain-agonistic database for datasets derived from independently managed, external sources. While these models are built a few different ways, the primary method used is through calling internal functions that leverage curated datasets, such as Token Flow or DefiLlama's API endpoints, to create accessible sql models for the analytics community. These models follow our standard approach, built using three layers of sql models: bronze, silver, and gold (or core). However, when the models are built externally (non-Flipside), the naming conventions may vary and models will be placed into schemas based on the source.

  • Bronze: Data is loaded in from the source as a view
  • Silver: All necessary parsing, filtering, de-duping, and other transformations are done here
  • Gold (or core): Final views and tables that are available in Velocity

The dimension tables are sourced from a variety of on-chain and off-chain sources.

Convenience views (denoted ez_) are a combination of different fact and dimension tables.

Using dbt docs

Navigation

You can use the Project and Database navigation tabs on the left side of the window to explore the models in the project.

Database Tab

This view shows relations (tables and views) grouped into database schemas. Note that ephemeral models are not shown in this interface, as they do not exist in the database.

Graph Exploration

You can click the blue icon on the bottom-right corner of the page to view the lineage graph of your models.

On model pages, you'll see the immediate parents and children of the model you're exploring. By clicking the Expand button at the top-right of this lineage pane, you'll be able to see all of the models that are used to build, or are built from, the model you're exploring.

Once expanded, you'll be able to use the --models and --exclude model selection syntax to filter the models in the graph. For more information on model selection, check out the dbt docs.

Note that you can also right-click on models to interactively filter and explore the graph.

More information

{% enddocs %}