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

CIP-0119 | Add "@" to the "@type" field of "references" #950

Open
wants to merge 2 commits into
base: master
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
8 changes: 4 additions & 4 deletions CIP-0119/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,19 +122,19 @@ If the `imageObject` DOES NOT contain a base64 encoded image, the `contentUrl` M
#### `references`
- Optional
- This CIP extends the `references` property from [CIP-100](https://github.com/cardano-foundation/CIPs/tree/master/CIP-0100#high-level-description)
- `references` contain the following sub-properties `type`, `label`, and `uri`
- `references` contain the following sub-properties `@type`, `label`, and `uri`
- This CIP adds two `@type` identifiers "Identity" and "Link"

##### `type`: Link
##### `@type`: Link
- Optional
- It is expected that these links will be the addresses of the social media/ websites associated with the DRep in order to give a person reviewing this information a fulsome overview of the DRep's online presence.
- The creator of the metadata SHOULD add a `label`, this `label` SHOULD describe the source of the url, e.g. if it is a link to the DRep's X account then the `label` SHOULD say "X". If it is the only personal website provided by the DRep the `label` should say "Personal Website" rather than domain_name.com.
- The `label` of each `Link` SHOULD NOT be left blank
- Each `Link` MUST have exactly one `uri` (as specified in CIP-100) which SHOULD not be blank.

##### `type`: Identity
##### `@type`: Identity
- Optional
- The `uri` of a reference with the `type` "Identity" is a way for DReps to prove that they are who they say they are
- The `uri` of a reference with the `@type` "Identity" is a way for DReps to prove that they are who they say they are
- It is expected that the "Identity" of a DRep will be the addresses of their most active social media account twitter, linkedin etc. or personal website.
- The DRep must reference their DRep ID in a prominent place at the location that is specified in the `uri` property of that reference. This will be used by people reviewing this DRep to prove and verify that the person described in the metadata is the same as the person who set up the social media profile.

Expand Down
4 changes: 2 additions & 2 deletions CIP-0119/cip-0119.common.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@
"title": "Reference",
"description": "A reference to a document",
"type": "object",
"required": ["type", "label", "uri"],
"required": ["@type", "label", "uri"],
"properties": {
"type": {
"@type": {
"type": "string",
"enum": ["GovernanceMetadata", "Other", "Link", "Identity"],
"title": "Type"
Expand Down