Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

feat: remove all esoteric ipld formats #3360

Merged
merged 8 commits into from
Oct 30, 2020

Conversation

achingbrain
Copy link
Member

We bundle ipld formats for ethereum, zcash, bitcoin and git though they speak beyond the files part of the Interplanetary File System.

Since #3347 we can now configure extra IPLD formats in the http client, in-process and daemon nodes, we no longer have to bundle these formats for them to be supported, instead the user can choose to configure their node with the formats they require.

This makes the behaviour of core the same in node as it is in the browser and also means we don't waste time installing deps our users may not use.

If they do use them, they can configure the node as they see fit.

BREAKING CHANGE: only dag-pb, dag-cbor and raw formats are supported out of the box, any others will need to be configured during node startup.

We bundle ipld formats for ethereum, zcash, bitcoin and git though they
speak beyond the files part of the Interplanetary File System.

Since #3347 we can now configure extra IPLD formats in the http client,
in-process and daemon nodes, we no longer have to bundle these formats
for them to be supported, instead the user can choose to configure their
node with the formats they require.

This makes the behaviour of core the same in node as it is in the browser
and also means we don't waste time installing deps our users may not use.

If they do use them, they can configure the node as they see fit.

BREAKING CHANGE: only dag-pb, dag-cbor and raw formats are supported out
  of the box, any others will need to be configured during node startup.
@achingbrain
Copy link
Member Author

Cuts the install size for ipfs-core from ~160mb to ~135mb

Copy link
Member

@vasco-santos vasco-santos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks good!
What do you think on adding to the custom-ipld-formats README a small section with the config for adding ipld formats?

const ipfs = await createNode({
    ipld: {
      formats: [
        // Your formats
      ]
    }
  })

Copy link
Member

@vasco-santos vasco-santos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@achingbrain achingbrain merged commit a542882 into master Oct 30, 2020
@achingbrain achingbrain deleted the feat/remove-all-esoteric-ipld-formats branch October 30, 2020 13:06
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