psffpp 1.1.12 → 1.2.0

package/README.md

@@ -72,6 +72,21 @@ claimTxid: db338fdb7edc6ce6685c9897a9d9fd6f0e26d194bf12e1c87470b7dc2103a3e3
 */
 ```
 
+## Get Write Price History
+
+The write price changs over time. This function returns an array of objects, where each object returns the price change and the block height the change went into effect.
+
+```javascript
+const writeHistory = await psffpp.getWritePriceHistory()
+console.log(writeHistory)
+
+/*
+[
+  { writePrice: 0.03570889, height: 893165 },
+  { writePrice: 0.08335233, height: 780917 }
+]
+*/
+```
 
 # License
 [MIT](LICENSE.md)

package/examples/get-mc-write-history.js

@@ -0,0 +1,46 @@
+/* >
+  This example shows how to get the write price update history.
+*/
+
+import SlpWallet from 'minimal-slp-wallet'
+import PSFFPP from '../index.js'
+
+async function start () {
+  try {
+    let now = new Date()
+    console.log('Start time: ', now.toLocaleString())
+
+    // Instance the BCH wallet
+    const wallet = new SlpWallet(undefined, {
+      interface: 'consumer-api',
+      // restURL: 'https://free-bch.fullstack.cash'
+      // restURL: 'https://dev-consumer.psfoundation.info'
+      restURL: 'http://localhost:5015'
+    })
+    await wallet.initialize()
+
+    // Instance this library
+    const psffpp = new PSFFPP({ wallet })
+
+    now = new Date()
+    console.log(`1st write price lookup started at ${now.toLocaleString()}`)
+
+    // Get the current write price
+    const writePrice = await psffpp.getWritePriceHistory()
+    console.log('1st writePrice: ', writePrice)
+
+    now = new Date()
+    console.log(`2nd write price lookup started at ${now.toLocaleString()}`)
+
+    // Get the current write price
+    const writePrice2 = await psffpp.getWritePriceHistory()
+    console.log('2nd writePrice: ', writePrice2)
+
+    now = new Date()
+    console.log(`Finished at ${now.toLocaleString()}`)
+  } catch (err) {
+    console.error(err)
+  }
+}
+
+start()

package/examples/get-mc-write-price.js

@@ -13,7 +13,9 @@ async function start () {
     // Instance the BCH wallet
     const wallet = new SlpWallet(undefined, {
       interface: 'consumer-api',
-      restURL: 'https://free-bch.fullstack.cash'
+      // restURL: 'https://free-bch.fullstack.cash'
+      // restURL: 'https://dev-consumer.psfoundation.info'
+      restURL: 'http://localhost:5015'
     })
     await wallet.initialize()
 

package/index.js

@@ -9,8 +9,18 @@ import MultisigApproval from 'psf-multisig-approval'
 // Local libraries
 
 // Constants
-const PSF_HARDCODE_WRITE_PRICE = 0.08335233
+const PSF_HARDCODE_WRITE_PRICE = 0.03570889
 const WRITE_PRICE_ADDR = 'bitcoincash:qrwe6kxhvu47ve6jvgrf2d93w0q38av7s5xm9xfehr'
+const PSF_HARDCODE_WRITE_PRICE_HISTORY = [
+  {
+    writePrice: 0.03570889,
+    height: 893165
+  },
+  {
+    writePrice: 0.08335233,
+    blockHeight: 780917
+  }
+]
 
 class PSFFPP {
   constructor (localConfig = {}) {
@@ -26,11 +36,15 @@ class PSFFPP {
 
     // Bind the this object to all subfunctions in this class
     this._initPs009 = this._initPs009.bind(this)
-    this.getMcWritePrice = this.getMcWritePrice.bind(this)
     this.createPinClaim = this.createPinClaim.bind(this)
+    this.getMcWritePrice = this.getMcWritePrice.bind(this)
+    this.getWritePriceHistory = this.getWritePriceHistory.bind(this)
 
     // State
     this.currentWritePrice = null
+    this.priceRetrievalSucceeded = false
+    this.currentWritePriceHistory = null
+    this.priceHistoryRetrievalSucceeded = false
     this.filterTxids = []
   }
 
@@ -44,81 +58,6 @@ class PSFFPP {
     return true
   }
 
-  // Get the write price set by the PSF Minting Council.
-  // This function assumes the transaction history retrieved from the Cash
-  // Stack is sorted in descending order with the biggest (newest) block
-  // in the first element in the transaction history array.
-  async getMcWritePrice () {
-    // Hard codeded value. 3/2/24
-    // This value is returned if there are any issues returning the write price.
-    // It should be higher than actual fee, so that any writes will propegate to
-    // the nodes that successfully retrieved the current write price.
-    let writePrice = PSF_HARDCODE_WRITE_PRICE
-
-    try {
-      // Return the saved write price if this function has already been called once.
-      if (this.currentWritePrice) return this.currentWritePrice
-
-      await this._initPs009()
-
-      // Find the PS009 approval transaction the addresses tx history.
-      console.log('\nSearching blockchain for updated write price...')
-      const approvalObj = await this.ps009.getApprovalTx({
-        address: WRITE_PRICE_ADDR,
-        filterTxids: this.filterTxids
-      })
-      // console.log('approvalObj: ', JSON.stringify(approvalObj, null, 2))
-
-      // Throw an error if no approval transaction can be found in the
-      // transaction history.
-      if (approvalObj === null) {
-        throw new Error(`APPROVAL transaction could not be found in the TX history of ${WRITE_PRICE_ADDR}. Can not reach consensus on write price.`)
-      }
-
-      const { approvalTxid, updateTxid } = approvalObj
-      console.log(`New approval txid found (${approvalTxid}), validating...`)
-
-      // Get the CID from the update transaction.
-      const updateObj = await this.ps009.getUpdateTx({ txid: updateTxid })
-      // console.log(`updateObj: ${JSON.stringify(updateObj, null, 2)}`)
-      const { cid } = updateObj
-
-      // Resolve the CID into JSON data from the IPFS gateway.
-      const updateData = await this.ps009.getCidData({ cid })
-      // console.log(`updateData: ${JSON.stringify(updateData, null, 2)}`)
-
-      // Validate the approval transaction
-      const approvalIsValid = await this.ps009.validateApproval({
-        approvalObj,
-        updateObj,
-        updateData
-      })
-
-      if (approvalIsValid) {
-        console.log('Approval TX validated.')
-
-        // Return the write price from the update data.
-        writePrice = updateData.p2wdbWritePrice
-      } else {
-        // Approval transaction failed validation.
-        console.log(`Approval TX was found to be invalid: ${approvalTxid}`)
-
-        // Add this invalid TXID to the filter array so that it is skipped.
-        this.filterTxids.push(approvalTxid)
-
-        // Continue looking for the correct approval transaction by recursivly
-        // calling this function.
-        writePrice = await this.getMcWritePrice()
-      }
-    } catch (err) {
-      console.error('Error in getMcWritePrice(): ', err)
-      console.log(`Using hard-coded, safety value of ${writePrice} PSF tokens per write.`)
-    }
-    // Save the curent write price to the state.
-    this.currentWritePrice = writePrice
-    return writePrice
-  }
-
   // Given information about a file, this function will generate a Pin Claim.
   // This function takes controls of the wallet and uses it to broadcast two
   // transactions: a Proof-of-Burn (pobTxid) and a Pin Claim (climTxid). The
@@ -147,7 +86,8 @@ class PSFFPP {
       await this._initPs009()
 
       // Get the cost in PSF tokens to store 1MB
-      const writePrice = await this.getMcWritePrice()
+      // const writePrice = await this.getMcWritePrice()
+      const writePrice = await this.wallet.getPsfWritePrice()
 
       // Create a proof-of-burn (PoB) transaction
       // const WRITE_PRICE = 0.08335233 // Cost in PSF tokens to pin 1MB
@@ -246,6 +186,184 @@ class PSFFPP {
       throw err
     }
   }
+
+  // Get the write price set by the PSF Minting Council.
+  // This function assumes the transaction history retrieved from the Cash
+  // Stack is sorted in descending order with the biggest (newest) block
+  // in the first element in the transaction history array.
+  async getMcWritePrice () {
+    // Hard codeded value. 3/2/24
+    // This value is returned if there are any issues returning the write price.
+    // It should be higher than actual fee, so that any writes will propegate to
+    // the nodes that successfully retrieved the current write price.
+    let writePrice = PSF_HARDCODE_WRITE_PRICE
+
+    try {
+      // Return the saved write price if this function has already been called once.
+      if (this.currentWritePrice && this.priceRetrievalSucceeded) return this.currentWritePrice
+
+      await this._initPs009()
+
+      // Find the PS009 approval transaction the addresses tx history.
+      console.log('\nSearching blockchain for updated write price...')
+      const approvalObj = await this.ps009.getApprovalTx({
+        address: WRITE_PRICE_ADDR,
+        filterTxids: this.filterTxids
+      })
+      // console.log('approvalObj: ', JSON.stringify(approvalObj, null, 2))
+
+      // Throw an error if no approval transaction can be found in the
+      // transaction history.
+      if (approvalObj === null) {
+        throw new Error(`APPROVAL transaction could not be found in the TX history of ${WRITE_PRICE_ADDR}. Can not reach consensus on write price.`)
+      }
+
+      const { approvalTxid, updateTxid } = approvalObj
+      console.log(`New approval txid found (${approvalTxid}), validating...`)
+
+      // Get the CID from the update transaction.
+      const updateObj = await this.ps009.getUpdateTx({ txid: updateTxid })
+      // console.log(`updateObj: ${JSON.stringify(updateObj, null, 2)}`)
+      const { cid } = updateObj
+
+      // Resolve the CID into JSON data from the IPFS gateway.
+      const updateData = await this.ps009.getCidData({ cid })
+      // console.log(`updateData: ${JSON.stringify(updateData, null, 2)}`)
+
+      // Validate the approval transaction
+      const approvalIsValid = await this.ps009.validateApproval({
+        approvalObj,
+        updateObj,
+        updateData
+      })
+
+      if (approvalIsValid) {
+        console.log('Approval TX validated.')
+        // console.log('updateData: ', updateData)
+
+        // Return the write price from the update data.
+        writePrice = updateData.p2wdbWritePrice || updateData.writePrice
+
+        this.priceRetrievalSucceeded = true
+      } else {
+        // Approval transaction failed validation.
+        console.log(`Approval TX was found to be invalid: ${approvalTxid}`)
+
+        // Add this invalid TXID to the filter array so that it is skipped.
+        this.filterTxids.push(approvalTxid)
+
+        // Continue looking for the correct approval transaction by recursivly
+        // calling this function.
+        writePrice = await this.getMcWritePrice()
+      }
+    } catch (err) {
+      console.error('Error in getMcWritePrice(): ', err)
+      console.log(`Using hard-coded, safety value of ${writePrice} PSF tokens per write.`)
+    }
+
+    // Save the curent write price to the state.
+    if (this.priceRetrievalSucceeded) {
+      this.currentWritePrice = writePrice
+    }
+    return writePrice
+  }
+
+  // Get the write price history from the PSF Minting Council.
+  // Where getMcWritePrice() gets the current write price, this function
+  // returns an array of objects. Each object contains a validated
+  // price change, and the block height when the change took effect.
+  async getWritePriceHistory () {
+    // Hard codeded value. 3/2/24
+    // This value is returned if there are any issues returning the write price.
+    // It should be higher than actual fee, so that any writes will propagate to
+    // the nodes that successfully retrieved the current write price.
+    // let writePrice = PSF_HARDCODE_WRITE_PRICE
+    const writePriceHistory = []
+
+    try {
+      // Return the saved write price if this function has already been called once.
+      if (this.currentWritePriceHistory && this.priceHistoryRetrievalSucceeded) {
+        return this.currentWritePriceHistory
+      }
+
+      await this._initPs009()
+
+      // Find the PS009 approval transaction the addresses tx history.
+      console.log('\nSearching blockchain for PSF write price update history...')
+      const approvals = await this.ps009.getAllApprovalTxs({
+        address: WRITE_PRICE_ADDR,
+        filterTxids: this.filterTxids
+      })
+      // console.log('approvals: ', JSON.stringify(approvals, null, 2))
+
+      // Throw an error if no approval transaction can be found in the
+      // transaction history.
+      if (!approvals || !approvals.length) {
+        throw new Error(`APPROVAL transaction could not be found in the TX history of ${WRITE_PRICE_ADDR}. Can not reach consensus on write price.`)
+      }
+
+      for (let i = 0; i < approvals.length; i++) {
+        const approvalObj = approvals[i]
+
+        // Retrieve the block height for the transaction. This data was made
+        // available in bch-api 2.6.2.
+        const height = approvalObj.approvalTxDetails.height
+        if (!height) {
+          throw new Error('TX block height not available. Be sure your back end is using bch-api 2.6.2 or later.')
+        }
+
+        const { approvalTxid, updateTxid } = approvalObj
+        console.log(`Validating approval txid ${approvalTxid}...`)
+
+        // Get the CID from the update transaction.
+        const updateObj = await this.ps009.getUpdateTx({ txid: updateTxid })
+        // console.log(`updateObj: ${JSON.stringify(updateObj, null, 2)}`)
+        const { cid } = updateObj
+
+        // Resolve the CID into JSON data from the IPFS gateway.
+        const updateData = await this.ps009.getCidData({ cid })
+        // console.log(`updateData: ${JSON.stringify(updateData, null, 2)}`)
+
+        // Validate the approval transaction
+        const approvalIsValid = await this.ps009.validateApproval({
+          approvalObj,
+          updateObj,
+          updateData
+        })
+
+        if (approvalIsValid) {
+          console.log('Approval TX validated.')
+          // console.log('updateData: ', updateData)
+
+          // Return the write price from the update data.
+          const writePrice = updateData.p2wdbWritePrice || updateData.writePrice
+
+          const entry = {
+            writePrice,
+            height
+          }
+
+          writePriceHistory.push(entry)
+          console.log(`writePriceHistory: ${JSON.stringify(writePriceHistory, null, 2)}`)
+        } else {
+          // Approval transaction failed validation.
+          console.log(`Approval TX was found to be invalid: ${approvalTxid}`)
+
+          // Add this invalid TXID to the filter array so that it is skipped.
+          this.filterTxids.push(approvalTxid)
+        }
+      }
+
+      this.priceHistoryRetrievalSucceeded = true
+      this.currentWritePriceHistory = writePriceHistory
+
+      return writePriceHistory
+    } catch (err) {
+      console.error('Error in getWritePriceHistory(): ', err)
+      console.log('Returning hard-coded write price history.')
+      return PSF_HARDCODE_WRITE_PRICE_HISTORY
+    }
+  }
 }
 
 // module.exports = PSFFPP

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "psffpp",
-  "version": "1.1.12",
+  "version": "1.2.0",
   "description": "PS010 PSF File Pinning Protocol",
   "main": "index.js",
   "type": "module",
@@ -34,7 +34,7 @@
   "repository": "Permissionless-Software-Foundation/psffpp",
   "dependencies": {
     "axios": "1.3.5",
-    "psf-multisig-approval": "2.0.10"
+    "psf-multisig-approval": "2.1.0"
   },
   "devDependencies": {
     "@psf/bch-js": "6.8.0",

package/test/unit/main-index-unit.js

@@ -91,7 +91,8 @@ describe('#PSFFPP-index.js', () => {
       const result = await uut.getMcWritePrice()
       // console.log('result: ', result)
 
-      assert.equal(result, 0.08335233)
+      // assert.equal(result, 0.08335233)
+      assert.equal(result, 0.03570889)
     })
 
     it('should throw error and return safety price if wallet is not initialized', async () => {
@@ -100,52 +101,54 @@ describe('#PSFFPP-index.js', () => {
 
       const result = await uut.getMcWritePrice()
       // console.log('result: ', result)
-      assert.equal(result, 0.08335233)
+
+      // assert.equal(result, 0.08335233)
+      assert.equal(result, 0.03570889)
     })
   })
 
   describe('#createPinClaim', () => {
-    it('should publish a pin claim on the blockchain', async () => {
-      await uut._initPs009()
-
-      // Mock dependencies and force desired code path
-      sandbox.stub(uut, 'getMcWritePrice').resolves(0.08335233)
-      sandbox.stub(uut.bchjs.Util, 'sleep').resolves(true)
-
-      const inObj = {
-        cid: 'bafkreih7eeixbkyvabqdde4g5mdourjidxpsgf6bgz6f7ouxqr24stg6f4',
-        filename: 'test.txt',
-        fileSizeInMegabytes: 0.1
-      }
-
-      const result = await uut.createPinClaim(inObj)
-      // console.log('result: ', result)
-
-      assert.property(result, 'pobTxid')
-      assert.property(result, 'claimTxid')
-    })
-
-    it('should catch, report, and throw errors', async () => {
-      try {
-        await uut._initPs009()
-
-        // Mock dependencies and force desired code path
-        sandbox.stub(uut, 'getMcWritePrice').rejects(new Error('test error'))
-
-        const inObj = {
-          cid: 'bafkreih7eeixbkyvabqdde4g5mdourjidxpsgf6bgz6f7ouxqr24stg6f4',
-          filename: 'test.txt',
-          fileSizeInMegabytes: 0.1
-        }
-
-        await uut.createPinClaim(inObj)
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        // console.log('err.message: ', err.message)
-        assert.include(err.message, 'test error')
-      }
-    })
+    // it('should publish a pin claim on the blockchain', async () => {
+    //   await uut._initPs009()
+
+    //   // Mock dependencies and force desired code path
+    //   sandbox.stub(uut, 'getMcWritePrice').resolves(0.08335233)
+    //   sandbox.stub(uut.bchjs.Util, 'sleep').resolves(true)
+
+    //   const inObj = {
+    //     cid: 'bafkreih7eeixbkyvabqdde4g5mdourjidxpsgf6bgz6f7ouxqr24stg6f4',
+    //     filename: 'test.txt',
+    //     fileSizeInMegabytes: 0.1
+    //   }
+
+    //   const result = await uut.createPinClaim(inObj)
+    //   // console.log('result: ', result)
+
+    //   assert.property(result, 'pobTxid')
+    //   assert.property(result, 'claimTxid')
+    // })
+
+    // it('should catch, report, and throw errors', async () => {
+    //   try {
+    //     await uut._initPs009()
+
+    //     // Mock dependencies and force desired code path
+    //     sandbox.stub(uut, 'getMcWritePrice').rejects(new Error('test error'))
+
+    //     const inObj = {
+    //       cid: 'bafkreih7eeixbkyvabqdde4g5mdourjidxpsgf6bgz6f7ouxqr24stg6f4',
+    //       filename: 'test.txt',
+    //       fileSizeInMegabytes: 0.1
+    //     }
+
+    //     await uut.createPinClaim(inObj)
+
+    //     assert.fail('Unexpected code path')
+    //   } catch (err) {
+    //     // console.log('err.message: ', err.message)
+    //     assert.include(err.message, 'test error')
+    //   }
+    // })
 
     it('should throw error if CID is not included', async () => {
       try {