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

Docs improvements #30

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/core--concepts/credible-neutrality.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Consider a world where every digital interaction is tinged with doubt. Is this p
## EAS Embodies Credible Neutrality
EAS provides a platform that doesn't play favorites. Every attestation, every interaction, is treated with the same level of impartiality. The code has been refactored so many times to not presuppose how it will be used or who will use it, giving everyone a fair shot to build amazing things on top of it.

Credible Neutrality is a core strength required in becoming a standard. Anyone can copy open-source code, but it's the community's trust in its neutrality that makes it unique and irreplaceable.
Credible Neutrality is a core strength required to become a standard. Anyone can copy open-source code, but it's the community's trust in its neutrality that makes it unique and irreplaceable.

## Centralization & Tokens != Credible Neutrality
### Centralization: The Single Point of Bias
Expand Down
2 changes: 1 addition & 1 deletion docs/core--concepts/how-eas-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Attestations are the building blocks of building trust online. Think of an attes
But for this system to work seamlessly, we need a standardized way to structure this data. This is where schemas come into play.

## Schemas give structure to the attestation
Think of a schema as a blueprint or template. It defines the structure and format of the data you want to attest to. For example if you want to attest to someone you trust, all you'd need is a true false field for "isTrusted". Or if you wanted to a vote, you might have a "eventName" and a "location" and "startTime" and "endTime". It's the builder's choice to determine the right schema for their particular use case.
Think of a schema as a blueprint or template. It defines the structure and format of the data you want to attest to. For example if you want to attest to someone you trust, all you'd need is a true false field for "isTrusted". Or if you wanted to vote, you might have a "eventName" and a "location" and "startTime" and "endTime". It's the builder's choice to determine the right schema for their particular use case.

Here's the general flow of how a schema is registered:
1. The schema's structure is defined (e.g., what fields it will have and the data types).
Expand Down
4 changes: 2 additions & 2 deletions docs/core--concepts/onchain-vs-offchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Attestations can be made either onchain or offchain. While **onchain attestation
## What are Onchain and Offchain Attestations?
- **Onchain Attestations:** These are attestations that are stored directly on the Ethereum blockchain. They are immutable and benefit from the security and decentralization of the blockchain. They are great when attestations need to be read by smart contracts or you need guaranteed availability.

- **Offchain Attestations:** These attestations are stored off the Ethereum blockchain, typically in a database or another storage mechanism. They are linked to the blockchain through cryptographic signatures but do not reside on it. Offchain attestations are great when you want to hold the attestation privately and shared on a need to know basis.
- **Offchain Attestations:** These attestations are stored off the Ethereum blockchain, typically in a database or another storage mechanism. They are linked to the blockchain through cryptographic signatures but do not reside on it. Offchain attestations are great when you want to hold the attestation privately and shared it on a need to know basis.

## Onchain vs Offchain: At a Glance
| Feature/Aspect | Onchain Attestations | Offchain Attestations |
Expand Down Expand Up @@ -66,4 +66,4 @@ Some projects may require the scalability and cost efficiencies that coincide wi

There are, however, additional storage options designed to maximize on both scalability and decentralization, offering a less binary solution suitable for many use-cases, including off-chain attestations. For example, options like the Ceramic Network offer data-streaming and querying capabilities familiar to developers who have worked with Kafka, GraphQL, and relational databases, but built on a fully decentralized and open-source framework built on IPFS content addressing with "roll-up" publishing transactions directly on the Ethereum blockchain. *Learn how to store and retrieve off-chain attestations on Ceramic using ComposeDB in [this tutorial](../tutorials/ceramic-storage).*

It's important for teams to consider the trade-offs between on-chain, off-chain, and non-conforming solutions like Verifiable Data Ledgers, and make the design choices best suited for their unique goals and use-cases.
It's important for teams to consider the trade-offs between on-chain, off-chain, and non-conforming solutions like Verifiable Data Ledgers, and make the design choices best suited for their unique goals and use-cases.
2 changes: 1 addition & 1 deletion docs/core--concepts/privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Always encrypt sensitive data, even if it's offchain. When attesting to encrypte


### Zero Knowledge Proofs (ZKPs)
ZKPs allow one party to prove to another that a statement is true without revealing any specific information about the statement itself. It's a powerful tool for privacy-preserving attestations. For example, you can generate an attestation onchain or offchain and then allow the recipient or issuer of the attestation generate an ZKP from the attestation data. Which then can be selectively shared to those who need to know without disclosing the addresses or data involved.
ZKPs allow one party to prove to another that a statement is true without revealing any specific information about the statement itself. It's a powerful tool for privacy-preserving attestations. For example, you can generate an attestation onchain or offchain and then allow the recipient or issuer of the attestation generate a ZKP from the attestation data. Which then can be selectively shared with those who need to know without disclosing the addresses or data involved.



Expand Down
2 changes: 1 addition & 1 deletion docs/developer-tools/eas-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ const transaction = await schemaRegistry.register({
revocable,
});

// Optional: Wait for transaction to be validated
// Optional: Wait for the transaction to be validated
await transaction.wait();
```

Expand Down
2 changes: 1 addition & 1 deletion docs/easscan/offchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Creating an offchain attestation requires only a digital signature from your wal
## Sharing Your Offchain Attestation
With your offchain attestation created, you can:

- **Download the Data:** Save the attestation data for future reference or sharing. Store it in your own servers.
- **Download the Data:** Save the attestation data for future reference or sharing. Store it on your own servers.
- **Download the QR Image:** A scannable QR code containing the attestation data, including the signature.
- **Share the Link**: Share the URL link of your attestation and share it peer-to-peer.

Expand Down
2 changes: 1 addition & 1 deletion docs/easscan/utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Here's an example of the Capitol Building in Colorado, USA.
![Land Registry Example](./img/land-registry-example.png)

### Devfolios Quadratic Voting System
Kudos to the [**Devfolio**](https://devfolio.co/discover) team! They built a unique `Quadratic Voting System` for their hackathon. It allowed the community to cast their votes on the projects they believe deserve the prize pool. Each attestation was a record of the users votes to ensure transparency.
Kudos to the [**Devfolio**](https://devfolio.co/discover) team! They built a unique `Quadratic Voting System` for their hackathon. It allowed the community to cast their votes on the projects they believe deserve the prize pool. Each attestation was a record of the user's votes to ensure transparency.

**Read More:**:[**Introooducing Quadratic Voting:**](https://devfolio.co/blog/introooducing-quadratic-voting-on-devfolio/)

Expand Down