Skip to content

Update schemas.mdx #856

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

Merged
merged 3 commits into from
Aug 26, 2024
Merged

Update schemas.mdx #856

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab47b87
Update schemas.mdx
C-Emily-Furlong Aug 26, 2024
3d60ff1
fix linting issues
krofax Aug 26, 2024
e762b30
fix linting issues
krofax Aug 26, 2024
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
46 changes: 36 additions & 10 deletions pages/chain/identity/schemas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,31 @@ Below you will find a list of relevant schemas that are being used on OP Mainnet

## Schemas related to project creation and Retro Funding application

### [Project Identifier](https://optimism.easscan.org/schema/view/0x7ae9f4adabd9214049df72f58eceffc48c4a69e920882f5b06a6c69a3157e5bd)
### [Project and Organization identifier](https://optimism.easscan.org/schema/view/0xff0b916851c1c5507406cfcaa60e5d549c91b7f642eb74e33b88143cae4b47d0)

Used as the unique identifier for projects created in the Collective.
Used as the unique identifier for projects and organizations created on or after 23 August 2024. For projects created earlier, please see the archived section at the bottom of this page.

| Schema UID | `0x7ae9f4adabd9214049df72f58eceffc48c4a69e920882f5b06a6c69a3157e5bd` |
| Schema UID | `0xff0b916851c1c5507406cfcaa60e5d549c91b7f642eb74e33b88143cae4b47d0` |
| ----------- | --------------------------------------------------------------------------------------------------------------- |
| Issuer | Attestations issued as part of Retro Funding sign up are issued by `0xF6872D315CC2E1AfF6abae5dd814fd54755fE97C` |
| Recipient | Null |
| farcasterID | The Farcaster id of the individual who created the project |
| farcasterID | The Farcaster id of the individual who created the project or organization |
| type | "Project" or "Organization" |

### [Organization Metadata](https://optimism.easscan.org/schema/view/0xc2b376d1a140287b1fa1519747baae1317cf37e0d27289b86f85aa7cebfd649f)

Used to associate metadata to an organization. Re-issued each time there is a change to metadata

| Schema UID | `0xc2b376d1a140287b1fa1519747baae1317cf37e0d27289b86f85aa7cebfd649f` |
| ------------ | --------------------------------------------------------------------------------------------------------------- |
| Issuer | Attestations issued as part of Retro Funding sign up are issued by `0xF6872D315CC2E1AfF6abae5dd814fd54755fE97C` |
| Recipient | Null |
| RefUID | The attestation UID of the organization this metadata relates to |
| farcasterID | The Farcaster id of the individual who published the organization metadata |
| name | The name of the organization |
| projects | The array of projects that belong to this organization |
| parentOrgUID | The attestation UID of this organizations's parent, in case it has one |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical error.

Change "this organizations's" to "these organizations'".

Apply this diff to fix the grammatical error:

- | parentOrgUID | The attestation UID of this organizations's parent, in case it has one |
+ | parentOrgUID | The attestation UID of these organizations' parent, in case it has one |
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| parentOrgUID | The attestation UID of this organizations's parent, in case it has one |
| parentOrgUID | The attestation UID of these organizations' parent, in case it has one |
Tools
LanguageTool

[grammar] ~42-~42: The singular determiner ‘this’ may not agree with the plural noun ‘organizations’. Did you mean “these”?
Context: ...| parentOrgUID | The attestation UID of this organizations's parent, in case it has ...

(THIS_NNS)

| metadataType | How the metadata can be accessed. 1 for ipfs, 2 for http |
| metadataUrl | The storage location where the metadata can be retrieved |

### [Project Metadata](https://optimism.easscan.org/schema/view/0xe035e3fe27a64c8d7291ae54c6e85676addcbc2d179224fe7fc1f7f05a8c6eac)

Expand All @@ -39,7 +55,7 @@ Used to associate metadata to a project. Re-issued each time there is a change t
| farcasterID | The Farcaster id of the individual who published the project metadata |
| name | The name of the project |
| category | The category of the project |
| parentProject RefUID | The attestation UID of this project's parent project, in case it has a parent. |
| parentProject RefUID | The attestation UID of this project's parent project, in case it has a parent |
| metadataType | How the metadata can be accessed. 1 for ipfs, 2 for http |
| metadataUrl | The storage location where the metadata can be retrieved |

Expand All @@ -53,8 +69,8 @@ Used to identify a project's application to a specific Retro Funding Round.
| Recipient | Null |
| round | The round number for which this application was submitted |
| projectRefUID | The unique identifier of the project that submitted this application |
| farcasterID | The individual that submitted this application on behalf of the project |
| metadataSnapshot RefUID | The project metadata at the time the application was submitted |
| farcasterID | The individual that submitted this application on behalf of the project. |
| metadataSnapshot RefUID | The project metadata at the time the application was submitted. |

### [Retro Funding Application Approval/Rejection](https://optimism.easscan.org/schema/view/0x683b1b399d47aabed79c9aa8f2674729021174b6e5cce1e20675eab404fc82d6)

Expand All @@ -64,8 +80,8 @@ Used to identify which Retro Funding applications have been approved or rejected
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Issuer | Currently, the Optimism Foundation issues these from the following address: `0xE4553b743E74dA3424Ac51f8C1E586fd43aE226F` |
| Recipient | Null |
| projectApplicationUID | The unique identifier of the projects Retro Funding application |
| Status | The status of the Retro Funding application |
| projectApplicationUID | The unique identifier of the projects Retro Funding application. |
| Status | The status of the Retro Funding application. |
| Reason | Identifier for the reason an application was rejected. 1 = "Duplicate Application", 2 = "Deceiving Badgeholders", 3 = "Spam", 4 = "Not meeting eligibility criteria" |

### [Retro Funding Rewards](https://optimism.easscan.org/schema/view/0x670ad6e6ffb842d37e050ea6d3a5ab308195c6f584cf2121076067e0d8adde18)
Expand Down Expand Up @@ -121,6 +137,16 @@ Issued to those who held governance roles in the Collective, such as Grants Coun

These schemas are no longer being actively issued, but capture valuable historical data.

### [Project Identifier](https://optimism.easscan.org/schema/view/0x7ae9f4adabd9214049df72f58eceffc48c4a69e920882f5b06a6c69a3157e5bd)

Used as the unique identifier for projects created in the Collective before 23 August 2024. Attestations issued from this schema prior to 23 August 2024 are still used as the unique identifier for projects. New projects created after 23 August 2024 use the new entity identifier (see above).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve readability.

Replace "prior to" with "before".

Apply this diff to improve readability:

- Attestations issued from this schema prior to 23 August 2024 are still used as the unique identifier for projects.
+ Attestations issued from this schema before 23 August 2024 are still used as the unique identifier for projects.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Used as the unique identifier for projects created in the Collective before 23 August 2024. Attestations issued from this schema prior to 23 August 2024 are still used as the unique identifier for projects. New projects created after 23 August 2024 use the new entity identifier (see above).
Used as the unique identifier for projects created in the Collective before 23 August 2024. Attestations issued from this schema before 23 August 2024 are still used as the unique identifier for projects. New projects created after 23 August 2024 use the new entity identifier (see above).
Tools
LanguageTool

[style] ~142-~142: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...4. Attestations issued from this schema prior to 23 August 2024 are still used as the un...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


| Schema UID | `0x7ae9f4adabd9214049df72f58eceffc48c4a69e920882f5b06a6c69a3157e5bd` |
| ----------- | --------------------------------------------------------------------------------------------------------------- |
| Issuer | Attestations issued as part of Retro Funding sign up are issued by `0xF6872D315CC2E1AfF6abae5dd814fd54755fE97C` |
| Recipient | Null |
| farcasterID | The Farcaster id of the individual who created the project |

* **[RetroPGF 3 Approved Application schema UID](https://optimism.easscan.org/schema/view/0xebbf697d5d3ca4b53579917ffc3597fb8d1a85b8c6ca10ec10039709903b9277):**`0xebbf697d5d3ca4b53579917ffc3597fb8d1a85b8c6ca10ec10039709903b9277`. Important: Remember to verify the attester address is `0x621477dBA416E12df7FF0d48E14c4D20DC85D7D9`
* **[RetroPGF 3 Application schema UID](https://optimism.easscan.org/schema/view/0x76e98cce95f3ba992c2ee25cef25f756495147608a3da3aa2e5ca43109fe77cc):** `0x76e98cce95f3ba992c2ee25cef25f756495147608a3da3aa2e5ca43109fe77cc`
* **[RetroPGF 3 Lists schema UID](https://optimism.easscan.org/schema/view/0x3e3e2172aebb902cf7aa6e1820809c5b469af139e7a4265442b1c22b97c6b2a5):** `0x3e3e2172aebb902cf7aa6e1820809c5b469af139e7a4265442b1c22b97c6b2a5`
Expand Down
Loading