Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

Update ipld formats #1010

Merged
merged 7 commits into from
May 21, 2019
Merged

Update ipld formats #1010

merged 7 commits into from
May 21, 2019

Conversation

achingbrain
Copy link
Collaborator

@achingbrain achingbrain commented May 19, 2019

Updates property names to the various ways we refer to links and data in DAGNode/DAGLinks

BREAKING CHANGE: The default string encoding for version 1 CIDs has changed to base32.

IPLD formats have been updated to the latest versions. IPLD nodes returned by ipfs.dag and ipfs.object commands have significant breaking changes. If you are using these commands in your application you are likely to encounter the following changes to dag-pb nodes (the default node type that IPFS creates):

  • DAGNode properties have been renamed as follows:
    • data => Data
    • links => Links
    • size => size (Note: no change)
  • DAGLink properties have been renamed as follows:
    • cid => Hash
    • name => Name
    • size => Tsize

See CHANGELOGs for each IPLD format for it's respective changes, you can read more about the dag-pb changes in the CHANGELOG

Alan Shaw and others added 3 commits May 20, 2019 09:29
BREAKING CHANGE: v1 CIDs are now eencoded in base32 when stringified. Additionally IPLD formats have been updated to the latest versions. See CHANGELOGs for ipld-dag-pb and ipld-dag-cbor for more details:

* https://github.com/ipld/js-ipld-dag-pb/blob/master/CHANGELOG.md#0160-2019-05-08
* https://github.com/ipld/js-ipld-dag-cbor/blob/master/CHANGELOG.md#0140-2019-05-08

License: MIT
Signed-off-by: Alan Shaw <[email protected]>
Updates property names to the various ways we refer to links and
data in DAGNode/DAGLinks
License: MIT
Signed-off-by: Alan Shaw <[email protected]>
License: MIT
Signed-off-by: Alan Shaw <[email protected]>
@alanshaw alanshaw merged commit a423d7f into master May 21, 2019
@alanshaw alanshaw deleted the update-ipld-formats branch May 21, 2019 09:06
alanshaw pushed a commit to ipfs/js-ipfs that referenced this pull request May 21, 2019
…2068)

This is part of the Awesome Endeavour: Async Iterators: #1670

Depends on

* [x] ipld/js-ipld-dag-pb#137
* [x] ipfs-inactive/interface-js-ipfs-core#473
* [x] ipfs-inactive/js-ipfs-http-client#1010
* [x] ipfs/js-ipfs-http-response#25

resolves #1995

BREAKING CHANGE: The default string encoding for version 1 CIDs has changed to `base32`.

IPLD formats have been updated to the latest versions. IPLD nodes returned by `ipfs.dag` and `ipfs.object` commands have significant breaking changes. If you are using these commands in your application you are likely to encounter the following changes to `dag-pb` nodes (the default node type that IPFS creates):

* `DAGNode` properties have been renamed as follows:
    * `data` => `Data`
    * `links` => `Links`
    * `size` => `size` (Note: no change)
* `DAGLink` properties have been renamed as follows:
    * `cid` => `Hash`
    * `name` => `Name`
    * `size` => `Tsize`

See CHANGELOGs for each IPLD format for it's respective changes, you can read more about the [`dag-pb` changes in the CHANGELOG](https://github.com/ipld/js-ipld-dag-pb/blob/master)

License: MIT
Signed-off-by: Alan Shaw <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants