Merge pull request #73 from Permissionless-Software-Foundation/ct-unstable

Syncing with upstream. Usage improvements.
fix(upstream): Syncing with upstream and fixing merge conflicts
2026-09-22 09:12:03 -07:00 · 2025-06-05 18:42:47 -07:00 · 2025-06-05 18:40:55 -07:00 · 2025-06-05 18:30:09 -07:00 · 2025-06-05 18:27:06 -07:00 · 2025-06-05 18:25:45 -07:00
38 changed files with 4285 additions and 4766 deletions
@@ -125,7 +125,9 @@ class Server {
      console.log('\nConfiguration:')
      console.log(`Circuit Relay: ${this.config.isCircuitRelay}`)
      console.log(`IPFS TCP port: ${this.config.ipfsTcpPort}`)
-      console.log(`IPFS WS port: ${this.config.ipfsWsPort}\n`)
+      console.log(`IPFS WS port: ${this.config.ipfsWsPort}`)
+      console.log(`IPFS WebRTC port: ${this.config.ipfsWebRtcPort}`)
+      console.log(`Connection preference: ${this.config.connectPref}\n`)

      return app
    } catch (err) {
@@ -131,6 +131,8 @@ export default {
  // IPFS Ports
  ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 4101,
  ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 4103,
+  ipfsWebRtcPort: process.env.IPFS_WEB_RTC_PORT ? process.env.IPFS_WEB_RTC_PORT : 4105,
+  connectPref: process.env.CONNECT_PREF, // Used in helia-coord to select connection preference.

  // Settings for production, using external go-ipfs node.
  isProduction: process.env.SVC_ENV === 'prod' ? true : false,
@@ -170,6 +172,11 @@ export default {
  // Preferred P2WDB provider
  preferredIpfsFileProvider: process.env.PREFERRED_IPFS_FILE_PROVIDER
    ? process.env.PREFERRED_IPFS_FILE_PROVIDER
-    : ''
+    : '',

+  // Account Configuration
+  disableNewAccounts: process.env.DISABLE_NEW_ACCOUNTS ? true : false,
+
+  // Admin password
+  adminPassword: process.env.ADMIN_PASSWORD
 }
@@ -1,6 +1,8 @@
 {
-  "password": "eYrzProqwsAyO3CT0Ftf",
  "email": "system@system.com",
-  "id": "67a8af30c958c587f890cd8f",
-  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YThhZjMwYzk1OGM1ODdmODkwY2Q4ZiIsImlhdCI6MTczOTEwODE0NH0.OFdVwH8ikbChHV0wjRpYvnL7vu46HDYS-od3FRtm9Nc"
+  "name": "admin",
+  "password": "O52nYamPmP7zE9Jfwgxo",
+  "type": "admin",
+  "id": "684246cf4e94f2261caf9848",
+  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4NDI0NmNmNGU5NGYyMjYxY2FmOTg0OCIsImlhdCI6MTc0OTE3NDAyMX0.9GAS6q_xFz5Bwi7RwIqrqM3Q48DFlz_A-S0_r_L2pTQ"
 }
@@ -1,4 +1,8 @@
 import Server from './bin/server.js'
 const server = new Server()

+process.on('unhandledRejection', (reason, promise) => {
+  console.log(`Handling ${reason.code} error. stack: `, reason)
+})
+
 server.startServer()
@@ -6,11 +6,12 @@
  "type": "module",
  "scripts": {
    "start": "node index.js",
-    "test": "npm run test:all",
+    "test": "npm run test:unit",
    "test:all": "export CONSUMER_ENV=test && c8 --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
-    "test:unit": "export CONSUMER_ENV=test && mocha --exit --timeout 15000 --recursive test/unit/",
+    "test:unit": "export CONSUMER_ENV=test && c8 --reporter=text mocha --exit --timeout 15000 --recursive test/unit/",
    "test:e2e:auto": "export CONSUMER_ENV=test && mocha --exit --timeout 15000 test/e2e/automated/",
-    "test:temp": "export CONSUMER_ENV=test && mocha --exit --timeout 15000 -g '#rate-limit' test/unit/json-rpc/",
+    "start:e2e:server": "export CONSUMER_ENV=test && node index.js",
+    "test:temp": "export SVC_ENV=test && mocha --exit --timeout 15000 -g '#rate-limit' test/unit/json-rpc/",
    "lint": "standard --env mocha --fix",
    "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
    "coverage": "c8 report --reporter=text-lcov | coveralls",
@@ -24,26 +25,28 @@
  },
  "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-consumer",
  "dependencies": {
-    "@chainsafe/libp2p-gossipsub": "13.1.1",
-    "@chainsafe/libp2p-noise": "15.1.1",
-    "@chainsafe/libp2p-yamux": "6.0.2",
-    "@helia/unixfs": "3.0.7",
-    "@libp2p/bootstrap": "10.1.5",
-    "@libp2p/circuit-relay-v2": "1.1.5",
-    "@libp2p/identify": "2.1.5",
-    "@libp2p/keychain": "4.1.5",
-    "@libp2p/logger": "4.0.20",
-    "@libp2p/tcp": "9.1.5",
-    "@libp2p/webrtc": "4.1.7",
-    "@libp2p/websockets": "8.2.0",
-    "@multiformats/multiaddr": "12.3.0",
+    "@chainsafe/libp2p-gossipsub": "14.1.0",
+    "@chainsafe/libp2p-noise": "16.0.1",
+    "@chainsafe/libp2p-yamux": "7.0.1",
+    "@helia/unixfs": "4.0.2",
+    "@libp2p/bootstrap": "11.0.26",
+    "@libp2p/circuit-relay-v2": "3.2.2",
+    "@libp2p/config": "1.1.0",
+    "@libp2p/identify": "3.0.22",
+    "@libp2p/keychain": "5.0.14",
+    "@libp2p/logger": "5.1.8",
+    "@libp2p/ping": "2.0.22",
+    "@libp2p/tcp": "10.1.2",
+    "@libp2p/webrtc": "5.2.2",
+    "@libp2p/websockets": "9.2.2",
+    "@multiformats/multiaddr": "12.3.5",
    "axios": "0.27.2",
    "bcryptjs": "2.4.3",
-    "blockstore-fs": "2.0.0",
-    "datastore-fs": "9.1.7",
+    "blockstore-fs": "2.0.2",
+    "datastore-fs": "10.0.2",
    "glob": "7.1.6",
-    "helia": "4.2.5",
-    "helia-coord": "1.5.15",
+    "helia": "5.2.1",
+    "helia-coord": "1.7.2",
    "jsonrpc-lite": "2.2.0",
    "jsonwebtoken": "8.5.1",
    "jwt-bch-lib": "1.3.0",
@@ -58,15 +61,15 @@
    "koa-router": "10.0.0",
    "koa-static": "5.0.0",
    "koa2-ratelimit": "0.9.1",
-    "libp2p": "1.9.1",
+    "libp2p": "2.7.2",
    "line-reader": "0.4.0",
    "mime-types": "2.1.35",
-    "minimal-slp-wallet": "5.12.0",
+    "minimal-slp-wallet": "5.13.2",
    "mongoose": "5.13.14",
    "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
    "nodemailer": "6.7.5",
    "passport-local": "1.0.0",
-    "psffpp": "1.1.9",
+    "psffpp": "1.2.0",
    "public-ip": "6.0.1",
    "semver": "7.3.5",
    "winston": "3.3.3",
@@ -66,9 +66,6 @@ RUN npm install
 # Generate the API docs
 RUN npm run docs

-# Expose the port the API will be served on.
-#EXPOSE 5010
-
 # Start the application.
 #COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]
@@ -26,9 +26,12 @@ services:
    links:
      - mongo-bch-consumer
    ports:
-      - '5015:5015' # <host port>:<container port>
-      - '4101:4101'
-      - '4103:4103'
+      # <host port>:<container port>
+      - '5015:5015' # REST API
+      - '4101:4101' # TCP
+      - '4103:4103' # Websockets
+      - '4105:4105' # WebRTC
+
    volumes:
      - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-consumer/.ipfsdata
      - ./start-production.sh:/home/safeuser/ipfs-bch-wallet-consumer/start-production.sh
@@ -31,9 +31,15 @@ export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 export IPFS_TCP_PORT=4101
 export IPFS_WS_PORT=4103
+export IPFS_WEB_RTC_PORT=4105

 # Set the debug level for helia-coord. 0-3.
 # 0 = no debug logs. 3 = maximum debug logs.
 export DEBUG_LEVEL=0

+# Use this if the IPFS node has a publically accessible IP address.
+#export CONNECT_PREF=direct
+# Use this if the IPFS node is behind a NAT or Firewall and cannot be accessed directly.
+export CONNECT_PREF=cr
+
 npm start
@@ -51,70 +51,37 @@ class Admin {
  // used by the Listing Manager and test scripts, in order access private API
  // functions.
  async createSystemUser () {
-    // Create the system user.
    try {
-      context.password = _this._randomString(20)
-
-      const options = {
-        method: 'POST',
-        url: `${LOCALHOST}/users`,
-        data: {
-          user: {
-            email: 'system@system.com',
-            password: context.password,
-            name: 'admin'
-          }
-        }
+      const context = {
+        email: 'system@system.com',
+        name: 'admin',
+        password: _this.config.adminPassword || _this._randomString(20),
+        type: 'admin'
      }
-      const result = await _this.axios.request(options)
-      // console.log('admin.data: ', result.data)
+      // Check if the user already exists
+      let adminUser = await _this.User.findOne({ email: context.email })

-      context.email = result.data.user.email
-      context.id = result.data.user._id
-      context.token = result.data.token
+      if (adminUser) {
+        // Update the password
+        adminUser.password = context.password
+      } else {
+        // Create a new admin user
+        adminUser = new _this.User(context)
+      }
+      // Update context with the new user id and token
+      context.id = adminUser._id
+      context.token = await adminUser.generateToken()

-      // Get the mongoDB entry
-      const user = await _this.User.findById(context.id)
+      // Save the user
+      await adminUser.save()

-      // Change the user type to admin
-      user.type = 'admin'
-      // console.log(`user created: ${JSON.stringify(user, null, 2)}`)
-
-      // Save the user model.
-      await user.save()
-
-      // console.log(`admin user created: ${JSON.stringify(result.body, null, 2)}`)
-      // console.log(`with password: ${context.password}`)
-
-      // Write out the system user information to a JSON file that external
-      // applications like the Task Manager and the test scripts can access.
-
-      await jsonFiles.writeJSON(context, JSON_PATH)
-      // console.log('context: ', context)
-      // console.log('JSON_PATH: ', JSON_PATH)
+      // Write the user data to the JSON file
+      await _this.jsonFiles.writeJSON(context, JSON_PATH)

      return context
-    } catch (err) {
-      // Handle existing system user.
-      if (err.response.status === 422) {
-        try {
-          // Delete the existing user
-          await _this.deleteExistingSystemUser()
-
-          // Call this function again.
-          return _this.createSystemUser()
-        } catch (err2) {
-          console.error(
-            'Error in admin.js/createSystemUser() while trying generate new system user.'
-          )
-          // process.end(1)
-          throw err2
-        }
-      } else {
-        console.log('Error in admin.js/createSystemUser: ')
-        // process.end(1)
-        throw err
-      }
+    } catch (error) {
+      console.log('Error in admin.js/createSystemUser()')
+      throw error
    }
  }

@@ -129,6 +96,7 @@ class Admin {
      })

      await _this.User.deleteOne({ email: 'system@system.com' })
+      return true
    } catch (err) {
      console.log('Error in admin.js/deleteExistingSystemUser()')
      throw err
@@ -152,7 +120,7 @@ class Admin {
          Accept: 'application/json'
        },
        data: {
-          email: 'system@system.com',
+          email: existingUser.email,
          password: existingUser.password
        }
      }
@@ -405,7 +405,7 @@ class BchAdapter {

      // Wait for data to come back from the wallet service.
      const data = await this.waitForRPCResponse(rpcId)
-      console.log(`data: ${JSON.stringify(data, null, 2)}`)
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)

      return data
    } catch (err) {
@@ -45,6 +45,10 @@ class IpfsFilesAdapter {
    this.rpcHandler = this.rpcHandler.bind(this)
    this.getStatus = this.getStatus.bind(this)
    this.selectProvider = this.selectProvider.bind(this)
+    this.getFileMetadata = this.getFileMetadata.bind(this)
+    this.getPins = this.getPins.bind(this)
+    this.waitForRPCResponse = this.waitForRPCResponse.bind(this)
+    this.pinClaim = this.pinClaim.bind(this)
  }

  // This handler is triggered when RPC data comes in over IPFS.
@@ -60,7 +64,7 @@ class IpfsFilesAdapter {
      this.rpcDataQueue.push(data)
    } catch (err) {
      console.error('Error in files/rpcHandler(): ', err)
-    // Do not throw error. This is a top-level function.
+      // Do not throw error. This is a top-level function.
    }
  }

@@ -77,7 +81,7 @@ class IpfsFilesAdapter {

      // Add names to the IPFS IDs for each provider.
      const initialServiceProviders =
-      this.ipfs.ipfsCoordAdapter.state.ipfsFileProviders
+        this.ipfs.ipfsCoordAdapter.state.ipfsFileProviders
      const serviceProviders = []
      for (let i = 0; i < initialServiceProviders.length; i++) {
        const thisProvider = initialServiceProviders[i]
@@ -120,7 +124,7 @@ class IpfsFilesAdapter {
      return true
    } catch (err) {
      // console.log('createUser() error: ', err)
-      wlogger.error('Error in adapters/files/getStatus()')
+      wlogger.error('Error in adapters/files/selectProvider()')
      throw err
    }
  }
@@ -139,7 +143,7 @@ class IpfsFilesAdapter {
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
-      this.ipfs.ipfsCoordAdapter.state.selectedIpfsFileProvider
+        this.ipfs.ipfsCoordAdapter.state.selectedIpfsFileProvider
      if (!selectedProvider) {
        throw new Error('No IPFS File Pin Service provider available yet.')
      }
@@ -182,13 +186,16 @@ class IpfsFilesAdapter {
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
-      this.ipfs.ipfsCoordAdapter.state.selectedIpfsFileProvider
+        this.ipfs.ipfsCoordAdapter.state.selectedIpfsFileProvider
      if (!selectedProvider) {
        throw new Error('No IPFS File Pin Service provider available yet.')
      }

+      const { page } = inObj
+
      const rpcData = {
-        endpoint: 'getPins'
+        endpoint: 'getPins',
+        page
      }

      // Generate a UUID for the call.
@@ -258,7 +265,7 @@ class IpfsFilesAdapter {

        cnt++

-      // Exit if data was returned, or the window for a response expires.
+        // Exit if data was returned, or the window for a response expires.
      } while (!dataFound && cnt < 10)
      // console.log(`dataFound: ${dataFound}, cnt: ${cnt}`)

@@ -268,6 +275,53 @@ class IpfsFilesAdapter {
      throw err
    }
  }
+
+  async pinClaim (inObj = {}) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // ipfs service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedIpfsFileProvider
+      if (!selectedProvider) {
+        throw new Error('No IPFS File Provider Service is available yet. Try again in a few seconds.')
+      }
+
+      const { proofOfBurnTxid, cid, claimTxid, filename, address } = inObj
+
+      const rpcData = {
+        endpoint: 'pinClaim',
+        proofOfBurnTxid,
+        cid,
+        claimTxid,
+        filename,
+        address
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'file-pin', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      // console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+
+      return data
+    } catch (err) {
+      console.error('Error in pinClaim()')
+      throw err
+    }
+  }
 }

 // module.exports = P2wdbAdapter
@@ -19,17 +19,20 @@ import { noise } from '@chainsafe/libp2p-noise'
 import { yamux } from '@chainsafe/libp2p-yamux'
 // import { bootstrap } from '@libp2p/bootstrap'
 // import { identifyService } from 'libp2p/identify'
-import { identify } from '@libp2p/identify'
-// import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
-import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
+import { identify, identifyPush } from '@libp2p/identify'
+import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+// import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
 import { gossipsub } from '@chainsafe/libp2p-gossipsub'
 import { webSockets } from '@libp2p/websockets'
 import { publicIpv4 } from 'public-ip'
 import { multiaddr } from '@multiformats/multiaddr'
-// import { webRTC } from '@libp2p/webrtc'
+import { webRTC, webRTCDirect } from '@libp2p/webrtc'
 import { keychain } from '@libp2p/keychain'
-import { defaultLogger } from '@libp2p/logger'
 import { unixfs } from '@helia/unixfs'
+// import { generateKeyPairFromSeed } from '@libp2p/crypto/keys'
+// import crypto from 'crypto'
+import { ping } from '@libp2p/ping'
+import { loadOrCreateSelfKey } from '@libp2p/config'

 // Local libraries
 import config from '../../../config/index.js'
@@ -64,8 +67,8 @@ class IpfsAdapter {
    this.createNode = this.createNode.bind(this)
    this.stop = this.stop.bind(this)
    this.ensureBlocksDir = this.ensureBlocksDir.bind(this)
+    // this.getPrivateKey = this.getPrivateKey.bind(this)
    this.getSeed = this.getSeed.bind(this)
-    this.getKeychain = this.getKeychain.bind(this)
  }

  // Start an IPFS node.
@@ -111,19 +114,6 @@ class IpfsAdapter {
    }
  }

-  async getKeychain (datastore) {
-    const keychainInit = {
-      pass: await this.getSeed()
-    }
-
-    const chain = this.keychain(keychainInit)({
-      datastore,
-      logger: defaultLogger()
-    })
-
-    return chain
-  }
-
  // This function creates an IPFS node using Helia.
  // It returns the node as an object.
  async createNode () {
@@ -132,44 +122,38 @@ class IpfsAdapter {
      const blockstore = new FsBlockstore(`${IPFS_DIR}/blockstore`)
      const datastore = new FsDatastore(`${IPFS_DIR}/datastore`)

-      // const keychainInit = {
-      //   pass: await this.getSeed()
-      // }
+      // Get the private key.
+      // const privateKey = await this.getPrivateKey()
+      // console.log('privateKey: ', privateKey)

      // Create an identity
-      let peerId
-      // console.log('this.keychain: ', this.keychain)
-      // const chain = this.keychain(keychainInit)({
-      //   datastore,
-      //   logger: defaultLogger()
-      // })
-      const chain = await this.getKeychain(datastore)
-      try {
-        peerId = await chain.exportPeerId('myKey')
-      } catch (err) {
-        await chain.createKey('myKey', 'Ed25519', 4096)
-        peerId = await chain.exportPeerId('myKey')
+      const keychainInit = {
+        selfKey: 'myKey',
+        pass: await this.getSeed()
      }
+      const privateKey = await loadOrCreateSelfKey(datastore, keychainInit)

      // Configure services
      const services = {
        identify: identify(),
-        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true })
+        identifyPush: identifyPush(),
+        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }),
+        ping: ping(),
+        keychain: keychain(keychainInit)
      }
      if (this.config.isCircuitRelay) {
        console.log('Helia (IPFS) node IS configured as Circuit Relay')
        services.relay = circuitRelayServer({ // makes the node function as a relay server
          hopTimeout: 30 * 1000, // incoming relay requests must be resolved within this time limit
-          advertise: true,
          reservations: {
            maxReservations: 15, // how many peers are allowed to reserve relay slots on this server
            reservationClearInterval: 300 * 1000, // how often to reclaim stale reservations
            applyDefaultLimit: true, // whether to apply default data/duration limits to each relayed connection
            defaultDurationLimit: 2 * 60 * 1000, // the default maximum amount of time a relayed connection can be open for
-            defaultDataLimit: BigInt(2 << 7), // the default maximum number of bytes that can be transferred over a relayed connection
-            maxInboundHopStreams: 32, // how many inbound HOP streams are allow simultaneously
-            maxOutboundHopStreams: 64 // how many outbound HOP streams are allow simultaneously
-          }
+            defaultDataLimit: BigInt(2 << 7) // the default maximum number of bytes that can be transferred over a relayed connection
+          },
+          maxInboundHopStreams: 32, // how many inbound HOP streams are allow simultaneously
+          maxOutboundHopStreams: 64 // how many outbound HOP streams are allow simultaneously
        })
      } else {
        console.log('Helia (IPFS) node IS NOT configured as Circuit Relay')
@@ -177,28 +161,31 @@ class IpfsAdapter {

      const transports = [
        tcp(),
-        webSockets()
-        // circuitRelayTransport({
-        //   discoverRelays: 3,
-        //   reservationConcurrency: 3
-        // }),
-        // webRTC()
+        webSockets(),
+        circuitRelayTransport({
+          discoverRelays: 3,
+          reservationConcurrency: 3
+        }),
+        webRTC(),
+        webRTCDirect()
      ]

      // libp2p is the networking layer that underpins Helia
      const libp2p = await this.createLibp2p({
-        peerId,
+        // peerId,
+        privateKey,
        datastore,
        addresses: {
          listen: [
            '/ip4/127.0.0.1/tcp/0',
            `/ip4/0.0.0.0/tcp/${this.config.ipfsTcpPort}`,
-            `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`
-            // '/webrtc'
+            `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`,
+            '/webrtc',
+            '/p2p-circuit'
          ]
        },
        transports,
-        connectionEncryption: [
+        connectionEncrypters: [
          noise()
        ],
        streamMuxers: [
@@ -244,6 +231,8 @@ class IpfsAdapter {

      !this.fs.existsSync(`${IPFS_DIR}/datastore`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore`)

+      !this.fs.existsSync(`${IPFS_DIR}/datastore/pkcs8`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore/pkcs8`)
+
      // !fs.existsSync(`${IPFS_DIR}/datastore/peers`) && fs.mkdirSync(`${IPFS_DIR}/datastore/peers`)

      return true
@@ -280,6 +269,48 @@ class IpfsAdapter {
      throw err
    }
  }
+
+  // Get the private key from disk, or generate a new one and save it,
+  // if it doesn't exist.
+  // async getPrivateKey () {
+  //   try {
+  //     const filename = `${IPFS_DIR}/privkey.json`
+
+  //     let privKeyHex
+  //     try {
+  //       // Try to read the JSON file containing the seed.
+  //       privKeyHex = await this.jsonFiles.readJSON(filename)
+  //       // console.log('saved privKeyHex: ', privKeyHex)
+  //     } catch (err) {
+  //       // Generate a new private key and save it to disk.
+
+  //       // Generate a new private key and save it to disk.
+  //       const randomBuffer = crypto.randomBytes(32)
+  //       // console.log('randomBuffer: ', randomBuffer)
+
+  //       privKeyHex = randomBuffer.toString('hex')
+  //       // console.log('new privKeyHex: ', privKeyHex)
+
+  //       // Save the newly generated seed
+  //       await this.jsonFiles.writeJSON(privKeyHex, filename)
+  //     }
+
+  //     // Convert the saved hex string to a buffer.
+  //     const privKeyBuf = Buffer.from(privKeyHex, 'hex')
+
+  //     // Convert the buffer to a Uint8Array 'seed'
+  //     const seed = new Uint8Array(privKeyBuf.buffer, privKeyBuf.byteOffset, privKeyBuf.byteLength)
+  //     // console.log('seed: ', seed)
+
+  //     // Generate a ED25519 key pair.
+  //     const privKey = await generateKeyPairFromSeed('Ed25519', seed)
+
+  //     return privKey
+  //   } catch (err) {
+  //     console.error('Error in adapters/ipfs/ipfs.js/getPrivateKey(): ', err)
+  //     throw err
+  //   }
+  // }
 }

 export default IpfsAdapter
@@ -4,11 +4,13 @@

 // Load Mongoose models.
 import Users from './models/users.js'
+import Usage from './models/usage.js'

 class LocalDB {
  constructor () {
    // Encapsulate dependencies
    this.Users = Users
+    this.Usage = Usage
  }
 }

@@ -0,0 +1,15 @@
+/*
+  Usage data model
+*/
+
+// Global npm libraries
+import mongoose from 'mongoose'
+
+const Usage = new mongoose.Schema({
+  ip: { type: String },
+  url: { type: String },
+  method: { type: String },
+  timestamp: { type: Date }
+})
+
+export default mongoose.model('usage', Usage)
@@ -20,6 +20,13 @@ class Wallet {

    // Bind 'this' object to all subfunctions
    this.instanceWalletWithoutInitialization = this.instanceWalletWithoutInitialization.bind(this)
+    this._instanceWallet = this._instanceWallet.bind(this)
+    this.openWallet = this.openWallet.bind(this)
+    this.instanceWallet = this.instanceWallet.bind(this)
+    this.incrementNextAddress = this.incrementNextAddress.bind(this)
+    this.getKeyPair = this.getKeyPair.bind(this)
+    this.optimize = this.optimize.bind(this)
+    this.getBalance = this.getBalance.bind(this)
  }

  // This is used for initializing the wallet, without waiting to update the wallet
@@ -40,6 +40,8 @@ class IpfsRESTControllerLib {
    this.getFileInfo = this.getFileInfo.bind(this)
    this.getPins = this.getPins.bind(this)
    this.cid2json = this.cid2json.bind(this)
+    this.downloadFile = this.downloadFile.bind(this)
+    this.pinClaim = this.pinClaim.bind(this)
  }

  /**
@@ -165,12 +167,34 @@ class IpfsRESTControllerLib {
      )
      ctx.body = readStream
    } catch (err) {
-      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/viewFile(): ', err)
      this.handleError(ctx, err)
    }
  }

+  /**
+   * @api {get} /ipfs/download/:cid Download a file via its IPFS CID
+   * @apiPermission public
+   * @apiName GetCidDownload
+   * @apiGroup REST IPFS
+   * @apiDescription Download a file via its IPFS CID. Returns a readable stream.
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs/download/bafkreieaqtdhfywyddomswogynzymukosqqgqo7lkt5lch2zwfnc55m6om
+   */
+  async downloadFile (ctx) {
+    try {
+      const { cid } = ctx.params
+
+      const { readStream } = await this.useCases.ipfs.downloadCid({ cid })
+
+      ctx.body = readStream
+    } catch (err) {
+      console.log('Error in ipfs/controller.js/downloadFile(): ', err)
+      this.handleError(ctx, err)
+    }
+  }
+
  /**
   * @api {get} /ipfs/service Get the IPFS ID for the File Pin service
   * @apiPermission public
@@ -192,7 +216,7 @@ class IpfsRESTControllerLib {
        selectedIpfsFileProvider
      }
    } catch (err) {
-      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
+      // wlogger.error('Error in ipfs/controller.js/getService(): ', err)
      console.log('Error in ipfs/controller.js/getService(): ', err)
      this.handleError(ctx, err)
    }
@@ -220,7 +244,6 @@ class IpfsRESTControllerLib {

      ctx.body = metadata
    } catch (err) {
-      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/getFileInfo(): ', err)
      this.handleError(ctx, err)
    }
@@ -239,16 +262,15 @@ class IpfsRESTControllerLib {
   */
  async getPins (ctx) {
    try {
-      // const { cid } = ctx.params
+      const { page } = ctx.params

      const ipfsFiles = this.adapters.ipfsFiles

-      const pinData = await ipfsFiles.getPins()
+      const pinData = await ipfsFiles.getPins({ page })
      console.log('getPins() pinData: ', pinData)

      ctx.body = pinData
    } catch (err) {
-      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
      console.log('Error in ipfs/controller.js/getPins(): ', err)
      this.handleError(ctx, err)
    }
@@ -274,7 +296,29 @@ class IpfsRESTControllerLib {

      ctx.body = json
    } catch (err) {
-      // wlogger.error('Error in ipfs/controller.js/viewFile(): ', err)
+      console.log('Error in ipfs/controller.js/cid2json(): ', err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+   * @api {post} /ipfs/pin-claim Process pin claim.
+   * @apiPermission public
+   * @apiName PinClaim
+   * @apiGroup REST IPFS
+   * @apiDescription Process pin claim.
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST -d '{ "proofOfBurnTxid": "be4b63156c93f58ed311d403d9f756deda9abbc81d0fef8fbe5d769538b4261c", "cid": "bafybeied3zdwdiro7fqytyha2yfband4lwcrtozmf6shynylt3kexh26dq", "claimTxid": "c71e2f2cdf8658d90c61ac6183b8ffeeb359779807b317386044705d8352f0f2", "filename": "mutable-67ccefcca67097473e78ca10.json", "address": "bitcoincash:qqs2wrahl6azn9qdyrmp9ygeejqvzr8ruv7e9m30fr" }' http://localhost:5001/ipfs/pin-claim   *
+   */
+  async pinClaim (ctx) {
+    try {
+      const body = ctx.request.body
+
+      const result = await this.useCases.ipfs.pinClaim(body)
+
+      ctx.body = result
+    } catch (err) {
      console.log('Error in ipfs/controller.js/cid2json(): ', err.message)
      this.handleError(ctx, err)
    }
@@ -57,11 +57,12 @@ class IpfsRouter {
    this.router.post('/connect', this.ipfsRESTController.connect)
    this.router.get('/node', this.ipfsRESTController.getThisNode)
    this.router.get('/view/:cid', this.ipfsRESTController.viewFile)
+    this.router.get('/download/:cid', this.ipfsRESTController.downloadFile)
    this.router.get('/service', this.ipfsRESTController.getService)
    this.router.get('/file-info/:cid', this.ipfsRESTController.getFileInfo)
-    this.router.get('/pins', this.ipfsRESTController.getPins)
+    this.router.get('/pins/:page', this.ipfsRESTController.getPins)
    this.router.get('/cid2json/:cid', this.ipfsRESTController.cid2json)
-
+    this.router.post('/pin-claim', this.ipfsRESTController.pinClaim)
    // Attach the Controller routes to the Koa app.
    app.use(this.router.routes())
    app.use(this.router.allowedMethods())
@@ -10,6 +10,8 @@ import UserRESTControllerLib from './controller.js'

 import Validators from '../middleware/validators.js'

+import config from '../../../../config/index.js'
+
 let _this

 class UserRouter {
@@ -34,6 +36,7 @@ class UserRouter {
    }

    // Encapsulate dependencies.
+    this.config = config
    this.userRESTController = new UserRESTControllerLib(dependencies)
    this.validators = new Validators()

@@ -52,7 +55,7 @@ class UserRouter {
    }

    // Define the routes and attach the controller.
-    this.router.post('/', this.userRESTController.createUser)
+    this.router.post('/', this.createUser)
    this.router.get('/', this.getAll)
    this.router.get('/:id', this.getById)
    this.router.put('/:id', this.updateUser)
@@ -63,6 +66,14 @@ class UserRouter {
    app.use(this.router.allowedMethods())
  }

+  async createUser (ctx, next) {
+    if (process.env.DISABLE_NEW_ACCOUNTS) {
+      await _this.validators.ensureAdmin(ctx, next)
+    }
+    await _this.userRESTController.createUser(ctx, next)
+    return true
+  }
+
  async getAll (ctx, next) {
    await _this.validators.ensureUser(ctx, next)
    await _this.userRESTController.getUsers(ctx, next)
@@ -1,6 +1,6 @@
 /*
  This Controller library is concerned with timer-based functions that are
-  kicked off periodicially.
+  kicked off periodically.
 */

 import config from '../../config/index.js'
@@ -23,55 +23,76 @@ class TimerControllers {

    this.debugLevel = localConfig.debugLevel

+    // Constants
+    this.cleanUsageInterval = 60000 * 60 // 1 hour
+    this.backupUsageInterval = 60000 * 10 // 10 minutes
+
    // Encapsulate dependencies
    this.config = config

    // Bind 'this' object to all subfunctions.
-    this.exampleTimerFunc = this.exampleTimerFunc.bind(this)
    this.cleanUsage = this.cleanUsage.bind(this)
-
-    // this.startTimers()
+    this.backupUsage = this.backupUsage.bind(this)
  }

  // Start all the time-based controllers.
  startTimers () {
    // Any new timer control functions can be added here. They will be started
    // when the server starts.
-    this.optimizeWalletHandle = setInterval(this.exampleTimerFunc, 60000 * 60)
-    this.cleanUsageHandle = setInterval(this.cleanUsage, 60000 * 60) // 1 hour
+    this.cleanUsageHandle = setInterval(this.cleanUsage, this.cleanUsageInterval)
+    this.backupUsageHandle = setInterval(this.backupUsage, this.backupUsageInterval)

    return true
  }

  stopTimers () {
-    clearInterval(this.optimizeWalletHandle)
-    clearInterval(this.cleanusageHandle)
+    clearInterval(this.cleanUsageHandle)
+    clearInterval(this.backupUsageHandle)
  }

-  // Replace this example function with your own timer handler.
-  exampleTimerFunc (negativeTest) {
+  // Clean the usage state so that stats reflect the last 24 hours.
+  cleanUsage () {
    try {
-      // console.log('Example timer controller executed.')
+      clearInterval(this.cleanUsageHandle)

-      if (negativeTest) throw new Error('test error')
+      const now = new Date()
+      console.log(`cleanUsage() Timer Controller executing at ${now.toLocaleString()}`)
+
+      this.useCases.usage.cleanUsage()
+
+      this.cleanUsageHandle = setInterval(this.cleanUsage, this.cleanUsageInterval)

      return true
    } catch (err) {
-      console.error('Error in exampleTimerFunc(): ', err)
+      console.error('Error in time-controller.js/cleanUsage(): ', err)
+
+      this.cleanUsageHandle = setInterval(this.cleanUsage, this.cleanUsageInterval)

      // Note: Do not throw an error. This is a top-level function.
      return false
    }
  }

-  // Clean the usage state so that stats reflect the last 24 hours.
-  cleanUsage () {
+  // Backup the usage stats to the database
+  async backupUsage () {
    try {
-      this.useCases.usage.cleanUsage()
+      clearInterval(this.backupUsageHandle)
+
+      console.log('backupUsage() Timer Controller executing at ', new Date().toLocaleString())
+
+      // Clear the database of old usage data.
+      await this.useCases.usage.clearUsage()
+
+      // Save the current usage snapshot to the database.
+      await this.useCases.usage.saveUsage()
+
+      this.backupUsageHandle = setInterval(this.backupUsage, this.backupUsageInterval)

      return true
    } catch (err) {
-      console.error('Error in time-controller.js/cleanUsage(): ', err)
+      console.error('Error in time-controller.js/backupUsage(): ', err)
+
+      this.backupUsageHandle = setInterval(this.backupUsage, this.backupUsageInterval)

      // Note: Do not throw an error. This is a top-level function.
      return false
@@ -32,6 +32,9 @@ class UseCases {

  // Run any startup Use Cases at the start of the app.
  async start () {
+    // Load the usage stats from the database
+    await this.usage.loadUsage()
+
    console.log('Async Use Cases have been started.')

    return true
@@ -9,6 +9,7 @@
 // import { exporter } from 'ipfs-unixfs-exporter'
 import { Duplex } from 'stream'
 import PSFFPP from 'psffpp'
+import { CID } from 'multiformats'

 // Local libraries
 // import PinEntity from '../entities/pin.js'
@@ -28,12 +29,15 @@ class IpfsUseCases {

    // Encapsulate dependencies
    this.psffpp = null // placeholder
+    this.CID = CID

    // Bind 'this' object to all class subfunctions.
    this.downloadCid = this.downloadCid.bind(this)
    // this.downloadCid2 = this.downloadCid2.bind(this)
    this.getWritePrice = this.getWritePrice.bind(this)
+    this.getCidMetadata = this.getCidMetadata.bind(this)
    this.cid2json = this.cid2json.bind(this)
+    this.pinClaim = this.pinClaim.bind(this)

    // State
    this.lastWritePriceUpdate = null // Used to periodically update write price.
@@ -43,7 +47,7 @@ class IpfsUseCases {
  // Returns a readable stream.
  async downloadCid (inObj = {}) {
    try {
-      const { cid } = inObj
+      let { cid } = inObj

      if (!cid) throw new Error('CID is undefined')

@@ -64,6 +68,47 @@ class IpfsUseCases {

      const helia = this.adapters.ipfs.ipfs

+      const cidClass = this.CID.parse(cid)
+
+      // Download the file from other nodes.
+      await helia.blockstore.get(cidClass)
+
+      // list cid content, to dermine if this is a file-based or directory-based CID.
+      const contentArray = []
+      for await (const file of helia.fs.ls(cid)) {
+        contentArray.push(file)
+      }
+
+      // Handle directory-based CIDs. This is used by Token Tiger for mutable and immutable token data.
+      /**
+      *  If the cid is a directory
+       * The next block of code sends a html page with a list of links with the file names into the directory.
+       * Skipping this code delivers directly the first file detected in the directory.
+       */
+      const isDir = contentArray[0].path.match('/') // TODO : looking for a better way to detect if is a directory
+      // 'listDir' is a flag to ignore this code on /download endpoint.
+      if (isDir) {
+        console.log('This CID is a directory. contentArray[0]: ', contentArray[0])
+        cid = `${cid}/${contentArray[0].name}`
+
+        // throw new Error('CID is a directory. Not supported yet.')
+        // const stream = new Stream.Readable({ read () { } })
+        // for (let i = 0; i < contentArray.length; i++) {
+        //   const cont = contentArray[i]
+        //   // List all paths excluding root path.
+        //   if (cont.path !== cid) {
+        //     // Add links to the gateway with the format  cid/:filename
+        //     stream.push(`<a href='${this.config.domainName}/ipfs/view/${cid}/${cont.name}' >/${cont.name} ( CID:  ${cont.cid} )</a><hr />`)
+        //   }
+        // }
+
+        // stream.push(null)
+        // // return fileName as html because the controller the library <mime.lookup> sends it as html
+        // return { readStream: stream }
+      } else {
+        console.log('This CID is not a directory.')
+      }
+
      // Convert the file to a Buffer.
      const fileChunks = []
      for await (const chunk of helia.fs.cat(cid)) {
@@ -181,9 +226,11 @@ class IpfsUseCases {

      // Throw an error if this is not a JSON file
      const filename = fileMetadata.filename
+
      if (!filename.endsWith('.json')) {
        throw new Error(`CID ${cid} does not resolve to a JSON file.`)
      }
+
      // Retrieve the CID content and store it in a Buffer.
      const helia = this.adapters.ipfs.ipfs
      const fileChunks = []
@@ -237,6 +284,20 @@ class IpfsUseCases {
    }
  }

+  async pinClaim (inObj = {}) {
+    try {
+      // Throw an error if ipfs-bch-wallet-consumer can not communicate with the ipfs-file-pin-service.
+      const metadata = await this.adapters.ipfsFiles.pinClaim(inObj)
+
+      return {
+        success: metadata.success,
+        message: metadata.message
+      }
+    } catch (err) {
+      console.error('Error in ipfs-use-cases.js/pinClaim(): ', err)
+      throw err
+    }
+  }
  // async downloadCid2 (inObj = {}) {
  //   try {
  //     const { cid } = inObj
@@ -3,6 +3,10 @@
  for tracking the usage of REST API and JSON RPC calls. This library is used
  by admins to keep an eye on how many API calls were made in a 24-hour and
  1-hour time period.
+
+  Usage stats are held in memory. But they are periodically backed up to the
+  Mongo database. On startup, the usage stats are loaded from the database.
+  This allows the usage stats to be persisted across restarts.
 */

 // This global variable is used to share data between the REST middleware and
@@ -19,11 +23,17 @@ class UsageUseCases {
      )
    }

+    // Encapsulate dependencies
+    this.UsageModel = this.adapters.localdb.Usage
+
    // Bind 'this' object to all subfunctions
    this.cleanUsage = this.cleanUsage.bind(this)
    this.getRestSummary = this.getRestSummary.bind(this)
    this.getTopIps = this.getTopIps.bind(this)
    this.getTopEndpoints = this.getTopEndpoints.bind(this)
+    this.clearUsage = this.clearUsage.bind(this)
+    this.saveUsage = this.saveUsage.bind(this)
+    this.loadUsage = this.loadUsage.bind(this)

    // State
  }
@@ -36,7 +46,11 @@ class UsageUseCases {
      const now = new Date()
      const twentyFourHoursAgo = now.getTime() - (60000 * 60 * 24)

+      console.log('cleanUsage() now: ', now)
+      console.log('cleanUsage() restCalls.length before filtering: ', restCalls.length)
      restCalls = restCalls.filter(x => x.timestamp > twentyFourHoursAgo)
+      console.log('cleanUsage() restCalls.length after filtering: ', restCalls.length)
+
      return restCalls
    } catch (err) {
      console.error('Error in usage-use-cases.js/cleanUsage()')
@@ -104,6 +118,56 @@ class UsageUseCases {
      throw err
    }
  }
+
+  // Clear the usage database data
+  async clearUsage () {
+    try {
+      await this.UsageModel.deleteMany({})
+
+      // Debugging: verify the database is empty
+      // Delete this code after debugging
+      const usage = await this.UsageModel.find({})
+      console.log('clearUsage() usage: ', usage)
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/clearUsage()')
+      throw err
+    }
+  }
+
+  // Save the usage data to the database
+  async saveUsage (inObj = {}) {
+    try {
+      for (let i = 0; i < restCalls.length; i++) {
+        const thisRestCall = restCalls[i]
+
+        const usageData = {
+          ip: thisRestCall.ip,
+          url: thisRestCall.url,
+          method: thisRestCall.method,
+          timestamp: thisRestCall.timestamp
+        }
+
+        const usage = new this.UsageModel(usageData)
+        await usage.save()
+      }
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/saveUsage()')
+      throw err
+    }
+  }
+
+  // Load usage data from the database
+  async loadUsage () {
+    try {
+      const usage = await this.UsageModel.find({})
+      // console.log('usage: ', usage)
+
+      restCalls = usage
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/loadUsage(): ', err)
+      // throw err
+    }
+  }
 }

 // This Koa middleware is called any time there is a REST API. It logs the
@@ -0,0 +1,45 @@
+/*
+  Liveness test runs before all other tests to ensure the server is running.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import axios from 'axios'
+import testUtils from '../../utils/test-utils.js'
+
+// const sinon = require('sinon')
+
+// Local support libraries
+import config from '../../../config/index.js'
+// import Server from '../../../bin/server.js'
+// import testUtils from '../../utils/test-utils.js'
+// const adminLib = new AdminLib()
+
+const LOCALHOST = `http://localhost:${config.port}`
+
+describe('#Check Server Liveness', () => {
+  // before(async () => {
+  it('should confirm the server is running', async () => {
+    try {
+      const response = await axios.get(`${LOCALHOST}/`)
+      assert(response.status === 200, 'Server is running, continuing with E2E tests.')
+    } catch (err) {
+      console.log('\nServer is not running, exiting tests.')
+      console.log('Start the server with `npm run start:e2e:server` before running E2E tests.\n')
+      console.log('Ensure running npm run docs before running the test server')
+      process.exit(1)
+    }
+  })
+  it('should confirm the server is running over test enviroment', async () => {
+    try {
+      const res = await testUtils.loginAdminUser()
+      assert.property(res, 'user')
+      assert.property(res, 'token')
+      assert.property(res, 'id')
+    } catch (err) {
+      console.log('\nServer is not running over test enviroment, exiting tests.')
+      console.log('Start the server with `npm run start:e2e:server` before running E2E tests.\n')
+      process.exit(1)
+    }
+  })
+})
@@ -13,10 +13,8 @@ import axios from 'axios'

 // Local support libraries
 import config from '../../../config/index.js'
-import Server from '../../../bin/server.js'
+// import Server from '../../../bin/server.js'
 import testUtils from '../../utils/test-utils.js'
-import AdminLib from '../../../src/adapters/admin.js'
-const adminLib = new AdminLib()

 // const request = supertest.agent(app.listen())
 const context = {}
@@ -26,10 +24,12 @@ const LOCALHOST = `http://localhost:${config.port}`
 if (!config.noMongo) {
  describe('Auth', () => {
    before(async () => {
-      const app = new Server()
+      // const app = new Server()

      // This should be the first instruction. It starts the REST API server.
-      await app.startServer()
+      // await app.startServer()
+
+      // TODO:

      // Stop the IPFS node for the rest of the e2e tests.
      // await app.controllers.adapters.ipfs.stop()
@@ -37,9 +37,6 @@ if (!config.noMongo) {
      // Delete all previous users in the database.
      await testUtils.deleteAllUsers()

-      // Create a new admin user.
-      await adminLib.createSystemUser()
-
      const userObj = {
        email: 'test@test.com',
        password: 'pass',
@@ -5,22 +5,11 @@ import axios from 'axios'
 import sinon from 'sinon'
 import util from 'util'

-import UserController from '../../../src/controllers/rest-api/users/controller.js'
-import Adapters from '../../../src/adapters/index.js'
-import UseCases from '../../../src/use-cases/index.js'
-
-// import UserController from '../../../src/controllers/rest-api/users/controller.js'
-// import Adapters from '../../../src/adapters/index.js'
-import EventEmitter from 'events'
 util.inspect.defaultOptions = { depth: 1 }

 const LOCALHOST = `http://localhost:${config.port}`

 const context = {}
-const adapters = new Adapters({ eventEmitter: new EventEmitter() })
-// import UseCases from '../../../src/use-cases/index.js'
-
-let uut
 let sandbox

 // const mockContext = require('../../unit/mocks/ctx-mock').context
@@ -56,9 +45,6 @@ if (!config.noMongo) {
    })

    beforeEach(() => {
-      const useCases = new UseCases({ adapters })
-      uut = new UserController({ adapters, useCases })
-
      sandbox = sinon.createSandbox()
    })

@@ -274,33 +260,6 @@ if (!config.noMongo) {
        assert.hasAnyKeys(users[0], ['type', '_id', 'email'])
        assert.isNumber(users.length)
      })
-
-      it('should return a 422 http status if biz-logic throws an error', async () => {
-        try {
-          const { token } = context
-
-          // Force an error
-          sandbox
-            .stub(uut.useCases.user, 'getAllUsers')
-            .rejects(new Error('test error'))
-
-          const options = {
-            method: 'GET',
-            url: `${LOCALHOST}/users`,
-            headers: {
-              Accept: 'application/json',
-              Authorization: `Bearer ${token}`
-            }
-          }
-          await axios(options)
-
-          assert.fail('Unexpected code path!')
-        } catch (err) {
-          // console.log(err)
-          assert.equal(err.response.status, 422)
-          assert.equal(err.response.data, 'test error')
-        }
-      })
    })

    describe('GET /users/:id', () => {
@@ -1,119 +0,0 @@
-import { assert } from 'chai'
-import Admin from '../../../src/adapters/admin.js'
-import sinon from 'sinon'
-import util from 'util'
-import config from '../../../config/index.js'
-
-util.inspect.defaultOptions = { depth: 1 }
-
-let sandbox
-let uut
-describe('Admin', () => {
-  beforeEach(() => {
-    uut = new Admin()
-
-    sandbox = sinon.createSandbox()
-  })
-
-  afterEach(() => sandbox.restore())
-
-  if (!config.noMongo) {
-    describe('loginAdmin()', () => {
-      it('should logind admin', async () => {
-        try {
-          const error = new Error('test error')
-          error.response = {
-            status: 422
-          }
-          // sandbox.stub(uut.axios, 'request').onFirstCall().throws(error)
-
-          const result = await uut.loginAdmin()
-          const user = result.data.user
-
-          assert.property(user, '_id')
-          assert.property(user, 'email')
-          assert.property(user, 'type')
-
-          assert.isString(user._id)
-          assert.isString(user.email)
-          assert.isString(user.type)
-
-          assert.equal(user.type, 'admin')
-        } catch (err) {
-          assert(false, 'Unexpected result')
-        }
-      })
-
-      it('should handle axios error', async () => {
-        try {
-          // Returns an erroneous password to force
-          // an auth error
-          sandbox.stub(uut.jsonFiles, 'readJSON').resolves({ password: 'wrong' })
-
-          await uut.loginAdmin()
-          assert(false, 'Unexpected result')
-        } catch (err) {
-          assert.equal(err.response.status, 401)
-          assert.include(err.response.data, 'Unauthorized')
-        }
-      })
-    })
-
-    describe('createSystemUser()', () => {
-      it('should create admin', async () => {
-        try {
-          const result = await uut.createSystemUser()
-
-          assert.property(result, 'email')
-          assert.property(result, 'password')
-          assert.property(result, 'id')
-          assert.property(result, 'token')
-        } catch (err) {
-          assert(false, 'Unexpected result')
-        }
-      })
-
-      it('should handle axios error', async () => {
-        try {
-          const error1 = new Error('test error')
-          error1.response = {
-            status: 422
-          }
-          const error2 = new Error('test error')
-          error1.response = {
-            status: 500
-          }
-          // The loginAdmin() function in some use cases is recursive
-          // after handling the 422 error, it gets called again
-          sandbox
-            .stub(uut.axios, 'request')
-            .onFirstCall()
-            .throws(error1)
-            .onSecondCall()
-            .throws(error2)
-
-          await uut.createSystemUser()
-          assert(false, 'Unexpected result')
-        } catch (err) {
-          assert.include(err.message, 'test error')
-        }
-      })
-
-      it('should handle errors when remove user', async () => {
-        try {
-          const error1 = new Error('test error')
-          error1.response = {
-            status: 422
-          }
-          sandbox.stub(uut.axios, 'request').throws(error1)
-          sandbox.stub(uut.User, 'deleteOne').throws(new Error('test error'))
-
-          await uut.createSystemUser()
-          assert(false, 'Unexpected result')
-        } catch (err) {
-          assert.include(err.message, 'test error')
-        }
-      })
-    })
-  }
-})
@@ -0,0 +1,121 @@
+import { assert } from 'chai'
+import Admin from '../../../src/adapters/admin.js'
+import sinon from 'sinon'
+import util from 'util'
+import config from '../../../config/index.js'
+
+util.inspect.defaultOptions = { depth: 1 }
+
+let sandbox
+let uut
+describe('Admin', () => {
+  beforeEach(() => {
+    uut = new Admin()
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  if (!config.noMongo) {
+    describe('loginAdmin()', () => {
+      // it('should login admin', async () => {
+      //   try {
+      //     sandbox.stub(uut.axios, 'request').resolves(true)
+
+      //     const result = await uut.loginAdmin()
+      //     assert.isTrue(result)
+      //   } catch (err) {
+      //     assert(false, 'Unexpected result')
+      //   }
+      // })
+
+      it('should handle axios error', async () => {
+        try {
+          // Returns an erroneous password to force
+          // an auth error
+          sandbox.stub(uut.axios, 'request').throws(new Error('test error'))
+          sandbox.stub(uut.jsonFiles, 'readJSON').resolves({ password: 'wrong' })
+
+          await uut.loginAdmin()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
+    })
+
+    describe('createSystemUser()', () => {
+      it('should create admin', async () => {
+        try {
+          await uut.deleteExistingSystemUser()
+          const result = await uut.createSystemUser()
+
+          assert.property(result, 'email')
+          assert.property(result, 'password')
+          assert.property(result, 'id')
+          assert.property(result, 'token')
+        } catch (err) {
+          assert(false, 'Unexpected result')
+        }
+      })
+      it('should update admin password', async () => {
+        try {
+          uut.config.adminPassword = 'newpassword'
+
+          const fakeUser = {
+            password: 'oldpassword',
+            save: () => { return 'token' },
+            generateToken: () => { return 'token' }
+          }
+
+          sandbox.stub(uut.User, 'findOne').resolves(fakeUser)
+          sandbox.stub(uut.jsonFiles, 'writeJSON').resolves(true)
+          const result = await uut.createSystemUser()
+
+          assert.property(result, 'email')
+          assert.property(result, 'password')
+          assert.property(result, 'id')
+          assert.property(result, 'token')
+
+          assert.equal(fakeUser.password, 'newpassword', 'password should be updated')
+        } catch (err) {
+          console.log(err)
+          assert(false, 'Unexpected result')
+        }
+      })
+
+      it('should handle error', async () => {
+        try {
+          sandbox.stub(uut.User, 'findOne').throws(new Error('test error'))
+          await uut.createSystemUser()
+          assert.fail('Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
+    })
+
+    describe('deleteExistingSystemUser()', () => {
+      it('should delete admin', async () => {
+        try {
+          sandbox.stub(uut.User, 'deleteOne').resolves(true)
+          const result = await uut.deleteExistingSystemUser()
+          assert.isTrue(result)
+        } catch (err) {
+          assert(false, 'Unexpected result')
+        }
+      })
+
+      it('should handle error when deleting admin', async () => {
+        try {
+          sandbox.stub(uut.User, 'deleteOne').throws(new Error('test error'))
+          await uut.deleteExistingSystemUser()
+          assert.fail('Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
+    })
+  }
+})
@@ -6,7 +6,7 @@
 import { assert } from 'chai'
 import sinon from 'sinon'
 import cloneDeep from 'lodash.clonedeep'
-import { peerIdFromString } from '@libp2p/peer-id'
+// import { peerIdFromString } from '@libp2p/peer-id'

 // Local libraries
 import IPFSLib from '../../../src/adapters/ipfs/ipfs.js'
@@ -165,17 +165,17 @@ describe('#IPFS-adapter', () => {
      uut.config.isCircuitRelay = false

      // Mock dependencies and force desired code path.
-      let beenCalled = false
-      sandbox.stub(uut, 'getKeychain').resolves({
-        exportPeerId: async () => {
-          if (!beenCalled) {
-            beenCalled = true
-            throw new Error('test error')
-          }
-          return peerIdFromString('12D3KooWSXF1PnEfiA8bCG8SJduCvzdwHtvhVPK4WC6zzDoto2XP')
-        },
-        createKey: async () => {}
-      })
+      // const beenCalled = false
+      // sandbox.stub(uut, 'getKeychain').resolves({
+      //   exportPeerId: async () => {
+      //     if (!beenCalled) {
+      //       beenCalled = true
+      //       throw new Error('test error')
+      //     }
+      //     return peerIdFromString('12D3KooWSXF1PnEfiA8bCG8SJduCvzdwHtvhVPK4WC6zzDoto2XP')
+      //   },
+      //   createKey: async () => {}
+      // })
      sandbox.stub(uut, 'createLibp2p').resolves()
      sandbox.stub(uut, 'createHelia').resolves({})

@@ -248,4 +248,247 @@ describe('#IPFS REST API', () => {
      assert.property(ctx.body, 'thisNode')
    })
  })
+  describe('#viewFile', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        ctx.params = {
+          cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+        }
+        sandbox.stub(uut.useCases.ipfs, 'downloadCid').throws(new Error('test error'))
+        uut.adapters.ipfs.ipfsCoordAdapter = {}
+
+        ctx.request.body = {}
+
+        await uut.viewFile(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      ctx.params = {
+        cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+      }
+      // Mock dependencies
+      sandbox.stub(uut.useCases.ipfs, 'downloadCid').resolves({ success: true, readStream: 'readStream' })
+
+      uut.adapters.ipfs.ipfsCoordAdapter = {
+        ipfsCoord: {
+          thisNode: {}
+        }
+      }
+
+      ctx.request.body = {}
+
+      await uut.viewFile(ctx)
+
+      assert.exists(ctx.body)
+    })
+  })
+  describe('#downloadFile', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        ctx.params = {
+          cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+        }
+        // Force an error
+        sandbox.stub(uut.useCases.ipfs, 'downloadCid').throws(new Error('test error'))
+        uut.adapters.ipfs.ipfsCoordAdapter = {}
+
+        ctx.request.body = {}
+
+        await uut.downloadFile(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      ctx.params = {
+        cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+      }
+      // Mock dependencies
+      sandbox.stub(uut.useCases.ipfs, 'downloadCid').resolves({ success: true, readStream: 'readStream' })
+
+      uut.adapters.ipfs.ipfsCoordAdapter = {
+        ipfsCoord: {
+          thisNode: {}
+        }
+      }
+
+      ctx.request.body = {}
+
+      await uut.downloadFile(ctx)
+
+      assert.exists(ctx.body)
+    })
+  })
+  describe('#getService', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        uut.adapters.ipfs.ipfsCoordAdapter = {}
+
+        ctx.request.body = {}
+
+        await uut.getService(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'Cannot read properties of undefined')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+
+      uut.adapters.ipfs.ipfsCoordAdapter = {
+        state: {
+          selectedIpfsFileProvider: 'provider'
+        }
+      }
+
+      ctx.request.body = {}
+
+      await uut.getService(ctx)
+
+      assert.isTrue(ctx.body.success)
+    })
+  })
+  describe('#getFileInfo', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        ctx.params = {
+          cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+        }
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').throws(new Error('test error'))
+
+        ctx.request.body = {}
+
+        await uut.getFileInfo(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      ctx.params = {
+        cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+      }
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ success: true, filename: 'filename' })
+
+      ctx.request.body = {}
+
+      await uut.getFileInfo(ctx)
+
+      assert.isTrue(ctx.body.success)
+    })
+  })
+
+  describe('#getPins', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getPins').throws(new Error('test error'))
+
+        ctx.request.body = {}
+        ctx.params = { page: 1 }
+
+        await uut.getPins(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfsFiles, 'getPins').resolves({ success: true })
+
+      ctx.request.body = {}
+      ctx.params = { page: 1 }
+
+      await uut.getPins(ctx)
+
+      assert.isTrue(ctx.body.success)
+    })
+  })
+
+  describe('#cid2json', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        ctx.params = {
+          cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+        }
+        sandbox.stub(uut.useCases.ipfs, 'cid2json').throws(new Error('test error'))
+
+        ctx.request.body = {}
+
+        await uut.cid2json(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      ctx.params = {
+        cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy'
+      }
+      // Mock dependencies
+      sandbox.stub(uut.useCases.ipfs, 'cid2json').resolves({ success: true })
+
+      ctx.request.body = {}
+
+      await uut.cid2json(ctx)
+
+      assert.isTrue(ctx.body.success)
+    })
+  })
+  describe('#pinClaim', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        sandbox.stub(uut.useCases.ipfs, 'pinClaim').throws(new Error('test error'))
+
+        ctx.request.body = {}
+
+        await uut.pinClaim(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.useCases.ipfs, 'pinClaim').resolves({ success: true })
+
+      ctx.request.body = {}
+
+      await uut.pinClaim(ctx)
+
+      assert.isTrue(ctx.body.success)
+    })
+  })
 })
@@ -79,4 +79,32 @@ describe('#Users-REST-Router', () => {
      }
    })
  })
+
+  describe('#createUser', () => {
+    it('should ignore admin validator when DISABLE_NEW_ACCOUNTS is not defined', async () => {
+      // Stub functions
+      const validationSpy = sandbox.stub(uut.validators, 'ensureAdmin').resolves(true)
+      sandbox.stub(uut.userRESTController, 'createUser').resolves(true)
+
+      // Call function
+      await uut.createUser()
+
+      // Assertions
+      assert.isTrue(validationSpy.notCalled, 'Admin validator should not be called')
+    })
+    it('should ensure admin when DISABLE_NEW_ACCOUNTS is defined', async () => {
+      // Set environment variable
+      process.env.DISABLE_NEW_ACCOUNTS = true
+
+      // Stub functions
+      const validationSpy = sandbox.stub(uut.validators, 'ensureAdmin').resolves(true)
+      sandbox.stub(uut.userRESTController, 'createUser').resolves(true)
+
+      // Call function
+      await uut.createUser()
+
+      // Assertions
+      assert.isTrue(validationSpy.calledOnce, 'Admin validator should be called')
+    })
+  })
 })
@@ -66,19 +66,19 @@ describe('#Timer-Controllers', () => {
    })
  })

-  describe('#exampleTimerFunc', () => {
-    it('should kick off the Use Case', async () => {
-      const result = await uut.exampleTimerFunc()
+  // describe('#exampleTimerFunc', () => {
+  //   it('should kick off the Use Case', async () => {
+  //     const result = await uut.exampleTimerFunc()

-      assert.equal(result, true)
-    })
+  //     assert.equal(result, true)
+  //   })

-    it('should return false on error', async () => {
-      const result = await uut.exampleTimerFunc(true)
+  //   it('should return false on error', async () => {
+  //     const result = await uut.exampleTimerFunc(true)

-      assert.equal(result, false)
-    })
-  })
+  //     assert.equal(result, false)
+  //   })
+  // })

  describe('#cleanUsage', () => {
    it('should kick off the Use Case', async () => {
@@ -94,4 +94,21 @@ describe('#Timer-Controllers', () => {
      assert.equal(result, false)
    })
  })
+
+  describe('#backupUsage', () => {
+    it('should kick off the Use Case', async () => {
+      const result = await uut.backupUsage()
+
+      assert.equal(result, true)
+    })
+
+    it('should return false on error', async () => {
+      sandbox.stub(uut.useCases.usage, 'clearUsage').throws(new Error('test error'))
+      // sandbox.stub(uut.useCases.usage, 'saveUsage').throws(new Error('test error'))
+
+      const result = await uut.backupUsage()
+
+      assert.equal(result, false)
+    })
+  })
 })
@@ -1,10 +1,26 @@
 /*
  Mocks for the Adapter library.
 */
-
+class BlockstoreMock {
+  constructor () {
+    this.get = async () => {}
+  }
+}
+class FsMock {
+  constructor () {
+    this.ls = async function* () {
+      yield { path: 'test.txt', cid: 'QmS4ghgMgfFvqPjB4WKXHaN15ZyT4K4JYZxY5X5x5x5x5' }
+    }
+    this.cat = async function* () {
+      yield Buffer.from('test data')
+    }
+  }
+}
 class IpfsAdapter {
  constructor () {
    this.ipfs = {
+      blockstore: new BlockstoreMock(),
+      fs: new FsMock(),
      files: {
        stat: () => {}
      }
@@ -34,7 +50,9 @@ class IpfsCoordAdapter {
    this.peerInputHandler = () => {}

    this.state = {
-      serviceProviders: []
+      serviceProviders: [],
+      serviceProvidersByType: '',
+      selectedIpfsFileProvider:''
    }
  }
 }
@@ -138,5 +156,29 @@ class BchUseCaseMock {
  }
 }
 const bch = new BchUseCaseMock()
+const wallet = {
+  bchWallet: bch

-export default { ipfs, localdb, bch }
+}
+
+const ipfsFiles = {
+  pinClaim: () => {
+    return {
+      success: true,
+      message: 'Pin claimed'
+    }
+  },
+  getFileMetadata: () => {
+    return {
+      success: true,
+      message: 'Files metadata'
+    }
+  },
+  getPins: () => {
+    return {
+      success: true,
+      message: 'Pins'
+    }
+  }
+}
+export default { ipfs, localdb, bch, wallet, ipfsFiles }
@@ -65,6 +65,36 @@ class UsageUseCaseMock {
  async getTopEndpoints(existingUser, newData) {
    return true
  }
+
+  async clearUsage() {
+    return true
+  }
+
+  async saveUsage() {
+    return true
+  }
+}
+
+class IpfsUseCaseMock {
+  async downloadCid() {
+    return {}
+  }
+
+  async cid2json() {
+    return {}
+  } 
+
+  async getCidMetadata() {
+    return {}
+  }
+
+  async getService() {
+    return {}
+  } 
+
+  async pinClaim() {
+    return {}
+  }
 }

 class UseCasesMock {
@@ -77,6 +107,7 @@ class UseCasesMock {
  user = new UserUseCaseMock()
  bch = new BchUseCaseMock()
  usage = new UsageUseCaseMock()
+  ipfs = new IpfsUseCaseMock()
 }

 export default UseCasesMock;
@@ -0,0 +1,270 @@
+/*
+  Unit tests for the ipfs-use-cases.js file.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+
+import sinon from 'sinon'
+
+// Local support libraries
+// const testUtils = require('../../utils/test-utils')
+
+// Unit under test (uut)
+import UseCases from '../../../src/use-cases/ipfs-use-cases.js'
+
+import adapters from '../mocks/adapters/index.js'
+
+describe('#ipfs-use-cases', () => {
+  let uut
+  let sandbox
+
+  before(async () => {
+    // Delete all previous users in the database.
+    // await testUtils.deleteAllUsers()
+  })
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+
+    uut = new UseCases({ adapters })
+    uut.adapters.ipfs.ipfsCoordAdapter = {
+      state: {
+        selectedIpfsFileProvider: 'provider'
+      }
+    }
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new UseCases()
+
+        assert.fail('Unexpected code path')
+
+        // This is here to prevent the linter from complaining.
+        assert.isOk(uut)
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of adapters must be passed in when instantiating IPFS Use Cases library.'
+        )
+      }
+    })
+  })
+
+  describe('#downloadCid', () => {
+    it('should download a file from IPFS', async () => {
+      sandbox.stub(uut, 'getCidMetadata').resolves('file.txt')
+
+      const result = await uut.downloadCid({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+
+      assert.property(result, 'filename')
+      assert.property(result, 'readStream')
+    })
+    it('should handle directory-based CIDs', async () => {
+      sandbox.stub(uut, 'getCidMetadata').resolves('file.txt')
+      sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'ls').callsFake(async function * () {
+        yield { path: 'dir1/test.txt', cid: 'QmS4ghgMgfFvqPjB4WKXHaN15ZyT4K4JYZxY5X5x5x5x5' }
+      })
+      const result = await uut.downloadCid({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+
+      assert.property(result, 'filename')
+      assert.property(result, 'readStream')
+    })
+    it('should throw an error if cid is not provided ', async () => {
+      try {
+        await uut.downloadCid({})
+      } catch (error) {
+        assert.include(error.message, 'CID is undefined')
+      }
+    })
+  })
+  describe('#getWritePrice', () => {
+    it('should get price', async () => {
+      const result = await uut.getWritePrice()
+      assert.isNumber(result)
+    })
+    it('should handle undefined psffpp instance', async () => {
+      uut.psffpp = null
+      const result = await uut.getWritePrice()
+      assert.isNumber(result)
+    })
+
+    it('should handle error ', async () => {
+      try {
+        uut.psffpp = {
+          getMcWritePrice: () => {
+            throw new Error('test error')
+          }
+        }
+        await uut.getWritePrice()
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+  })
+  describe('#getCidMetadata', () => {
+    it('should get cid metadata', async () => {
+      sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ success: true, fileMetadata: { dataPinned: true, filename: 'test.json' } })
+      const result = await uut.getCidMetadata({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      assert.isString(result)
+      assert.equal(result, 'test.json')
+    })
+
+    it('should handle error ', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').throws(new Error('test error'))
+        await uut.getCidMetadata({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+
+    it('should handle non-success response from getFileMetadata', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ success: false, message: 'test error' })
+        await uut.getCidMetadata({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+  })
+  describe('#cid2json', () => {
+    it('should get cid2json', async () => {
+      uut.adapters.ipfs.ipfsCoordAdapter = {
+        state: {
+          selectedIpfsFileProvider: 'provider'
+        }
+      }
+      sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ fileMetadata: { dataPinned: true, filename: 'test.json' } })
+      sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'ls').callsFake(function * () {
+        yield { name: 'test.json' }
+      })
+      sandbox.stub(JSON, 'parse').returns(true)
+      const result = await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      assert.isObject(result)
+      assert.property(result, 'success')
+      assert.property(result, 'json')
+    })
+
+    it('should throw error if selectedIpfsFileProvider is not defined', async () => {
+      try {
+        uut.adapters.ipfs.ipfsCoordAdapter = {
+          state: {
+            selectedIpfsFileProvider: null
+          }
+        }
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'No IPFS File Provider Service is available yet. Try again in a few seconds')
+      }
+    })
+    it('should throw error if file metadata cant be fetched', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ success: false })
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'Could not communicate with instance of ipfs-file-pin-service')
+      }
+    })
+    it('should throw error if cid is not pinned', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ success: true, fileMetadata: { dataPinned: false } })
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'has not been pinned by ipfs-file-pin-service instance')
+      }
+    })
+    it('should throw error if filename has no .json extension', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ success: true, fileMetadata: { dataPinned: true, filename: 'test' } })
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'does not resolve to a JSON file')
+      }
+    })
+    it('should handle error if file cant be retrieved', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ fileMetadata: { dataPinned: true, filename: 'test.json' } })
+        sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'cat').throws(new Error('test error'))
+        sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'ls').callsFake(function * () {
+          yield { name: 'test.json' }
+        })
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+
+    it('should handle error if cid is a directory', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ fileMetadata: { dataPinned: true, filename: 'test.json' } })
+        sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'cat')
+          .onCall(0).throws(new Error('test error'))
+          .onCall(1).callsFake(function * () {
+            yield { name: 'test.json' }
+          })
+        sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'ls').callsFake(function * () {
+          yield { name: 'test/directory/' }
+        })
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      } catch (error) {
+        assert.include(error.message, 'file does not resolve to a valid JSON file')
+      }
+    })
+    it('should get content from cid/name.json format', async () => {
+      sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ fileMetadata: { dataPinned: true, filename: 'test.json' } })
+      sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'cat')
+        .onCall(0).throws(new Error('test error'))
+        .onCall(1).callsFake(function * () {
+          yield Buffer.from('{"test": "test"}')
+        })
+      sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'ls').callsFake(function * () {
+        yield { name: 'test/directory/test.json' }
+      })
+
+      const result = await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      assert.isObject(result)
+      assert.property(result, 'success')
+      assert.property(result, 'json')
+    })
+    it('should handle if content cant be parsed', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'getFileMetadata').resolves({ fileMetadata: { dataPinned: true, filename: 'test.json' } })
+        sandbox.stub(uut.adapters.ipfs.ipfs.fs, 'ls').callsFake(function * () {
+          yield { name: 'test.json' }
+        })
+        sandbox.stub(JSON, 'parse').throws(new Error())
+
+        await uut.cid2json({ cid: 'bafybeib2rphswe7clvclverw7xi7nejkpkh4mdfcurdmcgw7wcup7za6wy' })
+      } catch (error) {
+        assert.include(error.message, 'not resolve to a valid JSON object')
+      }
+    })
+  })
+  describe('#pinClaim', () => {
+    it('should process pinClaim', async () => {
+      const result = await uut.pinClaim()
+      assert.isObject(result)
+      assert.property(result, 'success')
+      assert.property(result, 'message')
+    })
+
+    it('should handle error ', async () => {
+      try {
+        sandbox.stub(uut.adapters.ipfsFiles, 'pinClaim').throws(new Error('test error'))
+        await uut.pinClaim()
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+  })
+})
@@ -1,6 +1,5 @@
 /*
-Unit tests for the use-cases/usage-use-cases.js  business logic library.
-
+  Unit tests for the use-cases/usage-use-cases.js business logic library.
 */

 // Public npm libraries
@@ -58,7 +57,7 @@ describe('#usage-use-case', () => {

      // set older mock data
      restCalls.push({
-        timestamp: now.getTime() - (60000 * 60 * 24),
+        timestamp: now.getTime() - (60000 * 60 * 48), // 48 hours ago
        ip: '127.0.0.1'
      })

@@ -88,6 +87,7 @@ describe('#usage-use-case', () => {
      }
    })
  })
+
  describe('#getRestSummary', () => {
    it('should get the number of rest calls', () => {
      // Set mock data
@@ -137,6 +137,7 @@ describe('#usage-use-case', () => {
      assert.equal(result[0].ip, 'localhost')
      assert.equal(result[0].cnt, '2')
    })
+
    it('should return a maximum of 20 values', () => {
      //  Fill Array with 21 values
      for (let i = 0; i < 21; i++) {
@@ -154,6 +155,7 @@ describe('#usage-use-case', () => {

      assert.equal(result.length, 20)
    })
+
    it('should handle error', () => {
      try {
        // Set mock data
@@ -194,6 +196,7 @@ describe('#usage-use-case', () => {
      assert.equal(result[0].endpoint, 'GET /api/v1/users')
      assert.equal(result[0].cnt, '2')
    })
+
    it('should return a maximum of 20 values', () => {
      //  Fill Array with 21 values
      for (let i = 0; i < 21; i++) {
@@ -8,7 +8,6 @@ import axios from 'axios'

 // Local libraries
 import config from '../../config/index.js'
-import User from '../../src/adapters/localdb/models/users.js'
 import JsonFiles from '../../src/adapters/json-files.js'

 // Hack to get __dirname back.
@@ -33,24 +32,6 @@ async function cleanDb () {
  }
 }

-// Delete all users in the database. This ensures there is no previous state
-// to confuse tests.
-async function deleteAllUsers () {
-  try {
-    // Get all the users in the DB.
-    const users = await User.find({}, '-password')
-    // console.log(`users: ${JSON.stringify(users, null, 2)}`)
-
-    // Delete each user.
-    for (let i = 0; i < users.length; i++) {
-      const thisUser = users[i]
-      await thisUser.remove()
-    }
-  } catch (err) {
-    console.error('Error in test-utils.js/deleteAllUsers()')
-  }
-}
-
 // This function is used to create new users.
 // userObj = {
 //   username,
@@ -170,12 +151,56 @@ async function getAdminJWT () {
    throw err
  }
 }
+// Fetches all users from the database.
+async function getAllUsers () {
+  try {
+    const adminJWT = await getAdminJWT()
+    const options = {
+      method: 'GET',
+      url: `${LOCALHOST}/users`,
+      headers: {
+        Authorization: `Bearer ${adminJWT}`
+      }
+    }
+    const result = await axios(options)
+    return result.data.users
+  } catch (err) {
+    console.error('Error in test/utils.js/getAllUsers()', err)
+    throw err
+  }
+}

+// Deletes all users from the database.
+async function deleteAllUsers () {
+  try {
+    const allUsers = await getAllUsers()
+    const adminJWT = await getAdminJWT()
+    for (let i = 0; i < allUsers.length; i++) {
+      const user = allUsers[i]
+      // Skip the admin user.
+      if (user.type === 'admin') {
+        continue
+      }
+      const options = {
+        method: 'DELETE',
+        url: `${LOCALHOST}/users/${user._id}`,
+        headers: {
+          Authorization: `Bearer ${adminJWT}`
+        }
+      }
+      await axios(options)
+    }
+  } catch (err) {
+    console.error('Error in test/utils.js/deleteAllUsers()', err)
+    throw err
+  }
+}
 export default {
  cleanDb,
  createUser,
  loginTestUser,
  loginAdminUser,
  getAdminJWT,
-  deleteAllUsers
+  deleteAllUsers,
+  getAllUsers
 }
@@ -1,8 +1,9 @@
 import mongoose from 'mongoose'
 import config from '../../config/index.js'
+import User from '../../src/adapters/localdb/models/users.js'

-const EMAIL = 'test@test.com'
-const PASSWORD = 'pass'
+const EMAIL = process.env.EMAIL || 'test@test3.com'
+const PASSWORD = process.env.PASSWORD || 'pass'

 async function addUser () {
  // Connect to the Mongo Database.
@@ -13,8 +14,6 @@ async function addUser () {
    { useNewUrlParser: true, useUnifiedTopology: true }
  )

-  const User = require('../../src/models/users')
-
  const userData = {
    email: EMAIL,
    password: PASSWORD
Author	SHA1	Message	Date
Chris Troutner	6ceec71dd6	Merge pull request #73 from Permissionless-Software-Foundation/ct-unstable Syncing with upstream. Usage improvements.	2025-06-05 18:42:47 -07:00
Chris Troutner	f1296fafd6	fix(upstream): Syncing with upstream and fixing merge conflicts	2025-06-05 18:40:55 -07:00
Chris Troutner	479299d747	fix(usage): Removing debugging logs	2025-06-05 18:30:09 -07:00
Chris Troutner	cf88fadfdc	Merge pull request #177 from Permissionless-Software-Foundation/ct-unstable Usage: back up to DB to track usage over restarts.	2025-06-05 18:27:06 -07:00
Chris Troutner	4977ae7003	Increasing backup to 10 minutes	2025-06-05 18:25:45 -07:00
Chris Troutner	f0f6970a08	Added timer controllers for managing usage stats	2025-06-05 18:25:10 -07:00
Chris Troutner	fcb4acb11d	feat(usage-use-cases.js): Added functions for persisting usage data to database	2025-06-04 12:26:03 -07:00
Chris Troutner	28e012feb6	Merge pull request #176 from Permissionless-Software-Foundation/e2e-tests Separating E2E tests from Unit tests	2025-05-30 17:18:40 -07:00
Chris Troutner	958c637c24	Commenting out failing test	2025-05-30 17:17:22 -07:00
Daniel Gonzalez	34381e6e93	Improved e2e tests	2025-05-30 11:53:57 -04:00
Daniel Gonzalez	8843b3e2b0	Separate e2e tests	2025-05-28 20:52:25 -04:00
Chris Troutner	3f91653d23	feat(e2e): separating e2e from unit tests	2025-05-23 07:26:51 -07:00
Chris Troutner	70da4d8000	fix(getTransaction): Reducing debug logs	2025-05-20 06:03:32 -07:00
Chris Troutner	3a4569c33f	Merge pull request #175 from Permissionless-Software-Foundation/dh-env-var-admin feat(admin): added env var setting so only admin can create new users	2025-05-19 13:06:40 -07:00
Daniel Gonzalez	05a0620663	feat(admin): added env var setting so only admin can create new users	2025-05-19 12:17:09 -04:00
Chris Troutner	b8c1156de7	Merge pull request #72 from Permissionless-Software-Foundation/ct-unstable Adding debugging to usage tracking	2025-05-18 15:40:31 -07:00
Chris Troutner	5146155555	Merge remote-tracking branch 'upstream/master' into ct-unstable	2025-05-18 15:38:43 -07:00
Chris Troutner	af83c06b43	Merge pull request #174 from Permissionless-Software-Foundation/ct-unstable fix(usage): Debugging issue with usage tracking	2025-05-18 15:37:46 -07:00
Chris Troutner	e6317c3282	fix(usage): Debugging issue with usage tracking	2025-05-18 15:36:32 -07:00
Chris Troutner	354321c956	Merge pull request #173 from Permissionless-Software-Foundation/ct-unstable fix(wallet.adapter): Binding this object to all methods	2025-04-22 19:07:06 -07:00
Chris Troutner	af2572a493	fix(wallet.adapter): Binding this object to all methods	2025-04-22 18:58:03 -07:00
Chris Troutner	ac451fd601	Merge pull request #71 from Permissionless-Software-Foundation/ct-unstable Passing pagination paramter through to PSFFPP	2025-04-16 07:38:00 -07:00
Chris Troutner	6857fe0166	linting	2025-04-16 07:29:40 -07:00
Chris Troutner	89a03e561a	feat(GET /pins/:page): Adding pagenation to endpoint	2025-04-16 07:29:27 -07:00
Chris Troutner	22e32a6fc1	Merge pull request #70 from Permissionless-Software-Foundation/ct-unstable fix(psffpp): Updating to psffpp v1.2.0	2025-04-12 21:05:52 -07:00
Chris Troutner	fcf5db7fa4	fix(psffpp): Updating to psffpp v1.2.0	2025-04-12 21:04:17 -07:00
Chris Troutner	f8cf903fb9	Merge pull request #69 from Permissionless-Software-Foundation/dh-pin-claim-endpoint feat(pin): Added pin-claim endpoint to ipfs-bch-wallet-consumer	2025-03-29 10:57:16 -07:00
Daniel Gonzalez	c7986d1986	feat(pin): Added pin-claim endpoint to ipfs-bch-wallet-consumer	2025-03-27 11:01:30 -04:00
Chris Troutner	87ca75425b	Merge pull request #68 from Permissionless-Software-Foundation/ct-unstable feat(GET /ipfs/download/:cid): Download CID as readable stream	2025-02-27 18:46:57 -07:00
Chris Troutner	587114e827	feat(GET /ipfs/download/:cid): Download CID as readable stream	2025-02-27 18:45:06 -07:00
Chris Troutner	c3a694546d	Fixing mintor code formatting issues	2025-02-25 13:24:10 -07:00
Chris Troutner	591bd618e4	Merge pull request #67 from Permissionless-Software-Foundation/ct-unstable Helia V5	2025-02-23 10:46:30 -07:00
Chris Troutner	166f2de20e	fix(prod): Switching back to ct-unstable branch	2025-02-23 10:44:45 -07:00
Chris Troutner	35fbc23fe0	Syncing with upstream ipfs-service-provider. Fixing merge conflicts	2025-02-23 10:44:10 -07:00
Chris Troutner	c65d662630	Merge pull request #172 from Permissionless-Software-Foundation/ct-unstable fix(config): Added webRTC port & connection preference reporting	2025-02-23 10:37:30 -07:00
Chris Troutner	1b99f8afa1	fix(config): Added webRTC port & connection preference reporting	2025-02-23 10:34:00 -07:00
Chris Troutner	1bba636e43	Syncing with upstream ipfs-service-provider. Fixing merge conflicts	2025-02-23 10:25:55 -07:00
Chris Troutner	c6f0a1317c	Merge pull request #171 from Permissionless-Software-Foundation/ct-unstable fix(prod): Switching Docker container to master branch	2025-02-23 09:57:41 -07:00
Chris Troutner	fad5f8e23d	fix(prod): Switching Docker container to master branch	2025-02-23 09:56:13 -07:00
Chris Troutner	ec6e0f5e46	Merge pull request #170 from Permissionless-Software-Foundation/helia-v5 Helia v5	2025-02-23 09:46:10 -07:00
Chris Troutner	f1caef2c0d	fix(prod): Adding connection prefrence to production startup script	2025-02-23 09:41:55 -07:00
Chris Troutner	55bf9424f9	fix(libp2p): Updating deps to prevent AbortError issue 2702	2025-02-23 09:01:17 -07:00
Chris Troutner	aa100c97ed	fix(helia-coord): Updating to v1.7.1	2025-02-20 22:41:25 -07:00
Chris Troutner	9fa5eafe95	removing relay advetising deprecated setting	2025-02-20 20:51:40 -07:00
Chris Troutner	4d9e948e30	fix(helia): Manually porting @achingbrian PR to v5 branch	2025-02-20 20:51:09 -07:00
Chris Troutner	e5cdf28e34	Catching and reporting AbortError race condition	2025-02-20 19:03:45 -07:00
Chris Troutner	1d82b36105	fix(helia): Updated to 1.7.0 with webRTC and circuit relay enabled	2025-02-16 15:27:43 -07:00
Chris Troutner	b910cd1e6d	fix(webRTC): Adding /p2p-circuit multiaddr + ping service	2025-02-16 09:29:18 -07:00
Chris Troutner	536861ba99	Re-enabled webRTC and circuit relays	2025-02-14 12:53:12 -07:00
Chris Troutner	ef030e3dc6	fix(libp2p): Updated to v2.6.2 with node.js webrtc fix	2025-02-14 09:52:09 -07:00
Chris Troutner	3da46c3d6f	Using helia-v5 branch when building docker container	2025-02-12 16:22:44 -07:00
Chris Troutner	82f5552836	feat(helia v5): Generating and saving new private key	2025-02-12 14:58:11 -07:00
Chris Troutner	4d25681c51	fix(helia v5): Changes to get node to connect to other nodes with helia v5	2025-02-12 09:22:36 -07:00