An 1179/docs (#9)

* docs

* attribute descriptions

* attributes docs

* docs generated

models/descriptions/_event_data_fields.md

@@ -0,0 +1,5 @@
+{% docs _event_data_fields %}
+
+The fields object from the event_data.
+
+{% enddocs %}

models/descriptions/_event_data_type.md

@@ -0,0 +1,5 @@
+{% docs _event_data_type %}
+
+The type object from event_data.
+
+{% enddocs %}

models/descriptions/_ingested_at.md

@@ -0,0 +1,5 @@
+{% docs _ingested_at %}
+
+When the record was ingested by the chainwalker.
+
+{% enddocs %}

models/descriptions/attribute_id.md

@@ -0,0 +1,5 @@
+{% docs attribute_id %}
+
+ID for the attribute, which is a concatenation of tx_id-event_index-attribute_index.
+
+{% enddocs %}

models/descriptions/attribute_index.md

@@ -0,0 +1,5 @@
+{% docs attribute_index %}
+
+Index of the attribute within the event, corresponds with how the attributes are presented on the explorer.
+
+{% enddocs %}

models/descriptions/attribute_key.md

@@ -0,0 +1,5 @@
+{% docs attribute_key %}
+
+The key of the attribute key-value pair. This is the label while attribute_value is the data.
+
+{% enddocs %}

models/descriptions/attribute_value.md

@@ -0,0 +1,5 @@
+{% docs attribute_value %}
+
+The value of the attribute key-value pair. This is the data that attribute_key labels.
+
+{% enddocs %}

models/descriptions/attribute_value_adj.md

@@ -0,0 +1,5 @@
+{% docs attribute_value_adj %}
+
+The adjusted attribute_value where an address from decoded_address is used in place of the encoded binary string, where applicable.
+
+{% enddocs %}

models/descriptions/authorizers.md

@@ -0,0 +1,5 @@
+{% docs authorizers %}
+
+Address(es) authorizing the transaction.
+
+{% enddocs %}

models/descriptions/block_height.md

@@ -0,0 +1,6 @@
+
+{% docs block_height %}
+
+The block height the block was recorded at.
+
+{% enddocs %}

models/descriptions/block_timestamp.md

@@ -0,0 +1,5 @@
+{% docs block_timestamp %}
+
+The date and time for when the block was written.
+
+{% enddocs %}

models/descriptions/chain_id.md

@@ -0,0 +1,5 @@
+{% docs chain_id %}
+
+The id for the chain of the network on which this block occurred.
+
+{% enddocs %}

models/descriptions/count_authorizers.md

@@ -0,0 +1,5 @@
+{% docs count_authorizers %}
+
+Number of authorizers
+
+{% enddocs %}

models/descriptions/decoded_address.md

@@ -0,0 +1,5 @@
+{% docs decoded_address %}
+
+The decoded address, if applicable, for the attribute_value.
+
+{% enddocs %}

models/descriptions/event_contract.md

@@ -0,0 +1,5 @@
+{% docs event_contract %}
+
+The contract called for this event. This is equivalent to the Contract column on Flowscan.
+
+{% enddocs %}

models/descriptions/event_data.md

@@ -0,0 +1,5 @@
+{% docs event_data %}
+
+The raw event data from the event.
+
+{% enddocs %}

models/descriptions/event_id.md

@@ -0,0 +1,5 @@
+{% docs event_id %}
+
+The id for the event, which is a concatenation of tx_id-event_index.
+
+{% enddocs %}

models/descriptions/event_index.md

@@ -0,0 +1,5 @@
+{% docs event_index %}
+
+The index of the event within the transaction, i.e. in what order the events occurred.
+
+{% enddocs %}

models/descriptions/event_type.md

@@ -0,0 +1,5 @@
+{% docs event_type %}
+
+The type of method called on the event_contract. This is equivalent to the Type column on Flowscan.
+
+{% enddocs %}

models/descriptions/gas_limit.md

@@ -0,0 +1,5 @@
+{% docs gas_limit %}
+
+Upper gas limit attached to the transaction.
+
+{% enddocs %}

models/descriptions/id.md

@@ -0,0 +1,5 @@
+{% docs id %}
+
+The block hash.
+
+{% enddocs %}

models/descriptions/network.md

@@ -0,0 +1,5 @@
+{% docs network %}
+
+The blockchain network the block or transaction occurred on.
+
+{% enddocs %}

models/descriptions/parent_id.md

@@ -0,0 +1,5 @@
+{% docs parent_id %}
+
+The block hash for the parent block.
+
+{% enddocs %}

models/descriptions/payer.md

@@ -0,0 +1,5 @@
+{% docs payer %}
+
+Address of the wallet paying for the transaction.
+
+{% enddocs %}

models/descriptions/proposer.md

@@ -0,0 +1,5 @@
+{% docs proposer %}
+
+Address of the transaction proposer.
+
+{% enddocs %}

models/descriptions/transaction_result.md

@@ -0,0 +1,5 @@
+{% docs transaction_result %}
+
+Outcome of the transaction, including events that were called.
+
+{% enddocs %}

models/descriptions/tx_count.md

@@ -0,0 +1,5 @@
+{% docs tx_count %}
+
+The number of transactions in the block.
+
+{% enddocs %}

models/descriptions/tx_id.md

@@ -0,0 +1,5 @@
+{% docs tx_id %}
+
+ID for the transaction.
+
+{% enddocs %}

models/descriptions/tx_succeeded.md

@@ -0,0 +1,5 @@
+{% docs tx_succeeded %}
+
+Transaction status, if it succeeded or failed.
+
+{% enddocs %}

models/silver/silver__blocks.yml

@@ -7,7 +7,7 @@ models:
 
     columns:
       - name: block_height
-        description: tbd
+        description: "{{ doc('block_height') }}"
         tests:
           - not_null
           - unique
@@ -17,7 +17,7 @@ models:
                 - FLOAT
 
       - name: block_timestamp
-        description: tbd
+        description: "{{ doc('block_timestamp') }}"
         tests:
           - not_null
           - dbt_expectations.expect_row_values_to_have_recent_data:
@@ -28,7 +28,7 @@ models:
                 - TIMESTAMP_NTZ
 
       - name: network
-        description: tbd
+        description: "{{ doc('network') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -37,7 +37,7 @@ models:
                 - VARCHAR
 
       - name: chain_id
-        description: tbd
+        description: "{{ doc('chain_id') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -46,7 +46,7 @@ models:
                 - VARCHAR
 
       - name: tx_count
-        description: tbd
+        description: "{{ doc('tx_count') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -54,7 +54,7 @@ models:
                 - NUMBER
 
       - name: id
-        description: tbd
+        description: "{{ doc('id') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -63,7 +63,7 @@ models:
                 - VARCHAR
 
       - name: parent_id
-        description: tbd
+        description: "{{ doc('parent_id') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -72,7 +72,7 @@ models:
                 - VARCHAR
 
       - name: _ingested_at
-        description: tbd
+        description: "{{ doc('_ingested_at') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:

models/silver/silver__event_attributes.yml

@@ -14,7 +14,7 @@ models:
 
     columns:
       - name: attribute_id
-        description: tbd
+        description: "{{ doc('attribute_id') }}"
         tests:
           - not_null
           - unique
@@ -24,7 +24,7 @@ models:
                 - VARCHAR
 
       - name: event_id
-        description: tbd
+        description: "{{ doc('event_id') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -33,12 +33,12 @@ models:
                 - VARCHAR
 
       - name: tx_id
-        description: tbd
+        description: "{{ doc('tx_id') }}"
         tests:
           - not_null
 
       - name: block_timestamp
-        description: tbd
+        description: "{{ doc('block_timestamp') }}"
         tests:
           - not_null
           - dbt_expectations.expect_row_values_to_have_recent_data:
@@ -49,7 +49,7 @@ models:
                 - TIMESTAMP_NTZ
 
       - name: event_index
-        description: tbd
+        description: "{{ doc('event_index') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -57,7 +57,7 @@ models:
                 - NUMBER
 
       - name: attribute_index
-        description: tbd
+        description: "{{ doc('attribute_index') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -65,7 +65,7 @@ models:
                 - NUMBER
 
       - name: event_contract
-        description: tbd
+        description: "{{ doc('event_contract') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -74,7 +74,7 @@ models:
                 - VARCHAR
 
       - name: event_type
-        description: tbd
+        description: "{{ doc('event_type') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -83,7 +83,7 @@ models:
                 - VARCHAR
 
       - name: attribute_key
-        description: tbd
+        description: "{{ doc('attribute_key') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -92,19 +92,19 @@ models:
                 - VARCHAR
 
       - name: decoded_address
-        description: tbd
+        description: "{{ doc('decoded_address') }}"
         tests:
 
       - name: attribute_value
-        description: tbd
+        description: "{{ doc('attribute_value') }}"
         tests:
 
       - name: attribute_value_adj
-        description: tbd
+        description: "{{ doc('attribute_value_adj') }}"
         tests:
                 
       - name: _ingested_at
-        description: tbd
+        description: "{{ doc('_ingested_at') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:

models/silver/silver__events.yml

@@ -13,18 +13,18 @@ models:
 
     columns:
       - name: event_id
-        description: tbd
+        description: "{{ doc('event_id') }}"
         tests:
           - not_null
           - unique
 
       - name: tx_id
-        description: tbd
+        description: "{{ doc('tx_id') }}"
         tests:
           - not_null
 
       - name: block_timestamp
-        description: tbd
+        description: "{{ doc('block_timestamp') }}"
         tests:
           - not_null
           - dbt_expectations.expect_row_values_to_have_recent_data:
@@ -35,7 +35,7 @@ models:
                 - TIMESTAMP_NTZ
 
       - name: block_height
-        description: tdb
+        description: "{{ doc('block_height') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -44,7 +44,7 @@ models:
                 - FLOAT  
 
       - name: tx_succeeded
-        description: tbd
+        description: "{{ doc('tx_succeeded') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -52,7 +52,7 @@ models:
                 - BOOLEAN
 
       - name: event_index
-        description: tbd
+        description: "{{ doc('event_index') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -60,7 +60,7 @@ models:
                 - NUMBER
 
       - name: event_contract
-        description: tbd
+        description: "{{ doc('event_contract') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -69,7 +69,7 @@ models:
                 - VARCHAR
 
       - name: event_type
-        description: tbd
+        description: "{{ doc('event_type') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -78,7 +78,7 @@ models:
                 - VARCHAR
 
       - name: event_data
-        description: tbd
+        description: "{{ doc('event_data') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -86,7 +86,7 @@ models:
                 - VARIANT
 
       - name: _event_data_type
-        description: tbd
+        description: "{{ doc('_event_data_type') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -94,7 +94,7 @@ models:
                 - VARIANT
 
       - name: _event_data_fields
-        description: tbd
+        description: "{{ doc('_event_data_fields') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -102,7 +102,7 @@ models:
                 - VARIANT
 
       - name: _ingested_at
-        description: tbd
+        description: "{{ doc('_ingested_at') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:

models/silver/silver__transactions.yml

@@ -13,13 +13,13 @@ models:
 
     columns:
       - name: tx_id
-        description: ID for the transaction.
+        description: "{{ doc('tx_id') }}"
         tests:
           - not_null
           - unique
 
       - name: block_timestamp
-        description: Timestamp of when the block occurred.
+        description: "{{ doc('block_timestamp') }}"
         tests:
           - not_null
           - dbt_expectations.expect_row_values_to_have_recent_data:
@@ -30,7 +30,7 @@ models:
                 - TIMESTAMP_NTZ
 
       - name: block_height
-        description: Height of the block.
+        description: "{{ doc('block_height') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -39,7 +39,7 @@ models:
                 - FLOAT  
 
       - name: chain_id
-        description: Name of the chain on which the block was written.
+        description: "{{ doc('chain_id') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -56,7 +56,7 @@ models:
                 - NUMBER    
 
       - name: proposer
-        description: Address of the transaction proposer.
+        description: "{{ doc('proposer') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -65,7 +65,7 @@ models:
               - VARCHAR
 
       - name: payer
-        description: Address of the wallet paying for the transaction.
+        description: "{{ doc('payer') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -74,7 +74,7 @@ models:
               - VARCHAR
 
       - name: authorizers
-        description: Address(es) authorizing the transaction.
+        description: "{{ doc('authorizers') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -82,7 +82,7 @@ models:
                 - ARRAY
 
       - name: count_authorizers
-        description: Number of authorizers.
+        description: "{{ doc('count_authorizers') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -90,7 +90,7 @@ models:
                 - NUMBER
 
       - name: gas_limit
-        description: Upper gas limit attached to the transaction.
+        description: "{{ doc('gas_limit') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -98,7 +98,7 @@ models:
                 - NUMBER
 
       - name: transaction_result
-        description: Outcome of the transaction, including events that were called.
+        description: "{{ doc('transaction_result') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -106,7 +106,7 @@ models:
                 - VARIANT
 
       - name: tx_succeeded
-        description: Transaction status, if it succeeded or failed.
+        description: "{{ doc('tx_succeeded') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list:
@@ -123,7 +123,7 @@ models:
                 - VARCHAR
 
       - name: _ingested_at
-        description: Timestamp for when the record was ingested by the chainwalker.
+        description: "{{ doc('_ingested_at') }}"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_in_type_list: