Skip to content

Commit 15c55b1

Browse files
authored
Merge pull request #28 from airchains-network/fix/sidebar-patch-1
fix/sidebar-patch-1 --> fix/sidebar
2 parents 2b9a3c5 + 5372622 commit 15c55b1

34 files changed

+510
-44
lines changed

.github/workflows/deploy.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Auto Deploy Airchains Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout Repository
14+
uses: actions/checkout@v3
15+
16+
- name: Deploy to Server
17+
uses: appleboy/ssh-action@master
18+
with:
19+
host: 148.113.38.220
20+
username: ubuntu
21+
key: ${{ secrets.DEPLOY_SSH_KEY }}
22+
script: |
23+
echo "🚀 Starting remote deployment..."
24+
chmod +x /home/ubuntu/deploy.sh
25+
/home/ubuntu/deploy.sh
26+
echo "✅ Deployment complete!"

docs/data-availability/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,41 @@
22
id: data-availability
33
title: Data Availability
44
sidebar_position: 6
5+
slug: /concepts/data-availability
56
---
7+
8+
# Data Availability
9+
10+
## What is Data Availability
11+
12+
Data availability addresses the issue of whether specific data has been released into a blockchain network. This aspect becomes especially significant when a network node comes across a new block proposed for addition to the blockchain. At this juncture, it's the node's duty to gather all transaction data within this new block. Successfully obtaining this transaction data is critical for the node; it verifies that the data has been effectively spread throughout the network. In essence, if a node manages to retrieve and download all the transaction data from the incoming block, it affirms that data availability is upheld, confirming that the block's data has been properly published and is accessible across the network.
13+
14+
In blockchain systems, especially in scaling solutions like rollups or sidechains, only a summary of the data might be posted to the main chain (like Ethereum), with the detailed data hosted off-chain or on a secondary layer. Ensuring data availability in these scenarios is crucial because:
15+
16+
- **Security**: If data is unavailable, even temporarily, it can lead to security vulnerabilities. Nodes or validators must have access to complete data to validate transactions and maintain the integrity of the blockchain.
17+
18+
- **Decentralization**: Full data availability supports the decentralized nature of blockchain technology. It prevents central points of control or failure and ensures that all participants can independently verify the state of the network.
19+
20+
- **Trustlessness**: In a trustless environment like blockchain, participants shouldn't need to rely on a third party to assert that the data is correct. Availability allows participants to independently verify data.
21+
22+
## How Data Availability Works on Airchains
23+
24+
In of our blockchain system, the Data Availability (DA) layer functions as a critical intermediary, ensuring the seamless and secure settlement of transaction batches within the settlement layer. This layer plays a pivotal role in maintaining the integrity and availability of data, a cornerstone in our blockchain's operational framework.
25+
26+
### 1. Building a Robust Connection
27+
28+
The process begins with the DA layer establishing a robust connection between the execution and settlement layers. This connection is not just a mere linkage; it's a crucial bridge ensuring the continuous and reliable availability of data across different segments of the blockchain. This step is fundamental in maintaining the coherence and integrity of the blockchain's state across its various layers.
29+
30+
### 2. Requesting and Validating Data
31+
32+
The DA layer then proceeds to perform a series of critical validation checks. It requests the state root of the execution layer along with the compressed transaction hash and other relevant metadata. The state root serves as a cryptographic representation of the entire state of the execution chain at a given point in time. By verifying the state root, the DA layer confirms the validity and consistency of the execution chain's state, an essential aspect in ensuring the integrity of the blockchain.
33+
34+
### 3. Storing and Referencing Transaction Data
35+
36+
In parallel, the DA layer stores the compressed transaction hash within its own framework. This stored data becomes a reference point, available for future validation and verification processes. It acts as an immutable record, confirming whether specific transaction data was available at a certain point in time. This aspect of the DA layer's functionality is vital for maintaining transparency and trust in the blockchain network.
37+
38+
### 4. Finalizing the Settlement Process
39+
40+
Upon successful completion of these validation checks, the DA layer provides a crucial piece of information - the block height in the case of Celestia-based systems, and the transaction hash in the case of Avail-based systems. This information is not just a confirmation but also a marker of a successful transaction settlement. It signifies the completion of a critical phase in the transaction lifecycle and the readiness of the batch for integration into the blockchain ledger.
41+
42+
The DA layer, through these meticulously executed steps, reinforces the security, transparency, and efficiency of our blockchain system. It ensures that every transaction batch settled in the settlement layer is not only valid and consistent but also readily available and verifiable. This layer's role is a testament to our commitment to maintaining a blockchain environment that is both robust and trustworthy, aligning with the highest standards of data integrity and availability.

docs/intro-to-zkfhe/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,9 @@ id: intro-to-zkfhe
33
title: Intro to zkFHE
44
description: Introduction to Zero-Knowledge Fully Homomorphic Encryption
55
sidebar_position: 3
6-
---
6+
slug: /concepts/intro-to-zkfhe
7+
---
8+
9+
import IntroToZKFHE from '@site/src/components/Docs/intro-to-zkfhe.js';
10+
11+
<IntroToZKFHE />

docs/introduction.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
sidebar_position: 1
3+
# id : introduction
4+
slug: /introduction
5+
---
6+
7+
# Introduction
8+
9+
<img
10+
src="/img/introduction.jpg"
11+
alt="Introduction"
12+
className="intro_image"
13+
/>
14+
15+
import IntroductionComponent from '@site/src/components/Docs/introduction.js';
16+
17+
<IntroductionComponent />

docs/overview.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

sidebars.js

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const sidebars = {
2121
tutorialSidebar: [
2222
{
2323
type: "doc",
24-
id: "overview",
24+
id: "introduction",
2525
className: "custom-sidebar-item",
2626
},
2727
{
@@ -37,6 +37,10 @@ const sidebars = {
3737
type: "category",
3838
label: "Intro to zkFHE",
3939
className: "custom-sidebar-item",
40+
link: {
41+
type: "doc",
42+
id: "intro-to-zkfhe/intro-to-zkfhe",
43+
},
4044
items: [
4145
"intro-to-zkfhe/zk-proofs",
4246
"intro-to-zkfhe/fully-homomorphic-encryption",
@@ -132,6 +136,10 @@ const sidebars = {
132136
"rollups/cosmwasm-zk-rollup/become-a-validator",
133137
],
134138
},
139+
{
140+
type: "html",
141+
value: '<div class="sidebar-heading">Develop</div>',
142+
},
135143
],
136144
};
137145

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import Link from "@docusaurus/Link";
2+
import React from "react";
3+
4+
const IntroToZKFHE = () => {
5+
return (
6+
<div>
7+
<p>
8+
Airchains leverages advanced Zero-Knowledge (ZK) and Fully Homomorphic
9+
Encryption (FHE) technologies to address critical challenges in
10+
scalability, privacy, and security.
11+
</p>
12+
<p>
13+
By integrating the two technologies together, Airchains ensures that
14+
computations can be performed on encrypted data, maintaining privacy,
15+
while zk-SNARKs provide robust mechanisms for verifying computations
16+
without exposing the underlying data, ensuring confidentiality and
17+
security. This is the essence of zkFHE.
18+
</p>
19+
<div className="docs_heading">Useful Links</div>
20+
<div className="docs_card_image_wrapper">
21+
<Link
22+
to={`/concepts/intro-to-zkfhe/zk-proofs`}
23+
className="docs_card_without_image"
24+
>
25+
<div className="docs_card_heading_title">ZK Proofs</div>
26+
<div className="docs_card_description">
27+
Explore how ZK Proofs enable privacy-preserving computations and how
28+
they are used in Airchains.
29+
</div>
30+
</Link>
31+
<Link
32+
to={`/concepts/intro-to-zkfhe/fully-homomorphic-encryption`}
33+
className="docs_card_without_image"
34+
>
35+
<div className="docs_card_heading_title">
36+
Fully Homomorphic Encryption
37+
</div>
38+
<div className="docs_card_description">
39+
Learn how FHE enables computations on encrypted data without the
40+
need to decrypt it.
41+
</div>
42+
</Link>
43+
<Link
44+
to={`/concepts/intro-to-zkfhe/zk-snark-and-fhe-integration`}
45+
className="docs_card_without_image"
46+
>
47+
<div className="docs_card_heading_title">
48+
zk-SNARK and FHE Integration
49+
</div>
50+
<div className="docs_card_description">
51+
Learn how Provers and Sequencers maintain trust, integrity, and
52+
order in decentralized networks.
53+
</div>
54+
</Link>
55+
</div>
56+
</div>
57+
);
58+
};
59+
60+
export default IntroToZKFHE;

0 commit comments

Comments
 (0)