doc: update for latest APIs

Author: coolaj86

README.md

@@ -385,13 +385,15 @@ Tx.OUTPUT_SIZE         //          34
 ```text
 Tx.create({ getPrivateKey, getPublicKey, sign, toPublicKey });
     tx.hashAndSignAll(txInfo);
+    tx.hashAndSignInput(privBytes, txInfo, i, sigHashType);
     tx.legacy.draftSingleOutput({ utxos, inputs, output });
     tx.legacy.finalizePresorted(txDraft, keys);
 
 Tx.createDonationOutput();
 
 Tx.appraise({ inputs, outputs });
-Tx.getId(txHex);
+
+Tx.parseUnknown(serializedHex);
 
 // Byte-level helpers
 Tx.utils.toVarInt(n);
@@ -402,10 +404,28 @@ Tx.utils.hexToBytes(hex);
 Tx.utils.strToHex(str);
 
 // Low-level helpers
-Tx.createRaw(txInfoMinimal);
-Tx.createHashable(txInfo, inputIndex);
+Tx.SIGHASH_ALL // 0x01
+Tx.SIGHASH_NONE // 0x02
+Tx.SIGHASH_ANYONECANPAY // 0x80
+
+Tx.createRaw(txRequestInfo);
+Tx.createForSig(txInfo, inputIndex, sigHashType);
 Tx.createSigned(txInfoSigned);
-Tx.hashPartial(txHex, Tx.SIGHASH_ALL);
+
+Tx.serialize(txRequestOrTxSigned);
+Tx.serializeForSig(txInfo, sigHashType);
+
+Tx.createInputRaw(input, i);
+Tx.createInputForSig(input, i);
+
+Tx.serializeInputs(inputs);
+Tx.serializeOutputs(outputs, opts);
+
+Tx.serializeInput(input, i);
+Tx.serializeOutput(output, i);
+
+Tx.sum(coins);
+Tx.doubleSha256(txBytes) {
 
 // Deprecated
 Tx.createLegacyTx(coins, outputs, changeOutput);
@@ -415,7 +435,7 @@ Tx.createLegacyTx(coins, outputs, changeOutput);
 /**
  * Creates a tx signer instance.
  */
-Tx.create({ getPrivateKey, getPublicKey, sign, toPublicKey });
+Tx.create(keyUtils);
 
 /**
  * Estimates the min, mid, and max sizes of (fees for) a transaction (including memos).
@@ -488,32 +508,47 @@ Tx.createLegacyTx(coins, outputs, changeOutput);
 }
 
 /**
- * Creates an "null" transaction with minimal information.
- * It which CANNOT be used for hashing or signing... and
- * we're not sure what it is useful for. Seemingly nothing.
+ * Creates a transaction request object with minimal information.
+ * It CANNOT be used for hashing or signing. Useful for sharing
+ * between wallets as a request to create a shared transaction.
+ * (i.e. for CoinJoin)
  *
  * Note: although these basically encode enough information
  * for a payment request, there are better ways to do that.
  */
 Tx.createRaw(txInfoMinimal);
 
 /**
- * Creates a transaction with all inputs "null"ed out,
- * except for the one corresponding to the given input index.
+ * Creates a transaction object with all inputs omitted
+ * (SIGHASH_ANYONECANPAY), or "null"ed out, except for the one
+ * corresponding to the given input index. That index will
+ * contain the lockscript from its previous output.
  *
  * This creates a one-off copy of the transaction suitable for
  * hashing to create the signature that will be inserted into
  * the (unrelated) final transaction.
  */
-Tx.createHashable(txInfo, inputIndex);
+Tx.createForSig(txInfo, inputIndex);
 
 /**
  * Creates a transaction that is ready to broadcast to the
- * network. It contains signatures from the one-off emphemeral,
- * hashable transactions created for each input.
+ * network.  Each input contains signatures from the one-off
+ * emphemeral, ready-to-sign transactions described above.
  */
 Tx.createSigned(txInfoSigned);
 
+/**
+ * Creates a transaction hex either for a raw request, or
+ * that is signed and ready to broadcast to the network.
+ */
+Tx.serialize(txInfo);
+
+/**
+ * Serialized a transaction as hex, appending the sigHashType
+ * of the target input, which is required for signing.
+ */
+Tx.serializeForSig(txInfo, sigHashType);
+
 /**
  * Double sha256 hashes the signed, broadcastable transaction
  * and reverses the byte order of the reseult.
@@ -526,7 +561,14 @@ Tx.getId(txHex);
  * order because we use a standard ECSDA signing function that
  * expects bytes in the normal order.
  */
-Tx.hashPartial(txHex, Tx.SIGHASH_ALL);
+Tx.doubleSha256(txBytes);
+
+/**
+ * Parse a transaction hex, which may be a raw request will "null"-ed
+ * inputs, a ready-to-sign transaction with lockscript inputs, or a
+ * ready-to-broadcast transaction with signed inputs.
+ */
+Tx.parseUnknown(serializedHex);
 ```
 
 ### Utility Functions

dashtx.js

@@ -34,6 +34,7 @@
  * @prop {TxSelectSigHashInputs} selectSigHashInputs
  * @prop {TxSelectSigHashOutputs} selectSigHashOutputs
  * @prop {TxSerialize} serialize
+ * @prop {TxSerializeForSig} serializeForSig
  * @prop {TxSerializeInputs} serializeInputs
  * @prop {TxSerializeInput} serializeInput
  * @prop {TxSerializeOutputs} serializeOutputs
@@ -424,6 +425,7 @@ var DashTx = ("object" === typeof module && exports) || {};
       }
 
       let totalAvailable = DashTx.sum(inputs);
+      //@ts-ignore - TODO update typedefs
       let fees = DashTx.appraise({ inputs: inputs, outputs: [output] });
 
       //let EXTRA_SIG_BYTES_PER_INPUT = 2;
@@ -471,6 +473,7 @@ var DashTx = ("object" === typeof module && exports) || {};
         fullTransfer,
       };
 
+      //@ts-ignore - TODO update typedefs
       return txInfoRaw;
     };
 
@@ -672,6 +675,7 @@ var DashTx = ("object" === typeof module && exports) || {};
    * the smallest coin that is bigger or equal to the amount sent + fees,
    * or the largest available coins until that total is met.
    */
+  //@ts-ignore - TODO update typedefs
   Tx.createLegacyTx = async function (coins, outputs, changeOutput) {
     // TODO bump to 4 for DIP: enforce tx hygiene
     let version = CURRENT_VERSION;
@@ -686,6 +690,7 @@ var DashTx = ("object" === typeof module && exports) || {};
 
     /** @type {Array<TxInputUnspent>} */
     let inputs = [];
+    //@ts-ignore - TODO update typedefs
     let fees = DashTx.appraise({ inputs, outputs });
     let taxes = fees.max;
     // requires at least one input
@@ -1137,6 +1142,8 @@ var DashTx = ("object" === typeof module && exports) || {};
 
     return txHex;
   };
+  //@ts-ignore - same function, but typed and documented separately for clarity
+  Tx.serializeForSig = Tx.serialize;
 
   Tx.serializeInputs = function (inputs, _opts) {
     let tx = _opts?._tx || [];
@@ -2205,6 +2212,17 @@ if ("object" === typeof module) {
  * @param {Uint32} [sigHashType]
  */
 
+/**
+ * @callback TxSerializeForSig
+ * @param {Object} txInfo
+ * @param {Array<TxInputRaw|TxInputForSig>} txInfo.inputs
+ * @param {Uint32} [txInfo.locktime]
+ * @param {Array<TxOutput>} txInfo.outputs
+ * @param {Uint32} [txInfo.version]
+ * @param {Boolean} [txInfo._debug] - bespoke debug output
+ * @param {Uint32} sigHashType
+ */
+
 /**
  * @callback TxSerializeInputs
  * @param {Array<TxInput|TxInputRaw|TxInputForSig|TxInputSigned>} txInputs