From 02bf91dfada5a07094a0fd82f2ac2c537099c0bc Mon Sep 17 00:00:00 2001 From: Vladimir Bobrikov Date: Tue, 9 May 2023 20:08:43 +0600 Subject: [PATCH 01/11] glossary init --- docs/Glossary.md | 32 ++++++++++++++++++++++++++++++++ docs/SUMMARY.md | 1 + 2 files changed, 33 insertions(+) create mode 100644 docs/Glossary.md diff --git a/docs/Glossary.md b/docs/Glossary.md new file mode 100644 index 000000000..0e31e6e75 --- /dev/null +++ b/docs/Glossary.md @@ -0,0 +1,32 @@ + +### DipDup Terms + +| Term | Definition | +| --- | --- | +| DipDup | An open source framework for building smart contract indexes for the Tezos network. | +| Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying. | +| Handler | | +| Hook | | +| callback | | +| Model | | +| SDK | | +| TzKT | | +| tortoise | | + +### Tezos Terms + +| Term | Definition | +| --- | --- | +| Tezos | A blockchain platform for smart contracts and decentralized applications. | + +### Infrastructure Terms + +| Term | Definition | +| --- | --- | +| Hasura | | +| GraphQL | | +| Docker | | +| Docker Compose | | +| PostgreSQL | | +| Sentry | | +| Prometheus | | \ No newline at end of file diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 61263c9c3..c942be13c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -97,4 +97,5 @@ # Community * [Contribution guide](CONTRIBUTING.md) +* [Glossary](Glossary.md) * [MIT License](LICENSE.md) From ed87c91f0edd7ecb330b47861f403ed9160e10ea Mon Sep 17 00:00:00 2001 From: Vladimir Bobrikov Date: Wed, 10 May 2023 14:08:33 +0600 Subject: [PATCH 02/11] add some definitions --- docs/Glossary.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/Glossary.md b/docs/Glossary.md index 0e31e6e75..19b5899a6 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -3,21 +3,25 @@ | Term | Definition | | --- | --- | -| DipDup | An open source framework for building smart contract indexes for the Tezos network. | -| Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying. | +| DipDup | An open source framework for building smart contract indexes for the Tezos network | +| Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying | | Handler | | | Hook | | | callback | | | Model | | | SDK | | -| TzKT | | -| tortoise | | +| TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos | +| RPC API | RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relativly to TzKT | +| tortoise | Tortoise automates data conversion between the application and the database, allowing users to manage and efficiently access data | ### Tezos Terms | Term | Definition | | --- | --- | -| Tezos | A blockchain platform for smart contracts and decentralized applications. | +| big_map | big_map object covered in [big map index page](indexes/tezos_tzkt_big_maps.md) | +| Origination | The process of deploying a new smart contract on the Tezos network, creating a new originated contract address | +| Entry points | Functions defined within a smart contract that can be called by external contract invocations or other contracts | +| Contract storage | Persistent data storage within a smart contract, holding the contract's state and any associated data | ### Infrastructure Terms From 98c3b7fa0a21f691b30b904d9311d1529d9f6d6e Mon Sep 17 00:00:00 2001 From: Vladimir Bobrikov Date: Wed, 10 May 2023 17:13:45 +0600 Subject: [PATCH 03/11] add infra definitions, overall improve --- docs/Glossary.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/Glossary.md b/docs/Glossary.md index 19b5899a6..c6014ca50 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -7,12 +7,12 @@ | Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying | | Handler | | | Hook | | -| callback | | -| Model | | -| SDK | | +| Callback | | +| Model | A Python class representing a database table, defined using the Tortoise ORM library | +| SDK | A toolkit for developing smart contract indexing applications | | TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos | -| RPC API | RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relativly to TzKT | -| tortoise | Tortoise automates data conversion between the application and the database, allowing users to manage and efficiently access data | +| RPC API | RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relativly to TzKT and other APIs | +| tortoise | A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management within the DipDup framework | ### Tezos Terms @@ -27,10 +27,10 @@ | Term | Definition | | --- | --- | -| Hasura | | -| GraphQL | | -| Docker | | -| Docker Compose | | -| PostgreSQL | | -| Sentry | | -| Prometheus | | \ No newline at end of file +| Hasura | An open-source engine that connects to databases and microservices, providing real-time GraphQL APIs for faster and efficient data access | +| GraphQL | A query language and runtime for APIs that enables clients to request only the data they need, offering more flexibility and efficiency compared to traditional REST APIs | +| Docker | An open-source platform for creating, deploying, and managing containerized applications, improving consistency and reducing infrastructure overhead | +| Docker Compose | A tool for defining and managing multi-container Docker applications, using a YAML file to configure services, networks, and volumes, simplifying application deployment and scaling | +| PostgreSQL | A powerful, open-source object-relational database system known for its reliability, robustness, and performance, widely used for managing structured data | +| Sentry | A real-time error tracking and monitoring platform that helps developers identify, diagnose, and fix issues in applications, improving overall software quality and performance | +| Prometheus | An open-source monitoring and alerting toolkit designed for reliability and scalability, used to collect and process metrics from various systems, providing valuable insights into application and infrastructure performance | \ No newline at end of file From 3ec01171052031b9d44a8903ec4bef378a4b8c96 Mon Sep 17 00:00:00 2001 From: Vladimir Bobrikov Date: Wed, 10 May 2023 23:12:22 +0600 Subject: [PATCH 04/11] sort --- docs/Glossary.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/Glossary.md b/docs/Glossary.md index c6014ca50..b8a2026be 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -1,36 +1,35 @@ - ### DipDup Terms | Term | Definition | | --- | --- | +| Callback | | | DipDup | An open source framework for building smart contract indexes for the Tezos network | -| Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying | | Handler | | | Hook | | -| Callback | | +| Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying | | Model | A Python class representing a database table, defined using the Tortoise ORM library | -| SDK | A toolkit for developing smart contract indexing applications | -| TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos | | RPC API | RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relativly to TzKT and other APIs | +| SDK | A toolkit for developing smart contract indexing applications | | tortoise | A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management within the DipDup framework | +| TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos | ### Tezos Terms | Term | Definition | | --- | --- | | big_map | big_map object covered in [big map index page](indexes/tezos_tzkt_big_maps.md) | -| Origination | The process of deploying a new smart contract on the Tezos network, creating a new originated contract address | -| Entry points | Functions defined within a smart contract that can be called by external contract invocations or other contracts | | Contract storage | Persistent data storage within a smart contract, holding the contract's state and any associated data | +| Entry points | Functions defined within a smart contract that can be called by external contract invocations or other contracts | +| Origination | The process of deploying a new smart contract on the Tezos network, creating a new originated contract address | ### Infrastructure Terms | Term | Definition | | --- | --- | -| Hasura | An open-source engine that connects to databases and microservices, providing real-time GraphQL APIs for faster and efficient data access | -| GraphQL | A query language and runtime for APIs that enables clients to request only the data they need, offering more flexibility and efficiency compared to traditional REST APIs | | Docker | An open-source platform for creating, deploying, and managing containerized applications, improving consistency and reducing infrastructure overhead | | Docker Compose | A tool for defining and managing multi-container Docker applications, using a YAML file to configure services, networks, and volumes, simplifying application deployment and scaling | +| GraphQL | A query language and runtime for APIs that enables clients to request only the data they need, offering more flexibility and efficiency compared to traditional REST APIs | +| Hasura | An open-source engine that connects to databases and microservices, providing real-time GraphQL APIs for faster and efficient data access | | PostgreSQL | A powerful, open-source object-relational database system known for its reliability, robustness, and performance, widely used for managing structured data | -| Sentry | A real-time error tracking and monitoring platform that helps developers identify, diagnose, and fix issues in applications, improving overall software quality and performance | -| Prometheus | An open-source monitoring and alerting toolkit designed for reliability and scalability, used to collect and process metrics from various systems, providing valuable insights into application and infrastructure performance | \ No newline at end of file +| Prometheus | An open-source monitoring and alerting toolkit designed for reliability and scalability, used to collect and process metrics from various systems, providing valuable insights into application and infrastructure performance | +| Sentry | A real-time error tracking and monitoring platform that helps developers identify, diagnose, and fix issues in applications, improving overall software quality and performance | \ No newline at end of file From 8d3256e1f5d8774eb0125cd8b3dc2ace927e00dc Mon Sep 17 00:00:00 2001 From: Vladimir Bobrikov Date: Wed, 10 May 2023 23:26:33 +0600 Subject: [PATCH 05/11] mdbook auto repairs --- docs/cli-reference.md | 106 ++++++++++++++++-------------- docs/config/reference.md | 14 ++-- docs/include/context-reference.md | 4 +- 3 files changed, 68 insertions(+), 56 deletions(-) diff --git a/docs/cli-reference.md b/docs/cli-reference.md index 65bbdc9af..f1c2f131a 100644 --- a/docs/cli-reference.md +++ b/docs/cli-reference.md @@ -1,5 +1,4 @@ -

dipdup

Manage and run DipDup indexers.

@@ -111,38 +110,6 @@

Do not remove JSONSchemas after generating types.

-
-
-

install

-

Install DipDup for the current user.

-
dipdup install [OPTIONS]
-
-
-

Options

-
-
--q, --quiet
-

Use default values for all prompts.

-
- -
-
--f, --force
-

Force reinstall.

-
- -
-
--r, --ref <ref>
-

Install DipDup from a specific git ref.

-
- -
-
--p, --path <path>
-

Install DipDup from a local path.

-
-

migrate

@@ -237,45 +204,86 @@
-
-

status

-

Show the current status of indexes in the database.

-
dipdup status [OPTIONS]
+

+
self

+
Commands to manage local DipDup installation.

+
dipdup self [OPTIONS] COMMAND [ARGS]...
+

+

+

+
install

+
Install DipDup for the current user.

+
dipdup self install [OPTIONS]
 

 

+
Options

+

+

+-q, --quiet

+
Use default values for all prompts.

+

+
+

+

+-f, --force

+
Force reinstall.

+

+
+

+

+-r, --ref <ref>

+
Install DipDup from a specific git ref.

+

+
+

+

+-p, --path <path>

+
Install DipDup from a local path.

+

+
 

-

-
uninstall

+

+
uninstall

 
Uninstall DipDup for the current user.

-
dipdup uninstall [OPTIONS]
+
dipdup self uninstall [OPTIONS]
 

 

 
Options

 

-

--q, --quiet

+

+-q, --quiet

 
Use default values for all prompts.

 

 
 

-

-
update

+

+
update

 
Update DipDup for the current user.

-
dipdup update [OPTIONS]
+
dipdup self update [OPTIONS]
 

 

 
Options

 

-

--q, --quiet

+

+-q, --quiet

 
Use default values for all prompts.

 

 
 

-

--f, --force

+

+-f, --force

 
Force reinstall.

 

 
 

 

+

+
status

+
Show the current status of indexes in the database.

+
dipdup status [OPTIONS]
+

+

+

+

+
+
diff --git a/docs/config/reference.md b/docs/config/reference.md
index 7b34d1b99..a1b44d49d 100644
--- a/docs/config/reference.md
+++ b/docs/config/reference.md
@@ -1,5 +1,4 @@
 
-
   

 

 class DipDupConfig(spec_version, package, datasources=<factory>, database=<factory>, contracts=<factory>, indexes=<factory>, templates=<factory>, jobs=<factory>, hooks=<factory>, hasura=None, sentry=<factory>, prometheus=None, advanced=<factory>, custom=<factory>, logging=LoggingValues.default)

@@ -294,7 +293,7 @@
 
 

 

-class dipdup.models.LoggingValues(value)

+class dipdup.models.LoggingValues(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
 
Enum for logging field values.

 

 

@@ -400,7 +399,7 @@
 
 

 

-class dipdup.models.tezos_tzkt.TzktOperationType(value)

+class dipdup.models.tezos_tzkt.TzktOperationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

 
Type of blockchain operation

 

 

@@ -475,7 +474,7 @@
 
 

 

-class dipdup.models.ReindexingAction(value)

+class dipdup.models.ReindexingAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

 
Action that should be performed on reindexing

 

 

@@ -496,7 +495,7 @@
 
 

 

-class dipdup.models.ReindexingReason(value)

+class dipdup.models.ReindexingReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

 
Reason that caused reindexing

 

 

@@ -545,7 +544,7 @@
 
 

 

-class dipdup.models.SkipHistory(value)

+class dipdup.models.SkipHistory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

 
Whether to skip indexing operation history and use only current state

 

 

@@ -644,3 +643,6 @@
 

 

 

+
+
+
diff --git a/docs/include/context-reference.md b/docs/include/context-reference.md
index d248287da..1ab6d8237 100644
--- a/docs/include/context-reference.md
+++ b/docs/include/context-reference.md
@@ -1,5 +1,4 @@
 
-
   

 

 class dipdup.context.DipDupContext(config, package, datasources, callbacks, transactions)

@@ -308,3 +307,6 @@ to provide a generic metadata interface (see docs).

 

 

 

+
+
+

From 143180d8ec87d35045f89f9e03a2602ff2f81101 Mon Sep 17 00:00:00 2001
From: Vladimir Bobrikov 
Date: Wed, 10 May 2023 23:30:47 +0600
Subject: [PATCH 06/11] fix lint

---
 docs/Glossary.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/Glossary.md b/docs/Glossary.md
index b8a2026be..08c93475b 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -1,3 +1,5 @@
+# Glossary
+
 ### DipDup Terms
 
 | Term | Definition |

From bc161fd4ac1cf175665b05ea44c4b3a96291ade5 Mon Sep 17 00:00:00 2001
From: Vladimir Bobrikov 
Date: Wed, 10 May 2023 23:39:09 +0600
Subject: [PATCH 07/11] lint

---
 docs/Glossary.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/Glossary.md b/docs/Glossary.md
index 08c93475b..daf7379f2 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -1,6 +1,6 @@
 # Glossary
 
-### DipDup Terms
+## DipDup Terms
 
 | Term | Definition |
 | --- | --- |
@@ -15,7 +15,7 @@
 | tortoise | A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management within the DipDup framework |
 | TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos |
 
-### Tezos Terms
+## Tezos Terms
 
 | Term | Definition |
 | --- | --- |
@@ -24,7 +24,7 @@
 | Entry points | Functions defined within a smart contract that can be called by external contract invocations or other contracts |
 | Origination | The process of deploying a new smart contract on the Tezos network, creating a new originated contract address |
 
-### Infrastructure Terms
+## Infrastructure Terms
 
 | Term | Definition |
 | --- | --- |

From f0cbee5f752d5512cc790f062f7bddcac60d0236 Mon Sep 17 00:00:00 2001
From: Vladimir Bobrikov 
Date: Wed, 10 May 2023 23:48:16 +0600
Subject: [PATCH 08/11] Revert "mdbook auto repairs"

This reverts commit 8d3256e1f5d8774eb0125cd8b3dc2ace927e00dc.
---
 docs/cli-reference.md             | 106 ++++++++++++++----------------
 docs/config/reference.md          |  14 ++--
 docs/include/context-reference.md |   4 +-
 3 files changed, 56 insertions(+), 68 deletions(-)

diff --git a/docs/cli-reference.md b/docs/cli-reference.md
index f1c2f131a..65bbdc9af 100644
--- a/docs/cli-reference.md
+++ b/docs/cli-reference.md
@@ -1,4 +1,5 @@
 
+
   

 
dipdup

 
Manage and run DipDup indexers.

@@ -110,6 +111,38 @@
 
Do not remove JSONSchemas after generating types.

 

 
+

+

+
install

+
Install DipDup for the current user.

+
dipdup install [OPTIONS]
+

+

+
Options

+

+

+-q, --quiet

+
Use default values for all prompts.

+

+
+

+

+-f, --force

+
Force reinstall.

+

+
+

+

+-r, --ref <ref>

+
Install DipDup from a specific git ref.

+

+
+

+

+-p, --path <path>

+
Install DipDup from a local path.

+

+
 

 

 
migrate

@@ -204,86 +237,45 @@
-
-

self

-

Commands to manage local DipDup installation.

-
dipdup self [OPTIONS] COMMAND [ARGS]...
-
-
-
-

install

-

Install DipDup for the current user.

-
dipdup self install [OPTIONS]
+

+
status

+
Show the current status of indexes in the database.

+
dipdup status [OPTIONS]
 

 

-
Options

-

-

--q, --quiet

-
Use default values for all prompts.

-

-
-

-

--f, --force

-
Force reinstall.

-

-
-

-

--r, --ref <ref>

-
Install DipDup from a specific git ref.

-

-
-

-

--p, --path <path>

-
Install DipDup from a local path.

-

-
 

-

-
uninstall

+

+
uninstall

 
Uninstall DipDup for the current user.

-
dipdup self uninstall [OPTIONS]
+
dipdup uninstall [OPTIONS]
 

 

 
Options

 

-

--q, --quiet

+

+-q, --quiet

 
Use default values for all prompts.

 

 
 

-

-
update

+

+
update

 
Update DipDup for the current user.

-
dipdup self update [OPTIONS]
+
dipdup update [OPTIONS]
 

 

 
Options

 

-

--q, --quiet

+

+-q, --quiet

 
Use default values for all prompts.

 

 
 

-

--f, --force

+

+-f, --force

 
Force reinstall.

 

 
 

 

-

-
status

-
Show the current status of indexes in the database.

-
dipdup status [OPTIONS]
-

-

-

-

-
-
diff --git a/docs/config/reference.md b/docs/config/reference.md
index a1b44d49d..7b34d1b99 100644
--- a/docs/config/reference.md
+++ b/docs/config/reference.md
@@ -1,4 +1,5 @@
 
+
   

 

 class DipDupConfig(spec_version, package, datasources=<factory>, database=<factory>, contracts=<factory>, indexes=<factory>, templates=<factory>, jobs=<factory>, hooks=<factory>, hasura=None, sentry=<factory>, prometheus=None, advanced=<factory>, custom=<factory>, logging=LoggingValues.default)

@@ -293,7 +294,7 @@
 
 

 

-class dipdup.models.LoggingValues(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

+class dipdup.models.LoggingValues(value)
 
Enum for logging field values.

 

 

@@ -399,7 +400,7 @@
 
 

 

-class dipdup.models.tezos_tzkt.TzktOperationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

+class dipdup.models.tezos_tzkt.TzktOperationType(value)

 
Type of blockchain operation

 

 

@@ -474,7 +475,7 @@
 
 

 

-class dipdup.models.ReindexingAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

+class dipdup.models.ReindexingAction(value)

 
Action that should be performed on reindexing

 

 

@@ -495,7 +496,7 @@
 
 

 

-class dipdup.models.ReindexingReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

+class dipdup.models.ReindexingReason(value)

 
Reason that caused reindexing

 

 

@@ -544,7 +545,7 @@
 
 

 

-class dipdup.models.SkipHistory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

+class dipdup.models.SkipHistory(value)

 
Whether to skip indexing operation history and use only current state

 

 

@@ -643,6 +644,3 @@
 

 

 

-
-
-
diff --git a/docs/include/context-reference.md b/docs/include/context-reference.md
index 1ab6d8237..d248287da 100644
--- a/docs/include/context-reference.md
+++ b/docs/include/context-reference.md
@@ -1,4 +1,5 @@
 
+
   

 

 class dipdup.context.DipDupContext(config, package, datasources, callbacks, transactions)

@@ -307,6 +308,3 @@ to provide a generic metadata interface (see docs).

 

 

 

-
-
-

From d519cf5161a11f473bbb33ca7cd50b21db9b5103 Mon Sep 17 00:00:00 2001
From: Vladimir Bobrikov 
Date: Thu, 11 May 2023 22:43:15 +0600
Subject: [PATCH 09/11] add new items before changing structure

---
 docs/Glossary.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/docs/Glossary.md b/docs/Glossary.md
index daf7379f2..1c623deee 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -4,15 +4,28 @@
 
 | Term | Definition |
 | --- | --- |
+| ABI | |
 | Callback | |
+| config | |
+| context | ctx |
+| datasource | |
 | DipDup | An open source framework for building smart contract indexes for the Tezos network |
+| Environment Variables | |
 | Handler | |
-| Hook | |
+| head | |
+| Hook | could be two types |
 | Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying |
+| job | |
+| JSONSchema | |
 | Model | A Python class representing a database table, defined using the Tortoise ORM library |
+| package | |
 | RPC API | RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relativly to TzKT and other APIs |
 | SDK | A toolkit for developing smart contract indexing applications |
+| schema | |
+| Sync level | |
 | tortoise | A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management within the DipDup framework |
+| transaction | |
+| typeclass | |
 | TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos |
 
 ## Tezos Terms

From 516ef1e02c74cb92c9aed43953ace3c1deb0d13a Mon Sep 17 00:00:00 2001
From: Vladimir Bobrikov 
Date: Thu, 11 May 2023 22:53:01 +0600
Subject: [PATCH 10/11] restructure

---
 docs/Glossary.md | 120 ++++++++++++++++++++++++++++-------------------
 1 file changed, 72 insertions(+), 48 deletions(-)

diff --git a/docs/Glossary.md b/docs/Glossary.md
index 1c623deee..e70c66021 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -1,50 +1,74 @@
 # Glossary
 
-## DipDup Terms
-
-| Term | Definition |
-| --- | --- |
-| ABI | |
-| Callback | |
-| config | |
-| context | ctx |
-| datasource | |
-| DipDup | An open source framework for building smart contract indexes for the Tezos network |
-| Environment Variables | |
-| Handler | |
-| head | |
-| Hook | could be two types |
-| Indexer | A program that reads data from a blockchain and stores it in a database for quick and easy querying |
-| job | |
-| JSONSchema | |
-| Model | A Python class representing a database table, defined using the Tortoise ORM library |
-| package | |
-| RPC API | RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relativly to TzKT and other APIs |
-| SDK | A toolkit for developing smart contract indexing applications |
-| schema | |
-| Sync level | |
-| tortoise | A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management within the DipDup framework |
-| transaction | |
-| typeclass | |
-| TzKT API | A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos |
-
-## Tezos Terms
-
-| Term | Definition |
-| --- | --- |
-| big_map | big_map object covered in [big map index page](indexes/tezos_tzkt_big_maps.md) |
-| Contract storage | Persistent data storage within a smart contract, holding the contract's state and any associated data |
-| Entry points | Functions defined within a smart contract that can be called by external contract invocations or other contracts |
-| Origination | The process of deploying a new smart contract on the Tezos network, creating a new originated contract address |
-
-## Infrastructure Terms
-
-| Term | Definition |
-| --- | --- |
-| Docker | An open-source platform for creating, deploying, and managing containerized applications, improving consistency and reducing infrastructure overhead |
-| Docker Compose | A tool for defining and managing multi-container Docker applications, using a YAML file to configure services, networks, and volumes, simplifying application deployment and scaling |
-| GraphQL | A query language and runtime for APIs that enables clients to request only the data they need, offering more flexibility and efficiency compared to traditional REST APIs |
-| Hasura | An open-source engine that connects to databases and microservices, providing real-time GraphQL APIs for faster and efficient data access |
-| PostgreSQL | A powerful, open-source object-relational database system known for its reliability, robustness, and performance, widely used for managing structured data |
-| Prometheus | An open-source monitoring and alerting toolkit designed for reliability and scalability, used to collect and process metrics from various systems, providing valuable insights into application and infrastructure performance |
-| Sentry | A real-time error tracking and monitoring platform that helps developers identify, diagnose, and fix issues in applications, improving overall software quality and performance |
\ No newline at end of file
+## General Terms
+
+### A
+- **ABI**: 
+- **Asyncio**: 
+
+### C
+- **Callback**: 
+- **config**: 
+- **context (ctx)**: 
+
+### D
+- **datasource**: 
+- **DipDup**: An open source framework for building smart contract indexes for the Tezos network.
+- **Docker**: An open-source platform for creating, deploying, and managing containerized applications, improving consistency and reducing infrastructure overhead.
+- **Docker Compose**: A tool for defining and managing multi-container Docker applications, using a YAML file to configure services, networks, and volumes, simplifying application deployment and scaling.
+
+### E
+- **Environment Variables**: 
+
+### G
+- **GraphQL**: A query language and runtime for APIs that enables clients to request only the data they need, offering more flexibility and efficiency compared to traditional REST APIs.
+
+### H
+- **Handler**: 
+- **Hasura**: An open-source engine that connects to databases and microservices, providing real-time GraphQL APIs for faster and efficient data access.
+- **head**: 
+- **Hook**: Could be two types.
+
+### I
+- **Indexer**: A program that reads data from a blockchain and stores it in a database for quick and easy querying.
+
+### J
+- **job**: 
+- **JSONSchema**: 
+
+### M
+- **Model**: A Python class representing a database table, defined using the Tortoise ORM library.
+
+### P
+- **package**: 
+- **PostgreSQL**: A powerful, open-source object-relational database system known for its reliability, robustness, and performance, widely used for managing structured data.
+- **Prometheus**: An open-source monitoring and alerting toolkit designed for reliability and scalability, used to collect and process metrics from various systems, providing valuable insights into application and infrastructure performance.
+
+### R
+- **RPC API**: RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relatively to TzKT and other APIs.
+
+### S
+- **schema**: 
+- **SDK**: A toolkit for developing smart contract indexing applications.
+- **Sentry**: A real-time error tracking and monitoring platform that helps developers identify, diagnose, and fix issues in applications, improving overall software quality and performance.
+- **Sync level**: 
+
+### T
+- **tortoise**: A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management.
+- **transaction**: 
+- **typeclass**: 
+- **TzKT API**: A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos.
+
+## Blockchain or Tezos Terms
+
+### B
+- **big_map**: big_map object covered in [big map index page](indexes/tezos_tzkt_big_maps.md).
+
+### C
+- **Contract storage**: Persistent data storage within a smart contract, holding the contract's state and any associated data.
+
+### E
+- **Entry points**: Functions defined within a smart contract that can be called by external contract invocations or other contracts.
+
+### O
+- **Origination**: The process of deploying a new smart contract on the Tezos network, creating a new originated contract address.

From cfc2330f5650cf2dc8a1d96d5c9b349830c219c3 Mon Sep 17 00:00:00 2001
From: Vladimir Bobrikov 
Date: Fri, 12 May 2023 10:50:13 +0600
Subject: [PATCH 11/11] ref

---
 docs/Glossary.md | 25 ++++++++++++-------------
 1 file changed, 12 insertions(+), 13 deletions(-)

diff --git a/docs/Glossary.md b/docs/Glossary.md
index e70c66021..c52551ad1 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -1,18 +1,17 @@
 # Glossary
 
-## General Terms
+## DipDup and General Tech Terms
 
 ### A
 - **ABI**: 
-- **Asyncio**: 
 
 ### C
 - **Callback**: 
-- **config**: 
-- **context (ctx)**: 
+- **Config**: 
+- **Context**: in handlers
 
 ### D
-- **datasource**: 
+- **Datasource**: 
 - **DipDup**: An open source framework for building smart contract indexes for the Tezos network.
 - **Docker**: An open-source platform for creating, deploying, and managing containerized applications, improving consistency and reducing infrastructure overhead.
 - **Docker Compose**: A tool for defining and managing multi-container Docker applications, using a YAML file to configure services, networks, and volumes, simplifying application deployment and scaling.
@@ -26,21 +25,21 @@
 ### H
 - **Handler**: 
 - **Hasura**: An open-source engine that connects to databases and microservices, providing real-time GraphQL APIs for faster and efficient data access.
-- **head**: 
+- **Head**: 
 - **Hook**: Could be two types.
 
 ### I
 - **Indexer**: A program that reads data from a blockchain and stores it in a database for quick and easy querying.
 
 ### J
-- **job**: 
+- **Job**: 
 - **JSONSchema**: 
 
 ### M
 - **Model**: A Python class representing a database table, defined using the Tortoise ORM library.
 
 ### P
-- **package**: 
+- **Package**: 
 - **PostgreSQL**: A powerful, open-source object-relational database system known for its reliability, robustness, and performance, widely used for managing structured data.
 - **Prometheus**: An open-source monitoring and alerting toolkit designed for reliability and scalability, used to collect and process metrics from various systems, providing valuable insights into application and infrastructure performance.
 
@@ -48,18 +47,18 @@
 - **RPC API**: RPC stands for Remote Procedure Call. A protocol used to communicate with Tezos nodes and interact with the blockchain. DipDup receives minimal amount of data from RPC API due to slow performance relatively to TzKT and other APIs.
 
 ### S
-- **schema**: 
+- **Schema**: 
 - **SDK**: A toolkit for developing smart contract indexing applications.
 - **Sentry**: A real-time error tracking and monitoring platform that helps developers identify, diagnose, and fix issues in applications, improving overall software quality and performance.
 - **Sync level**: 
 
 ### T
-- **tortoise**: A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management.
-- **transaction**: 
-- **typeclass**: 
+- **Tortoise**: A Python asyncio library for defining models and relationships between tables, simplifying asynchronous database interactions and data management.
+- **Transaction**: 
+- **Typeclass**: 
 - **TzKT API**: A popular Tezos indexer API that provides a more user-friendly way to access Tezos blockchain data compared to the RPC API, often used for building applications on top of Tezos.
 
-## Blockchain or Tezos Terms
+## Blockchain and Tezos-Specific Terms
 
 ### B
 - **big_map**: big_map object covered in [big map index page](indexes/tezos_tzkt_big_maps.md).