feat: Adding Address Class with tests #10

erdimaden · 2024-05-14T18:59:26Z

What changed? Why?

Adding Base Address Class with tests
faucet_transaction_test.ts file name updated and removing unused import

Qualified Impact

…file name

John-peterson-coinbase · 2024-05-14T20:29:39Z

src/coinbase/address.ts

+import { AddressClient } from "./types";
+
+/**
+ * Class representing an Address in the Coinbase SDK.


Lets be consistent on information in class docs across SDK's

Reference Ruby SDK - https://github.com/coinbase/coinbase-sdk-ruby/blob/eb7326c69a67bd8d4000d3169c01e3adfd40e97d/lib/coinbase/address.rb#L11

John-peterson-coinbase · 2024-05-14T20:30:51Z

src/coinbase/address.ts

+  private client: AddressClient;
+
+  /**
+   * Creates an instance of Address.


Suggested change

* Creates an instance of Address.

* Initializes a new Address instance.

To align with User constructor documentation

John-peterson-coinbase · 2024-05-14T20:32:28Z

src/coinbase/address.ts

+  }
+
+  /**
+   * Requests faucet funds for the address.


note: only supported on testnet networks

John-peterson-coinbase · 2024-05-14T20:35:06Z

src/coinbase/address.ts

+      );
+      return new FaucetTransaction(response.data);
+    } catch (e) {
+      throw new Error(`Failed to request faucet funds`);


We should add the api response code and message to the error thrown.

I think there is a ticket for this? Let's handle this soon so we don't have to retroactively replace the temporary thrown errors in many places.

Ruby SDK Reference

Makes sense, I'm going to throw AxiosError for failed HTTP request.

src/coinbase/address.ts

src/coinbase/types.ts

src/coinbase/tests/address_test.ts

John-peterson-coinbase · 2024-05-15T14:18:00Z

src/coinbase/tests/address_test.ts

+  it("should request faucet funds and return a FaucetTransaction", async () => {
+    axiosMock.onPost().reply(200, {
+      transaction_hash: "mocked_transaction_hash",
+    });
+    const address = new Address(VALID_ADDRESS_MODEL, client);
+    const faucetTransaction = await address.faucet();
+    expect(faucetTransaction).toBeInstanceOf(FaucetTransaction);
+    expect(faucetTransaction.getTransactionHash()).toBe("mocked_transaction_hash");
+  });
+
+  it("should request faucet funds and throw an InternalError if the request does not return a transaction hash", async () => {
+    axiosMock.onPost().reply(200, {});
+    const address = new Address(VALID_ADDRESS_MODEL, client);
+    await expect(address.faucet()).rejects.toThrow("Failed to complete faucet request");
+  });
+
+  it("should throw an AxiosError if faucet request fails", async () => {
+    axiosMock.onPost().reply(400);
+    const address = new Address(VALID_ADDRESS_MODEL, client);
+    await expect(address.faucet()).rejects.toThrow("Request failed with status code 400");
+  });


Lets group these in a describe for the method. There also is a few things missing for Ruby SDK parity in these tests.

Faucet limit reached failure case

let(:tx_hash) { '0xdeadbeef' } - value for transaction hash response is different

reference

John-peterson-coinbase · 2024-05-15T14:19:57Z

src/coinbase/tests/address_test.ts

+    expect(address.getPublicKey()).toBe(newEthAddress.publicKey);
+    expect(address.getNetworkId()).toBe(VALID_ADDRESS_MODEL.network_id);
+    expect(address.getWalletId()).toBe(VALID_ADDRESS_MODEL.wallet_id);


Separate describe block tests for the getter methods?

Ruby SDK Reference

John-peterson-coinbase · 2024-05-15T14:21:54Z

src/coinbase/tests/address_test.ts

+
+  it("should request faucet funds and throw an InternalError if the request does not return a transaction hash", async () => {
+    axiosMock.onPost().reply(200, {});
+    const address = new Address(VALID_ADDRESS_MODEL, client);


these can be moved to beforeEach block

…reateAxiosMock and registerAxiosInterceptors functions - Updating Address and Coinbase class test cases

Adding Address Class with tests and updating faucet_transaction test …

fc1202e

…file name

John-peterson-coinbase reviewed May 14, 2024

View reviewed changes

erdimaden force-pushed the feat/address-class-implementation branch from c5da5d2 to f7be1d3 Compare May 14, 2024 20:56

Updating JSDocs

19563da

erdimaden force-pushed the feat/address-class-implementation branch from f7be1d3 to 19563da Compare May 14, 2024 20:57

Updating error type in types file

d52fc66

erdimaden force-pushed the feat/address-class-implementation branch from e32db61 to d52fc66 Compare May 14, 2024 21:53

Updating Address JSDoc

4cc5c7b

erdimaden force-pushed the feat/address-class-implementation branch from 54b009a to 4cc5c7b Compare May 14, 2024 22:19

Updating mock Address Model object

d7af21d

John-peterson-coinbase reviewed May 15, 2024

View reviewed changes

src/coinbase/tests/address_test.ts Outdated Show resolved Hide resolved

Updating mock value

6598071

John-peterson-coinbase reviewed May 15, 2024

View reviewed changes

erdimaden force-pushed the feat/address-class-implementation branch from bbef36f to f01cf6a Compare May 15, 2024 20:13

- Adding APIErrors Class to handle HTTP errors globally, - Creating c…

7cd9c7d

…reateAxiosMock and registerAxiosInterceptors functions - Updating Address and Coinbase class test cases

erdimaden force-pushed the feat/address-class-implementation branch from f01cf6a to 7cd9c7d Compare May 15, 2024 20:14

John-peterson-coinbase approved these changes May 15, 2024

View reviewed changes

erdimaden merged commit b34089d into master May 15, 2024
4 checks passed

erdimaden deleted the feat/address-class-implementation branch June 21, 2024 18:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding Address Class with tests #10

feat: Adding Address Class with tests #10

erdimaden commented May 14, 2024

John-peterson-coinbase May 14, 2024

John-peterson-coinbase May 14, 2024

John-peterson-coinbase May 14, 2024

John-peterson-coinbase May 14, 2024

John-peterson-coinbase May 14, 2024

erdimaden May 14, 2024

John-peterson-coinbase May 15, 2024

John-peterson-coinbase May 15, 2024

John-peterson-coinbase May 15, 2024

	* Creates an instance of Address.
	* Initializes a new Address instance.

feat: Adding Address Class with tests #10

feat: Adding Address Class with tests #10

Conversation

erdimaden commented May 14, 2024

What changed? Why?

Qualified Impact

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment