Update IPFS codec registration example #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update documentation to reflect that versions of js-IPFS greater than 0.40 support direct usage of multiformats codecs.
rvagg
reviewed
Sep 8, 2021
README.md
Outdated
| @@ -166,7 +163,7 @@ const storeEncrypted = async (payload, key) => { | |||
| // encrypt into JWE container layout using secret key | |||
| const jwe = await createJWE(cleartext, [dirEncrypter]) | |||
| // let IPFS store the bytes using the DAG-JOSE codec and return a CID | |||
| const cid = await ipfs.dag.put(jwe, { format: dagJoseIpldFormat.codec, hashAlg: 'sha2-256' }) | |||
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |||
There was a problem hiding this comment.
best to use use dagJose.name since that's the internal matching that's going to happen in js-ipfs and the user can avoid one magic string
There was a problem hiding this comment.
Suggested change
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |
| const cid = await ipfs.dag.put(jwe, { format: dagJose.name, hashAlg: 'sha2-256' }) |
rvagg
approved these changes
Sep 8, 2021
Done -- thank you for the review. I arrived here after stepping through https://blog.ceramic.network/how-to-store-signed-and-encrypted-data-on-ipfs/ which refers to the legacy codec wrapper. I wonder if there's a way to attach a note there mentioning the change. |
|
@oed will know. There's been a lot of change in the entire IPLD (and therefore js-ipfs) stack this year but it should have stabilised now so this pattern should be good for the time being. |
oed
requested changes
Sep 8, 2021
README.md
Outdated
| @@ -166,7 +163,7 @@ const storeEncrypted = async (payload, key) => { | |||
| // encrypt into JWE container layout using secret key | |||
| const jwe = await createJWE(cleartext, [dirEncrypter]) | |||
| // let IPFS store the bytes using the DAG-JOSE codec and return a CID | |||
| const cid = await ipfs.dag.put(jwe, { format: dagJoseIpldFormat.codec, hashAlg: 'sha2-256' }) | |||
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |||
There was a problem hiding this comment.
Suggested change
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |
| const cid = await ipfs.dag.put(jwe, { format: dagJose.name, hashAlg: 'sha2-256' }) |
README.md
Outdated
| @@ -206,7 +203,7 @@ const storeEncrypted = async (payload, pubkey) => { | |||
| // encrypt into JWE container layout using public key | |||
| const jwe = await createJWE(cleartext, [asymEncrypter]) | |||
| // let IPFS store the bytes using the DAG-JOSE codec and return a CID | |||
| const cid = await ipfs.dag.put(jwe, { format: dagJoseIpldFormat.codec, hashAlg: 'sha2-256' }) | |||
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |||
There was a problem hiding this comment.
Suggested change
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |
| const cid = await ipfs.dag.put(jwe, { format: dagJose.name, hashAlg: 'sha2-256' }) |
README.md
Outdated
| @@ -246,7 +243,7 @@ const cleartext = prepareCleartext({ my: 'secret message' }) | |||
|
|
|||
| // encrypt and put into ipfs | |||
| const jwe = jose.JWE.encrypt.flattened(cleartext, jwk, { alg: 'dir', enc: 'A128CBC-HS256' }) | |||
| const cid = await ipfs.dag.put(jwe, { format: format.codec, hashAlg: 'sha2-256' }) | |||
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |||
There was a problem hiding this comment.
Suggested change
| const cid = await ipfs.dag.put(jwe, { format: 'dag-jose', hashAlg: 'sha2-256' }) | |
| const cid = await ipfs.dag.put(jwe, { format: dagJose.name, hashAlg: 'sha2-256' }) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update documentation to reflect that versions of js-IPFS greater than 0.40 support direct usage of multiformats codecs.