Skip to content

Commit a1a2182

Browse files
wesbiggsWes Biggs
authored and
Wes Biggs
committed
DIP-257 Attribute Sets and attestation
1 parent f782332 commit a1a2182

19 files changed

+1112
-25
lines changed

.spellcheckerdict.txt

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
Alexa
1+
accreditations
22
announcementType
3+
attributeSetType
4+
attributeSetTypeName
5+
attributeSetTypeNamespace
36
Avro
47
Base58
8+
BCP-47
59
BLAKE2b
610
Brötli
711
CalVer
@@ -10,26 +14,32 @@ Changelog
1014
changeType
1115
[Cc]odec('s)?
1216
contentHash
13-
cryptographic
17+
[Cc]ryptographic
1418
cryptographically
19+
[Cc]ryptosuites
1520
CtxSharedSecretA
1621
CtxSharedSecretB
1722
CtxSharedSecretBob
1823
Curve25519
1924
decrypt
2025
Delegator
21-
Deserialize
26+
[Dd]eserialize(d?)
27+
DIDs
2228
Diffie-Hellman
2329
[Dd]iscoverable
2430
DSNP
2531
DSNP-compatible
32+
dsnp-did-resolver
2633
DSNP-referenced
34+
dsnp-verifiable-credentials
2735
ECIES
36+
EdDSA
2837
[Ee]num(s)?
2938
Ethereum
3039
Extrinsics
3140
fromId
3241
GraphEdge
42+
hashcode
3343
H265
3444
HBASE
3545
HTTPS
@@ -46,29 +56,40 @@ LibertyDSNP
4656
libsodium
4757
little-endian
4858
localhost
59+
localizable
60+
lookups
4961
Mainnet
5062
mdBook
5163
MDX
64+
Metaschema
5265
MP[34]
5366
MSA
5467
multibase
68+
[Mm]ultibase-encoded
5569
multicodec
70+
multicodec-prefixed
5671
[Mm]ultihash
5772
multihash-encoded
58-
multikey
73+
[Mm]ultikey
5974
NaCl
75+
namespaced
76+
non-DSNP
6077
objectId
6178
OGG
6279
Parachain
6380
parseable
6481
Paseo
82+
personhood
6583
PNG
6684
Polkadot
6785
Poly1305
6886
pre-configured
87+
[Pp]rerelease
6988
PRId([ABs])?
89+
pseudonymously
7090
publicKey
7191
repo
92+
resolvers
7293
RFC[1-9][0-9]*
7394
Ristretto
7495
RPC
@@ -80,7 +101,9 @@ SDK
80101
SHA-256
81102
Stateful
82103
stringified
83-
subkey
104+
subjectContentHash
105+
subkey(s?)
106+
substring
84107
SVG
85108
targetAnnouncementType
86109
targetContentHash
@@ -92,17 +115,21 @@ UINT_8
92115
uncompress
93116
unencrypted
94117
[Uu]nfollow(ed)?
118+
unhashed
95119
URI
96120
url
97121
userId
98122
UTF-8
99123
v[0-9]+(\.[0-9]+)*
100124
vanishingly
101125
varint
126+
[Vv]erifier(s?)
127+
verifiability
102128
W3C
103129
WebM
104130
WebP
105131
websocket
106132
whitepaper
133+
whitespace
107134
X25519
108135
XSalsa20

STYLEGUIDE.md

Lines changed: 105 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,69 +4,119 @@ Style guide defining wording, spelling, and other details regarding how DSNP ter
44
For more information about DSNP, visit [dsnp.org](https://www.dsnp.org/)
55
or [DSNP on GitHub](https://github.com/LibertyDSNP/spec)
66

7-
## Announcement
8-
Uppercase A
7+
## General rules
8+
* Announcements specific to DSNP have initial caps. (i.e., Broadcast Announcement)
9+
* Announcement Types also have initial caps.
10+
* General words that aren't specific to DSNP are lowercase (i.e., announcement, batch, content hash).
11+
* Attribute is lowercase except when combined with an announcement or a specific DSNP set type. (i.e., Attribute Set Announcement)
12+
13+
## announcement
14+
Generally all lowercase
915

1016
## Announcement Type
1117
Uppercase A and T
1218

13-
## Batch
14-
Uppercase B
19+
## attribute
20+
All lowercase
21+
22+
## attribute sets
23+
All lowercase
24+
25+
## Attribute Set Announcement
26+
Uppercase A, S and A
27+
28+
## Attribute Set Type
29+
Uppercase A, S and T
30+
31+
## Attribute Set Value Document
32+
Uppercase A, S, V and D
33+
34+
## batch
35+
All lowercase
1536

1637
## Batch Publication
1738
Uppercase B and P
1839

40+
## bloom filter
41+
lowercase b and f
42+
43+
## Broadcast Announcements
44+
Uppercase B and A
45+
1946
## Code of Conduct
2047
Uppercase C and C
2148

2249
## community
2350
All lowercase
2451

52+
## content announcement
53+
All lowercase
54+
55+
## Content Attribute Set
56+
57+
## content hash
58+
All lowercase
59+
60+
## credential document
61+
All lowercase
62+
2563
## Decentralized Social Networking Protocol (DSNP)
2664
Spelled out fully first time it appears and then acronym thereafter. Avoid preceding with the word "the" and never follow with the word "protocol".
2765

2866
## development community
2967
All lowercase
3068

69+
## DSNP Announcements
70+
Uppercase DSNP and A
71+
3172
## DSNP public social graph
3273
All lowercase after acronym
3374

3475
## DSNP Batch Publications
3576
Uppercase Acronym plus uppercase B and P
3677

78+
## DSNP content
79+
Uppercase acronym, lowercase c
80+
3781
## DSNP Content Hash
3882
Uppercase Acronym plus uppercase C and H
3983

84+
## DSNP Content URI
85+
Uppercase D, C and URI
86+
4087
## DSNP graph
4188
Only acronym is uppercase
4289

4390
## DSNP Identifiers
4491
Uppercase Acronym plus uppercase I
4592

46-
## DSNP Identity
47-
Uppercase Acronym plus Uppercase I
93+
## DSNP identity
94+
Uppercase Acronym lowercase i
4895

4996
## DSNP Id
50-
Short for DSNP Identity, Uppercase Acronym plus uppercase I
97+
Short for DSNP identity, Uppercase Acronym lowercase when spelled out
5198

5299
## DSNP Protocol Scheme
53100
Uppercase Acronym plus uppercase P and S
54101

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

105+
## DSNP user
106+
Uppercase DSNP and lowercase u
107+
58108
## DSNP User Id
59109
Uppercase acronym, U and I, avoid preceding with the word "the"
60110

61111
## DSNP User URI
62112
Uppercase Acronyms plus uppercase U
63113

64-
## End User
65-
Uppercase E and U
66-
67114
## Exclamation Marks
68115
Should be avoided
69116

117+
## External Content Attributes
118+
Uppercase E, C and A
119+
70120
## Graph Change Announcements
71121
Uppercase G, C and A.
72122
Note: Graph Change Announcements and events have been migrated to use User Data Operations as of version 1.2.0.
@@ -78,9 +128,15 @@ Note: Graph Change Announcements and events have been migrated to use User Data
78128
## InterPlanetary File System (IPFS)
79129
Uppercase I, P, F and S. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.
80130

131+
## issuer
132+
All lower case
133+
81134
## MUST/MUST NOT
82135
All Caps when defining rules for specification
83136

137+
## on-demand credential
138+
Hyphenated, all lower case
139+
84140
## Operation
85141
Uppercase O when referring to spec-defined DSNP Operations
86142

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

149+
## Profile Announcement
150+
Uppercase P and A
151+
93152
## Project Liberty
94153
Uppercase P and L
95154

155+
## public key
156+
All lowercase
157+
96158
## public graph
97159
All lowercase
98160

161+
## Public Key Announcement
162+
Uppercase P, K and A
163+
99164
## Reaction Announcement
100165
Uppercase R and A
101166

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

170+
## Reply Announcements
171+
Uppercase R and A
172+
173+
## schema
174+
All lowercase
175+
105176
## social network graph
106177
All lowercase
107178

108179
## Team
109180
Should not be used in context with DSNP
110181

182+
## Tombstone Announcement
183+
Uppercase T and A
184+
185+
## User Attribute Set Announcement
186+
Uppercase U, A, S and A
187+
188+
## verifier
189+
Lowercase v
190+
191+
## Verifiable Credential Document
192+
Uppercase V, C and D
193+
194+
## Verifier Credential Schema Document
195+
Uppercase V, C, S and D
196+
111197
## Update Announcement
112198
Uppercase U and A
113199

200+
## user
201+
All lowercase
202+
203+
## User Attribute Set
204+
Uppercase U, A and S
205+
206+
## verifier
207+
All lowercase
208+
114209
## We/Us/Our
115210
Should not be used in context with Frequency

0 commit comments

Comments
 (0)