Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

Proposal: Move resolver to use CID instances for links #44

Closed
mikeal opened this issue Aug 17, 2018 · 1 comment
Closed

Proposal: Move resolver to use CID instances for links #44

mikeal opened this issue Aug 17, 2018 · 1 comment
Labels
api-review Tackle during the API review

Comments

@mikeal
Copy link
Contributor

mikeal commented Aug 17, 2018

The current API for resolver.resolve(binaryBlob, path, callback) calls for us to return {'/': baseEncodedCID}.

Now that we're moving to returning CID instances in the serializers it would be better to return instances here as well since the majority of the time, possibly all the time, we end up just parsing this baseEncodedCID back into a CID instance.

@vmx vmx added the api-review Tackle during the API review label Nov 21, 2018
vmx added a commit that referenced this issue Nov 22, 2018
The whole IPLD APIs get a review to make them more consistent and
easier to use.

The biggest change is that there's not `resolve` API anymore. From
now on you access the properties of the JavaScript objects directly.

Issues that were taken into account:

 - #31
   - [x] Remove `isLink()` method from formats: `isLink()` is no
         longer needed as all links will be CID objects you can easily
         check for
 - #44
   - [x] Proposal: Move resolver to use CID instances for links: Not
         applicable anymore as `resolve.resolve()` is removed
 - #46
   - [x] properties: align spec with implementation: Covered by spec
 - #49
   - [x] Define how `toJSON()` should look like: Binary and CIDs are
         defined with example
 - #34
   - [x] Implementation of nested objects: Won’t fix as `tree()` is
         not part of the API anymore
vmx added a commit that referenced this issue Nov 22, 2018
The whole IPLD APIs get a review to make them more consistent and
easier to use.

The biggest change is that there's not `resolve` API anymore. From
now on you access the properties of the JavaScript objects directly.

Issues that were taken into account:

 - #31
   - [x] Remove `isLink()` method from formats: `isLink()` is no
         longer needed as all links will be CID objects you can easily
         check for
 - #44
   - [x] Proposal: Move resolver to use CID instances for links: Not
         applicable anymore as `resolve.resolve()` is removed
 - #46
   - [x] properties: align spec with implementation: Covered by spec
 - #49
   - [x] Define how `toJSON()` should look like: Binary and CIDs are
         defined with example
 - #34
   - [x] Implementation of nested objects: Won’t fix as `tree()` is
         not part of the API anymore

Closes #48.
@vmx vmx mentioned this issue Nov 22, 2018
5 tasks
@vmx
Copy link
Member

vmx commented May 8, 2019

All IPLD Formats in this org return CIDs now.

@vmx vmx closed this as completed May 8, 2019
@ghost ghost removed the ready label May 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api-review Tackle during the API review
Projects
None yet
Development

No branches or pull requests

3 participants