Adding initial version of Coinbase Class #8

erdimaden · 2024-05-13T22:01:26Z

What changed? Why?

Adding initial version of Coinbase Class. I will have more update in my second PR

src/coinbase/coinbase.ts

src/coinbase/tests/config/coinbase_cloud_api_key.json

src/coinbase/coinbase.ts

John-peterson-coinbase · 2024-05-13T22:37:21Z

src/coinbase/user.ts

+export class User {
+  private userId: string = "";
+  private client: ApiClients;
+
+  constructor(userId: string, client: ApiClients) {
+    this.userId = userId;
+    this.client = client;
+  }


Should (User, Wallet, Address etc..) classes create member vars for each of their respective fields or should the class encapsulate the generated model (UserModel) and use the model to retrieve field values in the getters?

The diff would be roughly:

Suggested change

export class User {

private userId: string = "";

private client: ApiClients;

constructor(userId: string, client: ApiClients) {

this.userId = userId;

this.client = client;

}

import { User as UserModel } from "../clients/api");

export class User {

private model: UserModel;

private client: ApiClients;

constructor(model: UserModel, client: ApiClients) {

this.model = model;

this.client = client;

}

public getUserId(): string {

return this.model.user_id:

}

This seems a bit cleaner especially for classes such as Address and Transfer where we would be duplicating / redeclaring lots of fields otherwise and is more similar to what we do with the Ruby SDK.

Curious everyone's thoughts here! @erdimaden @yuga-cb @alex-stone

While I appreciate the use of a generated model, I personally lean towards including fields within the same class. This approach can help reduce dependency on the generated code and provide more control over modifications that might arise from changes in the generated code

We should not deviate approaches between SDKs. Please use and delegate to the generated model. If we don't think that is the right solution, then we should evaluate that holistically for both the JS and Ruby SDK.

Co-authored-by: John-peterson-coinbase <[email protected]>

src/coinbase/coinbase.ts

yuga-cb · 2024-05-14T00:37:34Z

src/coinbase/coinbase.ts

+import { ApiClients } from "./types";
+import { User } from "./user";
+
+// The Coinbase SDK.


When do we use // and when do we use /* style comments? Let's have some consistency around this

I added "multiline-comment-style": ["error", "starred-block"], to eslint so with this configuration:

we use // for single-line comments.
we use /* */ for multi-line comments with a starred block style.

https://eslint.org/docs/latest/rules/multiline-comment-style

src/coinbase/coinbase.ts

src/coinbase/tests/config/coinbase_cloud_api_key.json

yuga-cb · 2024-05-14T00:41:06Z

src/coinbase/types.ts

+import { AxiosPromise } from "axios";
+import { User as UserModel } from "./../client/api";
+
+export type UserAPIClient = { getCurrentUser(options?): AxiosPromise<UserModel> };


src/coinbase/types.ts

src/coinbase/user.ts

John-peterson-coinbase · 2024-05-14T16:18:00Z

src/coinbase/errors.ts

+  }
+}
+
+export class InvalidConfiguration extends Error {


I have a ticket for Errors but I will add JSDocs for the existing classes
https://jira.coinbase-corp.com/browse/PSDK-115

John-peterson-coinbase · 2024-05-14T16:18:06Z

src/coinbase/errors.ts

+  }
+}
+
+export class InternalError extends Error {


John-peterson-coinbase · 2024-05-14T16:18:12Z

src/coinbase/errors.ts

+export class InvalidAPIKeyFormat extends Error {
+  static DEFAULT_MESSAGE = "Invalid API key format";
+
+  constructor(message: string = InvalidAPIKeyFormat.DEFAULT_MESSAGE) {


John-peterson-coinbase · 2024-05-14T16:18:19Z

src/coinbase/errors.ts

-export const InvalidConfiguration = new Error("Invalid configuration");
-export const InvalidAPIKeyFormat = new Error("Invalid format of API private key");
-export const InternalError = new Error(`Internal Error`);
+export class InvalidAPIKeyFormat extends Error {


John-peterson-coinbase · 2024-05-14T16:18:56Z

src/coinbase/coinbase.ts

+    debugging = false,
+    basePath: string = BASE_PATH,
+  ) {
+    if (apiKeyName === "" || privateKey === "") {


lets explicitly say which one is empty?

John-peterson-coinbase · 2024-05-14T16:20:06Z

src/coinbase/errors.ts

+export class InternalError extends Error {
+  static DEFAULT_MESSAGE = "Internal Error";
+
+  constructor(message: string = InternalError.DEFAULT_MESSAGE) {


John-peterson-coinbase · 2024-05-14T16:20:17Z

src/coinbase/errors.ts

+export class InvalidConfiguration extends Error {
+  static DEFAULT_MESSAGE = "Invalid configuration";
+
+  constructor(message: string = InvalidConfiguration.DEFAULT_MESSAGE) {


John-peterson-coinbase · 2024-05-14T16:21:03Z

src/coinbase/user.ts

+  private model: UserModel;
+  private client: ApiClients;
+
+  constructor(user: UserModel, client: ApiClients) {


John-peterson-coinbase · 2024-05-14T16:21:16Z

src/coinbase/user.ts

+    this.model = user;
+  }
+
+  public getUserId(): string {


John-peterson-coinbase · 2024-05-14T16:21:23Z

src/coinbase/user.ts

+    return this.model.id;
+  }
+
+  toString(): string {


John-peterson-coinbase · 2024-05-14T16:28:43Z

src/coinbase/user.ts

+    this.model = user;
+  }
+
+  public getUserId(): string {


Suggested change

public getUserId(): string {

public getId(): string {

Adding initial version of Coinbase Class

623997a

erdimaden marked this pull request as ready for review May 13, 2024 22:01

erdimaden requested a review from John-peterson-coinbase May 13, 2024 22:28

John-peterson-coinbase reviewed May 13, 2024

View reviewed changes

erdimaden and others added 2 commits May 13, 2024 18:23

Update src/coinbase/coinbase.ts

60a7953

Co-authored-by: John-peterson-coinbase <[email protected]>

adding JSON config changes

744560b