ipfs/helia-remote-pinning

A library that helps Helia consumers pin content via the https://ipfs.github.io/pinning-services-api-spec/. Initial design at https://pl-strflt.notion.site/create-interface-API-example-for-helia-remote-pinning-library-71011845a7b9476cb95ab425bb54455c

@helia/remote-pinning

A library that helps Helia users pin content via the IPFS pinning-services-api-spec

Table of contents

• Install
  • Browser <script> tag
• Documentation
  • Create remote pinner
  • Add a pin
  • Replace a pin
• Lead Maintainer
• Contributing
• License
• Contribute

Install

$ npm i @helia/remote-pinning

Browser <script> tag

Loading this module through a script tag will make it's exports available as HeliaRemotePinning in the global namespace.

<script src="https://unpkg.com/@helia/remote-pinning/dist/index.min.js"></script>

Documentation

Create remote pinner

import { unixfs } from '@helia/unixfs'
import { Configuration, RemotePinningServiceClient } from '@ipfs-shipyard/pinning-service-client'
import { createHelia } from 'helia'
import { createRemotePinner } from '@helia/remote-pinning'

const helia = await createHelia()
const pinServiceConfig = new Configuration({
  endpointUrl: `${endpointUrl}`, // the URI for your pinning provider, e.g. `http://localhost:3000`
  accessToken: `${accessToken}` // the secret token/key given to you by your pinning provider
})

const remotePinningClient = new RemotePinningServiceClient(pinServiceConfig)
const remotePinner = createRemotePinner(helia, remotePinningClient)

Add a pin

const heliaFs = unixfs(helia)
const cid = await heliaFs.addBytes(encoder.encode('hello world'))
const addPinResult = await remotePinner.addPin({
  cid,
  name: 'helloWorld'
})

Replace a pin

const newCid = await heliaFs.addBytes(encoder.encode('hi galaxy'))
const replacePinResult = await remotePinner.replacePin({
  newCid,
  name: 'hiGalaxy',
  requestid: addPinResult.requestid
})

Lead Maintainer

SgtPooki

Contributing

Contributions are welcome! This repository is part of the IPFS project and therefore governed by our contributing guidelines.

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

helia-remote-pinning's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

feat: publish initial library

initial plans at https://pl-strflt.notion.site/create-interface-API-example-for-helia-remote-pinning-library-71011845a7b9476cb95ab425bb54455c

Tasks

Beta Give feedback

1. Review existing code & tests with team - #2
2. update readme - #2
3. add to unifiedCI for JS: https://github.com/protocol/.github/blob/master/configs/js.json

Update for Helia 2.1

This one is simple. Please update for Helia 2.1 when you get a chance. The current version works only with Helia 1.3.11.
merging a3e3c78 might do the trick.

feat: support multiple remote pinning services

If it's desirable to use multiple pinning service endpoints, this module could take RemotePinningServiceClient | RemotePinningServiceClient[] and just try them all when adding/replacing pins?

#2 (comment)

---

Please upvote if this feature is desired.

README suggestions

Some things coming to mind when landing at https://github.com/ipfs/helia-remote-pinning:

1. Rather than have a "Lead Maintainer" section, just codify this in CODEOWNERS? I assume codeowners should be helia-dev.
2. Provide some explanation for why use this package (i.e., it's a convenience wrapper for binding Helia and pinning service providing promise for when certain actions have been completed)
3. The design document is linked in the right hand side project description. Ideally we'd like to design docs from the README.
4. I know covered elsewhere, but link to any relevant examples.
5. Make sure the project is linked from https://github.com/ipfs/helia for discoverability

feat: package improvements

See comment from @BigLep at #1 (comment)

1. We send relayed addresses for Pin.origins
2. We should only throw an error if we didn't have any public addresses in Pin.origins AND we couldn't connect to Pin.delegates.
3. Can we produce API docs that make clear when/what errors are thrown?
4. Make sure README points to the example being created in ipfs-examples/helia-examples#86

Tasks

Beta Give feedback

1. For 1 above, we want to make sure the addresses we send to the pinning service are dialable by that service.
2. For 2, pretty clear on action and expectations
3. For 3, we should document in readme what errors are thrown and when. (currently only one)
4. For 4, can do