Skip to content

Commit

Permalink
Ethereum Attestation Service
Browse files Browse the repository at this point in the history
  • Loading branch information
wise4rmgodroot committed Dec 12, 2024
1 parent d78e0e9 commit 0892bff
Show file tree
Hide file tree
Showing 12 changed files with 492 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/04-resources/06-guides/eas-guide/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
label: Ethereum Attestation Service
position: 2
link:
type: generated-index
description: The PowPeg App fka 2 way peg app converts BTC to RBTC and vice versa. It is secured by the powpeg protocol, which is a unique PowPeg system that secures the locked bitcoins with the same Bitcoin hashrate that establishes consensus.
slug: /resources/guides/eas-guide/
165 changes: 165 additions & 0 deletions docs/04-resources/06-guides/eas-guide/eas-userguide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
---
sidebar_position: 2
title: How to Navigate EAS Dashboard Guide
sidebar_label: How to Navigate EAS Dashboard Guide
tags: [rsk, rootstock, resources, mainnet, testnet, tutorials, Attestations, Indexing Service, EAS Devtool, Ethereum, dApps, smart contracts]
description: "This guide explains how to navigate the provided interface, connect your wallet, create an EAS Schema, and explore attestations in detail."
---

<figure>
<img src="/img/guides/EAS/EAS-devtool-dash.png" alt="EAS Dashboard on DevTool"/>
<figcaption>EAS Dashboard on DevTool (fig 1.)</figcaption>
</figure>

This guide explains how to navigate the provided interface, connect your wallet, create an EAS Schema, and explore attestations in detail.

## Getting Started
<Steps>
<Step title="Connecting Your Wallet">
1. **Locate the "Connect Wallet" Button**:
* At the top-right corner of the page, you will see the **Connect Wallet** button.
2. **Click the "Connect Wallet" Button**:
* A wallet connection modal will open, allowing you to choose your preferred cryptocurrency wallet (e.g., MetaMask, WalletConnect, etc.).
3. **Authenticate**:
* Select your wallet and authorize the connection.
* Ensure your wallet is set to the correct blockchain network supported by the EAS platform.
4. **Verify the Connection**:
* Once connected, your wallet address will replace the **Connect Wallet** button, confirming the link.

<figure>
<img src="/img/guides/EAS/EAS-devtool-dash.png" alt="Connecting Your Wallet to EAS"/>
<figcaption>Connecting Your Wallet (fig 2.)</figcaption>
</figure>

> Adding your wallet only provides access to view your schema and attestations.
</Step>
<Step title="Creating an EAS Schema">
1. **Click "Create EAS Schema"**:
* Located at the top-right corner of the interface.

<figure>
<img src="/img/guides/EAS/frontend-guide/eas-schema.png" alt="Creating an EAS Schema"/>
<figcaption>Creating an EAS Schema (fig 3.)</figcaption>
</figure>

2. **Fill Out the Schema Details**:
* **Name**: Enter a descriptive name for the schema.
* **Type**: Select the type of data (e.g., `Address`, `string`, `bool`, `uint8`, etc.).
* If multiple fields are required, click **Add New Field** to define additional data points.
* **Resolver Address** (optional):
* Add a resolver smart contract address if you need custom verification or actions associated with this schema.
* **Is Revocable?**:
* Enable this option if attestations under this schema can be revoked later.
3. **Submit the Schema**:
* Click the **Create Schema** button to deploy the schema on-chain.
4. **Confirmation**:
* Upon successful submission, the schema appears in the list with a unique ID

</Step>
<Step title="Exploring the Schema List">
<figure>
<img src="/img/guides/EAS/frontend-guide/shcema-list.png" alt="Exploring the Schema List"/>
<figcaption>Exploring the Schema List (fig 4.)</figcaption>
</figure>

1. **Schema Overview**
* **All Schemas**: Displays the total number of schemas created.
* **OnChain Attestation**: Number of attestations linked to schemas stored on-chain.
* **OffChain Attestation**: Number of attestations stored off-chain.
2. **Schema Details**:
* Each row displays:
* **ID**: Unique identifier for the schema.
* **UID**: A unique on-chain reference for the schema.
* **Schema Fields**: Data structure of the schema (e.g., `bytes32 schemaId, string name`).
* **Attestations**: The number of attestations linked to this schema.
3. **Clicking on a Schema**:
* Clicking on a schema opens detailed information about its attestations.

</Step>
<Step title="Viewing Attestation Details">
<figure>
<img src="/img/guides/EAS/frontend-guide/view-attestation.png" alt="Viewing Attestation Details"/>
<figcaption>Viewing Attestation Details (fig 5.)</figcaption>
</figure>

:::info[When you select a schema:]

1. **Header Details**:
* **Schema ID**: The unique identifier for the schema.
* **Total Attestations**: Total attestations associated with the schema (on-chain and off-chain).
* Includes growth percentage over the past week.
* **OnChain/OffChain Attestation Counts**: Breakdowns of attestations.
2. **Schema Metadata**:
* **Created On**: The date the schema was created.
* **Creator**: Wallet address of the schema creator.
* **Transaction ID**: Blockchain transaction ID for the schema creation (clickable for blockchain explorer verification).
* **Resolver Contract**: Address of the custom resolver contract (if any).
* **Revocable Attestations**: Indicates whether attestations can be revoked.
3. **Schema Structure**:
* Displays the fields defined in the schema (e.g., `bytes32 schemaId, string name`).
4. **Attest Button**:
* **Attest this Schema**: Allows creating a new attestation under this schema.
:::


</Step>
<Step title="Attesting to a Schema">
Attesting to a schema allows you to associate specific data with an address based on the schema's structure.

#### **Initiating the Attestation**

1. **Click "Attest this Schema"**:
* Located at the bottom of the schema details page (visible in the first screenshot).
2. **Modal Pop-Up**:
* A modal will appear with the following fields:
* **Recipient Address**:
* Enter the wallet address of the person or entity to whom the attestation is being made.
* **Schema Fields**:
* Each field defined in the schema is displayed with an appropriate input box.
* For example, if the schema has a `string` field labeled "Testu," you will see:
* `Testu (string):` followed by an input field to provide the corresponding value.

<figure>
<img src="/img/guides/EAS/frontend-guide/attest-to-schema.png" alt="Attest to schema"/>
<figcaption>Attest To Schema (fig 6.)</figcaption>
</figure>

#### **Completing the Attestation**

1. **Fill in the Details**:
* Enter the **Recipient Address** and all required values for the schema fields.
* Double-check that the data aligns with the schema's structure.
2. **Submit or Close**:
* **Attest Button**:
* Click the **Attest** button to finalize and submit the attestation.
* **Close Button**:
* If you wish to cancel the process, click the **Close** button to exit the modal without submitting.

#### **Processing the Attestation**

1. **On Submission**:
* After clicking **Attest**, the attestation will be sent to the blockchain for processing.
* A transaction approval modal may appear via your connected wallet. Approve the transaction to proceed.
2. **Confirmation**:
* After a few minutes, the attestation will be confirmed on the blockchain.

#### **Viewing the Completed Attestation**

<figure>
<img src="/img/guides/EAS/frontend-guide/completed-attestation.png" alt="Viewing the Completed Attestation"/>
<figcaption>Viewing the Completed Attestation (fig 7.)</figcaption>
</figure>

**Post-Attestation View**:
* Once confirmed, the attestation details will appear in the schema details page under its **Attestations** count.
* The attestation data can now be viewed as part of the schema's record.
</Step>
</Steps>







Loading

0 comments on commit 0892bff

Please sign in to comment.