Flipside Utility Functions

Dbt repo for managing the Flipside Utility Functions (FSC_UTILS) dbt package.

Variables

To control the creation of UDF or SP macros with dbt run:

UPDATE_UDFS_AND_SPS When True, executes all macros included in the on-run-start hooks within dbt_project.yml on model run as normal When False, none of the on-run-start macros are executed on model run

Default values are False

Usage: dbt run --var 'UPDATE_UDFS_AND_SPS": True' -m ...

Dropping and creating udfs can also be done without running a model:

dbt run-operation create_udfs --var 'UPDATE_UDFS_AND_SPS": True' --args 'drop_:false'
dbt run-operation create_udfs --var 'UPDATE_UDFS_AND_SPS": True' --args 'drop_:true'

Adding Release Versions

Make the necessary changes to your code in your dbt package repository (e.g., fsc-utils).
Commit your changes with git add . and git commit -m "Your commit message".
Tag your commit with a version number using git tag -a v1.1.0 -m "version 1.1.0".
Push your commits to the remote repository with git push origin ....
Push your tags to the remote repository with git push origin --tags.
In the packages.yml file of your other dbt project, specify the new version of the package with:

packages:
  - git: "https://github.com/FlipsideCrypto/fsc-utils.git"
    revision: "v1.1.0"

Run dbt deps in the other dbt project to pull the specific version of the package or follow the steps on adding the dbt package below.

Adding the `fsc_utils` dbt package

The fsc_utils dbt package is a centralized repository consisting of various dbt macros and snowflake functions that can be utilized across other repos.

Navigate to the create_udfs.sql macro in your respective repo where you want to install the package.
Add the following:

{% set name %}
{{- fsc_utils.create_udfs() -}}
{% endset %}
{% do run_query(sql) %}

Note: fsc_utils.create_udfs() takes two parameters (drop_=False, schema="utils"). Set drop_ to True to drop existing functions or define schema for the functions (default set to utils). Params not required.
Navigate to packages.yml in your respective repo.
Add the following:

- git: https://github.com/FlipsideCrypto/fsc-utils.git

Run dbt deps to install the package
Run the macro dbt run-operation create_udfs --var '{"UPDATE_UDFS_AND_SPS":True}'

Overview of Available Functions

UTILS Functions

utils.udf_hex_to_int: Use this UDF to transform any hex string to integer

ex: Curve Swaps

SELECT
    regexp_substr_all(SUBSTR(DATA, 3, len(DATA)), '.{64}') AS segmented_data,
    utils.hex_to_int(segmented_data [1] :: STRING) :: INTEGER AS tokens_sold
FROM
    optimism.core.fact_event_logs
WHERE
    topics [0] :: STRING IN (
        '0x8b3e96f2b889fa771c53c981b40daf005f63f637f1869f707052d15a3dd97140',
        '0xd013ca23e77a65003c2c659c5442c00c805371b7fc1ebd4c206c41d1536bd90b'
    )

utils.udf_hex_to_string: Use this UDF to transform any hexadecimal string to a regular string, removing any non-printable or control characters from the resulting string.

ex: Token Names

WITH base AS (
SELECT
    '0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000005452617265202d204368616e74616c20486167656c202d20576f6d656e2773204575726f2032303232202d2032303232205371756164202d20576f6d656e2773204e6174696f6e616c205465616d202d2032303232000000000000000000000000' AS input_token_name
    )

SELECT 
    utils.udf_hex_to_string(SUBSTR(input_token_name,(64*2+3),LEN(input_token_name))) AS output_token_name
FROM base;

NOTE: The expression 64 * 2 + 3 in the query navigates to the 131st character of the hexadecimal string returned by an EVM blockchain contract's function, skipping metadata and adjusting for Snowflake's 1-based indexing. Keep in mind that the exact start of relevant data may vary between different contracts and functions.

Resources

Learn more about dbt in the docs
Check out Discourse for commonly asked questions and answers
Join the chat on Slack for live discussions and support
Find dbt events near you
Check out the blog for the latest news on dbt's development and best practices

4.4 KiB Raw Blame History