Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add glossary to docs #698

Merged
merged 13 commits into from
Sep 8, 2024
73 changes: 73 additions & 0 deletions docs/Glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Glossary

## DipDup and General Tech Terms

### A
- **ABI**:

### C
- **Callback**:
- **Config**:
- **Context**: in handlers

### 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 and Tezos-Specific 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.
Loading