ipfs in web apps guide #1970
Open
ipfs in web apps guide #1970
+125
−45
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
3 tasks
2color
commented
Jan 23, 2025
|
|
||
| In this guide you will learn how to use IPFS in web applications, including addressing, retrieving, and providing. | ||
|
|
||
| In this guide, you will use [Helia](https://github.com/ipfs/helia), the most actively maintained TypeScript IPFS library for use on the web and the recommended library for most use cases. |
There was a problem hiding this comment.
Suggested change
| In this guide, you will use [Helia](https://github.com/ipfs/helia), the most actively maintained TypeScript IPFS library for use on the web and the recommended library for most use cases. | |
| For this, you will use [Helia](https://github.com/ipfs/helia), the most actively maintained implementation of IPFS in TypeScript for use on the web. |
2color
commented
Jan 23, 2025
|
|
||
| # IPFS in web-applications and resource-constrained environments | ||
|
|
||
| In this guide you will learn how to use IPFS in web applications, including addressing, retrieving, and providing. |
There was a problem hiding this comment.
Suggested change
| In this guide you will learn how to use IPFS in web applications, including addressing, retrieving, and providing. | |
| In this guide you will learn how to use IPFS using JavaScript/TypeScript in web applications, including addressing data with CIDs, retrieval by CID, working with CAR files, and the the nuances of providing. |
SgtPooki
reviewed
Jan 24, 2025
| - [Learn more](#learn-more) | ||
|
|
||
| ## 1. Content-addressable representation | ||
| ## 1. Content-addressing / Merkelizing |
There was a problem hiding this comment.
Suggested change
| ## 1. Content-addressing / Merkelizing | |
| ## 1. Content-addressing / Merkleizing |
|
|
||
| As a developer, IPFS exposes three main operations for interacting with the network: | ||
|
|
||
| - **Addressing data with CIDs** (also known as merklizing): taking arbitrary data and encoding so its addressable by CID. For example, given a file and encoding it so it can be addressed by a CID. |
There was a problem hiding this comment.
Suggested change
| - **Addressing data with CIDs** (also known as merklizing): taking arbitrary data and encoding so its addressable by CID. For example, given a file and encoding it so it can be addressed by a CID. | |
| - **Addressing data with CIDs** (also known as merkleizing): taking arbitrary data and encoding so its addressable by CID. For example, given a file and encoding it so it can be addressed by a CID. |
what is the accepted spelling of "merleizing"? i would make sure we're using that consistently in this doc
| As a developer, IPFS exposes three main operations for interacting with the network: | ||
|
|
||
| - **Addressing data with CIDs** (also known as merklizing): taking arbitrary data and encoding so its addressable by CID. For example, given a file and encoding it so it can be addressed by a CID. | ||
| - **Retrieving data by CID**: given a CID, IPFS finds providers (peers who share the block), connects to them, fetches the blocks, and verifies. |
There was a problem hiding this comment.
Suggested change
| - **Retrieving data by CID**: given a CID, IPFS finds providers (peers who share the block), connects to them, fetches the blocks, and verifies. | |
| - **Retrieving data by CID**: given a CID, IPFS finds providers (peers who share the block), connects to them, fetches the blocks, and verifies that the retrieved data is what the CID represents. |
or some other slightly less vague clarification.
|
|
||
| - Using the [`Verified Fetch`](https://www.npmjs.com/package/@helia/verified-fetch) library, which was modelled after the `fetch` API and returns `Response` objects, with the main difference being that it allows you to fetch data by CID, abstracting away the details of content routing, transports and retrieval. For more examples and background see the [release blog post](https://blog.ipfs.tech/verified-fetch/). | ||
| - Using the [`helia`](https://github.com/ipfs/helia/) library, which is the foundation for the `verified-fetch` library, and provides a more comprehensive and modular API for interacting with the IPFS network, beyond just retrieval. | ||
| - Using public recursive gateways, e.g. `ipfs.io` with HTTP. This is not recommended for most use cases, because it forgoes the verifiability and trustlessness enabled by content addressing. Granted, it might be the easiest way to retrieve data in a web application, but is also the most fraught with security and centralization concerns. |
There was a problem hiding this comment.
Do we want to mention that our goal is to push away from public backend infrastructure like this and that we aim more toward trustless gateways?
|
|
||
| For data to be retrievable by other peers on [IPFS Mainnet](../concepts/glossary.md#ipfs-mainnet) it will need to be uploaded to a pinning service or an IPFS node. | ||
|
|
||
| When possible, it's best to rely on client-side merklization to address data by CID and then upload it to a pinning service or a node. [CAR files](#car-files) are a great way to do this, though they are not supported by all pinning services. |
There was a problem hiding this comment.
I feel like we need a better term to use than merklization and merkleizing
| <iframe height="300" style="width: 100%;" scrolling="no" title="CAR export with Helia and dag-cbor" src="https://codepen.io/2color/embed/EaYoegX?default-tab=js%2Cresult" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true"> | ||
| See the Pen <a href="https://codepen.io/2color/pen/EaYoegX"> | ||
| CAR export with Helia and dag-cbor</a> by Daniel Norman (<a href="https://codepen.io/2color">@2color</a>) | ||
| </iframe> |
There was a problem hiding this comment.
it feels like this ends abruptly.
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.
What's in this PR