Source: inputs.js

  1. /**
  2.  * This module provides functions for sorting & validating multisig
  3.  * transaction inputs.
  4.  *
  5.  * @module inputs
  6.  */
  8. import {validateHex} from './utils';
  9. import {multisigBraidDetails} from './multisig';
  11.  /**
  12.  * Represents a transaction input.
  13.  *
  14.  * The [`Multisig`]{@link module:multisig.MULTISIG} object represents
  15.  * the address the corresponding UTXO belongs to.
  16.  *
  17.  * @typedef MultisigTransactionInput
  18.  * @type {Object}
  19.  * @property {string} txid - The transaction ID where funds were received
  20.  * @property {number} index - The index in the transaction referred to by {txid}
  21.  * @property {module:multisig.Multisig} multisig - The multisig object encumbering this UTXO
  22.  *
  23.  */
  25. /**
  26.  * Sorts the given inputs according to the [BIP69 standard]{@link https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki#transaction-inputs}: ascending lexicographic order.
  27.  *
  28.  * @param {module:inputs.MultisigTransactionInput[]} inputs - inputs to sort
  29.  * @returns {module:inputs.MultisigTransactionInput[]} inputs sorted according to BIP69
  30.  */
  31. export function sortInputs(inputs) {
  32.   return inputs.sort((input1, input2) => {
  33.     if (input1.txid > input2.txid) {
  34.       return 1;
  35.     } else {
  36.       if (input1.txid < input2.txid) {
  37.         return -1;
  38.       } else {
  39.         return ((input1.index < input2.index) ? -1 : 1);
  40.       }
  41.     }
  42.   });
  43. }
  45. /**
  46.  * Validates the given transaction inputs.
  47.  *
  48.  * Returns an error message if there are no inputs.  Passes each output to [`validateMultisigInput`]{@link module:transactions.validateOutput}.
  49.  *
  50.  * If the function is called with braidRequired, an additional check is performed
  51.  * on each input's multisig to make sure that it is braid-aware. In other words,
  52.  * does the input know the set of ExtendedPublicKeys it came from?
  53.  *
  54.  * @param {module:inputs.MultisigTransactionInput[]} inputs - inputs to validate
  55.  * @param {boolean} [braidRequired] - inputs need to have braid details attached to them
  56.  * @returns {string} empty if valid or corresponding validation message if not
  57.  */
  58. export function validateMultisigInputs(inputs, braidRequired) {
  59.   if (!inputs || inputs.length === 0) { return "At least one input is required."; }
  60.   let utxoIDs = [];
  61.   for (let inputIndex = 0; inputIndex < inputs.length; inputIndex++) {
  62.     const input = inputs[inputIndex];
  63.     if (braidRequired && input.multisig && !multisigBraidDetails(input.multisig)) {
  64.         return `At least one input cannot be traced back to its set of extended public keys.`;
  65.     }
  66.     const error = validateMultisigInput(input);
  67.     if (error) { return error; }
  68.     const utxoID = `${input.txid}:${input.index}`;
  69.     if (utxoIDs.includes(utxoID)) {
  70.       return `Duplicate input: ${utxoID}`;
  71.     }
  72.     utxoIDs.push(utxoID);
  73.   }
  74.   return "";
  75. }
  77. /**
  78.  * Validates the given transaction input.
  79.  *
  80.  * - Validates the presence and value of the transaction ID (`txid`) property.
  81.  *
  82.  * - Validates the presence and value of the transaction index (`index`) property.
  83.  *
  84.  * - Validates the presence of the `multisig` property.
  85.  *
  86.  * @param {module:inputs.MultisigTransactionInput} input - input to validate
  87.  * @returns {string} empty if valid or corresponding validation message if not
  88.  *
  89.  */
  90. export function validateMultisigInput(input) {
  91.   if (!input.txid) {
  92.     return `Does not have a transaction ID ('txid') property.`;
  93.   }
  94.   let error = validateTransactionID(input.txid);
  95.   if (error) { return error; }
  96.   if (input.index !== 0 && (!input.index)) {
  97.     return `Does not have a transaction index ('index') property.`;
  98.   }
  99.   error = validateTransactionIndex(input.index);
  100.   if (error) { return error; }
  101.   if (!input.multisig) {
  102.     return `Does not have a multisig object ('multisig') property.`;
  103.   }
  104.   return "";
  105. }
  107. const TXID_LENGTH = 64;
  109. /**
  110.  * Validates the given transaction ID.
  111.  *
  112.  * @param {string} txid - transaction ID to validate
  113.  * @returns {string} empty if valid or corresponding validation message if not
  114.  *
  115.  */
  116. export function validateTransactionID(txid) {
  117.   if (txid === null || txid === undefined || txid === '') {
  118.     return "TXID cannot be blank.";
  119.   }
  120.   let error = validateHex(txid);
  121.   if (error) {
  122.     return `TXID is invalid (${error})`;
  123.   }
  124.   if (txid.length !== TXID_LENGTH) {
  125.     return `TXID is invalid (must be ${TXID_LENGTH}-characters)`;
  126.   }
  127.   return '';
  128. }
  130. /**
  131.  * Validates the given transaction index.
  132.  *
  133.  * @param {string|number} indexString - transaction index to validate
  134.  * @returns {string} empty if valid or corresponding validation message if not
  135.  *
  136.  */
  137. export function validateTransactionIndex(indexString) {
  138.   if (indexString === null || indexString === undefined || indexString === '') {
  139.     return "Index cannot be blank.";
  140.   }
  141.   const index = parseInt(indexString, 10);
  142.   if (!isFinite(index)) {
  143.     return "Index is invalid";
  144.   }
  145.   if (index < 0) {
  146.     return "Index cannot be negative.";
  147.   }
  148.   return "";
  149. }