Added ability to get private key for WalletAddress and updated yarn.lock file (#213)

* Added ability to get private key for WalletAddress and updated yarn.lock file

* Add semicolon

* update

* Refactored tests

* lint

* address feedback

* Changes

Author: rohan-agarwal-coinbase

CHANGELOG.md

@@ -5,13 +5,14 @@
 ### Added
 
 - Add support for list address transactions.
+- Add support for exporting the private key of a `WalletAddress`
 
 ## [0.2.0]
 
 ### Added
 
 - USDC Faucet support on Base Sepolia
-- Improved error mesasges for `InternalError`
+- Improved error messages for `InternalError`
 
 ## [0.1.1] - 2024-08-27
 

src/coinbase/address/wallet_address.ts

@@ -74,6 +74,19 @@ export class WalletAddress extends Address {
     this.key = key;
   }
 
+  /**
+   * Exports the Address's private key to a hex string.
+   *
+   * @returns The Address's private key as a hex string. 
+   */
+  public export() {
+    if (this.key === undefined) {
+      throw new Error("Private key is not set");
+    }
+
+    return this.key.privateKey;
+  }
+
   /**
    * Returns whether the Address has a private key backing it to sign transactions.
    *

src/tests/wallet_address_test.ts

@@ -260,6 +260,38 @@ describe("WalletAddress", () => {
     );
   });
 
+  describe("#setKey", () => {
+    it("should set the key successfully", () => {
+      key = ethers.Wallet.createRandom();
+      const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, undefined);
+      expect(() => {
+        newAddress.setKey(key);
+      }).not.toThrow(Error);
+    });
+    it("should not set the key successfully", () => {
+      key = ethers.Wallet.createRandom();
+      const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, key);
+      expect(() => {
+        newAddress.setKey(key);
+      }).toThrow(Error);
+    });
+  });
+
+  describe("#export", () => {
+    it("should get the private key if it is set", () => {
+      key = ethers.Wallet.createRandom();
+      const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, key);
+      expect(newAddress.export()).toEqual(key.privateKey);
+    });
+
+    it("should not get the private key if not set", () => {
+      const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, undefined);
+      expect(() => { 
+        newAddress.export();
+      }).toThrow(Error);
+    });
+  });
+
   describe("#stakingOperation", () => {
     key = ethers.Wallet.createRandom();
     const newAddress = newAddressModel("", randomUUID(), Coinbase.networks.EthereumHolesky);
@@ -1071,23 +1103,6 @@ describe("WalletAddress", () => {
         ).rejects.toThrow(Error);
       });
     });
-
-    describe("#setKey", () => {
-      it("should set the key successfully", () => {
-        key = ethers.Wallet.createRandom();
-        const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, undefined);
-        expect(() => {
-          newAddress.setKey(key);
-        }).not.toThrow(Error);
-      });
-      it("should not set the key successfully", () => {
-        key = ethers.Wallet.createRandom();
-        const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, key);
-        expect(() => {
-          newAddress.setKey(key);
-        }).toThrow(Error);
-      });
-    });
   });
 
   describe("#createPayloadSignature", () => {