Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for integrating IPFS with Ethereum in README.md #6791

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Ramyromel
Copy link

@Ramyromel Ramyromel commented Feb 13, 2025

Add a new section "Integrating IPFS with Ethereum" to the README.md file.

  • Installation and usage:
    • Install IPFS: Follow the instructions on the IPFS installation page.
    • Initialize IPFS: Run ipfs init to initialize the IPFS repository.
    • Start the IPFS daemon: Run ipfs daemon to start the IPFS daemon.
    • Add files to IPFS: Use the command ipfs add <file> to add files to IPFS. This will return a CID (Content Identifier).
    • Store CID on Ethereum: Use a smart contract to store the CID on the Ethereum blockchain. You can use Solidity to create a contract that stores the CID as a string.
    • Retrieve files from IPFS: Use the command ipfs cat <CID> to retrieve files from IPFS using the CID.
    • Pinning files on IPFS: Use the command ipfs pin add <CID> to pin files on IPFS, ensuring they are not garbage collected.

For more details, open the Copilot Workspace session.

Add a new section "Integrating IPFS with Ethereum" to the README.md file.

* **Installation and usage**:
  - Install IPFS: Follow the instructions on the IPFS installation page.
  - Initialize IPFS: Run `ipfs init` to initialize the IPFS repository.
  - Start the IPFS daemon: Run `ipfs daemon` to start the IPFS daemon.
  - Add files to IPFS: Use the command `ipfs add <file>` to add files to IPFS. This will return a CID (Content Identifier).
  - Store CID on Ethereum: Use a smart contract to store the CID on the Ethereum blockchain. You can use Solidity to create a contract that stores the CID as a string.
  - Retrieve files from IPFS: Use the command `ipfs cat <CID>` to retrieve files from IPFS using the CID.
  - Pinning files on IPFS: Use the command `ipfs pin add <CID>` to pin files on IPFS, ensuring they are not garbage collected.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ethereum-lists/chains?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link

You successfully submitted a PR! Due to the amount of PRs coming in: we will only look at PRs that the CI is happy with. We can also not hold your hand getting the CI green - just look how others that where merged did it and RTFM. So as long as there is any CI check that reports an error - no human will look at this. You might be able to ask for some support after supporting the project - e.g. by sending funds to lists.eth. When you fixed things after a requested change - then you also need to (re-)request a review.

Copy link
Member

@ligi ligi left a comment

Choose a reason for hiding this comment

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

one step does not make sense to me - maybe elaborate here
also not really sure this should be in this doc - maybe just a link to "how to use IPFS" would be better

* **Initialize IPFS**: Run `ipfs init` to initialize the IPFS repository.
* **Start the IPFS daemon**: Run `ipfs daemon` to start the IPFS daemon.
* **Add files to IPFS**: Use the command `ipfs add <file>` to add files to IPFS. This will return a CID (Content Identifier).
* **Store CID on Ethereum**: Use a smart contract to store the CID on the Ethereum blockchain. You can use Solidity to create a contract that stores the CID as a string.
Copy link
Member

Choose a reason for hiding this comment

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

this makes no sense to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants