refactor: rework @ganache/ethereum-address to extend ethereumjs/util's Address (#3777)

Author: MicaiahReid

src/chains/ethereum/address/index.ts

@@ -1,14 +1,15 @@
-import { Data, JsonRpcDataInputArg } from "@ganache/utils";
+import { Address as EJSAddress } from "@ethereumjs/util";
+import { JsonRpcDataInputArg, Data } from "@ganache/utils";
 
-export class Address extends Data {
+export class Address extends EJSAddress {
   static ByteLength = 20;
 
-  constructor(value: string | Buffer) {
-    super(value, Address.ByteLength);
+  constructor(value: Buffer) {
+    super(value);
   }
 
   public static from<T extends string | Buffer = string | Buffer>(value: T) {
-    return new Address(value);
+    return new Address(Data.toBuffer(value, Address.ByteLength));
   }
 
   static toBuffer(value: JsonRpcDataInputArg): Buffer {
@@ -18,4 +19,8 @@ export class Address extends Data {
   static toString(value: JsonRpcDataInputArg): string {
     return Address.from(value).toString();
   }
+
+  toJSON() {
+    return this.toString();
+  }
 }

src/chains/ethereum/address/package-lock.json

@@ -56,6 +56,7 @@
     "typescript": "4.7.4"
   },
   "dependencies": {
+    "@ethereumjs/util": "8.0.0",
     "@ganache/utils": "0.6.0"
   }
 }

src/chains/ethereum/address/package.json

@@ -4,7 +4,7 @@ import { Address } from "../";
 describe("@ganache/ethereum-address", () => {
   describe("toString()", () => {
     it("should pad an address to 20 bytes", () => {
-      const address = new Address("0x1");
+      const address = Address.from("0x1");
       const stringifiedAddress = address.toString();
 
       assert.strictEqual(
@@ -13,15 +13,10 @@ describe("@ganache/ethereum-address", () => {
       );
     });
 
-    it("should truncate an address to the specified length", () => {
-      const address = new Address("0x1");
-      const stringifiedAddress = address.toString(1);
-
-      assert.strictEqual(stringifiedAddress, "0x01");
-    });
-
     it("should stringify a 20 byte address string", () => {
-      const address = new Address("0x2104859394604359378433865360947116707876");
+      const address = Address.from(
+        "0x2104859394604359378433865360947116707876"
+      );
       const stringifiedAddress = address.toString();
 
       assert.strictEqual(
@@ -42,23 +37,18 @@ describe("@ganache/ethereum-address", () => {
 
   describe("toBuffer()", () => {
     it("should pad an address to 20 bytes", () => {
-      const address = new Address("0x1");
+      const address = Address.from("0x1");
       const bufferAddress = address.toBuffer();
       const expected = Buffer.alloc(20);
       expected[19] = 1;
 
       assert.deepStrictEqual(bufferAddress, expected);
     });
 
-    it("should truncate an address to the specified length", () => {
-      const address = new Address("0x2104859394604359378433865360947116707876");
-      const stringifiedAddress = address.toString(1);
-
-      assert.strictEqual(stringifiedAddress, "0x21");
-    });
-
     it("should convert a 20 byte address to a buffer", () => {
-      const address = new Address("0x2104859394604359378433865360947116707876");
+      const address = Address.from(
+        "0x2104859394604359378433865360947116707876"
+      );
       const bufferAddress = address.toBuffer();
       const expected = Buffer.from([
         0x21, 0x04, 0x85, 0x93, 0x94, 0x60, 0x43, 0x59, 0x37, 0x84, 0x33, 0x86,
@@ -75,4 +65,16 @@ describe("@ganache/ethereum-address", () => {
       assert.deepStrictEqual(bufferAddress, expected);
     });
   });
+
+  describe("toJSON()", () => {
+    it("should return the address as a string", () => {
+      const address = Address.from("0x1");
+      const stringifiedAddress = address.toJSON();
+
+      assert.strictEqual(
+        stringifiedAddress,
+        "0x0000000000000000000000000000000000000001"
+      );
+    });
+  });
 });

src/chains/ethereum/address/tests/index.test.ts

@@ -77,7 +77,7 @@ export class RuntimeBlock {
     parentHash: Buffer;
     difficulty: bigint;
     totalDifficulty: Buffer;
-    coinbase: { buf: Buffer; toBuffer: () => Buffer };
+    coinbase: Address;
     number: bigint;
     gasLimit: bigint;
     gasUsed: bigint;
@@ -105,7 +105,7 @@ export class RuntimeBlock {
     const coinbaseBuffer = coinbase.toBuffer();
     this.header = {
       parentHash: parentHash.toBuffer(),
-      coinbase: { buf: coinbaseBuffer, toBuffer: () => coinbaseBuffer },
+      coinbase: new Address(coinbaseBuffer),
       number: number.toBigInt(),
       difficulty: difficulty.toBigInt(),
       totalDifficulty: Quantity.toBuffer(

src/chains/ethereum/block/src/runtime-block.ts

@@ -32,7 +32,7 @@ describe("@ganache/ethereum-block", async () => {
       });
       const wallet = new Wallet(options.wallet, options.logging);
       const [from, to] = wallet.addresses;
-      const fromAddress = new Address(from);
+      const fromAddress = Address.from(from);
       const tx: Transaction = {
         type: "0x2",
         from: from,