feat: create helia-remote-pinning example

.gitignore

@@ -14,3 +14,4 @@ playwright-report
 .parcel-cache
 .envrc
 .tool-versions
+.env

examples/helia-remote-pinning/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+# ⚠️ IMPORTANT ⚠️
+
+# Please do not create a Pull Request for this repository
+
+The contents of this repository are automatically synced from the parent [Helia Examples Project](https://github.com/ipfs-examples/helia-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/helia-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [Helia Examples Project](https://github.com/ipfs-examples/helia-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/helia-remote-pinning/.github/workflows/sync.yml

@@ -0,0 +1,19 @@
+name: pull
+
+on:
+  workflow_dispatch
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: ipfs-examples/helia-examples
+          source-folder-path: examples/${{ github.event.repository.name }}
+          source-branch: main
+          target-branch: main
+          git-username: github-actions
+          git-email: github-actions@github.com

examples/helia-remote-pinning/.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+/test-results/

examples/helia-remote-pinning/README.md

@@ -0,0 +1,136 @@
+<p align="center">
+  <a href="https://github.com/ipfs/helia" title="Helia">
+    <img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
+  </a>
+</p>
+
+<h3 align="center"><b>Helia remote pinning example via browser and nodeJS</b></h3>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
+  <br>
+  <a href="https://ipfs.github.io/helia/modules/helia.html">Explore the docs</a>
+  ·
+  <a href="https://codesandbox.io/p/sandbox/infallible-haibt-e3lcd4">View Demo</a>
+  ·
+  <a href="https://github.com/ipfs-examples/helia-examples/issues">Report Bug</a>
+  ·
+  <a href="https://github.com/ipfs-examples/helia-examples/issues">Request Feature/Example</a>
+</p>
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About The Project](#about-the-project)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation and Running example](#installation-and-running-example)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
+
+## About The Project
+
+- Read the [docs](https://ipfs.github.io/helia/modules/helia.html)
+- Look into other [examples](https://github.com/ipfs-examples/helia-examples) to learn how to spawn a Helia node in Node.js and in the Browser
+- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
+- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
+- Check out https://docs.ipfs.io for tips, how-tos and more
+- See https://blog.ipfs.io for news and more
+- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
+
+## Getting Started
+
+### Prerequisites
+
+Make sure you have installed all of the following prerequisites on your development machine:
+
+- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
+- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
+
+### Installation and Running example
+
+Before running either of the below, you should set two environment variables:
+
+* VITE_PINNING_ENDPOINT - the endpoint for the pinning provider you want to use
+* VITE_PINNING_TOKEN - the API key for the pinning provider you are using.
+
+#### Run the browser example
+
+```console
+> npm install
+> npm start
+```
+
+Now open your browser at `http://localhost:5173/`
+
+The environment variables mentioned above will pre-populate the inputs on the page if provided, otherwise you will need to enter them prior to proceeding.
+
+#### Run the node example
+
+The environment variables mentioned above are required to be set for this to succeed.
+
+```console
+> npm install
+> npm run start-node -- 'Some string you want to test'
+```
+
+The CID for the string you passed in will be output, as well as the result of the pin operation.
+
+#### Run the tests
+
+```console
+npx playwright install
+npm run test
+```
+
+
+## Usage
+
+In this example, you will find a boilerplate you can use to guide yourself into creating a react+vite app with helia, this provides a pattern to reuse the same client across components with the context API and suggests how to integrate it with custom hooks
+
+You should see the following:
+
+![](./public/hello-helia.gif)
+
+_For more examples, please refer to the [Documentation](#documentation)_
+
+## Documentation
+
+- [IPFS Primer](https://dweb-primer.ipfs.io/)
+- [IPFS Docs](https://docs.ipfs.io/)
+- [Tutorials](https://proto.school)
+- [More examples](https://github.com/ipfs-examples/helia-examples)
+- [API - Helia](https://ipfs.github.io/helia/modules/helia.html)
+- [API - @helia/unixfs](https://ipfs.github.io/helia-unixfs/modules/helia.html)
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the IPFS Project
+2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing feature'`)
+4. Push to the Branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Want to hack on IPFS?
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
+
+The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
+
+Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).
+
+- **Check out existing issues** The [issue list](https://github.com/ipfs/helia/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
+- **Look at the [Helia Roadmap](https://github.com/ipfs/helia/blob/main/ROADMAP.md)** This are the high priority items being worked on right now
+- **Perform code reviews** More eyes will help
+  a. speed the project along
+  b. ensure quality, and
+  c. reduce possible future bugs
+- **Add tests**. There can never be enough tests
+
+[cid]: https://docs.ipfs.tech/concepts/content-addressing  "Content Identifier"
+[Uint8Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
+[libp2p]: https://libp2p.io

examples/helia-remote-pinning/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Helia + Vite + React</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

examples/helia-remote-pinning/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "helia-remote-pinning",
+  "version": "0.0.0",
+  "description": "Example of pinning content to a remote IPFS pinning service using Helia, built with vite",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "dev": "vite",
+    "start": "vite",
+    "start-node": "node src/node.js",
+    "build": "vite build",
+    "preview": "vite preview",
+    "test": "npm run build && test-browser-example test"
+  },
+  "dependencies": {
+    "@chakra-ui/icons": "^2.1.1",
+    "@chakra-ui/react": "^2.8.1",
+    "@emotion/react": "^11.11.1",
+    "@emotion/styled": "^11.11.0",
+    "@helia/remote-pinning": "file:../../../../ipfs/helia-remote-pinning",
+    "@helia/unixfs": "^1.4.1",
+    "@ipfs-shipyard/pinning-service-client": "^1.0.3",
+    "blockstore-level": "^1.1.4",
+    "datastore-level": "^10.1.4",
+    "framer-motion": "^10.16.4",
+    "helia": "^2.0.1",
+    "libp2p": "^0.46.10",
+    "prop-types": "^15.8.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rimraf": "^5.0.1"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.37.1",
+    "@types/react": "^18.2.21",
+    "@types/react-dom": "^18.2.7",
+    "@vitejs/plugin-react": "^4.0.4",
+    "test-ipfs-example": "^1.0.0",
+    "vite": "^4.4.9"
+  },
+  "overrides": {
+    "libp2p": "^0.46.10"
+  }
+}

examples/helia-remote-pinning/src/App.css

@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}

examples/helia-remote-pinning/src/App.jsx

@@ -0,0 +1,39 @@
+import { useInterval } from '@chakra-ui/react'
+import React, { useState } from 'react'
+import './App.css'
+import CidForm from './components/CidForm'
+import PinningCredsForm from './components/PinningCredsForm'
+import PinningSubmitForm from './components/PinningSubmitForm'
+import { useHelia } from './hooks/useHelia'
+import { CidProvider } from './provider/CidProvider'
+
+function App () {
+  const [text, setText] = useState('')
+  const { error, starting, helia } = useHelia()
+  const [heliaMultiaddrs, setHeliaMultiaddrs] = useState([])
+  const [peers, setPeers] = useState([])
+
+  useInterval(() => {
+    setPeers(helia?.libp2p.getPeers() ?? [])
+    setHeliaMultiaddrs(helia?.libp2p.getMultiaddrs() ?? [])
+  }, 2000, [helia])
+
+  return (
+    <div className="App">
+      <div
+        id="heliaStatus"
+        style={{
+          border: `4px solid ${error ? 'red' : starting ? 'yellow' : 'green'}`,
+          paddingBottom: '4px'
+        }}
+      >Helia Status (peers={peers.length}, multiaddrs={heliaMultiaddrs.length})</div>
+      <CidProvider>
+        <CidForm text={text} setText={setText} />
+        <PinningCredsForm />
+        <PinningSubmitForm />
+      </CidProvider>
+    </div>
+  )
+}
+
+export default App

examples/helia-remote-pinning/src/components/CidForm.jsx

@@ -0,0 +1,35 @@
+/* eslint-disable react/prop-types */
+import {
+  FormControl,
+  FormLabel,
+  FormHelperText,
+  Input,
+  Button,
+  Text
+} from '@chakra-ui/react'
+import { React } from 'react'
+import { useCommitText } from '../hooks/useCommitText'
+
+export default function CidForm ({ text, setText }) {
+  const {
+    cidString,
+    commitText
+  } = useCommitText()
+
+  return (
+    <>
+      <FormControl>
+        <FormLabel>Pinning Endpoint</FormLabel>
+        <Input id="textInput" value={text} onChange={(event) => setText(event.target.value)} type="text" />
+        <FormHelperText>Enter some text content to store in your Helia node</FormHelperText>
+        <Button
+          id="commitTextButton"
+          onClick={() => commitText(text)}
+        >Add Text To Node</Button>
+      </FormControl>
+
+      <Text id="cidOutput" colorScheme='green'>CID: {cidString}</Text>
+      <br/>
+    </>
+  )
+}