ipfs-bch-wallet-service/src/lib/ipfs.js

/*
  This support library handles the connection to the IPFS network. It instantiates
  the IPFS node and starts the ipfs-coord library.
*/

// Global npm libraries
const IPFS = require('ipfs')
const IpfsCoord = require('ipfs-coord')
// const IpfsCoord = require('../../../ipfs-coord')
const BCHJS = require('@psf/bch-js')

// Local libraries
const config = require('../../config')
const JSONRPC = require('../rpc')

class IPFSLib {
  constructor (localConfig) {
    // Encapsulate dependencies
    this.IPFS = IPFS
    this.IpfsCoord = IpfsCoord
    this.bchjs = new BCHJS()
    this.rpc = new JSONRPC()
    this.config = config

    // this.rpc = {}
    // if (localConfig.rpc) {
    //   this.rpc = localConfig.rpc
    // }
  }

  // This is a 'macro' start method. It kicks off several smaller methods that
  // start the various subcomponents of this IPFS library.
  async start () {
    try {
      await this.startIpfs()
      await this.startIpfsCoord()

      // Update the RPC instance with the instance of ipfs-coord.
      this.rpc.ipfsCoord = this.ipfsCoord

      console.log('IPFS is ready.')
    } catch (err) {
      console.error('Error trying to start IPFS: ', err)

      // Added the exit() call because this app has been observed crashing due
      // to out-of-memory errors. IPFS is a memory hog. It then can't automatically
      // restart due to an IPFS lock-file error. Exiting the app will give a
      // process management like pm2 or systemd to successfully restart the app.
      console.log('Shutting down app. Hopefully pm2 can restart it!')
      process.exit(1)
    }
  }

  async startIpfs () {
    try {
      // Ipfs Options
      const ipfsOptions = {
        repo: './ipfsdata',
        start: true,
        config: {
          relay: {
            enabled: true, // enable circuit relay dialer and listener
            hop: {
              enabled: true // enable circuit relay HOP (make this node a relay)
            }
          },
          pubsub: true, // enable pubsub
          Swarm: {
            ConnMgr: {
              HighWater: 30,
              LowWater: 10
            }
          }
        }
      }

      // Create a new IPFS node.
      this.ipfs = await this.IPFS.create(ipfsOptions)

      // Set the 'server' profile so the node does not scan private networks.
      await this.ipfs.config.profiles.apply('server')

      // const nodeConfig = await this.ipfs.config.getAll()
      // console.log(
      //   `IPFS node configuration: ${JSON.stringify(nodeConfig, null, 2)}`
      // )

      // Stop the IPFS node if we're running tests.
      if (this.config.env === 'test') {
        await this.ipfs.stop()
      }
    } catch (err) {
      console.error('Error in startIpfs()')
      throw err
    }
  }

  async startIpfsCoord () {
    try {
      this.ipfsCoord = new this.IpfsCoord({
        ipfs: this.ipfs,
        type: 'node.js',
        // type: 'browser',
        bchjs: this.bchjs,
        privateLog: this.rpc.router,
        isCircuitRelay: this.config.isCircuitRelay,
        apiInfo: this.config.apiInfo,
        announceJsonLd: this.config.announceJsonLd
      })

      await this.ipfsCoord.isReady()
    } catch (err) {
      console.error('Error in startIpfsCoord()')
      throw err
    }
  }
}

module.exports = IPFSLib