@psf/bch-js 5.3.2 → 6.1.0

package/test/unit/utxo-unit.js

@@ -15,137 +15,6 @@ describe('#utxo', () => {
   beforeEach(() => (sandbox = sinon.createSandbox()))
   afterEach(() => sandbox.restore())
 
-  describe('#getOld', () => {
-    it('should get hydrated and filtered UTXOs for an address', async () => {
-      // Mock dependencies.
-      sandbox.stub(bchjs.Utxo.electrumx, 'utxo').resolves(mockData.mockUtxoData)
-      sandbox
-        .stub(bchjs.Utxo.slp.Utils, 'hydrateUtxos')
-        .resolves(mockData.mockHydratedUtxos)
-
-      const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-
-      const result = await bchjs.Utxo.getOld(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'address')
-      assert.property(result[0], 'bchUtxos')
-      assert.property(result[0], 'nullUtxos')
-      assert.property(result[0], 'slpUtxos')
-      assert.isArray(result[0].bchUtxos)
-      assert.isArray(result[0].nullUtxos)
-    })
-
-    it('should catch and throw an error', async () => {
-      try {
-        // Force an error
-        sandbox
-          .stub(bchjs.Utxo.electrumx, 'utxo')
-          .rejects(new Error('test error'))
-
-        const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-
-        await bchjs.Utxo.getOld(addr)
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        assert.include(err.message, 'test error')
-      }
-    })
-
-    it('should handle an array of addresses', async () => {
-      // Mock dependencies.
-      sandbox.stub(bchjs.Utxo.electrumx, 'utxo').resolves({ utxos: {} })
-      sandbox
-        .stub(bchjs.Utxo.slp.Utils, 'hydrateUtxos')
-        .resolves(mockData.mockTwoHydratedAddrs)
-
-      const addr = [
-        'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9',
-        'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
-      ]
-
-      const result = await bchjs.Utxo.getOld(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.equal(result.length, 2)
-      assert.property(result[0], 'address')
-      assert.property(result[0], 'bchUtxos')
-      assert.property(result[0], 'nullUtxos')
-      assert.property(result[0], 'slpUtxos')
-      assert.isArray(result[0].bchUtxos)
-      assert.isArray(result[0].nullUtxos)
-    })
-
-    it('should throw an error for array of 21 elements', async () => {
-      try {
-        const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-
-        const addrs = []
-        for (let i = 0; i < 21; i++) {
-          addrs.push(addr)
-        }
-
-        await bchjs.Utxo.getOld(addrs)
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        assert.include(err.message, 'Too many elements, 20 max.')
-      }
-    })
-
-    it('should handle NFTs and minting batons', async () => {
-      // Mock dependencies.
-      sandbox.stub(bchjs.Utxo.electrumx, 'utxo').resolves({ utxos: {} })
-      sandbox
-        .stub(bchjs.Utxo.slp.Utils, 'hydrateUtxos')
-        .resolves(mockData.mockEveryUtxoType)
-
-      const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
-
-      const result = await bchjs.Utxo.getOld(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'address')
-      assert.property(result[0], 'bchUtxos')
-      assert.property(result[0], 'nullUtxos')
-      assert.property(result[0], 'slpUtxos')
-      assert.isArray(result[0].bchUtxos)
-      assert.isArray(result[0].nullUtxos)
-
-      assert.isArray(result[0].slpUtxos.type1.mintBatons)
-      assert.isArray(result[0].slpUtxos.type1.tokens)
-      assert.isArray(result[0].slpUtxos.nft.groupMintBatons)
-      assert.isArray(result[0].slpUtxos.nft.groupTokens)
-      assert.isArray(result[0].slpUtxos.nft.tokens)
-    })
-
-    it('should use the whitelist when flag is set', async () => {
-      // Mock dependencies.
-      sandbox.stub(bchjs.Utxo.electrumx, 'utxo').resolves(mockData.mockUtxoData)
-      sandbox
-        .stub(bchjs.Utxo.slp.Utils, 'hydrateUtxosWL')
-        .resolves(mockData.mockHydratedUtxos)
-
-      const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-      const useWhitelist = true
-
-      const result = await bchjs.Utxo.getOld(addr, useWhitelist)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'address')
-      assert.property(result[0], 'bchUtxos')
-      assert.property(result[0], 'nullUtxos')
-      assert.property(result[0], 'slpUtxos')
-      assert.isArray(result[0].bchUtxos)
-      assert.isArray(result[0].nullUtxos)
-    })
-  })
-
   describe('#findBiggestUtxo', () => {
     it('should throw error for non-array input', async () => {
       try {

package/src/ipfs.js

@@ -1,454 +0,0 @@
-/*
-  This library interacts with the IPFS REST API at FullStack.cash for uploading
-  and downloading data from the IPFS network.
-*/
-
-const axios = require('axios')
-const Uppy = require('@uppy/core')
-const Tus = require('@uppy/tus')
-const fs = require('fs')
-
-let _this
-
-class IPFS {
-  constructor (config) {
-    this.IPFS_API = process.env.IPFS_API
-      ? process.env.IPFS_API
-      : 'https://ipfs-file-upload.fullstackcash.nl'
-    // : `http://localhost:5001`
-
-    // Default options when calling axios.
-    this.axiosOptions = {
-      headers: {
-        // authorization: `Token ${this.apiToken}`,
-        timeout: 15000 // Timeout if the server does not respond in time.
-      }
-    }
-
-    _this = this
-
-    _this.axios = axios
-    _this.fs = fs
-
-    // Initialize Uppy
-    _this.uppy = _this.initUppy()
-  }
-
-  // Initializes Uppy, which is used for file uploads.
-  initUppy () {
-    const uppy = Uppy({
-      allowMultipleUploads: false,
-      meta: { test: 'avatar' },
-      debug: false,
-      restrictions: {
-        maxFileSize: null,
-        maxNumberOfFiles: 1,
-        minNumberOfFiles: 1,
-        allowedFileTypes: null // type of files allowed to load
-      }
-    })
-    uppy.use(Tus, { endpoint: `${_this.IPFS_API}/uppy-files` })
-
-    return uppy
-  }
-
-  /**
-   * @api IPFS.createFileModelServer()  createFileModelServer()
-   * @apiName createFileModelServer()
-   * @apiGroup IPFS
-   * @apiDescription Creates a new model on the server. If successful, will
-   * return an object with file data. That object contains a BCH address,
-   * payment amount, and _id required to be able to upload a file.
-   *
-   * @apiExample Example usage:
-   * (async () => {
-   *   try {
-   *     const path = `${__dirname}/ipfs.js`
-   *     let fileData = await bchjs.IPFS.createFileModelServer(path);
-   *     console.log(fileData);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   * {
-   *   "success": true,
-   *   "hostingCostBCH": 0.00004197,
-   *   "hostingCostUSD": 0.01,
-   *   "file": {
-   *   "payloadLink": "",
-   *   "hasBeenPaid": false,
-   *   "_id": "5ec562319bfacc745e8d8a52",
-   *   "schemaVersion": 1,
-   *   "size": 4458,
-   *   "fileName": "ipfs.js",
-   *   "fileExtension": "js",
-   *   "createdTimestamp": "1589994033.655",
-   *   "hostingCost": 4196,
-   *   "walletIndex": 49,
-   *   "bchAddr": "bchtest:qzrpkevu7h2ayfa4rjx08r5elvpfu72dg567x3mh3c",
-   *   "__v": 0
-   * }
-   */
-  async createFileModelServer (path) {
-    try {
-      // Ensure the file exists.
-      if (!_this.fs.existsSync(path)) {
-        throw new Error(`Could not find this file: ${path}`)
-      }
-
-      // Read in the file.
-      const fileBuf = _this.fs.readFileSync(path)
-      // console.log(`fileBuf: `, fileBuf)
-
-      // console.log(`Buffer length: ${fileBuf.length}`)
-
-      // Get the file name from the path.
-      const splitPath = path.split('/')
-      const fileName = splitPath[splitPath.length - 1]
-
-      // Get the file extension.
-      const splitExt = fileName.split('.')
-      const fileExt = splitExt[splitExt.length - 1]
-
-      const fileObj = {
-        schemaVersion: 1,
-        size: fileBuf.length,
-        fileName: fileName,
-        fileExtension: fileExt
-      }
-      // console.log(`fileObj: ${JSON.stringify(fileObj, null, 2)}`)
-
-      const fileData = await _this.axios.post(`${this.IPFS_API}/files`, {
-        file: fileObj
-      })
-      // console.log(`fileData.data: ${JSON.stringify(fileData.data, null, 2)}`)
-
-      return fileData.data
-    } catch (err) {
-      console.error('Error in createFileModel()')
-      throw err
-    }
-  }
-
-  /**
-   * @api IPFS.uploadFileServer()  uploadFileServer()
-   * @apiName uploadFile()
-   * @apiGroup IPFS
-   * @apiDescription Upload a file to the FullStack.cash IPFS server. If
-   * successful, it will return an object with an ID, a BCH address, and an
-   * amount of BCH to pay.
-   *
-   * @apiExample Example usage:
-   * (async () => {
-   *   try {
-   *     const path = `${__dirname}/ipfs.js`
-   *     let fileData = await bchjs.IPFS.uploadFileServer(path, "5ec562319bfacc745e8d8a52");
-   *     console.log(fileData);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   * {
-   *   "schemaVersion": 1,
-   *   "size": 2374,
-   *   "fileId": "5ec562319bfacc745e8d8a52",
-   *   "fileName": "ipfs.js",
-   *   "fileExtension": "js"
-   * }
-   */
-  async uploadFileServer (path, modelId) {
-    try {
-      // Ensure the file exists.
-      if (!_this.fs.existsSync(path)) {
-        throw new Error(`Could not find this file: ${path}`)
-      }
-
-      if (!modelId) {
-        throw new Error(
-          'Must include a file model ID in order to upload a file.'
-        )
-      }
-
-      // Read in the file.
-      const fileBuf = _this.fs.readFileSync(path)
-
-      // Get the file name from the path.
-      const splitPath = path.split('/')
-      const fileName = splitPath[splitPath.length - 1]
-
-      // Prepare the upload object. Get a file ID from Uppy.
-      const id = _this.uppy.addFile({
-        name: fileName,
-        data: fileBuf,
-        source: 'Local',
-        isRemote: false
-      })
-      // console.log(`id: ${JSON.stringify(id, null, 2)}`)
-
-      // Add the model ID, required to be allowed to upload the file.
-      _this.uppy.setFileMeta(id, { fileModelId: modelId })
-
-      // Upload the file to the server.
-      const upData = await _this.uppy.upload()
-
-      if (upData.failed.length) {
-        throw new Error('The file could not be uploaded')
-      }
-
-      if (upData.successful.length) {
-        delete upData.successful[0].data
-        // console.log(`upData: ${JSON.stringify(upData, null, 2)}`)
-
-        const fileObj = {
-          schemaVersion: 1,
-          size: upData.successful[0].progress.bytesTotal,
-          fileId: upData.successful[0].meta.fileModelId,
-          fileName: upData.successful[0].name,
-          fileExtension: upData.successful[0].extension
-        }
-        // console.log(`fileObj: ${JSON.stringify(fileObj, null, 2)}`)
-
-        return fileObj
-        // return true
-      }
-
-      return false
-    } catch (err) {
-      console.error('Error in bch-js/src/ipfs.js/upload(): ')
-      throw err
-    }
-  }
-
-  /**
-   * @api IPFS.getStatus()  getStatus()
-   * @apiName getStatus()
-   * @apiGroup IPFS
-   * @apiDescription Gets the status of the uploaded file. Will return an object
-   * that indicates the payment status. If the file is paid, it should contain
-   * an IPFS hash.
-   *
-   * @apiExample Example usage:
-   * (async () => {
-   *   try {
-   *     const modelId = "5ec7392c2acfe57aa62e945a"
-   *     let fileData = await bchjs.IPFS.getStatus(modelId)
-   *     console.log(fileData)
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   * {
-   *    "hasBeenPaid": true,
-   *    "satCost": 4403,
-   *    "bchAddr": "bchtest:qz5z82u0suqh80x5tfx4ht8kdrkkw664vcy44uz0wk",
-   *    "ipfsHash": "QmRDHPhY5hCNVRMVQvS2H9uty8P1skdwgLaHpUAkEvsjcE",
-   *    "fileId": "5ec7392c2acfe57aa62e945a",
-   *    "fileName": "ipfs-e2e.js"
-   * }
-   */
-  async getStatus (modelId) {
-    try {
-      if (!modelId) throw new Error('Must include a file model ID.')
-
-      const fileData = await _this.axios.get(
-        `${this.IPFS_API}/files/${modelId}`
-      )
-      // console.log(`fileData.data: ${JSON.stringify(fileData.data, null, 2)}`)
-
-      const fileObj = {
-        hasBeenPaid: fileData.data.file.hasBeenPaid,
-        satCost: fileData.data.file.hostingCost,
-        bchAddr: fileData.data.file.bchAddr,
-        ipfsHash: fileData.data.file.payloadLink,
-        fileId: fileData.data.file._id,
-        fileName: fileData.data.file.fileName
-      }
-
-      return fileObj
-    } catch (err) {
-      console.error('Error in getStatus()')
-      throw err
-    }
-  }
-
-  /**
-   * @api IPFS.createFileModelWeb()  createFileModelWeb()
-   * @apiName createFileModelWeb()
-   * @apiGroup IPFS
-   * @apiDescription Creates a new model on the server. If successful, will
-   * return an object with file data. That object contains a BCH address,
-   * payment amount, and _id required to be able to upload a file.
-   *
-   * @apiExample Example usage:
-   * (async () => {
-   *   try {
-   *     const content = ['PSF']
-   *     const name = 'psf.txt' // Content can be Array , ArrayBuffer , Blob
-   *     const options = { type: "text/plain" }
-   *     const file =  new File(content,name,options)
-   *     let fileData = await bchjs.IPFS.createFileModelWeb(file);
-   *     console.log(fileData);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   * {
-   *   "success": true,
-   *   "hostingCostBCH": 0.00004197,
-   *   "hostingCostUSD": 0.01,
-   *   "file": {
-   *   "payloadLink": "",
-   *   "hasBeenPaid": false,
-   *   "_id": "5ec562319bfacc745e8d8a52",
-   *   "schemaVersion": 1,
-   *   "size": 4458,
-   *   "fileName": "ipfs.js",
-   *   "fileExtension": "js",
-   *   "createdTimestamp": "1589994033.655",
-   *   "hostingCost": 4196,
-   *   "walletIndex": 49,
-   *   "bchAddr": "bchtest:qzrpkevu7h2ayfa4rjx08r5elvpfu72dg567x3mh3c",
-   *   "__v": 0
-   * }
-   */
-  async createFileModelWeb (file) {
-    try {
-      if (!file) throw new Error('File is required')
-
-      const { name, size } = file
-
-      if (!name || typeof name !== 'string') {
-        throw new Error("File should have the property 'name' of string type")
-      }
-
-      if (!size || typeof size !== 'number') {
-        throw new Error("File should have the property 'size' of number type")
-      }
-
-      // Get the file extension.
-      const splitExt = name.split('.')
-      const fileExt = splitExt[splitExt.length - 1]
-
-      const fileObj = {
-        schemaVersion: 1,
-        size: size,
-        fileName: name,
-        fileExtension: fileExt
-      }
-      // console.log(`fileObj: ${JSON.stringify(fileObj, null, 2)}`)
-
-      const fileData = await _this.axios.post(`${this.IPFS_API}/files`, {
-        file: fileObj
-      })
-      // console.log(`fileData.data: ${JSON.stringify(fileData.data, null, 2)}`)
-
-      return fileData.data
-    } catch (err) {
-      console.error('Error in createFileModelWeb()')
-      throw err
-    }
-  }
-
-  /**
-   * @api IPFS.uploadFileWeb()  uploadFileWeb()
-   * @apiName uploadFileWeb()
-   * @apiGroup IPFS
-   * @apiDescription Upload a file to the FullStack.cash IPFS server. If
-   * successful, it will return an object with an ID, a BCH address, and an
-   * amount of BCH to pay.
-   *
-   * @apiExample Example usage:
-   * (async () => {
-   *   try {
-   *    *     const content = ['PSF']
-   *     const name = 'psf.txt' // Content can be Array , ArrayBuffer , Blob
-   *     const options = { type: "text/plain" }
-   *     const file =  new File(content,name,options)
-   *     let fileData = await bchjs.IPFS.uploadFile(file, "5ec562319bfacc745e8d8a52");
-   *     console.log(fileData);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   * {
-   *   "schemaVersion": 1,
-   *   "size": 2374,
-   *   "fileId": "5ec562319bfacc745e8d8a52",
-   *   "fileName": "ipfs.js",
-   *   "fileExtension": "js"
-   * }
-   */
-  async uploadFileWeb (file, modelId) {
-    try {
-      if (!file) throw new Error('File is required')
-
-      const { name, type, size } = file
-
-      if (!name || typeof name !== 'string') {
-        throw new Error("File should have the property 'name' of string type")
-      }
-
-      if (!type || typeof type !== 'string') {
-        throw new Error("File should have the property 'type' of string type")
-      }
-
-      if (!size || typeof size !== 'number') {
-        throw new Error("File should have the property 'size' of number type")
-      }
-
-      if (!modelId) {
-        throw new Error(
-          'Must include a file model ID in order to upload a file.'
-        )
-      }
-
-      // Prepare the upload object. Get a file ID from Uppy.
-      const id = _this.uppy.addFile({
-        name: name,
-        data: file,
-        source: 'Local',
-        isRemote: false
-      })
-      // console.log(`id: ${JSON.stringify(id, null, 2)}`)
-
-      // Add the model ID, required to be allowed to upload the file.
-      _this.uppy.setFileMeta(id, { fileModelId: modelId })
-
-      // Upload the file to the server.
-      const upData = await _this.uppy.upload()
-
-      if (upData.failed.length) {
-        throw new Error('The file could not be uploaded')
-      }
-
-      if (upData.successful.length) {
-        delete upData.successful[0].data
-        // console.log(`upData: ${JSON.stringify(upData, null, 2)}`)
-
-        const fileObj = {
-          schemaVersion: 1,
-          size: upData.successful[0].progress.bytesTotal,
-          fileId: upData.successful[0].meta.fileModelId,
-          fileName: upData.successful[0].name,
-          fileExtension: upData.successful[0].extension
-        }
-        // console.log(`fileObj: ${JSON.stringify(fileObj, null, 2)}`)
-
-        return fileObj
-        // return true
-      }
-
-      return false
-    } catch (err) {
-      console.error('Error in bch-js/src/ipfs.js/uploadFileWeb(): ')
-      throw err
-    }
-  }
-}
-
-module.exports = IPFS