refactor: Remove unneeded deserialize overloads

.github/MIGRATION.md

@@ -238,27 +238,16 @@ For easier migrating, renaming the following methods is possible to keep the pre
 - `StacksTransaction.serialize` → `StacksTransaction.serializeBytes`
 - `serializeCV` → `serializeCVBytes`
 - `serializeAddress` → `serializeAddressBytes`
-- `deserializeAddress` → `deserializeAddressBytes`
 - `serializeLPList` → `serializeLPListBytes`
-- `deserializeLPList` → `deserializeLPListBytes`
 - `serializeLPString` → `serializeLPStringBytes`
-- `deserializeLPString` → `deserializeLPStringBytes`
 - `serializePayload` → `serializePayloadBytes`
-- `deserializePayload` → `deserializePayloadBytes`
 - `serializePublicKey` → `serializePublicKeyBytes`
-- `deserializePublicKey` → `deserializePublicKeyBytes`
 - `serializeStacksMessage` → `serializeStacksMessageBytes`
-- `deserializeStacksMessage` → `deserializeStacksMessageBytes`
 - `serializeMemoString` → `serializeMemoStringBytes`
-- `deserializeMemoString` → `deserializeMemoStringBytes`
 - `serializeTransactionAuthField` → `serializeTransactionAuthFieldBytes`
-- `deserializeTransactionAuthField` → `deserializeTransactionAuthFieldBytes`
 - `serializeMessageSignature` → `serializeMessageSignatureBytes`
-- `deserializeMessageSignature` → `deserializeMessageSignatureBytes`
 - `serializePostCondition` → `serializePostConditionBytes`
-- `deserializePostCondition` → `deserializePostConditionBytes`
 - `serializeStacksMessage` → `serializeStacksWireBytes`
-- `deserializeStacksMessage` → `deserializeStacksWireBytes`
 
 ### Asset Helper Methods
 
@@ -287,7 +276,6 @@ This is only used for advanced serialization use-cases internally and should not
 - `StacksMessage` → `StacksWire`
 - `StacksMessageType` → `StacksWireType`
 - `serializeStacksMessage` → `serializeStacksWireBytes`
-- `deserializeStacksMessage` → `deserializeStacksWireBytes`
 
 More types were renamed to indicate use for serialization to _wire-format_:
 

packages/transactions/src/BytesReader.ts

@@ -1,4 +1,4 @@
-import { bytesToHex, readUInt16BE, readUInt32BE, readUInt8 } from '@stacks/common';
+import { bytesToHex, hexToBytes, readUInt16BE, readUInt32BE, readUInt8 } from '@stacks/common';
 
 function createEnumChecker<T extends string, TEnumValue extends number>(enumVariable: {
   [key in T]: TEnumValue;
@@ -47,8 +47,8 @@ export class BytesReader {
   source: Uint8Array;
   consumed: number = 0;
 
-  constructor(arr: Uint8Array) {
-    this.source = arr;
+  constructor(bytes: string | Uint8Array) {
+    this.source = typeof bytes === 'string' ? hexToBytes(bytes) : bytes;
   }
 
   readBytes(length: number): Uint8Array {

packages/transactions/src/authorization.ts

@@ -31,8 +31,8 @@ import {
   addressFromPublicKeys,
   createEmptyAddress,
   createLPList,
-  deserializeLPListBytes,
-  deserializeMessageSignatureBytes,
+  deserializeLPList,
+  deserializeMessageSignature,
   MessageSignatureWire,
   PublicKeyWire,
   serializeLPListBytes,
@@ -258,7 +258,7 @@ export function deserializeSingleSigSpendingCondition(
       'Failed to parse singlesig spending condition: incomaptible hash mode and key encoding'
     );
   }
-  const signature = deserializeMessageSignatureBytes(bytesReader);
+  const signature = deserializeMessageSignature(bytesReader);
   return {
     hashMode,
     signer,
@@ -277,7 +277,7 @@ export function deserializeMultiSigSpendingCondition(
   const nonce = BigInt('0x' + bytesToHex(bytesReader.readBytes(8)));
   const fee = BigInt('0x' + bytesToHex(bytesReader.readBytes(8)));
 
-  const fields = deserializeLPListBytes(bytesReader, StacksWireType.TransactionAuthField)
+  const fields = deserializeLPList(bytesReader, StacksWireType.TransactionAuthField)
     .values as TransactionAuthFieldWire[];
 
   let haveUncompressed = false;

packages/transactions/src/clarity/deserialize.ts

@@ -20,7 +20,7 @@ import {
 } from '.';
 import { BytesReader } from '../BytesReader';
 import { DeserializationError } from '../errors';
-import { deserializeAddressBytes, deserializeLPStringBytes } from '../wire';
+import { deserializeAddress, deserializeLPString } from '../wire';
 
 /**
  * Deserializes clarity value to clarity type
@@ -75,12 +75,12 @@ export function deserializeCV<T extends ClarityValue = ClarityValue>(
       return falseCV() as T;
 
     case ClarityWireType.address:
-      const sAddress = deserializeAddressBytes(bytesReader);
+      const sAddress = deserializeAddress(bytesReader);
       return standardPrincipalCVFromAddress(sAddress) as T;
 
     case ClarityWireType.contract:
-      const cAddress = deserializeAddressBytes(bytesReader);
-      const contractName = deserializeLPStringBytes(bytesReader);
+      const cAddress = deserializeAddress(bytesReader);
+      const contractName = deserializeLPString(bytesReader);
       return contractPrincipalCVFromAddress(cAddress, contractName) as T;
 
     case ClarityWireType.ok:
@@ -107,7 +107,7 @@ export function deserializeCV<T extends ClarityValue = ClarityValue>(
       const tupleLength = bytesReader.readUInt32BE();
       const tupleContents: { [key: string]: ClarityValue } = {};
       for (let i = 0; i < tupleLength; i++) {
-        const clarityName = deserializeLPStringBytes(bytesReader).content;
+        const clarityName = deserializeLPString(bytesReader).content;
         if (clarityName === undefined) {
           throw new DeserializationError('"content" is undefined');
         }

packages/transactions/src/transaction.ts

@@ -5,8 +5,8 @@ import {
   PublicKey,
   bytesToHex,
   concatArray,
-  hexToBytes,
   intToBigInt,
+  isInstance,
   writeUInt32BE,
 } from '@stacks/common';
 import {
@@ -56,8 +56,8 @@ import {
   createLPList,
   createMessageSignature,
   createTransactionAuthField,
-  deserializeLPListBytes,
-  deserializePayloadBytes,
+  deserializeLPList,
+  deserializePayload,
   serializeLPListBytes,
 } from './wire';
 
@@ -312,18 +312,7 @@ export class StacksTransaction {
  * @param tx hex string or bytes of serialized transaction
  */
 export function deserializeTransaction(tx: string | Uint8Array | BytesReader) {
-  let bytesReader: BytesReader; // todo: add readerFrom method
-  if (typeof tx === 'string') {
-    if (tx.slice(0, 2).toLowerCase() === '0x') {
-      bytesReader = new BytesReader(hexToBytes(tx.slice(2)));
-    } else {
-      bytesReader = new BytesReader(hexToBytes(tx));
-    }
-  } else if (tx instanceof Uint8Array) {
-    bytesReader = new BytesReader(tx);
-  } else {
-    bytesReader = tx;
-  }
+  const bytesReader = isInstance(tx, BytesReader) ? tx : new BytesReader(tx);
   const version = bytesReader.readUInt8Enum(TransactionVersion, n => {
     throw new Error(`Could not parse ${n} as TransactionVersion`);
   });
@@ -335,8 +324,8 @@ export function deserializeTransaction(tx: string | Uint8Array | BytesReader) {
   const postConditionMode = bytesReader.readUInt8Enum(PostConditionMode, n => {
     throw new Error(`Could not parse ${n} as PostConditionMode`);
   });
-  const postConditions = deserializeLPListBytes(bytesReader, StacksWireType.PostCondition);
-  const payload = deserializePayloadBytes(bytesReader);
+  const postConditions = deserializeLPList(bytesReader, StacksWireType.PostCondition);
+  const payload = deserializePayload(bytesReader);
 
   return new StacksTransaction(
     version,