ci: add typo checker

.github/workflow/typo-check.yml

@@ -0,0 +1,15 @@
+name: Typo Check
+
+on: [pull_request]
+
+jobs:
+  check-for-typos:
+    runs-on: 
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Check for typos
+        uses: crate-ci/typos@master
+        with:
+          config: ${{github.workspace}}/_typos.toml

_typos.toml

@@ -0,0 +1,11 @@
+[default.extend-words]
+# Don't correct
+hsa = "hsa"
+cips = "cips"
+BA = "BA"
+Ded = "Ded"
+Yto = "Yto"
+
+
+[files]
+extend-exclude = ["images/**"]

api-reference/node-rpc/evm/eth_getCode.json

@@ -37,7 +37,7 @@
         "/{api-key}": {
             "post": {
                 "summary": "eth_getCode",
-                "description": "Returns the byte code at a given address (if it's a smart contract).\n\n**Parameters**\n\n- `DATA`, 20 Bytes - Address from which to retreive byte code\n- `TAG` - Integer block number or one of \"earliest\", \"latest\" or \"pending\"\n\n**Returns**\n\n- `DATA` - The byte code (if any) found at the given address",
+                "description": "Returns the byte code at a given address (if it's a smart contract).\n\n**Parameters**\n\n- `DATA`, 20 Bytes - Address from which to retrieve byte code\n- `TAG` - Integer block number or one of \"earliest\", \"latest\" or \"pending\"\n\n**Returns**\n\n- `DATA` - The byte code (if any) found at the given address",
                 "operationId": "evm-eth-getCode",
                 "parameters": [
                     {

api-reference/node-rpc/evm/eth_getStorageAt.json

@@ -37,7 +37,7 @@
         "/{api-key}": {
             "post": {
                 "summary": "eth_getStorageAt",
-                "description": "Returns the value from a storage position at a given address.\n\n**Parameters**\n\n- `DATA`, 20 Bytes - Address of the contract whose storage to retreive \n- `QUANTITY` - Integer of the position in the storage \n- `TAG` - Integer block number or one of \"earliest\", \"latest\" or \"pending\"\n\n**Returns**\n\n- `DATA` - The value at this storage position",
+                "description": "Returns the value from a storage position at a given address.\n\n**Parameters**\n\n- `DATA`, 20 Bytes - Address of the contract whose storage to retrieve \n- `QUANTITY` - Integer of the position in the storage \n- `TAG` - Integer block number or one of \"earliest\", \"latest\" or \"pending\"\n\n**Returns**\n\n- `DATA` - The value at this storage position",
                 "operationId": "evm-eth-getStorageAt",
                 "parameters": [
                     {

api-reference/node-rpc/ton/v2_openapi.json

@@ -118,7 +118,7 @@
           "accounts"
         ],
         "summary": "Get Wallet Information",
-        "description": "Retrieve wallet information. This method parses contract state and currently supports more wallet types than getExtendedAddressInformation: simple wallet, standart wallet, v3 wallet, v4 wallet.",
+        "description": "Retrieve wallet information. This method parses contract state and currently supports more wallet types than getExtendedAddressInformation: simple wallet, standard wallet, v3 wallet, v4 wallet.",
         "operationId": "get_wallet_information_getWalletInformation_get",
         "parameters": [
           {
@@ -302,7 +302,7 @@
           "accounts"
         ],
         "summary": "Get Address",
-        "description": "Get state of a given address. State can be either *unitialized*, *active* or *frozen*.",
+        "description": "Get state of a given address. State can be either *uninitialized*, *active* or *frozen*.",
         "operationId": "get_address_getAddressState_get",
         "parameters": [
           {

api-reference/web3-api/balance/balance_api.json

@@ -700,7 +700,7 @@
                     "value": {
                         "title": "Value",
                         "type": "string",
-                        "description": "The ammount of the ERC-20 token."
+                        "description": "The amount of the ERC-20 token."
                     },
                     "symbol": {
                         "title": "Symbol",

api-reference/web3-api/basic/basic_api.json

@@ -124,7 +124,7 @@
                     "Block"
                 ],
                 "summary": "Get block by number",
-                "description": "Get the detail of a block by the given block humber.",
+                "description": "Get the detail of a block by the given block number.",
                 "operationId": "GetBlockDetail",
                 "parameters": [
                     {

api-reference/web3-api/nft/nft_api.json

@@ -2102,7 +2102,7 @@
                     "description": {
                         "title": "Description",
                         "type": "string",
-                        "description": "The description of the NFT colleciton"
+                        "description": "The description of the NFT collection"
                     },
                     "owner": {
                         "title": "Owner",
@@ -2154,7 +2154,7 @@
                     "value": {
                         "title": "Value",
                         "type": "string",
-                        "description": "The ammount of the ERC-20 token."
+                        "description": "The amount of the ERC-20 token."
                     },
                     "symbol": {
                         "title": "Symbol",

core-concepts/manuscript.mdx

@@ -82,7 +82,7 @@ Developers need to define the schema of the result table, including field names,
 The general syntax of the `SELECT` statement is:
 
 ```sql
-select select_list from table_expression [where boolen_expression]
+select select_list from table_expression [where boolean_expression]
 ```
 
 The `table_expression` refers to any data set in Chainbase Network. It could be an existing table, or VALUES clause, the joined results of multiple existing tables, or a subquery. The following would read all rows from `blocks`.

platform/overview.mdx

@@ -8,7 +8,7 @@ Welcome to Chainbase Data Platform docs. All-in-one web3 data infrastructure for
 
 Chainbase Data Platform is an all-in-one data infrastructure for Web3 that allows you to index, transform, and utilize large-scale on-chain data. It is a platform that provides a suite of tools and services to help you build, manage, and scale your Web3 applications.
 
-By leveraging enriched on-chain data and streaming computing technologies accross one data infrastructure, Chainbase Data Platform automates the indexing and querying of blockchain data, enabling developers to accomplish complex data tasks with ease.
+By leveraging enriched on-chain data and streaming computing technologies across one data infrastructure, Chainbase Data Platform automates the indexing and querying of blockchain data, enabling developers to accomplish complex data tasks with ease.
 
 ## Products & Features
 

platform/supported-networks/supported-networks.mdx

@@ -2,7 +2,7 @@
 title: "Supported Networks"
 ---
 
-We support the following networks in real-time across multiple data types. More chains and types are being onboarded and will comming soon.
+We support the following networks in real-time across multiple data types. More chains and types are being onboarded and will coming soon.
 
 
 

platform/usecases/nft-api/get-nft-metadata.mdx

@@ -4,7 +4,7 @@ title: "Get NFT metadata"
 
 The importance of NFT metadata lies in its ability to provide additional information about the NFT such as its name, description, image, and other attributes. This metadata is often used by marketplaces and collectors to display and search for NFTs. Additionally, the metadata can be used to verify the authenticity and ownership of an NFT.
 
-To get NFT metadata, you can use the [Get NFT metadata](/api-reference/web3-api/nft/nft-metadata/get-nft-metadata) function, which returns JSON-formated data that contains the metadata for the NFT.
+To get NFT metadata, you can use the [Get NFT metadata](/api-reference/web3-api/nft/nft-metadata/get-nft-metadata) function, which returns JSON-formatted data that contains the metadata for the NFT.
 
 ## Overview - Tools you need to work with Chainbase
 

theia/Resources/Roadmap.mdx

@@ -2,7 +2,7 @@
 title: 'Roadmap'
 ---
 
-Theia is the next-generation crypto world model that provides foundation knowledge and AI capability for the web3 era. To achieve this goal, the roadmap details the path to more intelligent, secure and transparant Theia model.
+Theia is the next-generation crypto world model that provides foundation knowledge and AI capability for the web3 era. To achieve this goal, the roadmap details the path to more intelligent, secure and transparent Theia model.
 
 ## Phase 1: Theia Demo Online
 

theia/TheiaChat/create-task-models.mdx

@@ -10,7 +10,7 @@ Theia Task Models is constructed using prompt and data engineering. We introduce
 
 Prompt engineering refers to a series of instruction for Theia. It can trigger Theia to wake up specific capability in some field and work as a task model as instructed. The instruction should be clear and the output format can be defined. To build a good task model, we normally tell Theia three important messages: role, hint for reasoning and generation, and goal.
 
-For example, to build a crypto investment adivsor, we can write the prompt including the three messages:
+For example, to build a crypto investment advisor, we can write the prompt including the three messages:
    - **Role:** Theia, you are an investment advisor.
    - **Hint:** Whenever I provide you a whitepaper of a project, please analyze the whitepaper and search the news of this project. 
    - **Goal:** Then generate an investment advisory report.

theia/TheiaChat/overview.mdx

@@ -9,12 +9,12 @@ Users can enhance the Chainabse Network when interacting with TheiaChat and bene
 1. **Non-Expert Users:** people without blockchain knowledge and skills, such as blockchain beginners. They can enhance the Chainbase Network by having conversations with TheiaChat and providing feedback on the results of the conversations, and the network rewards serious and honest users.
 2. **Expert Users:** People with blockchain knowledge and skills, such as professional traders and security experts. They can enhance the Chainbase Network by building Theia Task Models in TheiaChat, and the network will reward Task Model builders with high adoption.
 
-Chainbase Labs built the **Thea Security Model (TSM)** as an example to show the ability to build a Task Model based on the crypto world model Theia in TheiaChat. It is a security expert to offer advice in the crypto world, e.g., how to protect my wallet and money. It is constructed by training Theia with security books and community advices. 
+Chainbase Labs built the **Thea Security Model (TSM)** as an example to show the ability to build a Task Model based on the crypto world model Theia in TheiaChat. It is a security expert to offer advice in the crypto world, e.g., how to protect my wallet and money. It is constructed by training Theia with security books and community advice. 
 
 ## How do interactions with TheiaChat enhance the Chainbase Network?
 
-Every user interaction with TheiaChat and every task model built are enhancements to the under hood chainbase network. The basic logic is that these actions will directly trigger **Change Data Captures (CDCs, aka Changlog)**, and these contents are permanently stored on Arweave. 
+Every user interaction with TheiaChat and every task model built are enhancements to the under hood chainbase network. The basic logic is that these actions will directly trigger **Change Data Captures (CDCs, aka Changelog)**, and these contents are permanently stored on Arweave. 
 
 These are powerful complement to the Chainbase Network. It is also the first time that users can contribute data to enhance the Chainbase Network. Before this, only developers could enhance the network by building Manuscripts in the network. **This is the historical transformation of Chainbase Network from targeting 300,000 developers to targeting 30 million to 300 million users.**
 
-In addition, every Changlog is a transaction on the Chainbase Network, which is permanently recorded on the Chainbase Network, and is public, censorship-resistant and cannot be manipulated. Its traceability guarantees the data income rights of every data producer.
+In addition, every Changelog is a transaction on the Chainbase Network, which is permanently recorded on the Chainbase Network, and is public, censorship-resistant and cannot be manipulated. Its traceability guarantees the data income rights of every data producer.