feat: refactor code

Author: andysim3d

account-kit/java/signer-sdk/pom.xml

@@ -173,30 +173,7 @@
           </execution>
         </executions>
       </plugin>
-
-      <plugin>
-        <groupId>io.github.git-commit-id</groupId>
-        <artifactId>git-commit-id-maven-plugin</artifactId>
-        <version>5.0.0</version>
-        <executions>
-          <execution>
-            <id>get-the-git-infos</id>
-            <goals>
-              <goal>revision</goal>
-            </goals>
-            <phase>initialize</phase>
-          </execution>
-        </executions>
-        <configuration>
-          <generateGitPropertiesFile>true</generateGitPropertiesFile>
-          <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
-          <includeOnlyProperties>
-            <includeOnlyProperty>^git.build.(time|version)$</includeOnlyProperty>
-            <includeOnlyProperty>^git.commit.id.(abbrev|full)$</includeOnlyProperty>
-          </includeOnlyProperties>
-          <commitIdGenerationMode>full</commitIdGenerationMode>
-        </configuration>
-      </plugin>
+      
       <plugin>
         <groupId>com.hubspot.maven.plugins</groupId>
         <artifactId>prettier-maven-plugin</artifactId>

account-kit/java/signer-sdk/src/main/java/com/alchemy/aa/client/HttpConfig.java

@@ -1,7 +1,19 @@
 package com.alchemy.aa.client;
 
+/**
+ * Http configuration for signer client
+ *
+ * @param apiKey apiKey to call alchemy api
+ * @param url    alchemy api url
+ */
 public record HttpConfig(String apiKey, String url) {
+  /**
+   * default HttpConfig with only alchemy url
+   * @param apiKey apiKey to call alchemy api
+   */
   public HttpConfig(String apiKey) {
     this(apiKey, "https://api.g.alchemy.com/signer/v1/");
   }
+
+
 }

account-kit/java/signer-sdk/src/main/java/com/alchemy/aa/client/SignerClient.java

@@ -1,18 +1,17 @@
 package com.alchemy.aa.client;
 
-import com.alchemy.aa.Stamper;
-import com.alchemy.aa.Stamper.Stamp;
-import com.alchemy.aa.client.api.AuthJWT.Request;
+import com.alchemy.aa.client.api.AuthJWT;
 import com.alchemy.aa.client.api.AuthJWT.Response;
-import com.alchemy.aa.client.api.AuthUser;
-import com.alchemy.aa.client.api.AuthUser.TurnKeyWhoAmIRequest;
-import com.alchemy.aa.client.api.AuthUser.WhoAmIRequest;
-import com.alchemy.aa.client.api.SignRawMessage.SignParameters;
-import com.alchemy.aa.client.api.SignRawMessage.SignRawMessageRequest;
-import com.alchemy.aa.client.api.SignRawMessage.SignedResponse;
-import com.alchemy.aa.client.api.SignRawMessage.SigningBody;
+import com.alchemy.aa.client.api.SignMessage;
+import com.alchemy.aa.client.api.SignMessage.SignBody;
+import com.alchemy.aa.client.api.SignMessage.SignParameters;
 import com.alchemy.aa.client.api.StampedRequest;
+import com.alchemy.aa.client.api.WhoAmI;
+import com.alchemy.aa.client.api.WhoAmI.RawWhoAmIRequest;
+import com.alchemy.aa.client.api.WhoAmI.Request;
 import com.alchemy.aa.core.CredentialBundle;
+import com.alchemy.aa.core.Stamper;
+import com.alchemy.aa.core.Stamper.Stamp;
 import com.alchemy.aa.core.TekManager;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectWriter;
@@ -43,7 +42,7 @@ public record User(
   private enum PathName {
     LOOKUP("lookup"),
     AUTH("auth"),
-    AUTH_JWT("auth-jwt"),
+    AUTH_JWT("auth-JWT"),
     WHOAMI("whoami"),
     SIGN_PAYLOAD("sign-payload");
 
@@ -77,7 +76,7 @@ public SignerClient(HttpConfig httpConfig) {
    *
    * @throws Exception
    */
-  public Stamper authenticateWithBundle(
+  public UserStamper authenticateWithBundle(
     TekManager tekManager,
     String orgId,
     String bundle
@@ -90,18 +89,24 @@ public Stamper authenticateWithBundle(
 
     Stamper stamper = new Stamper(credentialBundle);
     User user = authUser(stamper, orgId);
-    stamper.setUser(user);
-    return stamper;
+    return new UserStamper(user, stamper);
   }
 
-  public Stamper authenticateWithJWT(
+  /**
+   * Authticate user with JWT and get a stamper
+   * @param tekManager client's tek keys
+   * @param JWT JWT token
+   * @param authProviderName auth provider
+   * @return authenticated user
+   * @throws Exception if JWT and tekManager mis match
+   */
+  public UserStamper authenticateWithJWT(
     TekManager tekManager,
-    String jwt,
-    String authProviderName,
-    int expirationInSeconds
+    String JWT,
+    String authProviderName
   ) throws Exception {
-    Request request = Request.builder()
-      .jwt(jwt)
+    AuthJWT.Request request = AuthJWT.Request.builder()
+      .jwt(JWT)
       .authProvider(authProviderName)
       .targetPublicKey(tekManager.publicKey())
       .build();
@@ -129,12 +134,12 @@ public Stamper authenticateWithJWT(
    * @param address
    *            signer's address.
    *
-   * @return signed data in bytes.
+   * @return signature in string.
    *
    * @throws Exception
    */
   public String signRawMessage(
-    Stamper stamper,
+    UserStamper userStamper,
     Bytes msg,
     String hashFunction,
     String address
@@ -146,53 +151,51 @@ public String signRawMessage(
       .signWith(address)
       .build();
 
-    SigningBody body = SigningBody.builder()
-      .organizationId(stamper.getUser().orgId)
+    SignBody body = SignBody.builder()
+      .organizationId(userStamper.user().orgId)
       .type("ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2")
       .timestampMs(String.valueOf(Instant.now().toEpochMilli()))
       .parameters(signParameters)
       .build();
 
     String jsonBody = mapper.writeValueAsString(body);
 
-    Stamp stamp = stamper.stamp(jsonBody);
+    Stamp stamp = userStamper.stamper().stamp(jsonBody);
     StampedRequest stampedRequest = StampedRequest.builder()
       .url("https://api.turnkey.com/public/v1/submit/sign_raw_payload")
       .body(jsonBody)
       .stamp(stamp)
       .build();
-    SignRawMessageRequest request = new SignRawMessageRequest(stampedRequest);
-    SignedResponse response = request(
+    SignMessage.Request request = new SignMessage.Request(stampedRequest);
+    SignMessage.Response response = request(
       PathName.SIGN_PAYLOAD.getName(),
       request,
-      SignedResponse.class
+      SignMessage.Response.class
     );
     return response.signature();
   }
 
   /**
    * Sign a Solana transcation.
-   *
-   * @param txBytes
-   *            transaction bytes
-   *
-   * @return signature
-   *
+   * @param stamper stamper to sign
+   * @param txBytes transaction bytes
+   * @return signature in string
    * @throws Exception
    */
-  public String signSolanaTx(Stamper stamper, Bytes txBytes) throws Exception {
+  public String signSolanaTx(UserStamper stamper, Bytes txBytes)
+    throws Exception {
     return signRawMessage(
       stamper,
       txBytes,
       "HASH_FUNCTION_NOT_APPLICABLE",
-      stamper.getUser().solanaAddress
+      stamper.user().solanaAddress
     );
   }
 
   /**
    * Sign an Eth transaction.
    *
-   * @param stamper
+   * @param userStamper
    *            stamper to stamp transaction
    * @param txBytes
    *            keccack256 hashed transaction byte
@@ -201,12 +204,13 @@ public String signSolanaTx(Stamper stamper, Bytes txBytes) throws Exception {
    *
    * @throws Exception
    */
-  public String signEthTx(Stamper stamper, Bytes txBytes) throws Exception {
+  public String signEthTx(UserStamper userStamper, Bytes txBytes)
+    throws Exception {
     return signRawMessage(
-      stamper,
+      userStamper,
       txBytes,
       "HASH_FUNCTION_NO_OP",
-      stamper.getUser().address
+      userStamper.user().address
     );
   }
 
@@ -219,23 +223,21 @@ public String signEthTx(Stamper stamper, Bytes txBytes) throws Exception {
    *
    * @throws Exception
    */
-  private User authUser(Stamper stamper, String orgId) throws Exception {
-    WhoAmIRequest whoAmIRequest = new WhoAmIRequest(orgId);
+  private User authUser(Stamper Stamper, String orgId) throws Exception {
+    RawWhoAmIRequest rawWhoAmIRequest = new RawWhoAmIRequest(orgId);
     ObjectWriter writer = mapper.writerWithDefaultPrettyPrinter();
-    String json_body = writer.writeValueAsString(whoAmIRequest);
-    Stamp stampedBody = stamper.stamp(json_body);
+    String json_body = writer.writeValueAsString(rawWhoAmIRequest);
+    Stamp stampedBody = Stamper.stamp(json_body);
     StampedRequest stampedRequestrequest = StampedRequest.builder()
       .url("https://api.whoami.com/v1/users/")
       .body(json_body)
       .stamp(stampedBody)
       .build();
-    TurnKeyWhoAmIRequest request = new TurnKeyWhoAmIRequest(
-      stampedRequestrequest
-    );
-    AuthUser.Response response = request(
+    Request request = new Request(stampedRequestrequest);
+    WhoAmI.Response response = request(
       PathName.WHOAMI.getName(),
       request,
-      AuthUser.Response.class
+      WhoAmI.Response.class
     );
     return User.builder()
       .address(response.address())

account-kit/java/signer-sdk/src/main/java/com/alchemy/aa/client/UserStamper.java

@@ -0,0 +1,11 @@
+package com.alchemy.aa.client;
+
+import com.alchemy.aa.client.SignerClient.User;
+import com.alchemy.aa.core.Stamper;
+
+/**
+ * A packet of user and stamper
+ * @param user Authed user
+ * @param stamper stamper of the user
+ */
+public record UserStamper(User user, Stamper stamper) {}

account-kit/java/signer-sdk/src/main/java/com/alchemy/aa/client/api/AuthJWT.java

@@ -3,15 +3,33 @@
 import java.util.Optional;
 import lombok.Builder;
 
+/**
+ * Types of Alchemy auth-jwt api
+ */
 public class AuthJWT {
 
+  /**
+   * Request type of auth-jwt
+   * @param jwt jwt token
+   * @param authProvider auth provider name
+   * @param targetPublicKey Turnkey public key for which cred bundle is issued.
+   */
   @Builder
   public record Request(
     String jwt,
     String authProvider,
     String targetPublicKey
   ) {}
 
+  /**
+   * Response type of auth-jwt
+   * @param isSignUp indicating whether it was a sign-up/pre-generated
+   * @param orgId org id for user
+   * @param credentialBundle a credential bundle returned by KMS, used by the client to sign messages after
+   * @param userId userId of the user
+   * @param address evm wallet address
+   * @param solanaAddress solana wallet address
+   */
   public record Response(
     boolean isSignUp,
     String orgId,

account-kit/java/signer-sdk/src/main/java/com/alchemy/aa/client/api/AuthUser.java

@@ -0,0 +1,55 @@
+package com.alchemy.aa.client.api;
+
+import lombok.Builder;
+
+///
+
+/**
+ * Types of Alchemy signmessage api
+ * https://docs.alchemy.com/reference/signmessage
+ */
+public class SignMessage {
+
+  /**
+   * Sign parameter
+   * @param encoding payload encoding method
+   * @param hashFunction signature hash function
+   * @param payload payload to sign
+   * @param signWith wallet address to sign payload
+   */
+  @Builder
+  public record SignParameters(
+    String encoding,
+    String hashFunction,
+    String payload,
+    String signWith
+  ) {}
+
+  /**
+   * Sign body
+   * @param organizationId org id to identify the signer
+   * @param type sign type. Always "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"
+   * @param timestampMs timestamp to sign
+   * @param parameters sign parameter above
+   */
+  @Builder
+  public record SignBody(
+    String organizationId,
+    String type,
+    String timestampMs,
+    SignParameters parameters
+  ) {}
+
+  /**
+   * Request type of signmessage
+   * @param stampedRequest stapmed signmessage request
+   */
+  @Builder
+  public record Request(StampedRequest stampedRequest) {}
+
+  /**
+   * Response type of signmessage
+   * @param signature signature
+   */
+  public record Response(String signature) {}
+}