From 9e5e077ba0605f5579c7d97cadc82a3593eaef3f Mon Sep 17 00:00:00 2001 From: hadi-saleh14 Date: Wed, 19 Mar 2025 13:32:03 +0300 Subject: [PATCH] improve attestor docs --- .../attestor-decentralization/attestor-contracts.mdx | 12 ++++++++++-- content/docs/attestor-decentralization/index.mdx | 9 +++------ .../attestor-decentralization/local-development.mdx | 6 +++--- 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/content/docs/attestor-decentralization/attestor-contracts.mdx b/content/docs/attestor-decentralization/attestor-contracts.mdx index 444bb5e..38bf474 100644 --- a/content/docs/attestor-decentralization/attestor-contracts.mdx +++ b/content/docs/attestor-decentralization/attestor-contracts.mdx @@ -7,7 +7,7 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs"; # Reclaim Protocol: Decentralized Architecture and Incentives -The Reclaim protocol's decentralized architecture relies on smart contracts and a network of Attestor nodes to ensure secure and trustless data verification. +The Reclaim protocol's decentralized architecture relies on smart contracts and a network of Attestor nodes to ensure secure and trustless data verification. Contracts are already deployed to Moca chain. ## Core Smart Contracts @@ -27,16 +27,22 @@ The Reclaim protocol's decentralized architecture relies on smart contracts and 1. **Claim Task Request:** * The user submits a "create claim task" request to the Task Contract via the Reclaim SDK. + 2. **Attestor Selection:** * The Task Contract randomly selects Attestors and returns them to the SDK. + 3. **zkTLS Protocol Execution:** * The Reclaim SDK establishes connections with the selected Attestors to execute the zkTLS protocol. + 4. **Proof Submission:** * Each Attestor returns a Proof to the SDK and submits it to the Task Contract. + 5. **Proof Consensus:** * The Task Contract achieves Proof consensus based on the 51% rule. + 6. **Final Proof Packaging:** * The SDK packages all Proofs and submits the final Proof to the Task Contract. + 7. **Proof Verification and Storage:** * The Task Contract verifies the Proof and stores the result upon successful validation. @@ -47,7 +53,8 @@ The Reclaim protocol's decentralized architecture relies on smart contracts and ## Try It -Contract can be found on [Github](https://github.com/reclaimprotocol/attestor-contracts). +Contracts can be found on [Github](https://github.com/reclaimprotocol/attestor-contracts). + ### Admin setup If you wish to try things beforehand, try the following upon cloning and installing packages. @@ -73,6 +80,7 @@ Alternatively, you can try out an e2e [example](https://github.com/reclaimprotoc 2. **Populate your `.env`, varibales are filled for you, you just need to add you private key:** * `PRIVATE_KEY=` + 3. **Run the script:** * `node index.js` diff --git a/content/docs/attestor-decentralization/index.mdx b/content/docs/attestor-decentralization/index.mdx index 57a453b..4805664 100644 --- a/content/docs/attestor-decentralization/index.mdx +++ b/content/docs/attestor-decentralization/index.mdx @@ -1,11 +1,11 @@ --- title: Reclaim Protocol Attestors -description: Expanding the Reclaim protocol with multi-attestor verification, economic incentives, and anonymity. +description: Reclaim Decentralization Overview --- # Decentralizing Reclaim -The foundational Reclaim protocol relies on trusted Attestors to sign and verify data Claims. However, this introduces a single point of trust vulnerability, as the Attestor's honesty is paramount. To mitigate this, we are expanding the protocol through decentralization, focusing on: +Expanding the Reclaim protocol with multi-attestor verification, economic incentives, and anonymity. ## Multi-Attestor Verification Mechanism @@ -43,7 +43,7 @@ The Reclaim protocol introduces a novel approach using "attestor" nodes to proxy ### How It Works 1. **Proxied API Request:** - * The user initiates an API request to a service like Gmail, routed through an attestor node. + * The user initiates an API request to a service, routed through an attestor node. * The attestor observes the traffic flow. 2. **Sensitive Data Protection:** * The protocol allows users to conceal sensitive data, such as passwords or API secrets (e.g., `{secret-token}`), from the attestor. @@ -54,9 +54,6 @@ The Reclaim protocol introduces a novel approach using "attestor" nodes to proxy 5. **Trustless Proof:** * This signed claim serves as verifiable proof of data access, without revealing the user's sensitive information. -### Example: Proving Gmail Access - -Using Reclaim, you can prove access to your Gmail account without sharing your password or screenshots. The attestor verifies the communication with Google's servers, ensuring the validity of your claim. ### Trust and Decentralization diff --git a/content/docs/attestor-decentralization/local-development.mdx b/content/docs/attestor-decentralization/local-development.mdx index 73439b3..1881bfc 100644 --- a/content/docs/attestor-decentralization/local-development.mdx +++ b/content/docs/attestor-decentralization/local-development.mdx @@ -1,6 +1,6 @@ --- title: Local Development -description: Run an attestor locally +description: Running an attestor locally --- import { Tab, Tabs } from "fumadocs-ui/components/tabs"; @@ -17,8 +17,8 @@ Following this doc, you will be able to run an attestor locally and start genera The workflow is as follows: -1. **Clone the `attestor-core` repository:** - - The user calls zkFetch, providing options such as URL, method, and headers. +1. **Clone the `attestor-core` [repository](https://github.com/reclaimprotocol/attestor-core/):** + - `git clone https://github.com/reclaimprotocol/attestor-core.git` 2. **Install packages:** - `npm i` 3. **Create an `.env.producation` with at least the `PRIVATE_KEY` variable populated**