Skip to content

The description of the attestation attribute may be confusing #24

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

The description of the attestation attribute may be confusing #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions docs/tutorials/make-an-attestation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ You can access this example private offchain attestation by going to this:
### EAS SDK
Make sure you've successfully initialized the SDK in your project. You can [**learn more about the SDK here**](/docs/developer-tools/eas-sdk.md) if you have not done this step yet.

The `attest` function allows you to create an onchain attestation for a specific schema. This function takes an object with the following properties:
The `attest` function allows you to create an onchain attestation for a specific schema. This function takes an object(`AttestationRequest`) with the following properties:
- **schema:** The UID of the schema for which the attestation is being created.
- **data:** An object containing the following properties:
- **recipient:** The Ethereum address of the recipient of the attestation.
- **expirationTime:** A Unix timestamp representing the expiration time of the attestation. Use 0 for no expiration.
- **revocable:** A boolean indicating whether the attestation is revocable or not.
- **refUID:** (Optional) The UID of a referenced attestation. Use ZERO_BYTES32 if there is no reference.
- **data:** The encoded data for the attestation, which should be generated using the SchemaEncoder class.
- **data:** An object(`AttestationRequestData`) containing the following properties:
- **recipient:** The Ethereum address of the recipient of the attestation.
- **expirationTime:** A Unix timestamp representing the expiration time of the attestation. Use 0 for no expiration.
- **revocable:** A boolean indicating whether the attestation is revocable or not.
- **refUID:** (Optional) The UID of a referenced attestation. Use ZERO_BYTES32 if there is no reference.
- **data:** The encoded data for the attestation, which should be generated using the SchemaEncoder class.

The function returns a Promise that resolves to the UID of the newly created attestation.

Expand Down