This repository was archived by the owner on Jun 2, 2022. It is now read-only.
wip: migrate to latest multiformats #16
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| import Block from './index.js' | ||
| import { codec as multicodec } from 'multiformats' | ||
| import * as dagcbor from '@ipld/dag-cbor' | ||
| Block.add(multicodec.codec(dagcbor)) | ||
|
|
||
| export default Block |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,174 +1,175 @@ | ||||||
| import transform from 'lodash.transform' | ||||||
| import reader from './reader.js' | ||||||
| import json from 'multiformats/codecs/json' | ||||||
| import raw from 'multiformats/codecs/raw' | ||||||
| import { sha256 } from 'multiformats/hashes/sha2' | ||||||
| import { bytes, CID } from 'multiformats' | ||||||
|
|
||||||
| const readonly = value => ({ get: () => value, set: () => { throw new Error('Cannot set read-only property') } }) | ||||||
|
|
||||||
| const immutableTypes = new Set(['number', 'string', 'boolean']) | ||||||
|
|
||||||
| const { coerce, isBinary } = bytes | ||||||
| const copyBinary = value => { | ||||||
| const b = coerce(value) | ||||||
| return coerce(b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength)) | ||||||
| } | ||||||
|
|
||||||
| const clone = obj => transform(obj, (result, value, key) => { | ||||||
| const cid = CID.asCID(value) | ||||||
| if (cid) { | ||||||
| result[key] = cid | ||||||
| } else if (isBinary(value)) { | ||||||
| result[key] = copyBinary(value) | ||||||
| } else if (typeof value === 'object' && value !== null) { | ||||||
| result[key] = clone(value) | ||||||
| } else { | ||||||
| result[key] = value | ||||||
| } | ||||||
| }) | ||||||
|
|
||||||
| const setImmutable = (obj, key, value) => { | ||||||
| if (typeof value === 'undefined') throw new Error(`${key} cannot be undefined`) | ||||||
| Object.defineProperty(this, key, readonly(value)) | ||||||
| } | ||||||
|
|
||||||
| class Block { | ||||||
| constructor ({ codec, hasher, source, cid, data }) { | ||||||
| setImmutable(this, '_codec', codec) | ||||||
| setImmutable(this, '_hasher', hasher) | ||||||
| if (source) setImmutable(this, '_source', source) | ||||||
| if (cid) setImmutable(this, '_cid', cid) | ||||||
| if (data) setImmutable(this, '_data', data) | ||||||
| if (!source && (!data || !cid)) throw new Error('Missing required argument') | ||||||
| if (source && (!codec || !hasher)) throw new Error('Missing required argument') | ||||||
| setImmutable(this, 'asBlock', this) | ||||||
| } | ||||||
|
|
||||||
| decodeUnsafe () { | ||||||
| if (typeof this.opts._source !== 'undefined') return this._source | ||||||
| throw new Error('Block created without a decoded state') | ||||||
| } | ||||||
|
|
||||||
| decode () { | ||||||
| const decoded = this.decodeUnsafe() | ||||||
| if (decoded === null) return null | ||||||
| if (isBinary(decoded)) return copyBinary(decoded) | ||||||
| if (immutableTypes.has(typeof decoded) || decoded === null) { | ||||||
| return decoded | ||||||
| } | ||||||
| return clone(decoded) | ||||||
| } | ||||||
|
|
||||||
| encodeUnsafe () { | ||||||
| if (this._data) return this._data | ||||||
| throw new Error('Block created without an encoded state') | ||||||
| } | ||||||
|
|
||||||
| encode () { | ||||||
| const data = this.encodeUnsafe() | ||||||
| return copyBinary(data) | ||||||
| } | ||||||
|
|
||||||
| async cid () { | ||||||
| if (this._cid) return this._cid | ||||||
| const hash = await this._hasher.digest(this.encodeUnsafe()) | ||||||
| const cid = CID.create(1, this.opts.codec.code, hash) | ||||||
| setImmutable(this, '_cid', cid) | ||||||
| return cid | ||||||
| } | ||||||
|
|
||||||
| get code () { | ||||||
| if (this._cid) return this._cid.code | ||||||
| return this._codec.code | ||||||
| } | ||||||
|
|
||||||
| reader () { | ||||||
| return reader(this.decodeUnsafe()) | ||||||
| } | ||||||
|
|
||||||
| async equals (block) { | ||||||
| if (block === this) return true | ||||||
| if (block.asBlock !== block) return false | ||||||
| const [a, b] = await Promise.all([this.cid(), block.cid()]) | ||||||
| return a.equals(b) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| class BlockDecoder extends Block { | ||||||
| decodeUnsafe () { | ||||||
| if (typeof this.opts._source !== 'undefined') return this._source | ||||||
| if (!this._codec) { | ||||||
|
There was a problem hiding this comment. This check is obsolete because validation occurs at construction site.
Contributor
Author
There was a problem hiding this comment. turns out, there is a case in which you want to create a Block without a codec attached. i actually have to drop the constructor error and move that check to the encoder/decoder methods, but it’ll still be necessary here so that you get a good error if you try to decode a block that doesn’t have a codec attached |
||||||
| throw new Error('Do not have codec implemention in this Block interface') | ||||||
| } | ||||||
| const source = this._codec.decode(this._data) | ||||||
| setImmutable(this, '_source', source) | ||||||
| return source | ||||||
| } | ||||||
| } | ||||||
| class BlockEncoder extends Block { | ||||||
| encodeUnsafe () { | ||||||
| if (this._data) return this._data | ||||||
| if (!this._codec) { | ||||||
|
There was a problem hiding this comment. This check is obsolete because it's validated at the construction site. |
||||||
| throw new Error('Do not have codec implemention in this Block interface') | ||||||
| } | ||||||
| const data = this._codec.encode(this._source) | ||||||
| setImmutable(this, '_data', data) | ||||||
| return data | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| Block.codecs = new Map() | ||||||
|
|
||||||
| Block.add = codec => { | ||||||
| if (codec.name) Block.codecs.set(codec.name, codec) | ||||||
| if (codec.code) Block.codecs.set(codec.code, codec) | ||||||
| } | ||||||
| Block.add(json) | ||||||
| Block.add(raw) | ||||||
|
|
||||||
| Block.encoder = (source, codec, hasher = sha256) => { | ||||||
| if (typeof codec === 'string') codec = Block.codecs.get(codec) | ||||||
| if (!codec) throw new Error('Missing codec') | ||||||
| return new BlockEncoder({ source, codec, hasher }) | ||||||
| } | ||||||
| Block.decoder = (data, codec, hasher = sha256) => { | ||||||
| if (typeof codec === 'string') codec = Block.codecs.get(codec) | ||||||
| if (!codec) throw new Error('Missing codec') | ||||||
| return new BlockDecoder({ data, codec, hasher }) | ||||||
| } | ||||||
| Block.createUnsafe = (data, cid, { hasher, codec } = {}) => { | ||||||
|
There was a problem hiding this comment. I think
Suggested change
|
||||||
| codec = codec || Block.codecs.get(cid.code) | ||||||
| if (!codec) throw new Error(`Missing codec ${cid.code}`) | ||||||
| return new BlockDecoder({ data, cid, codec, hasher: hasher || null }) | ||||||
| } | ||||||
| Block.create = async (data, cid, { hasher, codec } = {}) => { | ||||||
|
There was a problem hiding this comment. I think calling this
Suggested change
|
||||||
| hasher = hasher || Block.codec.get(cid.multihash.code) | ||||||
| if (!hasher) { | ||||||
| const { code } = cid.multihash.code | ||||||
| throw new Error(`Missing hasher for verification. Pass hasher for hash type ${code} or use createUnsafe()`) | ||||||
| } | ||||||
| const hash = await hasher.digest(data) | ||||||
| if (!bytes.equals(cid.multihash.bytes, hash.bytes)) { | ||||||
| throw new Error('CID hash does not match data') | ||||||
| } | ||||||
| return Block.createUnsafe(data, cid, { hasher, codec }) | ||||||
|
There was a problem hiding this comment. I think this this is a reason why
Suggested change
|
||||||
| } | ||||||
| Block.defaults = opts => ({ | ||||||
| CID, | ||||||
| defaults: opts, | ||||||
| encoder: (source, codec, hasher) => Block.encoder(source, codec || opts.codec, hasher || opts.hasher), | ||||||
| decoder: (data, codec, hasher) => Block.decoder(data, codec || opts.codec, hasher || opts.hasher), | ||||||
| createUnsafe: (data, cid, { hasher, codec } = {}) => Block.createUnsafe(data, cid, { | ||||||
| hasher: hasher || opts.hasher, | ||||||
| codec: codec || opts.codec | ||||||
| }), | ||||||
| create: (data, cid, { hasher, codec } = {}) => Block.create(data, cid, { | ||||||
| hasher: hasher || opts.hasher, | ||||||
| codec: codec || opts.codec | ||||||
| }), | ||||||
| codecs: Block.codecs, | ||||||
| add: Block.add | ||||||
| }) | ||||||
| Block.CID = CID | ||||||
|
|
||||||
| export default Block | ||||||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think things would be a lot cleaner if
Block.encoderandBlock.decoderwould do above invariant checks instead of deferring that to shared constructor.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed, i’m going to move all of these in the new patch to
js-multiformats.