Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gaia-x4plc-aad/poc-ipfs-content-identifier
Proof of concept to explain the usage of Content Identifiers (CIDs) from IPFS
https://github.com/gaia-x4plc-aad/poc-ipfs-content-identifier
cid ipfs
Last synced: 5 days ago
JSON representation
Proof of concept to explain the usage of Content Identifiers (CIDs) from IPFS
- Host: GitHub
- URL: https://github.com/gaia-x4plc-aad/poc-ipfs-content-identifier
- Owner: GAIA-X4PLC-AAD
- License: mit
- Created: 2024-04-18T07:33:22.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-24T14:21:06.000Z (8 months ago)
- Last Synced: 2024-12-15T11:49:47.314Z (11 days ago)
- Topics: cid, ipfs
- Language: TypeScript
- Homepage: https://specs.ipfs.tech/
- Size: 58.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# POC: IPFS Content Identifier (CIDs)
> *Note: This POC shows how a CID is specified, constructed, how you can validate and deconstruct it again and lists resources. This helps to understand the concept and gives implementation hints. If you want to create CIDs for arbitrary files you can simply create a Pinata account or use IPFS Desktop to upload files.*
# Summary
## What is a CID
When we exchange data with peers on the decentralized web, we depend on content addressing (as opposed to the location addressing of the centralized web) to securely locate and identify data.
A content identifier, or CID, is a self-describing content-addressed identifier. It doesn't indicate where content is stored, but it forms a kind of address based on the content itself.
The CID specification originated in IPFS.
## Why CID
With decentralisation in mind, we depend on having an agreed upon standard of identifying data. Aside from identifying data, being able to validate the contents of said data is required. However not every piece of data or every implementer has the same use case and/or properties resulting in different requirements. Because of that it's important there is enough flexibility.
IPFS has solved the problem of being able to convey all the requirements of the identification of data creating the concept of a CID. The link below "Anatomy of a CID" describes in great detail how a CID is built.
# Why this POC
This POC demonstrates how we can leverage the concept of a CID by building one and extracting information from one in our projects.
# Run locally
Make sure you have node > 18 and npm installed. Possibly through [nvm](https://github.com/nvm-sh/nvm).
## Install dependencies
```bash
npm install
```
## Run
```bash
npm run start
```
When making changes to `./src/index.ts` make sure to stop the server, restart and reload the page to view your changes. This POC does not have hot-reloading.
# Resources
- [What is a CID](https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid)
- [Anatomy of a CID](https://proto.school/anatomy-of-a-cid)
- [CID Inspector](https://cid.ipfs.io/#bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi)
- [Multiformats](https://multiformats.io/)
- [Codecs](https://github.com/multiformats/multicodec/blob/master/table.csv)
- [Pinata](https://www.pinata.cloud/)
- [IPFS Desktop](https://docs.ipfs.tech/install/ipfs-desktop/)