Skip to content

Commit

Permalink
Rebase and clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
Wes Biggs committed Jun 14, 2024
1 parent 1b0dd06 commit 7f39e0f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .spellcheckerdict.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ CalVer
CC0
Changelog
changeType
cid
(cid|CID)s?
[Cc]odec('s)?
contentHash
cryptographic
Expand All @@ -29,6 +29,7 @@ DSNP-referenced
ECIES
EdDSA
[Ee]num(s)?
encodings
Ethereum
Extrinsics
fromId
Expand All @@ -45,6 +46,7 @@ JSON-LD
keccak-256
keyId
keyType
Kubo
LibertyDSNP
libsodium
little-endian
Expand Down
4 changes: 2 additions & 2 deletions pages/DSNP/Announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Each Announcement has an enumerated type for use when separating out a stream of
| 2 | [Broadcast](Types/Broadcast.md) | a public post | YES | YES |
| 3 | [Reply](Types/Reply.md) | a public response to a Broadcast | YES | YES |
| 4 | [Reaction](Types/Reaction.md) | a public visual reply to a Broadcast | no | no |
| 5 | ~~[Profile](Types/Profile.md)~~<sup>b</sup> | ~~a profile~~ | ~~YES~~ | ~~no~~ |
| 5 | ~~[Profile](Types/Profile.md)~~<sup>c</sup> | ~~a profile~~ | ~~YES~~ | ~~no~~ |
| 6 | [Update](Types/Update.md) | an update to content| YES | no |
| 7 | ~~[Public Key](Types/PublicKey.md)~~<sup>b</sup> | ~~a public key for secure communication~~ | ~~no~~ | ~~no~~ |

<sup>a</sup> Since DSNP version 1.2, social graph changes use [User Data](UserData.md) operations as described in the [Graph](Graph.md) section.

<sup>b</sup> Since DSNP version 1.3, public keys use [User Data](UserData.md) operations.

<sup>b</sup> Since DSNP version 1.3, profile changes use [User Data](UserData.md) operations.
<sup>c</sup> Since DSNP version 1.3, profile changes use [User Data](UserData.md) operations.

## Announcement Validation

Expand Down
8 changes: 4 additions & 4 deletions pages/DSNP/Identifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ A DSNP CID is a valid [Content IDentifier](https://github.com/multiformats/cid)

### Supported CID Parameters

The CID specification allows CIDs to be generated with a wide and ever-growing range of possible hashing algorithms, string encodings, and blocks.
The CID specification allows CIDs to be generated with a wide and ever-growing range of possible hashing algorithms, string encodings, and block sizes.
In order for DSNP applications to interoperate, the required functionality is limited as follows:

- CID version: MUST be version 1, in order to distinguish CIDs from simple multihash values in situations where either may be used
- Hash algorithm: MUST be `sha2-256` or `blake2b-256`
- Encoding: MUST be `base58btc` or `base32`
- Codec: MUST be `dag-cbor` for data 256 KB or more; `raw` for data less than 256 KB
- Chunking: Non-leaf nodes MUST be 256 KB
- Codec: MUST be `dag-pb` for data 256*1024 bytes or longer; `raw` for data less than 256*1024 bytes
- Chunking: Non-leaf nodes MUST be 256*1024 bytes

The rationale for these options is to allow consuming applications to attempt to generate a matching CID from a byte stream for validation purposes without the need to reprocess the stream.
These options are intentionally aligned to interoperate with the default output of the Kubo IPFS command line utility when invoked with option `--cid-version=1`.
These options are intentionally aligned to interoperate with the default output of the [Kubo](https://github.com/ipfs/kubo) IPFS command line utility when invoked as `ipfs add --cid-version=1 ...`.

0 comments on commit 7f39e0f

Please sign in to comment.