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.

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

DIP-257 Attribute Sets and Attestation #275

Merged
merged 6 commits into from
Sep 17, 2024
Merged

DIP-257 Attribute Sets and Attestation #275

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c87310e
DIP-257 Attribute Sets and attestation
wesbiggs Jul 3, 2023
64dab1c
Minor doc fix
Aug 2, 2024
5faa5c2
Include support for VC 2.0 credentials.
Aug 29, 2024
3c9dc36
Lint fixes
Aug 29, 2024
1691ec2
Link fix and more extensive DID example.
Aug 29, 2024
f23be50
Review changes (mostly stylistic)
Sep 17, 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
37 changes: 31 additions & 6 deletions .spellcheckerdict.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
Alexa
accreditations
announcementType
attributeSetType
attributeSetTypeName
attributeSetTypeNamespace
Avro
base32
Base58
BCP-47
BLAKE3
Brötli
CalVer
Expand All @@ -13,21 +17,25 @@ changeType
[Cc]odec('s)?
contentAddress
contentHash
cryptographic
[Cc]ryptographic
cryptographically
[Cc]ryptosuites
CtxSharedSecretA
CtxSharedSecretB
CtxSharedSecretBob
Curve25519
decrypt(ed)?
Delegator
[Dd]eserialize(d)?
[Dd]eserialize(d?)
DIDs
Diffie-Hellman
discoverability
[Dd]iscoverable
DSNP
DSNP-compatible
dsnp-did-resolver
DSNP-referenced
dsnp-verifiable-credentials
ECIES
EdDSA
[Ee]num(s)?
Expand All @@ -36,6 +44,7 @@ Ethereum
Extrinsics
fromId
GraphEdge
hashcode
H265
HBASE
HTTPS
Expand All @@ -53,32 +62,42 @@ LibertyDSNP
libsodium
little-endian
localhost
localizable
lookups
Mainnet
mdBook
MDX
Metaschema
MP[34]
MSA
[Mm]ultibase
[Mm]ultibase-encoded
multicodec
multicodec-prefixed
[Mm]ultihash
multihash-encoded
multikey
[Mm]ultikey
NaCl
namespaced
non-DSNP
objectId
OGG
Parachain
parseable
Paseo
personhood
PNG
Polkadot
Poly1305
pre-configured
Prepending
Prerelease
[Pp]rerelease
PRId([ABs])?
ProfileResource
pseudonymously
[Pp]ublicKey
repo
resolvers
RFC[1-9][0-9]*
Ristretto
RPC
Expand All @@ -91,7 +110,9 @@ SHA-256
SHA-512
Stateful
stringified
subkey
subjectContentHash
subkey(s?)
substring
SVG
targetAnnouncementType
targetContentHash
Expand All @@ -103,17 +124,21 @@ UINT_8
uncompress
unencrypted
[Uu]nfollow(ed)?
unhashed
URI
url
userId
UTF-8
v[0-9]+(\.[0-9]+)*
vanishingly
varint
[Vv]erifier(s?)
verifiability
W3C
WebM
WebP
websocket
[Ww]hitepaper
whitespace
X25519
XSalsa20
115 changes: 105 additions & 10 deletions STYLEGUIDE.md
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

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

To the Style Guide I would add Activity Content - Uppercase A and C,
Verifiable Credentials - Uppercase V and C
Verifiable Credential Schema - Uppercase V, C and S
and
YES and no--When describing required items, use an all cap YES otherwise use a lowercase no.

Original file line number Diff line number Diff line change
Expand Up @@ -4,69 +4,119 @@ Style guide defining wording, spelling, and other details regarding how DSNP ter
For more information about DSNP, visit [dsnp.org](https://www.dsnp.org/)
or [DSNP on GitHub](https://github.com/LibertyDSNP/spec)

## Announcement
Uppercase A
## General rules
* Announcements specific to DSNP have initial caps. (i.e., Broadcast Announcement)
* Announcement Types also have initial caps.
* General words that aren't specific to DSNP are lowercase (i.e., announcement, batch, content hash).
* Attribute is lowercase except when combined with an announcement or a specific DSNP set type. (i.e., Attribute Set Announcement)

## announcement
Generally all lowercase

## Announcement Type
Uppercase A and T

## Batch
Uppercase B
## attribute
All lowercase

## attribute sets
All lowercase

## Attribute Set Announcement
Uppercase A, S and A

## Attribute Set Type
Uppercase A, S and T

## Attribute Set Value Document
Uppercase A, S, V and D

## batch
All lowercase

## Batch Publication
Uppercase B and P

## bloom filter
lowercase b and f

## Broadcast Announcements
Uppercase B and A

## Code of Conduct
Uppercase C and C

## community
All lowercase

## content announcement
All lowercase

## Content Attribute Set

## content hash
All lowercase

## credential document
All lowercase

## Decentralized Social Networking Protocol (DSNP)
Spelled out fully first time it appears and then acronym thereafter. Avoid preceding with the word "the" and never follow with the word "protocol".

## development community
All lowercase

## DSNP Announcements
Uppercase DSNP and A

## DSNP public social graph
All lowercase after acronym

## DSNP Batch Publications
Uppercase Acronym plus uppercase B and P

## DSNP content
Uppercase acronym, lowercase c

## DSNP Content Hash
Uppercase Acronym plus uppercase C and H

## DSNP Content URI
Uppercase D, C and URI

## DSNP graph
Only acronym is uppercase

## DSNP Identifiers
Uppercase Acronym plus uppercase I

## DSNP Identity
Uppercase Acronym plus Uppercase I
## DSNP identity
Uppercase Acronym lowercase i

## DSNP Id
Short for DSNP Identity, Uppercase Acronym plus uppercase I
Short for DSNP identity, Uppercase Acronym lowercase when spelled out

## DSNP Protocol Scheme
Uppercase Acronym plus uppercase P and S

## DSNP Specification
Uppercase DSNP and S, avoid preceding with the word "the"

## DSNP user
Uppercase DSNP and lowercase u

## DSNP User Id
Uppercase acronym, U and I, avoid preceding with the word "the"

## DSNP User URI
Uppercase Acronyms plus uppercase U

## End User
Uppercase E and U

## Exclamation Marks
Should be avoided

## External Content Attributes
Uppercase E, C and A

## Graph Change Announcements
Uppercase G, C and A.
Note: Graph Change Announcements and events have been migrated to use User Data Operations as of version 1.2.0.
Expand All @@ -78,9 +128,15 @@ Note: Graph Change Announcements and events have been migrated to use User Data
## InterPlanetary File System (IPFS)
Uppercase I, P, F and S. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.

## issuer
All lower case

## MUST/MUST NOT
All Caps when defining rules for specification

## on-demand credential
Hyphenated, all lower case

## Operation
Uppercase O when referring to spec-defined DSNP Operations

Expand All @@ -90,26 +146,65 @@ Always use
## Possessives
Making DSNP possessive should be avoided (e.g. DSNP’s)

## Profile Announcement
Uppercase P and A

## Project Liberty
Uppercase P and L

## public key
All lowercase

## public graph
All lowercase

## Public Key Announcement
Uppercase P, K and A

## Reaction Announcement
Uppercase R and A

## Record
Uppercase R when referring to spec-defined DSNP State Change Records

## Reply Announcements
Uppercase R and A

## schema
All lowercase

## social network graph
All lowercase

## Team
Should not be used in context with DSNP

## Tombstone Announcement
Uppercase T and A

## User Attribute Set Announcement
Uppercase U, A, S and A

## verifier
Lowercase v

## Verifiable Credential Document
Uppercase V, C and D

## Verifier Credential Schema Document
Uppercase V, C, S and D

## Update Announcement
Uppercase U and A

## user
All lowercase

## User Attribute Set
Uppercase U, A and S

## verifier
All lowercase

## We/Us/Our
Should not be used in context with Frequency
2 changes: 1 addition & 1 deletion book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ preferred-dark-theme = "coal"
[output.linkcheck]
follow-web-links = true
traverse-parent-directories = false
exclude = ['en\.bitcoin\.it', 'github\.com/LibertyDSNP/spec']
exclude = ['en\.bitcoin\.it', 'github\.com/LibertyDSNP/spec', 'w3\.org']

[output.html.fold]
enable = true
Loading