feature: implement remote pinning API

packages/ipfs-core/src/components/config.js

@@ -328,6 +328,7 @@ module.exports.profiles = profiles
  * @property {PubsubConfig} [Pubsub]
  * @property {SwarmConfig} [Swarm]
  * @property {RoutingConfig} [Routing]
+ * @property {PinningConfig} [Pinning]
  *
  * @typedef {Object} AddressConfig
  * Contains information about various listener addresses to be used by this node.
@@ -524,4 +525,12 @@ module.exports.profiles = profiles
  *
  * @typedef {import('ipfs-core-types/src/basic').ToJSON} ToJSON
  * @typedef {import('.').AbortOptions} AbortOptions
+ *
+ * @typedef {Object} PinningConfig
+ * @property {Object<string, RemotePinningServiceConfig>} [RemoteServices]
+ *
+ * @typedef {Object} RemotePinningServiceConfig
+ * @property {Object} API
+ * @property {string} API.Endpoint
+ * @property {string} API.Key
  */

packages/ipfs-core/src/components/index.js

@@ -29,6 +29,7 @@ const createIDAPI = require('./id')
 const createConfigAPI = require('./config')
 const DagAPI = require('./dag')
 const PinManagerAPI = require('./pin/pin-manager')
+const PinRemoteAPI = require('./pin/remote')
 const createPreloadAPI = require('../preload')
 const createMfsPreloadAPI = require('../mfs-preload')
 const createFilesAPI = require('./files')
@@ -57,6 +58,8 @@ class IPFS {
   constructor ({ print, storage, options }) {
     const { peerId, repo, keychain } = storage
     const network = Service.create(Network)
+    const swarm = new SwarmAPI({ network })
+    const config = createConfigAPI({ repo })
 
     const preload = createPreloadAPI(options.preload)
 
@@ -86,7 +89,8 @@ class IPFS {
     })
     const resolve = createResolveAPI({ ipld, name })
     const pinManager = new PinManagerAPI({ repo, dagReader })
-    const pin = new PinAPI({ gcLock, pinManager, dagReader })
+    const pinRemote = new PinRemoteAPI({ swarm, config, peerId })
+    const pin = new PinAPI({ gcLock, pinManager, dagReader, pinRemote })
     const block = new BlockAPI({ blockService, preload, gcLock, pinManager, pin })
     const dag = new DagAPI({ ipld, preload, gcLock, pin, dagReader })
     const refs = Object.assign(createRefsAPI({ ipld, resolve, preload }), {
@@ -155,7 +159,7 @@ class IPFS {
     this.version = createVersionAPI({ repo })
     this.bitswap = new BitswapAPI({ network })
     this.bootstrap = new BootstrapAPI({ repo })
-    this.config = createConfigAPI({ repo })
+    this.config = config
     this.ping = createPingAPI({ network })
 
     this.add = add
@@ -170,7 +174,7 @@ class IPFS {
     this.object = new ObjectAPI({ ipld, preload, gcLock, dag })
     this.repo = new RepoAPI({ gcLock, pin, repo, refs })
     this.stats = new StatsAPI({ repo, network })
-    this.swarm = new SwarmAPI({ network })
+    this.swarm = swarm
 
     // For the backwards compatibility
     Object.defineProperty(this, 'libp2p', {

packages/ipfs-core/src/components/pin/index.js

@@ -12,15 +12,17 @@ class PinAPI {
    * @param {GCLock} config.gcLock
    * @param {DagReader} config.dagReader
    * @param {PinManager} config.pinManager
+   * @param {PinRemoteAPI} config.pinRemote
    */
-  constructor ({ gcLock, dagReader, pinManager }) {
+  constructor ({ gcLock, dagReader, pinManager, pinRemote }) {
     const addAll = createAddAll({ gcLock, dagReader, pinManager })
     this.addAll = addAll
     this.add = createAdd({ addAll })
     const rmAll = createRmAll({ gcLock, dagReader, pinManager })
     this.rmAll = rmAll
     this.rm = createRm({ rmAll })
     this.ls = createLs({ dagReader, pinManager })
+    this.remote = pinRemote
   }
 }
 module.exports = PinAPI
@@ -32,4 +34,5 @@ module.exports = PinAPI
  * @typedef {import('..').PinManager} PinManager
  * @typedef {import('..').AbortOptions} AbortOptions
  * @typedef {import('..').CID} CID
+ * @typedef {import('./remote')} PinRemoteAPI
  */

packages/ipfs-core/src/components/pin/remote/add.js

@@ -0,0 +1,27 @@
+'use strict'
+
+const withTimeoutOption = require('ipfs-core-utils/src/with-timeout-option')
+
+module.exports = ({ serviceRegistry }) => {
+  /**
+   * Asks a remote pinning service to pin an IPFS object from a given path
+   *
+   * @param {string|CID} cid
+   * @param {AddOptions & AbortOptions} options
+   * @returns {Promise<Pin>}
+   */
+  async function add (cid, options) {
+    const { service } = options
+    const svc = serviceRegistry.serviceNamed(service)
+    return svc.add(cid, options)
+  }
+
+  return withTimeoutOption(add)
+}
+
+/**
+ * @typedef {import('cids')} CID
+ * @typedef {import('ipfs-core-types/src/basic').AbortOptions} AbortOptions
+ * @typedef {import('ipfs-core-types/src/pin/remote').Pin} Pin
+ * @typedef {import('ipfs-core-types/src/pin/remote').AddOptions} AddOptions
+ */