@psf/bch-js 5.3.1 → 5.4.1

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

package/test/integration/chains/abc/slp.js

@@ -1,226 +0,0 @@
-/*
-  Integration tests for the bchjs covering SLP tokens.
-  These tests are specific to the ABC chain.
-*/
-
-const chai = require('chai')
-const assert = chai.assert
-
-const BCHJS = require('../../../../src/bch-js')
-let bchjs
-
-// Inspect utility used for debugging.
-const util = require('util')
-util.inspect.defaultOptions = {
-  showHidden: true,
-  colors: true,
-  depth: 1
-}
-
-describe('#SLP', () => {
-  // before(() => {
-  //   console.log(`bchjs.SLP.restURL: ${bchjs.SLP.restURL}`)
-  //   console.log(`bchjs.SLP.apiToken: ${bchjs.SLP.apiToken}`)
-  // })
-
-  beforeEach(async () => {
-    // Introduce a delay so that the BVT doesn't trip the rate limits.
-    if (process.env.IS_USING_FREE_TIER) await sleep(1500)
-
-    bchjs = new BCHJS({ restURL: process.env.RESTURL })
-  })
-
-  describe('#util', () => {
-    describe('#tokenUtxoDetails', () => {
-      it('should handle a range of UTXO types', async () => {
-        const utxos = [
-          // Malformed SLP tx
-          {
-            note: 'Malformed SLP tx',
-            tx_hash:
-              'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
-            tx_pos: 1,
-            value: 546
-          },
-          // Normal TX (non-SLP)
-          {
-            note: 'Normal TX (non-SLP)',
-            tx_hash:
-              '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
-            tx_pos: 0,
-            value: 400000
-          },
-          // Valid PSF SLP tx
-          {
-            note: 'Valid PSF SLP tx',
-            tx_hash:
-              'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
-            tx_pos: 1,
-            value: 546
-          },
-          // Valid SLP token not in whitelist
-          {
-            note: 'Valid SLP token not in whitelist',
-            tx_hash:
-              '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
-            tx_pos: 1,
-            value: 546
-          },
-          // Token send on BCHN network.
-          {
-            note: 'Token send on BCHN network',
-            tx_hash:
-              '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
-            tx_pos: 1,
-            value: 546
-          },
-          // Token send on ABC network.
-          {
-            note: 'Token send on ABC network',
-            tx_hash:
-              '336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
-            tx_pos: 1,
-            value: 546
-          },
-          // Known invalid SLP token send of PSF tokens.
-          {
-            note: 'Known invalid SLP token send of PSF tokens',
-            tx_hash:
-              '2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74',
-            tx_pos: 1,
-            value: 546
-          }
-        ]
-
-        const data = await bchjs.SLP.Utils.tokenUtxoDetails(utxos)
-        // console.log(`data: ${JSON.stringify(data, null, 2)}`)
-
-        // Malformed SLP tx
-        assert.equal(data[0].tx_hash, utxos[0].tx_hash)
-        assert.equal(data[0].isValid, false)
-
-        // Normal TX (non-SLP)
-        assert.equal(data[1].tx_hash, utxos[1].tx_hash)
-        assert.equal(data[1].isValid, false)
-
-        // Valid PSF SLP tx
-        assert.equal(data[2].tx_hash, utxos[2].tx_hash)
-        assert.equal(data[2].isValid, true)
-
-        // Valid SLP token not in whitelist
-        assert.equal(data[3].tx_hash, utxos[3].tx_hash)
-        assert.equal(data[3].isValid, true)
-
-        // Token send on BCHN network
-        assert.equal(data[4].tx_hash, utxos[4].tx_hash)
-        // assert.equal(data[4].isValid, true)
-        assert.equal(data[4].isValid, null)
-
-        // Token send on ABC network
-        assert.equal(data[5].tx_hash, utxos[5].tx_hash)
-        assert.equal(data[5].isValid, true)
-
-        // Known invalid SLP token send of PSF tokens
-        assert.equal(data[6].tx_hash, utxos[6].tx_hash)
-        assert.equal(data[6].isValid, false)
-      })
-    })
-
-    describe('#validateTxid3', () => {
-      it('should invalidate a known invalid TXID', async () => {
-        const txid =
-          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
-
-        const result = await bchjs.SLP.Utils.validateTxid3(txid)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-
-        assert.property(result[0], 'txid')
-        assert.equal(result[0].txid, txid)
-
-        assert.property(result[0], 'valid')
-        assert.equal(result[0].valid, null)
-      })
-
-      it('should validate a known valid TXID', async () => {
-        const txid =
-          'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd'
-
-        const result = await bchjs.SLP.Utils.validateTxid3(txid)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-
-        assert.property(result[0], 'txid')
-        assert.equal(result[0].txid, txid)
-
-        assert.property(result[0], 'valid')
-        assert.equal(result[0].valid, true)
-      })
-
-      it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
-        const txids = [
-          // Malformed SLP tx
-          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
-          // Normal TX (non-SLP)
-          '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
-          // Valid PSF SLP tx
-          'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
-          // Valid SLP token not in whitelist
-          '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
-          // Unprocessed SLP TX
-          // "a0d6406eecfd8634158efa9314ff15b4cbf451938e9dc7b5678c46b41eabc6ed" // Mint baton
-          '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019'
-        ]
-
-        const result = await bchjs.SLP.Utils.validateTxid3(txids)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-        assert.equal(result[0].valid, null)
-        assert.equal(result[1].valid, null)
-        assert.equal(result[2].valid, true)
-        // assert.equal(result[2].valid, null)
-        assert.equal(result[3].valid, true)
-        assert.equal(result[4].valid, null)
-      })
-    })
-
-    describe('#validateTxid', () => {
-      it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
-        const txids = [
-          // Malformed SLP tx
-          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
-          // Normal TX (non-SLP)
-          '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
-          // Valid PSF SLP tx
-          'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
-          // Valid SLP token not in whitelist
-          '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
-          // Token send on BCHN network.
-          '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
-          // Token send on ABC network.
-          '336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d'
-        ]
-
-        const result = await bchjs.SLP.Utils.validateTxid(txids)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-        assert.equal(result[0].valid, null)
-        assert.equal(result[1].valid, null)
-        assert.equal(result[2].valid, true)
-        // assert.equal(result[2].valid, null)
-        assert.equal(result[3].valid, true)
-        assert.equal(result[4].valid, null)
-        assert.equal(result[5].valid, true)
-      })
-    })
-  })
-})
-
-// Promise-based sleep function
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}