Resolve "feat(Primitives): Have Bytes Primitive extends Uint8Array (if possible)"

packages/primitives/README.md

@@ -10,6 +10,6 @@ These Primitives follow a declarative style and are **NOT** optimized for tree-s
 
 1. Install the Primitives.
 
-    ```sh
-    npm install @xocash/primitives
-    ```
+   ```sh
+   npm install @xocash/primitives
+   ```

packages/primitives/src/address.ts

@@ -209,7 +209,7 @@ export class Address {
     type: 'P2SH20' | 'P2SH32' = 'P2SH32',
   ): Address {
     // Return a new instance of address.
-    return this.fromRedeemScript(Bytes.fromHex(hex).toBytes(), type);
+    return this.fromRedeemScript(Bytes.fromHex(hex).toUint8Array(), type);
   }
 
   /**
@@ -257,7 +257,7 @@ export class Address {
    * @returns {Address} Instance of Address.
    */
   public static fromLockscriptHex(hex: string): Address {
-    return this.fromLockscriptBytes(Bytes.fromHex(hex).toBytes());
+    return this.fromLockscriptBytes(Bytes.fromHex(hex).toUint8Array());
   }
 
   /**
@@ -298,7 +298,10 @@ export class Address {
     hash160Hex: string,
     type: AddressType = 'P2PKH',
   ): Address {
-    return this.fromHash160Bytes(Bytes.fromHex(hash160Hex).toBytes(), type);
+    return this.fromHash160Bytes(
+      Bytes.fromHex(hash160Hex).toUint8Array(),
+      type,
+    );
   }
 
   /**

packages/primitives/src/block-header.ts

@@ -73,7 +73,7 @@ export class BlockHeader {
    * @throws Error if the hex string length is not 160
    */
   static fromHex(hex: string): BlockHeader {
-    return this.fromBytes(Bytes.fromHex(hex).toBytes());
+    return this.fromBytes(Bytes.fromHex(hex).toUint8Array());
   }
 
   /**
@@ -119,7 +119,7 @@ export class BlockHeader {
    * @returns 160-character hex string representing the block header
    */
   toHex(): string {
-    return Bytes.fromBytes(this.toBytes()).toHex();
+    return Bytes.fromBytes(this.bytes).toHex();
   }
 
   /**
@@ -207,7 +207,7 @@ export class BlockHeader {
    * @returns 32-byte array containing the block hash
    */
   getHash(): Uint8Array {
-    return hash256(this.toBytes()).toReversed();
+    return hash256(this.bytes).toReversed();
   }
 
   /**

packages/primitives/src/bytes.ts

@@ -15,16 +15,19 @@ import {
 /**
  * Bytes Primitive.
  */
-export class Bytes {
-  protected readonly bytes: Uint8Array;
-
+export class Bytes extends Uint8Array {
   /**
    * Instantiate Bytes from a Uint8Array.
    *
    * @param bytes {Uint8Array} The bytes to use.
    */
   protected constructor(bytes: Uint8Array) {
-    this.bytes = bytes;
+    super(bytes);
+  }
+
+  // Override the constructor to ensure correct inheritance
+  static from(uint8Array: Uint8Array): Bytes {
+    return new Bytes(uint8Array);
   }
 
   /**
@@ -119,11 +122,11 @@ export class Bytes {
    * @returns Bytes as a Base64 string.
    */
   public toBase64(): string {
-    return binToBase64(this.bytes);
+    return binToBase64(this);
   }
 
   public toBigInt(): bigint {
-    return binToBigIntUintLE(this.bytes);
+    return binToBigIntUintLE(this);
   }
 
   /**
@@ -132,7 +135,7 @@ export class Bytes {
    * @returns Bytes as a hex string.
    */
   public toHex(): string {
-    return binToHex(this.bytes);
+    return binToHex(this);
   }
 
   /**
@@ -141,7 +144,7 @@ export class Bytes {
    * @returns Bytes as a UTF8 string.
    */
   public toUtf8(): string {
-    return binToUtf8(this.bytes);
+    return binToUtf8(this);
   }
 
   /**
@@ -149,11 +152,12 @@ export class Bytes {
    *
    * @returns Bytes as a Uint8Array.
    */
-  public toBytes(): Uint8Array {
-    return this.bytes;
+  public toUint8Array(): Uint8Array {
+    // NOTE: We clone the instance of Uint8Array so that we don't accidentally mutate it.
+    return new Uint8Array([...this]);
   }
 
   public invert(): Bytes {
-    return new Bytes(Uint8Array.from([...this.bytes].reverse()));
+    return new Bytes(Uint8Array.from([...this].reverse()));
   }
 }

packages/primitives/src/hd-private-node.ts

@@ -66,7 +66,7 @@ export class HDPrivateNode {
   public static fromSeed(seed: Uint8Array | string): HDPrivateNode {
     // Cast from hex if a string was provided.
     if (typeof seed === 'string') {
-      seed = Bytes.fromHex(seed).toBytes();
+      seed = Bytes.fromHex(seed);
     }
 
     // If the seed is not 64 bytes, throw an error.

packages/primitives/src/private-key.ts

@@ -98,7 +98,7 @@ export class PrivateKey {
    */
   public static fromHex(privateKeyHex: string): PrivateKey {
     // Convert the hex to binary (Uint8Array).
-    const privateKeyBin = Bytes.fromHex(privateKeyHex).toBytes();
+    const privateKeyBin = Bytes.fromHex(privateKeyHex);
 
     // Create a Private Key Entity from the binary.
     return new this(privateKeyBin);
@@ -268,7 +268,7 @@ export class PrivateKey {
    */
   public signMessageRecoverableCompact(message: Uint8Array | string) {
     if (typeof message === 'string') {
-      message = Bytes.fromUtf8(message).toBytes();
+      message = Bytes.fromUtf8(message);
     }
 
     const messageHash = sha256.hash(message);
@@ -292,7 +292,7 @@ export class PrivateKey {
    */
   public signMessageCompact(message: Uint8Array | string) {
     if (typeof message === 'string') {
-      message = Bytes.fromUtf8(message).toBytes();
+      message = Bytes.fromUtf8(message);
     }
 
     const messageHash = sha256.hash(message);
@@ -316,7 +316,7 @@ export class PrivateKey {
    */
   public signMessageSchnorr(message: Uint8Array | string) {
     if (typeof message === 'string') {
-      message = Bytes.fromUtf8(message).toBytes();
+      message = Bytes.fromUtf8(message);
     }
 
     const messageHash = sha256.hash(message);
@@ -340,7 +340,7 @@ export class PrivateKey {
    */
   public signMessageDER(message: Uint8Array | string) {
     if (typeof message === 'string') {
-      message = Bytes.fromUtf8(message).toBytes();
+      message = Bytes.fromUtf8(message);
     }
 
     const messageHash = sha256.hash(message);
@@ -363,10 +363,8 @@ export class PrivateKey {
    */
   public signMessageElectron(message: string): Uint8Array {
     // Compile the message.
-    const magicBytes = Bytes.fromUtf8(
-      '\x18Bitcoin Signed Message:\n',
-    ).toBytes();
-    const messageBytes = Bytes.fromUtf8(message).toBytes();
+    const magicBytes = Bytes.fromUtf8('\x18Bitcoin Signed Message:\n');
+    const messageBytes = Bytes.fromUtf8(message);
     const messageLengthBytes = bigIntToCompactUint(BigInt(messageBytes.length)); // hexToBin(messageBytes.length.toString(16)); //
     const messageFinal = new Uint8Array([
       ...magicBytes,
@@ -406,7 +404,7 @@ export class PrivateKey {
     // If a string was given, convert it from hex to bytes.
     // TODO: Consider using Bytes class - it ensures valid hex.
     if (typeof messageHash === 'string') {
-      messageHash = Bytes.fromHex(messageHash).toBytes();
+      messageHash = Bytes.fromHex(messageHash);
     }
 
     if (messageHash.length !== 32) {
@@ -441,7 +439,7 @@ export class PrivateKey {
     // If a string was given, convert it from hex to bytes.
     // TODO: Consider using Bytes class - it ensures valid hex.
     if (typeof messageHash === 'string') {
-      messageHash = Bytes.fromHex(messageHash).toBytes();
+      messageHash = Bytes.fromHex(messageHash);
     }
 
     if (messageHash.length !== 32) {
@@ -476,7 +474,7 @@ export class PrivateKey {
     // If a string was given, convert it from hex to bytes.
     // TODO: Consider using Bytes class - it ensures valid hex.
     if (typeof messageHash === 'string') {
-      messageHash = Bytes.fromHex(messageHash).toBytes();
+      messageHash = Bytes.fromHex(messageHash);
     }
 
     if (messageHash.length !== 32) {
@@ -511,7 +509,7 @@ export class PrivateKey {
     // If a string was given, convert it from hex to bytes.
     // TODO: Consider using Bytes class - it ensures valid hex.
     if (typeof messageHash === 'string') {
-      messageHash = Bytes.fromHex(messageHash).toBytes();
+      messageHash = Bytes.fromHex(messageHash);
     }
 
     if (messageHash.length !== 32) {

packages/primitives/src/public-key.ts

@@ -78,7 +78,7 @@ export class PublicKey {
    * @returns The created Public Key entity.
    */
   public static fromHex(publicKeyHex: string): PublicKey {
-    return new this(Bytes.fromHex(publicKeyHex).toBytes());
+    return new this(Bytes.fromHex(publicKeyHex));
   }
 
   /**
@@ -232,11 +232,11 @@ export class PublicKey {
     signature: Uint8Array | string,
   ): boolean {
     if (typeof messageHash === 'string') {
-      messageHash = Bytes.fromHex(messageHash).toBytes();
+      messageHash = Bytes.fromHex(messageHash);
     }
 
     if (typeof signature === 'string') {
-      signature = Bytes.fromHex(signature).toBytes();
+      signature = Bytes.fromHex(signature);
     }
 
     const validity = secp256k1.verifySignatureDER(
@@ -261,11 +261,11 @@ export class PublicKey {
     signature: Uint8Array | string,
   ): boolean {
     if (typeof messageHash === 'string') {
-      messageHash = Bytes.fromHex(messageHash).toBytes();
+      messageHash = Bytes.fromHex(messageHash);
     }
 
     if (typeof signature === 'string') {
-      signature = Bytes.fromHex(signature).toBytes();
+      signature = Bytes.fromHex(signature);
     }
 
     const validity = secp256k1.verifySignatureSchnorr(

packages/primitives/src/script.ts

@@ -24,7 +24,7 @@ import {
  * console.log(script.toHex());
  *
  * // Output as bytecode.
- * console.log(script.toBytes());
+ * console.log(script);
  * ```
  */
 export class Script {
@@ -177,7 +177,7 @@ export class Script {
    */
   public static fromHex(hex: string): Script {
     // Return new Script entity constructed from the binary.
-    return this.fromBytes(Bytes.fromHex(hex).toBytes());
+    return this.fromBytes(Bytes.fromHex(hex));
   }
 
   /**

packages/primitives/src/transaction.ts

@@ -212,7 +212,7 @@ export class Transaction extends BaseTransaction {
    * @returns {Transaction} The created Transaction Primitive.
    */
   public static fromHex(hex: string): Transaction {
-    const bytes = Bytes.fromHex(hex).toBytes();
+    const bytes = Bytes.fromHex(hex).toUint8Array();
     return this.fromBytes(bytes);
   }
 
@@ -319,7 +319,7 @@ export class TransactionResolved extends BaseTransaction {
    * @returns {Transaction} The created Transaction Primitive.
    */
   public static fromHex(hex: string, sourceOutputs: Array<any>) {
-    const bytes = Bytes.fromHex(hex).toBytes();
+    const bytes = Bytes.fromHex(hex).toUint8Array();
     return this.fromBytes(bytes, sourceOutputs);
   }
 
@@ -425,7 +425,7 @@ export class TransactionHash {
    * @returns {TransactionHash} Instance of TransactionHash.
    */
   public static fromHex(hex: string): TransactionHash {
-    const bytes = Bytes.fromHex(hex).toBytes();
+    const bytes = Bytes.fromHex(hex).toUint8Array();
     return this.fromBytes(bytes);
   }
 
@@ -469,7 +469,7 @@ export class TransactionHash {
    * @returns {TransactionHash} Instance of TransactionHash.
    */
   public static fromTransactionHex(transactionHex: string): TransactionHash {
-    const bytes = Bytes.fromHex(transactionHex).toBytes();
+    const bytes = Bytes.fromHex(transactionHex).toUint8Array();
     return this.fromTransactionBytes(bytes);
   }
 

packages/primitives/tests/address.spec.ts

@@ -1,6 +1,6 @@
 import { describe, it, expect } from 'vitest';
-import { Address } from '~/src/address';
-import { Bytes } from '~/src/bytes';
+import { Address } from '../src/address';
+import { Bytes } from '../src/bytes';
 
 describe('Success cases', () => {
   // Test cases with different address representations
@@ -27,7 +27,7 @@ describe('Success cases', () => {
         type: 'P2PKH',
         payload: Bytes.fromHex(
           '626025854e5a67ca5eb122e213f409ec842d45e4',
-        ).toBytes(),
+        ).toUint8Array(),
       },
       representations: {
         cashAddr: 'bitcoincash:qp3xqfv9fedx0jj7ky3wyyl5p8kggt29usvlhrrxws',
@@ -35,13 +35,13 @@ describe('Success cases', () => {
         tokenAddr: 'bitcoincash:zp3xqfv9fedx0jj7ky3wyyl5p8kggt29ust4yadq3r',
         lockscriptBytes: Bytes.fromHex(
           '76a914626025854e5a67ca5eb122e213f409ec842d45e488ac',
-        ).toBytes(),
+        ).toUint8Array(),
         lockscriptHex: '76a914626025854e5a67ca5eb122e213f409ec842d45e488ac',
         lockscriptASM:
           'OP_DUP OP_HASH160 OP_PUSHBYTES_20 0x626025854e5a67ca5eb122e213f409ec842d45e4 OP_EQUALVERIFY OP_CHECKSIG',
         hash160Bytes: Bytes.fromHex(
           '626025854e5a67ca5eb122e213f409ec842d45e4',
-        ).toBytes(),
+        ).toUint8Array(),
         hash160Hex: '626025854e5a67ca5eb122e213f409ec842d45e4',
       },
     },

packages/primitives/tests/block-header.spec.ts

@@ -1,6 +1,6 @@
 import { describe, it, expect } from 'vitest';
-import { BlockHeader } from '~/src/block-header';
-import { Bytes } from '~/src/bytes';
+import { BlockHeader } from '../src/block-header';
+import { Bytes } from '../src/bytes';
 
 describe('Success cases', () => {
   // Test cases with different block header representations
@@ -16,11 +16,11 @@ describe('Success cases', () => {
     {
       raw: Bytes.fromHex(
         '0000602093ea70b294aeef69db85981bd387285824fc5af732e487010000000000000000135576e1ba9cae5509d60b4fbb9e66612f35b5ee8db264cb12612d46cc8db60b5e34a164d46b021864abbb1d',
-      ).toBytes(),
+      ).toUint8Array(),
       representations: {
         bytes: Bytes.fromHex(
           '0000602093ea70b294aeef69db85981bd387285824fc5af732e487010000000000000000135576e1ba9cae5509d60b4fbb9e66612f35b5ee8db264cb12612d46cc8db60b5e34a164d46b021864abbb1d',
-        ).toBytes(),
+        ).toUint8Array(),
         hex: '0000602093ea70b294aeef69db85981bd387285824fc5af732e487010000000000000000135576e1ba9cae5509d60b4fbb9e66612f35b5ee8db264cb12612d46cc8db60b5e34a164d46b021864abbb1d',
       },
     },

packages/primitives/tests/mnemonic.spec.ts

@@ -51,7 +51,7 @@ describe('Success cases', () => {
       },
       toSeed: Bytes.fromHex(
         '7066f43a742829f0edce7d8e3c31651df320f13913995a6500f4e515db372b35202227f923ff181defc35cea02f8468df39f8fa9d97a202d252e61562e4bbfb5',
-      ).toBytes(),
+      ).toUint8Array(),
       toPhrase:
         'goose just fan kidney barrel album wave crowd movie flame cousin exhaust',
       toPhraseWithoutPassphrase:
@@ -124,7 +124,7 @@ describe('Success cases', () => {
       },
       toSeed: Bytes.fromHex(
         '2f706756ab2083f7ce07c0c0fcde8f14f062da5de839f42763262b25e0d871f03dd2b561d55eaacc471c94da656ee7b0007fb48a64e31ec91a1a2ba706b46b89',
-      ).toBytes(),
+      ).toUint8Array(),
       toPhrase:
         'goose just fan kidney barrel album wave crowd movie flame cousin exhaust GeneralProtocols!',
       toPhraseWithoutPassphrase:

packages/primitives/tests/satoshis.spec.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import { Satoshis } from '~/src/satoshis';
+import { Satoshis } from '../src/satoshis';
 
 describe('Success cases', () => {
   // Test cases with single representation for each unit

packages/primitives/tests/script.spec.ts

@@ -17,11 +17,11 @@ describe('Success cases', () => {
     {
       raw: Bytes.fromHex(
         '76a914876fbb82ec05caa6af7a3b5e5a983aae6c6cc6d688ac',
-      ).toBytes(),
+      ).toUint8Array(),
       representations: {
         bytes: Bytes.fromHex(
           '76a914876fbb82ec05caa6af7a3b5e5a983aae6c6cc6d688ac',
-        ).toBytes(),
+        ).toUint8Array(),
         asm: 'OP_DUP\nOP_HASH160\nOP_PUSHBYTES_20\n0x876fbb82ec05caa6af7a3b5e5a983aae6c6cc6d6\nOP_EQUALVERIFY\nOP_CHECKSIG',
         hex: '76a914876fbb82ec05caa6af7a3b5e5a983aae6c6cc6d688ac',
       },
@@ -38,19 +38,19 @@ describe('Success cases', () => {
   fromMethods.forEach(({ name, key }) => {
     it.each(testCases)(`${name}()`, ({ raw, representations }) => {
       const script = Script[name](representations[key]);
-      expect(script.toRaw()).toStrictEqual(raw);
+      expect(script.toRaw()).toEqual(raw);
     });
   });
 
   // Test generic from method
   it.each(testCases)('from(Uint8Array)', ({ raw, representations }) => {
     const script = Script.from(representations.bytes);
-    expect(script.toRaw()).toStrictEqual(raw);
+    expect(script.toRaw()).toEqual(raw);
   });
 
   it.each(testCases)('from(string)', ({ raw, representations }) => {
     const script = Script.from(representations.hex);
-    expect(script.toRaw()).toStrictEqual(raw);
+    expect(script.toRaw()).toEqual(raw);
   });
 
   // Test to methods with their respective types
@@ -63,14 +63,14 @@ describe('Success cases', () => {
   toMethods.forEach(({ name, key }) => {
     it.each(testCases)(`${name}()`, ({ raw, representations }) => {
       const script = Script.fromRaw(raw);
-      expect(script[name]()).toStrictEqual(representations[key]);
+      expect(script[name]()).toEqual(representations[key]);
     });
   });
 
   // Test fromRaw specifically
   it.each(testCases)('fromRaw() creates correct instance', ({ raw }) => {
     const script = Script.fromRaw(raw);
-    expect(script.toRaw()).toStrictEqual(raw);
+    expect(script.toRaw()).toEqual(raw);
   });
 });