Refactoring Clients usage #20
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,48 @@ | ||
| import { Address } from "./../address"; | ||
| import { FaucetTransaction } from "./../faucet_transaction"; | ||
|
|
||
| import Decimal from "decimal.js"; | ||
| import { APIError, FaucetLimitReachedError } from "../api_error"; | ||
| import { Coinbase } from "../coinbase"; | ||
| import { InternalError } from "../errors"; | ||
| import { | ||
| VALID_ADDRESS_BALANCE_LIST, | ||
| VALID_ADDRESS_MODEL, | ||
| addressesApiMock, | ||
| generateRandomHash, | ||
| mockFn, | ||
| mockReturnRejectedValue, | ||
| } from "./utils"; | ||
|
|
||
| // Test suite for Address class | ||
| describe("Address", () => { | ||
| const transactionHash = generateRandomHash(); | ||
| let address: Address, balanceModel; | ||
|
|
||
| beforeAll(() => { | ||
| Coinbase.apiClients.address = addressesApiMock; | ||
| Coinbase.apiClients.address!.getAddressBalance = mockFn(request => { | ||
| const { asset_id } = request; | ||
| balanceModel = { | ||
| amount: "1000000000000000000", | ||
| asset: { | ||
| asset_id, | ||
| network_id: Coinbase.networkList.BaseSepolia, | ||
| }, | ||
| }; | ||
| return { data: balanceModel }; | ||
| }); | ||
| Coinbase.apiClients.address!.listAddressBalances = mockFn(() => { | ||
| return { data: VALID_ADDRESS_BALANCE_LIST }; | ||
| }); | ||
| Coinbase.apiClients.address!.requestFaucetFunds = mockFn(() => { | ||
| return { data: { transaction_hash: transactionHash } }; | ||
| }); | ||
| }); | ||
|
Comment on lines
+24
to
+40
There was a problem hiding this comment. why are these in the There was a problem hiding this comment. Sure, I moved this |
||
|
|
||
| beforeEach(() => { | ||
| address = new Address(VALID_ADDRESS_MODEL); | ||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| it("should initialize a new Address", () => { | ||
|
|
@@ -101,85 +58,107 @@ describe("Address", () => { | |
| }); | ||
|
|
||
| it("should return the correct list of balances", async () => { | ||
| const balances = await address.listBalances(); | ||
| expect(balances.get(Coinbase.assetList.Eth)).toEqual(new Decimal(1)); | ||
| expect(balances.get("usdc")).toEqual(new Decimal(5000)); | ||
| expect(balances.get("weth")).toEqual(new Decimal(3)); | ||
| expect(Coinbase.apiClients.address!.listAddressBalances).toHaveBeenCalledWith( | ||
| address.getWalletId(), | ||
| address.getId(), | ||
| ); | ||
| expect(Coinbase.apiClients.address!.listAddressBalances).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should return the correct ETH balance", async () => { | ||
| const ethBalance = await address.getBalance(Coinbase.assetList.Eth); | ||
| expect(ethBalance).toBeInstanceOf(Decimal); | ||
| expect(ethBalance).toEqual(new Decimal(1)); | ||
| expect(Coinbase.apiClients.address!.getAddressBalance).toHaveBeenCalledWith( | ||
| address.getWalletId(), | ||
| address.getId(), | ||
| Coinbase.assetList.Eth, | ||
| ); | ||
| expect(Coinbase.apiClients.address!.getAddressBalance).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should return the correct Gwei balance", async () => { | ||
| const assetId = "gwei"; | ||
| const ethBalance = await address.getBalance(assetId); | ||
| expect(ethBalance).toBeInstanceOf(Decimal); | ||
| expect(ethBalance).toEqual(new Decimal(1000000000)); | ||
| expect(Coinbase.apiClients.address!.getAddressBalance).toHaveBeenCalledWith( | ||
| address.getWalletId(), | ||
| address.getId(), | ||
| assetId, | ||
| ); | ||
| expect(Coinbase.apiClients.address!.getAddressBalance).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should return the correct Wei balance", async () => { | ||
| const assetId = "wei"; | ||
| const ethBalance = await address.getBalance(assetId); | ||
| expect(ethBalance).toBeInstanceOf(Decimal); | ||
| expect(ethBalance).toEqual(new Decimal(1000000000000000000)); | ||
| expect(Coinbase.apiClients.address!.getAddressBalance).toHaveBeenCalledWith( | ||
| address.getWalletId(), | ||
| address.getId(), | ||
| assetId, | ||
| ); | ||
| expect(Coinbase.apiClients.address!.getAddressBalance).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should return an error for an unsupported asset", async () => { | ||
| const getAddressBalance = jest.fn().mockRejectedValue(new APIError("")); | ||
| const assetId = "unsupported-asset"; | ||
|
There was a problem hiding this comment. Mixed usage of jest.fn() and There was a problem hiding this comment. good catch! I'm updating. |
||
| Coinbase.apiClients.address!.getAddressBalance = getAddressBalance; | ||
| await expect(address.getBalance(assetId)).rejects.toThrow(APIError); | ||
| expect(getAddressBalance).toHaveBeenCalledWith(address.getWalletId(), address.getId(), assetId); | ||
| expect(getAddressBalance).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
Comment on lines
+115
to
+116
There was a problem hiding this comment. To create tests similar to the ones in Ruby, I've added toHaveBeenCalledWith and toHaveBeenCalledTimes assertions. Reference: https://github.com/coinbase/coinbase-sdk-ruby/blob/master/spec/unit/coinbase/address_spec.rb#L94 |
||
|
|
||
| it("should return the wallet ID", () => { | ||
| expect(address.getWalletId()).toBe(VALID_ADDRESS_MODEL.wallet_id); | ||
| }); | ||
|
|
||
| it("should throw an InternalError when model is not provided", () => { | ||
| expect(() => new Address(null!)).toThrow(`Address model cannot be empty`); | ||
| }); | ||
|
|
||
| it("should request funds from the faucet and returns the faucet transaction", async () => { | ||
| const faucetTransaction = await address.faucet(); | ||
| expect(faucetTransaction).toBeInstanceOf(FaucetTransaction); | ||
| expect(faucetTransaction.getTransactionHash()).toBe(transactionHash); | ||
| expect(Coinbase.apiClients.address!.requestFaucetFunds).toHaveBeenCalledWith( | ||
| address.getWalletId(), | ||
| address.getId(), | ||
| ); | ||
| expect(Coinbase.apiClients.address!.requestFaucetFunds).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should throw an APIError when the request is unsuccesful", async () => { | ||
| Coinbase.apiClients.address!.requestFaucetFunds = mockReturnRejectedValue(new APIError("")); | ||
| await expect(address.faucet()).rejects.toThrow(APIError); | ||
| expect(Coinbase.apiClients.address!.requestFaucetFunds).toHaveBeenCalledWith( | ||
| address.getWalletId(), | ||
| address.getId(), | ||
| ); | ||
| expect(Coinbase.apiClients.address!.requestFaucetFunds).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should throw a FaucetLimitReachedError when the faucet limit is reached", async () => { | ||
| Coinbase.apiClients.address!.requestFaucetFunds = mockReturnRejectedValue( | ||
| new FaucetLimitReachedError(""), | ||
| ); | ||
| await expect(address.faucet()).rejects.toThrow(FaucetLimitReachedError); | ||
| expect(Coinbase.apiClients.address!.requestFaucetFunds).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should throw an InternalError when the request fails unexpectedly", async () => { | ||
| Coinbase.apiClients.address!.requestFaucetFunds = mockReturnRejectedValue( | ||
| new InternalError(""), | ||
| ); | ||
| await expect(address.faucet()).rejects.toThrow(InternalError); | ||
| expect(Coinbase.apiClients.address!.requestFaucetFunds).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it("should return the correct string representation", () => { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Coinbase.apiClients is now globally accessible, so there's no need to pass clients to the Model class anymore.