Agama/routes/shepherd/electrum/transactions.js

const async = require('async');
const Promise = require('bluebird');

const MAX_VIN_LENGTH = 150; // parse up to MAX_VIN_LENGTH vins

// TODO: add z -> pub, pub -> z flag for zcash forks

module.exports = (shepherd) => {
  shepherd.sortTransactions = (transactions, sortBy) => {
    return transactions.sort((b, a) => {
      if (a[sortBy ? sortBy : 'height'] < b[sortBy ? sortBy : 'height']) {
        return -1;
      }

      if (a[sortBy ? sortBy : 'height'] > b[sortBy ? sortBy : 'height']) {
        return 1;
      }

      return 0;
    });
  }

  shepherd.getTransaction = (txid, network, ecl) => {
    return new Promise((resolve, reject) => {
      if (!shepherd.electrumCache[network]) {
        shepherd.electrumCache[network] = {};
      }
      if (!shepherd.electrumCache[network].tx) {
        shepherd.electrumCache[network]['tx'] = {};
      }

      if (!shepherd.electrumCache[network].tx[txid]) {
        shepherd.log(`electrum raw input tx ${txid}`, true);

        ecl.blockchainTransactionGet(txid)
        .then((_rawtxJSON) => {
          shepherd.electrumCache[network].tx[txid] = _rawtxJSON;
          resolve(_rawtxJSON);
        });
      } else {
        shepherd.log(`electrum cached raw input tx ${txid}`, true);
        resolve(shepherd.electrumCache[network].tx[txid]);
      }
    });
  }

  shepherd.getBlockHeader = (height, network, ecl) => {
    return new Promise((resolve, reject) => {
      if (!shepherd.electrumCache[network]) {
        shepherd.electrumCache[network] = {};
      }
      if (!shepherd.electrumCache[network].blockHeader) {
        shepherd.electrumCache[network]['blockHeader'] = {};
      }

      if (!shepherd.electrumCache[network].blockHeader[height]) {
        shepherd.log(`electrum raw block ${height}`, true);

        ecl.blockchainBlockGetHeader(height)
        .then((_rawtxJSON) => {
          shepherd.electrumCache[network].blockHeader[height] = _rawtxJSON;
          resolve(_rawtxJSON);
        });
      } else {
        shepherd.log(`electrum cached raw block ${height}`, true);
        resolve(shepherd.electrumCache[network].blockHeader[height]);
      }
    });
  }

  shepherd.get('/electrum/listtransactions', (req, res, next) => {
    if (shepherd.checkToken(req.query.token)) {
      const network = req.query.network || shepherd.findNetworkObj(req.query.coin);
      const ecl = shepherd.electrumServers[network].proto === 'insight' ? shepherd.insightJSCore(shepherd.electrumServers[network]) : new shepherd.electrumJSCore(shepherd.electrumServers[network].port, shepherd.electrumServers[network].address, shepherd.electrumServers[network].proto); // tcp or tls
      const _address = req.query.address;
      const _maxlength = req.query.maxlength;

      shepherd.log('electrum listtransactions ==>', true);

      if (!req.query.full ||
          ecl.insight) {
        ecl.connect();
        ecl.blockchainAddressGetHistory(_address)
        .then((json) => {
          ecl.close();
          shepherd.log(json, true);

          json = shepherd.sortTransactions(json, 'timestamp');

          const successObj = {
            msg: 'success',
            result: json,
          };

          res.end(JSON.stringify(successObj));
        });
      } else {
        // !expensive call!
        // TODO: limit e.g. 1-10, 10-20 etc
        const MAX_TX = _maxlength || 10;
        ecl.connect();

        ecl.blockchainNumblocksSubscribe()
        .then((currentHeight) => {
          if (currentHeight &&
              Number(currentHeight) > 0) {
            ecl.blockchainAddressGetHistory(_address)
            .then((json) => {
              if (json &&
                  json.length) {
                let _rawtx = [];

                json = shepherd.sortTransactions(json);
                json = json.length > MAX_TX ? json.slice(0, MAX_TX) : json;

                shepherd.log(json.length, true);
                let index = 0;

                // callback hell, use await?
                async.eachOfSeries(json, (transaction, ind, callback) => {
                  shepherd.getBlockHeader(transaction.height, network, ecl)
                  .then((blockInfo) => {
                    if (blockInfo &&
                        blockInfo.timestamp) {
                      shepherd.getTransaction(transaction['tx_hash'], network, ecl)
                      .then((_rawtxJSON) => {
                        shepherd.log('electrum gettransaction ==>', true);
                        shepherd.log((index + ' | ' + (_rawtxJSON.length - 1)), true);
                        // shepherd.log(_rawtxJSON, true);

                        // decode tx
                        const _network = shepherd.getNetworkData(network);
                        const decodedTx = shepherd.electrumJSTxDecoder(_rawtxJSON, network, _network);

                        let txInputs = [];
                        let opreturn = false;

                        shepherd.log(`decodedtx network ${network}`, true);

                        shepherd.log('decodedtx =>', true);
                        // shepherd.log(decodedTx.outputs, true);

                        let index2 = 0;

                        if (decodedTx &&
                            decodedTx.outputs &&
                            decodedTx.outputs.length) {
                          for (let i = 0; i < decodedTx.outputs.length; i++) {
                            if (decodedTx.outputs[i].scriptPubKey.type === 'nulldata') {
                              opreturn = shepherd.hex2str(decodedTx.outputs[i].scriptPubKey.hex);
                            }
                          }
                        }

                        if (decodedTx &&
                            decodedTx.inputs &&
                            decodedTx.inputs.length) {
                          async.eachOfSeries(decodedTx.inputs, (_decodedInput, ind2, callback2) => {
                            const checkLoop = () => {
                              index2++;

                              if (index2 === decodedTx.inputs.length ||
                                  index2 === MAX_VIN_LENGTH) {
                                shepherd.log(`tx history decode inputs ${decodedTx.inputs.length} | ${index2} => main callback`, true);
                                const _parsedTx = {
                                  network: decodedTx.network,
                                  format: decodedTx.format,
                                  inputs: txInputs,
                                  outputs: decodedTx.outputs,
                                  height: transaction.height,
                                  timestamp: Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timestamp,
                                  confirmations: Number(transaction.height) === 0 || Number(transaction.height) === -1 ? 0 : currentHeight - transaction.height,
                                };

                                const formattedTx = shepherd.parseTransactionAddresses(_parsedTx, _address, network);

                                if (formattedTx.type) {
                                  formattedTx.height = transaction.height;
                                  formattedTx.blocktime = Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timestamp;
                                  formattedTx.timereceived = Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timereceived;
                                  formattedTx.hex = _rawtxJSON;
                                  formattedTx.inputs = decodedTx.inputs;
                                  formattedTx.outputs = decodedTx.outputs;
                                  formattedTx.locktime = decodedTx.format.locktime;
                                  formattedTx.vinLen = decodedTx.inputs.length;
                                  formattedTx.vinMaxLen = MAX_VIN_LENGTH;
                                  formattedTx.opreturn = opreturn;
                                  _rawtx.push(formattedTx);
                                } else {
                                  formattedTx[0].height = transaction.height;
                                  formattedTx[0].blocktime = Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timestamp;
                                  formattedTx[0].timereceived = Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timereceived;
                                  formattedTx[0].hex = _rawtxJSON;
                                  formattedTx[0].inputs = decodedTx.inputs;
                                  formattedTx[0].outputs = decodedTx.outputs;
                                  formattedTx[0].locktime = decodedTx.format.locktime;
                                  formattedTx[0].vinLen = decodedTx.inputs.length;
                                  formattedTx[0].vinMaxLen = MAX_VIN_LENGTH;
                                  formattedTx[0].opreturn = opreturn[0];
                                  formattedTx[1].height = transaction.height;
                                  formattedTx[1].blocktime = Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timestamp;
                                  formattedTx[1].timereceived = Number(transaction.height) === 0 || Number(transaction.height) === -1 ? Math.floor(Date.now() / 1000) : blockInfo.timereceived;
                                  formattedTx[1].hex = _rawtxJSON;
                                  formattedTx[1].inputs = decodedTx.inputs;
                                  formattedTx[1].outputs = decodedTx.outputs;
                                  formattedTx[1].locktime = decodedTx.format.locktime;
                                  formattedTx[1].vinLen = decodedTx.inputs.length;
                                  formattedTx[1].vinMaxLen = MAX_VIN_LENGTH;
                                  formattedTx[1].opreturn = opreturn[1];
                                  _rawtx.push(formattedTx[0]);
                                  _rawtx.push(formattedTx[1]);
                                }
                                index++;

                                if (index === json.length) {
                                  ecl.close();

                                  const successObj = {
                                    msg: 'success',
                                    result: _rawtx,
                                  };

                                  res.end(JSON.stringify(successObj));
                                }

                                callback();
                                shepherd.log(`tx history main loop ${json.length} | ${index}`, true);
                              } else {
                                callback2();
                              }
                            }

                            if (_decodedInput.txid !== '0000000000000000000000000000000000000000000000000000000000000000') {
                              shepherd.getTransaction(_decodedInput.txid, network, ecl)
                              .then((rawInput) => {
                                const decodedVinVout = shepherd.electrumJSTxDecoder(rawInput, network, _network);

                                if (decodedVinVout) {
                                  shepherd.log(decodedVinVout.outputs[_decodedInput.n], true);
                                  txInputs.push(decodedVinVout.outputs[_decodedInput.n]);
                                }
                                checkLoop();
                              });
                            } else {
                              checkLoop();
                            }
                          });
                        } else {
                          const _parsedTx = {
                            network: decodedTx.network,
                            format: 'cant parse',
                            inputs: 'cant parse',
                            outputs: 'cant parse',
                            height: transaction.height,
                            timestamp: Number(transaction.height) === 0 ? Math.floor(Date.now() / 1000) : blockInfo.timestamp,
                            confirmations: Number(transaction.height) === 0 ? 0 : currentHeight - transaction.height,
                            opreturn,
                          };

                          const formattedTx = shepherd.parseTransactionAddresses(_parsedTx, _address, network);
                          _rawtx.push(formattedTx);
                          index++;

                          if (index === json.length) {
                            ecl.close();

                            const successObj = {
                              msg: 'success',
                              result: _rawtx,
                            };

                            res.end(JSON.stringify(successObj));
                          } else {
                            callback();
                          }
                        }
                      });
                    } else {
                      const _parsedTx = {
                        network: 'cant parse',
                        format: 'cant parse',
                        inputs: 'cant parse',
                        outputs: 'cant parse',
                        height: transaction.height,
                        timestamp: 'cant get block info',
                        confirmations: Number(transaction.height) === 0 ? 0 : currentHeight - transaction.height,
                      };
                      const formattedTx = shepherd.parseTransactionAddresses(_parsedTx, _address, network);
                      _rawtx.push(formattedTx);
                      index++;

                      if (index === json.length) {
                        ecl.close();

                        const successObj = {
                          msg: 'success',
                          result: _rawtx,
                        };

                        res.end(JSON.stringify(successObj));
                      } else {
                        callback();
                      }
                    }
                  });
                });
              } else {
                ecl.close();

                const successObj = {
                  msg: 'success',
                  result: [],
                };

                res.end(JSON.stringify(successObj));
              }
            });
          } else {
            const successObj = {
              msg: 'error',
              result: 'cant get current height',
            };

            res.end(JSON.stringify(successObj));
          }
        });
      }
    } else {
      const errorObj = {
        msg: 'error',
        result: 'unauthorized access',
      };

      res.end(JSON.stringify(errorObj));
    }
  });

  shepherd.get('/electrum/gettransaction', (req, res, next) => {
    if (shepherd.checkToken(req.query.token)) {
      const network = req.query.network || shepherd.findNetworkObj(req.query.coin);
      const ecl = new shepherd.electrumJSCore(
        shepherd.electrumServers[network].port,
        shepherd.electrumServers[network].address,
        shepherd.electrumServers[network].proto
      ); // tcp or tls

      shepherd.log('electrum gettransaction =>', true);

      ecl.connect();
      ecl.blockchainTransactionGet(req.query.txid)
      .then((json) => {
        ecl.close();
        shepherd.log(json, true);

        const successObj = {
          msg: 'success',
          result: json,
        };

        res.end(JSON.stringify(successObj));
      });
    } else {
      const errorObj = {
        msg: 'error',
        result: 'unauthorized access',
      };

      res.end(JSON.stringify(errorObj));
    }
  });

  shepherd.parseTransactionAddresses = (tx, targetAddress, network, skipTargetAddress) => {
    // TODO: - sum vins / sum vouts to the same address
    //       - multi vin multi vout
    //       - detect change address
    //       - double check for exact sum input/output values
    let result = [];
    let _parse = {
      inputs: {},
      outputs: {},
    };
    let _sum = {
      inputs: 0,
      outputs: 0,
    };
    let _total = {
      inputs: 0,
      outputs: 0,
    };
    let _addresses = {
      inputs: [],
      outputs: [],
    };

    shepherd.log('parseTransactionAddresses result ==>', true);

    if (tx.format === 'cant parse') {
      return {
        type: 'unknown',
        amount: 'unknown',
        address: targetAddress,
        timestamp: tx.timestamp,
        txid: tx.format.txid,
        confirmations: tx.confirmations,
      }
    }

    for (let key in _parse) {
      if (!tx[key].length) {
        _parse[key] = [];
        _parse[key].push(tx[key]);
      } else {
        _parse[key] = tx[key];
      }

      for (let i = 0; i < _parse[key].length; i++) {
        shepherd.log(`key ==>`, true);
        shepherd.log(_parse[key][i], true);
        shepherd.log(Number(_parse[key][i].value), true);

        _total[key] += Number(_parse[key][i].value);

        // ignore op return outputs
        if (_parse[key][i].scriptPubKey &&
            _parse[key][i].scriptPubKey.addresses &&
            _parse[key][i].scriptPubKey.addresses[0] &&
            _parse[key][i].scriptPubKey.addresses[0] === targetAddress &&
            _parse[key][i].value) {
          _sum[key] += Number(_parse[key][i].value);
        }

        if (_parse[key][i].scriptPubKey &&
            _parse[key][i].scriptPubKey.addresses &&
            _parse[key][i].scriptPubKey.addresses[0]) {
          _addresses[key].push(_parse[key][i].scriptPubKey.addresses[0]);

          if (_parse[key][i].scriptPubKey.addresses[0] === targetAddress &&
              skipTargetAddress) {
            _addresses[key].pop();
          }
        }
      }
    }

    _addresses.inputs = [ ...new Set(_addresses.inputs) ];
    _addresses.outputs = [ ...new Set(_addresses.outputs) ];

    shepherd.log('addresses in =>', true);
    shepherd.log(_addresses.inputs, true);
    shepherd.log('addresses out =>', true);
    shepherd.log(_addresses.outputs, true);

    let isSelfSend = {
      inputs: false,
      outputs: false,
    };

    for (let key in _parse) {
      for (let i = 0; i < _addresses[key].length; i++) {
        if (_addresses[key][i] === targetAddress &&
            _addresses[key].length === 1) {
          isSelfSend[key] = true;
        }
      }
    }

    if (_sum.inputs > 0 &&
        _sum.outputs > 0) {
      // vin + change, break into two tx

      // send to self
      if (isSelfSend.inputs && isSelfSend.outputs) {
        result = {
          type: 'self',
          amount: Number(_sum.inputs - _sum.outputs).toFixed(8),
          address: targetAddress,
          timestamp: tx.timestamp,
          txid: tx.format.txid,
          confirmations: tx.confirmations,
        };

        if (network === 'komodo') { // calc claimed interest amount
          const vinVoutDiff = _total.inputs - _total.outputs;

          if (vinVoutDiff < 0) {
            result.interest = Number(vinVoutDiff.toFixed(8));
          }
        }
      } else {
        result = [{ // reorder since tx sort by default is from newest to oldest
          type: 'sent',
          amount: Number(_sum.inputs.toFixed(8)),
          address: _addresses.outputs[0],
          timestamp: tx.timestamp,
          txid: tx.format.txid,
          confirmations: tx.confirmations,
          from: _addresses.inputs,
          to: _addresses.outputs,
        }, {
          type: 'received',
          amount: Number(_sum.outputs.toFixed(8)),
          address: targetAddress,
          timestamp: tx.timestamp,
          txid: tx.format.txid,
          confirmations: tx.confirmations,
          from: _addresses.inputs,
          to: _addresses.outputs,
        }];

        if (network === 'komodo') { // calc claimed interest amount
          const vinVoutDiff = _total.inputs - _total.outputs;

          if (vinVoutDiff < 0) {
            result[1].interest = Number(vinVoutDiff.toFixed(8));
          }
        }
      }
    } else if (_sum.inputs === 0 && _sum.outputs > 0) {
      result = {
        type: 'received',
        amount: Number(_sum.outputs.toFixed(8)),
        address: targetAddress,
        timestamp: tx.timestamp,
        txid: tx.format.txid,
        confirmations: tx.confirmations,
        from: _addresses.inputs,
        to: _addresses.outputs,
      };
    } else if (_sum.inputs > 0 && _sum.outputs === 0) {
      result = {
        type: 'sent',
        amount: Number(_sum.inputs.toFixed(8)),
        address: isSelfSend.inputs && isSelfSend.outputs ? targetAddress : _addresses.outputs[0],
        timestamp: tx.timestamp,
        txid: tx.format.txid,
        confirmations: tx.confirmations,
        from: _addresses.inputs,
        to: _addresses.outputs,
      };
    } else {
      // (?)
      result = {
        type: 'other',
        amount: 'unknown',
        address: 'unknown',
        timestamp: tx.timestamp,
        txid: tx.format.txid,
        confirmations: tx.confirmations,
      };
    }

    shepherd.log(_sum, true);
    shepherd.log(result, true);

    return result;
  }

  shepherd.get('/electrum/decoderawtx', (req, res, next) => {
    if (shepherd.checkToken(req.query.token)) {
      const _network = shepherd.getNetworkData(req.query.network);
      const _rawtx = req.query.rawtx;
      //const _rawtx = '010000006f2c395a02d81487fc7f9d1be3ea900316730133c044af70cd76d21e988e71de0e9e85918f010000006a47304402202097acd391e1d0eaaf91844bd596e918fb71320e3e0c51554acb71a39e4ee98b0220548fd61d4ae77a08d70b01bf5340983a1ba63f6b71ad71d478af77011f96fd510121031ffc010d8abc4180b4c1a13962bf9153a78082e7f2ac18f7d14cb6a6634ca218feffffff2b31f6c9a7916f7cf128cae94b3fc10e4c74ca3a740e1a7a6fd6624e4e9a5c8b010000006a473044022063f014c5fbaa7614732e0ae486179a854215fc32c02230e13f69b7e81fa000e50220236a2ba6373b1854aafc59c5391ab7505062067f3d293c016cbb5d252b35a56a012102f307f17d282fc0eabf99227c2e0f3122ae9ecd7da0de099f0c6007d4c941b57bfeffffff021b797ad7120000001976a914c7a7142d743b3e6eebe76923f43bae477d3ce31a88acff086d66000000001976a91463800ff36b9c52b2ffe5564af1c2a38df4f0126788ac16381d00';
      const decodedTx = shepherd.electrumJSTxDecoder(_rawtx, req.query.network, _network);

      shepherd.log('electrum decoderawtx input tx ==>', true);

      if (req.query.parseonly ||
          decodedTx.inputs[0].txid === '0000000000000000000000000000000000000000000000000000000000000000') {
        const successObj = {
          msg: 'success',
          result: {
            network: decodedTx.network,
            format: decodedTx.format,
            inputs: decodedTx.inputs,
            outputs: decodedTx.outputs,
          },
        };

        shepherd.log(successObj.result, true);

        res.end(JSON.stringify(successObj));
      } else {
        const ecl = new shepherd.electrumJSCore(
          shepherd.electrumServers[req.query.network].port,
          shepherd.electrumServers[req.query.network].address,
          shepherd.electrumServers[req.query.network].proto
        ); // tcp or tls

        shepherd.log(decodedTx.inputs[0]);
        shepherd.log(decodedTx.inputs[0].txid);

        ecl.connect();
        ecl.blockchainTransactionGet(decodedTx.inputs[0].txid)
        .then((json) => {
          ecl.close();
          shepherd.log(json, true);

          const decodedVin = shepherd.electrumJSTxDecoder(json, req.query.network, _network);

          const successObj = {
            msg: 'success',
            result: {
              network: decodedTx.network,
              format: decodedTx.format,
              inputs: decodedVin.outputs[decodedTx.inputs[0].n],
              outputs: decodedTx.outputs,
            },
          };

          res.end(JSON.stringify(successObj));
        });
      }
    } else {
      const errorObj = {
        msg: 'error',
        result: 'unauthorized access',
      };

      res.end(JSON.stringify(errorObj));
    }
  });

  return shepherd;
};