psffpp 1.0.1

package/.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+
+# A special property that should be specified at the top of the file outside of
+# any sections. Set to true to stop .editor config file search on current file
+root = true
+
+[*]
+# Indentation style
+# Possible values - tab, space
+indent_style = space
+
+# Indentation size in single-spaced characters
+# Possible values - an integer, tab
+indent_size = 2
+
+# Line ending file format
+# Possible values - lf, crlf, cr
+end_of_line = lf
+
+# File character encoding
+# Possible values - latin1, utf-8, utf-16be, utf-16le
+charset = utf-8
+
+# Denotes whether to trim whitespace at the end of lines
+# Possible values - true, false
+trim_trailing_whitespace = true
+
+# Denotes whether file should end with a newline
+# Possible values - true, false
+insert_final_newline = true

package/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": "standard",
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 8
+  }
+}

package/.on-save.json

@@ -0,0 +1,8 @@
+[
+  {
+    "srcDir": "",
+    "destDir": "",
+    "files": "**/*.js",
+    "command": "npm run lint"
+  }
+]

package/.travis.yml

@@ -0,0 +1,33 @@
+# This is a node.js v8+ JavaScript project
+language: node_js
+node_js:
+  - "10"
+
+# Build on Ubuntu Trusty (14.04)
+# https://docs.travis-ci.com/user/reference/trusty/#javascript-and-nodejs-images
+dist: xenial
+sudo: required
+
+# Use Docker
+services:
+  - docker
+
+before_install:
+  #- npm install -g mocha
+
+# https://github.com/greenkeeperio/greenkeeper-lockfile/issues/156
+#install: case $TRAVIS_BRANCH in greenkeeper*) npm i;; *) npm ci;; esac;
+install:
+  - npm install
+
+script: "npm run test"
+
+# Send coverage data to Coveralls
+after_success:
+  - npm run coverage
+
+deploy:
+  provider: script
+  skip_cleanup: true
+  script:
+    - npx semantic-release

package/LICENSE.md

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2021 Chris Troutner <chris.troutner@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/PEDIGREE.md

@@ -0,0 +1,3 @@
+# Pedigree
+
+This repository was originally forked from [npm-lib-boilerplate](https://github.com/christroutner/npm-lib-boilerplate). This is a boilerplate used to start JavaScript libraries which are intended to be published to npm.

package/README.md

@@ -0,0 +1,211 @@
+# psffpp
+
+This is an npm library for node.js. It implements the [PS010 specification for the PSF File Pinning Protocol](https://github.com/Permissionless-Software-Foundation/specifications/blob/master/ps009-multisig-approval.md). The main consumers of this library of [psf-bch-wallet](https://github.com/Permissionless-Software-Foundation/psf-bch-wallet) and [ipfs-p2wdb-service](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service).
+
+## Instancing Library
+This library depends on [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet). An instance of that library is expected to be injected into this this one when instantiated. Here is an example:
+
+```javascript
+const SlpWallet = require('minimal-slp-wallet')
+const MultisigApproval = require('psf-multisig-approval')
+
+async function start() {
+  // Instance the BCH wallet
+  const wallet = new SlpWallet(undefined, {
+    interface: 'consumer-api',
+    restURL: 'https://free-bch.fullstack.cash'
+  })
+  await wallet.initialize()
+
+  // Instance this library
+  const ps009 = new MultisigApproval({wallet})
+}
+start()
+```
+
+## Get NFT Holder Information
+PS009 uses NFTs as 'homing beacons'. It generates a multisignature wallet from the public keys of the NFT holders. Finding the addresses and public keys of the NFT holders is a foundational feature of the protocol. All NFTs are connected by the Group Token ID that generated them.
+
+If the holder of the NFT has not made any transactions, then their public key will not be on the blockchain. In that case, the NFT and address will be added to the `keysNotFound` array. Those holders will not be included in the multisignature wallet.
+
+```javascript
+const groupTokenId = '8e8d90ebdb1791d58eba7acd428ff3b1e21c47fb7aba2ba3b5b815aa0fe7d6d5'
+
+const result = await ps009.getNftHolderInfo(groupTokenId)
+console.log(result)
+
+/*
+{
+  keys: [
+    {
+      addr: 'bitcoincash:qz4zsa22glal5c4jqm748xge657gwuw2d5t9nvg64p',
+      pubKey: '021ca211a04a1d489ae77e01c28c97b02e733893890fda00a359ca8956c2e0d259',
+      nft: 'e86164aaa06efac1d6453951f67beafe042f0bceb9312845a95355b1e93aa846'
+    },
+    {
+      addr: 'bitcoincash:qpfvh07mdt7yq5czndaz5qq4g9q3m87qpspy7xaxgu',
+      pubKey: '0361fd21512b9072e8f6b984d9b04c57e5779867c2ad002999372268770fcb2674',
+      nft: 'da7ccbd5e24e468c9e7402489ca9148b5e76e588b73cc4aa4bbf1ca41d5808ab'
+    },
+    {
+      addr: 'bitcoincash:qpsxtzaa7rg677akcc2znpenpsy5jr2ygywmfd45p2',
+      pubKey: '03b9bdc40c478ab0536be29c368b26c48a5e8d6867fc34b77c727ab690365aae91',
+      nft: '0ec318bede8c2f229db840a24cb63d662ad91e8e6c840e46e6a8ff2d173049ce'
+    },
+    {
+      addr: 'bitcoincash:qqk3aczzggvxnfm7rwm0f9yz20yr00dmpv2f3tasdr',
+      pubKey: '033c930d4cff4ba68a70f7a21443e20ad4176173380d21f8c3ce27f7ce947f3246',
+      nft: '51624e772adafd7c6a9da38774e4f654282199bd5402e049ee087fc2bd900882'
+    },
+    {
+      addr: 'bitcoincash:qpszha37cjn6n83hpxn7zz5ndaa35vygtcgslxhpuc',
+      pubKey: '024be54accec310c2636140336ae548d610ba9b7ce300b3f42494b4a6f2963731f',
+      nft: 'e70cc72eeb15c82e96b1f8127d3b138b2fc8ea101fe9c62302ec641c05d4b97d'
+    }
+  ],
+  keysNotFound: []
+}
+*/
+```
+
+## Get an Approval Transaction
+This function will take a BCH address as input. It will search the transaction history for the address, and will return an object about the first `APPROVAL` transaction that it finds. If it can't find one, it will return null.
+
+```javascript
+const address = 'bitcoincash:qrwe6kxhvu47ve6jvgrf2d93w0q38av7s5xm9xfehr'
+
+const result = await ps009.getApprovalTx({address})
+console.log(result)
+
+/*
+  {
+    approvalTxid: 'a63f9fbcc901316e6e89f5a8caaad6b2ab268278b29866c6c22088bd3ab93900',
+    updateTxid: 'f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f',
+    approvalTxDetails: {
+      txid: 'a63f9fbcc901316e6e89f5a8caaad6b2ab268278b29866c6c22088bd3ab93900',
+      vin: [ [Object] ],
+      vout: [ [Object], [Object], [Object] ],
+      ...
+      isValidSlp: false
+    },
+    opReturn: 'j\x07APPROVE@f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f'
+  }
+*/
+```
+
+## Get an Update Transaction
+
+An *approval* transaction will point to an *update* transaction with its OP_RETURN output. This function is used to retrieve and decode that update transaction. Given a TXID, it will return details from the transaction, including the IPFS CID and timestamp stored in the update transactions OP_RETURN output.
+
+```javascript
+const txid = 'f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f'
+
+const result = await uut.getUpdateTx({ txid })
+console.log(result)
+
+/*
+  {
+    cid: 'bafybeib5d6s6t3tq4lhwp2ocvz7y2ws4czgkrmhlhv5y5aeyh6bqrmsxxi',
+    ts: 1676560247168,
+    txid: 'f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f',
+    txDetails: {
+      txid: 'f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f',
+      hash: 'f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f',
+      vin: [ [Object] ],
+      vout: [ [Object], [Object], [Object], [Object] ],
+      ...
+      isValidSlp: false
+    }
+  }
+
+*/
+```
+
+## Get IPFS CID Data
+
+The update transaction will reference an IPFS CID. That data will need to be retrieved from an IPFS gateway. The default gateway can be overwritten when this library is instantiated.
+
+```javascript
+// Instance this library and overwrite the default IPFS gateway
+const ps009 = new MultisigApproval({
+  wallet,
+  ipfsGateway: 'https://p2wdb-gateway-678.fullstack.cash'
+})
+
+const cid = 'bafybeib5d6s6t3tq4lhwp2ocvz7y2ws4czgkrmhlhv5y5aeyh6bqrmsxxi'
+
+const updateData = await ps009.getCidData({cid})
+console.log(updateData)
+
+/*
+  {
+    groupId: '8e8d90ebdb1791d58eba7acd428ff3b1e21c47fb7aba2ba3b5b815aa0fe7d6d5',
+    keys: [
+      {
+        addr: 'bitcoincash:qz4zsa22glal5c4jqm748xge657gwuw2d5t9nvg64p',
+        pubKey: '021ca211a04a1d489ae77e01c28c97b02e733893890fda00a359ca8956c2e0d259',
+        nft: 'e86164aaa06efac1d6453951f67beafe042f0bceb9312845a95355b1e93aa846'
+      },
+      {
+        addr: 'bitcoincash:qpfvh07mdt7yq5czndaz5qq4g9q3m87qpspy7xaxgu',
+        pubKey: '0361fd21512b9072e8f6b984d9b04c57e5779867c2ad002999372268770fcb2674',
+        nft: 'da7ccbd5e24e468c9e7402489ca9148b5e76e588b73cc4aa4bbf1ca41d5808ab'
+      },
+      {
+        addr: 'bitcoincash:qpsxtzaa7rg677akcc2znpenpsy5jr2ygywmfd45p2',
+        pubKey: '03b9bdc40c478ab0536be29c368b26c48a5e8d6867fc34b77c727ab690365aae91',
+        nft: '0ec318bede8c2f229db840a24cb63d662ad91e8e6c840e46e6a8ff2d173049ce'
+      },
+      {
+        addr: 'bitcoincash:qqk3aczzggvxnfm7rwm0f9yz20yr00dmpv2f3tasdr',
+        pubKey: '033c930d4cff4ba68a70f7a21443e20ad4176173380d21f8c3ce27f7ce947f3246',
+        nft: '51624e772adafd7c6a9da38774e4f654282199bd5402e049ee087fc2bd900882'
+      },
+      {
+        addr: 'bitcoincash:qpszha37cjn6n83hpxn7zz5ndaa35vygtcgslxhpuc',
+        pubKey: '024be54accec310c2636140336ae548d610ba9b7ce300b3f42494b4a6f2963731f',
+        nft: 'e70cc72eeb15c82e96b1f8127d3b138b2fc8ea101fe9c62302ec641c05d4b97d'
+      }
+    ],
+    walletObj: {
+      address: 'bitcoincash:pqntzt6wcp38h8ud68wjnwh437uek76lhvhlwcm4fj',
+      scriptHex: 'a91426b12f4ec0627b9f8dd1dd29baf58fb99b7b5fbb87',
+      publicKeys: [
+        '021ca211a04a1d489ae77e01c28c97b02e733893890fda00a359ca8956c2e0d259',
+        '0361fd21512b9072e8f6b984d9b04c57e5779867c2ad002999372268770fcb2674',
+        '03b9bdc40c478ab0536be29c368b26c48a5e8d6867fc34b77c727ab690365aae91',
+        '033c930d4cff4ba68a70f7a21443e20ad4176173380d21f8c3ce27f7ce947f3246',
+        '024be54accec310c2636140336ae548d610ba9b7ce300b3f42494b4a6f2963731f'
+      ],
+      requiredSigners: 3
+    },
+    multisigAddr: 'bitcoincash:pqntzt6wcp38h8ud68wjnwh437uek76lhvhlwcm4fj',
+    p2wdbWritePrice: 0.08335233
+  }
+*/
+```
+
+## Validate an Approval Transaction
+After data about the approval and update transactions have been retrieved, it's important to validate that the approval transaction is valid and has not been faked. This function will return either `true` or `false` depending on the result of testing the transaction validity.
+
+```javascript
+const address = 'bitcoincash:qrwe6kxhvu47ve6jvgrf2d93w0q38av7s5xm9xfehr'
+const approvalObj = await ps009.getApprovalTx({ address })
+
+const txid = 'f8ea1fcd4481adfd62c6251c6a4f63f3d5ac3d5fdcc38b350d321d93254df65f'
+const updateObj = await ps009.getUpdateTx({ txid })
+
+const cid = 'bafybeib5d6s6t3tq4lhwp2ocvz7y2ws4czgkrmhlhv5y5aeyh6bqrmsxxi'
+const updateData = await ps009.getCidData({ cid })
+
+const inObj = { approvalObj, updateObj, updateData }
+const result = await ps009.validateApproval(inObj)
+console.log(result)
+
+/*
+  true
+*/
+```
+
+# License
+[MIT](LICENSE.md)

package/apidoc.json

@@ -0,0 +1,3 @@
+{
+  "sampleUrl": null
+}

package/examples/create-wallet.js

@@ -0,0 +1,23 @@
+/*
+  An example app for creating a wallet using this library.
+*/
+
+const BchWallet = require('../index')
+
+async function createWallet () {
+  try {
+    // Instantiate the wallet library.
+    const bchWallet = new BchWallet()
+
+    // Wait for the wallet to be created.
+    await bchWallet.walletInfoPromise
+
+    // Print out the wallet information.
+    console.log(
+      `Wallet information: ${JSON.stringify(bchWallet.walletInfo, null, 2)}`
+    )
+  } catch (err) {
+    console.error('Error: ', err)
+  }
+}
+createWallet()

package/examples/list-tokens.js

@@ -0,0 +1,26 @@
+/*
+  An example for listing the tokens and token balances of the wallet. a
+*/
+
+const SlpWallet = require('../index')
+
+async function listTokens () {
+  try {
+    // Replace the values for the constants below to customize for your use.
+    const MNEMONIC =
+      'essence appear intact casino neck scatter search post cube fit door margin'
+
+    // Instantiate the wallet library.
+    const slpWallet = new SlpWallet(MNEMONIC)
+
+    // Wait for the wallet to be created.
+    await slpWallet.walletInfoPromise
+
+    // Get the token summary
+    const tokenInfo = await slpWallet.listTokens()
+    console.log(`tokenInfo: ${JSON.stringify(tokenInfo, null, 2)}`)
+  } catch (err) {
+    console.error('Error: ', err)
+  }
+}
+listTokens()

package/examples/send-bch.js

@@ -0,0 +1,60 @@
+/*
+  An example for sending BCH with this library.
+*/
+
+const SlpWallet = require('../index')
+
+async function sendBch () {
+  try {
+    // Replace the values for the constants below to customize for your use.
+    const MNEMONIC =
+      'essence appear intact casino neck scatter search post cube fit door margin'
+    const RECIEVER = ''
+    const SATS_TO_SEND = 1000
+
+    // Instantiate the wallet library.
+    const slpWallet = new SlpWallet(MNEMONIC)
+
+    // Wait for the wallet to be created.
+    await slpWallet.walletInfoPromise
+
+    // Get the balance of the wallet.
+    const balance = await slpWallet.getBalance()
+    console.log(`balance: ${balance} satoshis`)
+
+    // Exit if the wallet has no balance.
+    if (balance === 0) {
+      console.log(
+        `The balance of your wallet is zero. Send BCH to ${
+          slpWallet.walletInfo.address
+        } to run this example.`
+      )
+      return
+    }
+
+    // Create the outputs array.
+    const outputs = []
+
+    // If reciever is not specified, send the funds back to the wallet.
+    if (RECIEVER === '') {
+      outputs.push({
+        address: slpWallet.walletInfo.address,
+        amountSat: SATS_TO_SEND
+      })
+    //
+    // Send the funds to the reciever.
+    } else {
+      outputs.push({
+        address: RECIEVER,
+        amountSat: SATS_TO_SEND
+      })
+    }
+
+    const txid = await slpWallet.send(outputs)
+
+    console.log(`Success! BCH sent with TXID: ${txid}`)
+  } catch (err) {
+    console.error('Error: ', err)
+  }
+}
+sendBch()

package/examples/send-tokens.js

@@ -0,0 +1,66 @@
+/*
+  An example for sending tokens with this library.
+*/
+
+const SlpWallet = require('../index')
+
+async function sendBch () {
+  try {
+    // Replace the values for the constants below to customize for your use.
+    const MNEMONIC =
+      'essence appear intact casino neck scatter search post cube fit door margin'
+    const RECIEVER = ''
+    const TOKENID =
+      'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+    const TOKENS_TO_SEND = 1
+
+    // Instantiate the wallet library.
+    const slpWallet = new SlpWallet(MNEMONIC)
+
+    // Wait for the wallet to be created.
+    await slpWallet.walletInfoPromise
+
+    // console.log('slpWallet.utxos.utxoStore: ', slpWallet.utxos.utxoStore)
+
+    // Get the balance of the wallet.
+    const balance = await slpWallet.getBalance()
+    console.log(`balance: ${balance} satoshis`)
+
+    // Exit if the wallet has no balance.
+    if (balance === 0) {
+      console.log(
+        `The balance of your wallet is zero. Send BCH to ${
+          slpWallet.walletInfo.address
+        } to run this example.`
+      )
+      return
+    }
+
+    // Create the outputs array.
+    let output = {}
+
+    // If reciever is not specified, send the funds back to the wallet.
+    if (RECIEVER === '') {
+      output = {
+        address: slpWallet.walletInfo.address,
+        tokenId: TOKENID,
+        qty: TOKENS_TO_SEND
+      }
+      //
+      // Send the funds to the reciever.
+    } else {
+      output = {
+        address: RECIEVER,
+        tokenId: TOKENID,
+        qty: TOKENS_TO_SEND
+      }
+    }
+
+    const txid = await slpWallet.sendTokens(output)
+
+    console.log(`Success! Tokens sent with TXID: ${txid}`)
+  } catch (err) {
+    console.error('Error: ', err)
+  }
+}
+sendBch()