IPFS Virtual Meetups, 11 Aug 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Pinning Service API - Lidel

Description

The IPFS Pinning Service API is here, and Lidel was onhand to walk the IPFS community through the details of this highly sought after API. https://github.com/ipfs/pinning-services-api-spec

For more information on IPFS
- visit the project website: https://ipfs.io
- or follow IPFS on Twitter: https://twitter.com/IPFS

Sign up to get IPFS news, including releases, ecosystem updates, and community announcements in your inbox, each Tuesday: http://eepurl.com/gL2Pi5

A

Pinning service api is something we've been working for uh the past few weeks uh to sort of like create a generic spec, a very minimal spec that multiple uh parties and actors in our ipfs ecosystem can agree on both on the service side and the client side to facilitate the very basic persistence, um more or less. You can think about this uh as a minimum, valuable product to enable something like remote pinning.

A

So you just like district mentioned, you got your laptop, you import data to ipfs, but what happens when you close your laptop and someone else wants to access the data when your laptop is closed or your server is temporarily offline. You want to persist data somewhere else, so there's at least one seed provider data provider.

A

So this is where pinning service api spec comes in. It's a very basic open api spec, which, um like service providers, can implement uh you. Can it's only about providing a cid that you want to persist and getting the status? Is it ongoing? Is it cute? um That's it.

A

It does not include importing to ipfs. It does not include user space management. It's just one, a very small generic spec that you can implement and there's a ipfs pinning service api spec repo. If you want to learn more details about this, there's a specification which is in the yaml format, it's open api 3.0, I believe- and there is a human readable documentation uh that you can uh look at it's rendered from that yaml file and just to very briefly show you how simple this api is.

A

You got a pin object, which is just a basic representation of the stuff that you want to. Pin it's a cid. You can optionally, provide a list of known sources to speed up data transfer and additional metadata, which is also optional, and then you got in response or for initial pin operation or maybe later you want to check status. You got this pin status response where you got the id of pinning operation status where this was created, and then you got a list of providers provided by the pinning service themselves.

A

um Those new multi-others will be providing data, your data to the network and, of course, additional metadata um yep. So the list of operations is very short. You list. Pins. Add, pin uh you can read, pin status, modify it or remove it. That's it uh just to highlight that it's not just a very abstract thing that will be implemented by services. uh We will uh introduce a first.

A

uh uh It will be introduced into our gui applications. So if you install a ipfs desktop or you run web ui on the settings screen, there will be option to add a service, a remote service. This is just a mockup, but it will look more or less like this.

A

It could be something custom or it could be one of well-known already existing players. Maybe someone new, maybe your own thing that you created and you will be able to add pinning service to your ipfs, node and redo remote pinning and that remote pinning will not only work in the gui application. Like ipfs desktop, you will be able to use the same pinning service from the command line. So if you just use, go ipfs and don't use ipfs desktop, you still will be able to benefit from this spec.

A

uh So it's a very small spec and it's very early, but we are closing uh it's effectively done, we'll probably we may rename a field or two, but more or less it is pretty stable. So if you are interested in this uh just uh visit links which I will paste on the chat shortly and I believe that's it.