add authToken class (#81)

* add authToken class

* make account optional

* cleanup

* remove un-needed account

examples/sep24/sep24.ts

@@ -88,7 +88,7 @@ const createAccount = async () => {
 };
 
 // Create Deposit
-let authToken: string;
+let authToken: Types.AuthToken;
 export const runDeposit = async (anchor: Anchor, kp: SigningKeypair) => {
   console.log("\ncreating deposit ...");
   const auth = await anchor.sep10();

src/walletSdk/Anchor/Sep24.ts

@@ -87,7 +87,7 @@ export class Sep24 {
    * Initiates a withdrawal request.
    * @param {Sep24PostParams} params - The SEP-24 Post params.
    * @param {string} params.assetCode - The asset to withdraw.
-   * @param {string} params.authToken - Authentication token for the request.
+   * @param {AuthToken} params.authToken - Authentication token for the request.
    * @param {string} [params.lang] - The language for the request (defaults to the Anchor's language).
    * @param {ExtraFields} [params.extraFields] - Additional fields for the request.
    * @param {string} [params.withdrawalAccount] - The withdrawal account.
@@ -157,7 +157,7 @@ export class Sep24 {
         {
           headers: {
             "Content-Type": "application/json",
-            Authorization: `Bearer ${authToken}`,
+            Authorization: `Bearer ${authToken.token}`,
           },
         },
       );

src/walletSdk/Anchor/Sep6.ts

@@ -18,6 +18,7 @@ import {
   GetTransactionParams,
   GetTransactionsParams,
   WatcherSepType,
+  AuthToken,
 } from "../Types";
 import {
   Watcher,
@@ -76,7 +77,7 @@ export class Sep6 {
    * the anchor are given in the response.
    *
    * @param {object} options - The options for the deposit.
-   * @param {string} options.authToken - The authentication token.
+   * @param {AuthToken} options.authToken - The authentication token.
    * @param {Sep6DepositParams} options.params - The parameters for the deposit request.
    *
    * @returns {Promise<Sep6DepositResponse>} Sep6 deposit response, containing next steps if needed
@@ -88,7 +89,7 @@ export class Sep6 {
     authToken,
     params,
   }: {
-    authToken: string;
+    authToken: AuthToken;
     params: Sep6DepositParams;
   }): Promise<Sep6DepositResponse> {
     return this.flow({ type: "deposit", authToken, params });
@@ -98,7 +99,7 @@ export class Sep6 {
    * Initiates a withdrawal using SEP-6.
    *
    * @param {object} options - The options for the withdrawal operation.
-   * @param {string} options.authToken - The authentication token.
+   * @param {AuthToken} options.authToken - The authentication token.
    * @param {Sep6WithdrawParams} options.params - The parameters for the withdrawal request.
    *
    * @returns {Promise<Sep6WithdrawResponse>} Sep6 withdraw response.
@@ -107,7 +108,7 @@ export class Sep6 {
     authToken,
     params,
   }: {
-    authToken: string;
+    authToken: AuthToken;
     params: Sep6WithdrawParams;
   }): Promise<Sep6WithdrawResponse> {
     return this.flow({ type: "withdraw", authToken, params });
@@ -118,7 +119,7 @@ export class Sep6 {
    * that require an exchange.
    *
    * @param {object} options - The options for the deposit exchange.
-   * @param {string} options.authToken - The authentication token.
+   * @param {AuthToken} options.authToken - The authentication token.
    * @param {Sep6ExchangeParams} options.params - The parameters for the deposit request.
    *
    * @returns {Promise<Sep6DepositResponse>} Sep6 deposit response, containing next steps if needed
@@ -130,7 +131,7 @@ export class Sep6 {
     authToken,
     params,
   }: {
-    authToken: string;
+    authToken: AuthToken;
     params: Sep6ExchangeParams;
   }): Promise<Sep6DepositResponse> {
     return this.flow({ type: "deposit-exchange", authToken, params });
@@ -141,7 +142,7 @@ export class Sep6 {
    * that require an exchange.
    *
    * @param {object} options - The options for the deposit exchange.
-   * @param {string} options.authToken - The authentication token.
+   * @param {AuthToken} options.authToken - The authentication token.
    * @param {Sep6ExchangeParams} options.params - The parameters for the deposit request.
    *
    * @returns {Promise<Sep6WithdrawResponse>} Sep6 withdraw response, containing next steps if needed
@@ -153,7 +154,7 @@ export class Sep6 {
     authToken,
     params,
   }: {
-    authToken: string;
+    authToken: AuthToken;
     params: Sep6ExchangeParams;
   }): Promise<Sep6WithdrawResponse> {
     return this.flow({ type: "withdraw-exchange", authToken, params });
@@ -165,7 +166,7 @@ export class Sep6 {
     params,
   }: {
     type: "deposit" | "withdraw" | "deposit-exchange" | "withdraw-exchange";
-    authToken: string;
+    authToken: AuthToken;
     params: Sep6DepositParams | Sep6WithdrawParams | Sep6ExchangeParams;
   }) {
     const { transferServer } = await this.anchor.sep1();
@@ -176,7 +177,7 @@ export class Sep6 {
         {
           headers: {
             "Content-Type": "application/json",
-            Authorization: `Bearer ${authToken}`,
+            Authorization: `Bearer ${authToken.token}`,
           },
         },
       );
@@ -204,8 +205,6 @@ export class Sep6 {
    * @param {GetTransactionsParams} params - The Get Transactions params.
    * @param {AuthToken} params.authToken - The authentication token for the account authenticated with the anchor.
    * @param {string} params.assetCode - The target asset to query for.
-   * @param {string} params.account - The stellar account public key involved in the transactions. If the service requires SEP-10
-   * authentication, this parameter must match the authenticated account.
    * @param {string} [params.noOlderThan] - The response should contain transactions starting on or after this date & time.
    * @param {string} [params.limit] - The response should contain at most 'limit' transactions.
    * @param {string} [params.kind] - The kind of transaction that is desired. E.g.: 'deposit', 'withdrawal', 'depo
@@ -219,20 +218,19 @@ export class Sep6 {
   async getTransactionsForAsset({
     authToken,
     assetCode,
-    account,
     noOlderThan,
     limit,
     kind,
     pagingId,
     lang = this.anchor.language,
-  }: GetTransactionsParams & { account: string }): Promise<Sep6Transaction[]> {
+  }: GetTransactionsParams): Promise<Sep6Transaction[]> {
     const toml = await this.anchor.sep1();
     const transferServerEndpoint = toml.transferServer;
 
     // Let's convert all params to snake case for the API call
     const apiParams = camelToSnakeCaseObject({
       assetCode,
-      account,
+      account: authToken.account,
       noOlderThan,
       limit,
       kind,

src/walletSdk/Anchor/index.ts

@@ -10,7 +10,7 @@ import {
 } from "../Exceptions";
 import { Sep6 } from "./Sep6";
 import { Sep24 } from "./Sep24";
-import { AnchorServiceInfo, TomlInfo } from "../Types";
+import { AnchorServiceInfo, TomlInfo, AuthToken } from "../Types";
 import { parseToml } from "../Utils";
 
 // Let's prevent exporting this constructor type as
@@ -125,11 +125,11 @@ export class Anchor {
 
   /**
    * Create new customer object to handle customer records with the anchor using SEP-12.
-   * @param {string} authToken - The authentication token.
+   * @param {AuthToken} authToken - The authentication token.
    * @returns {Promise<Sep12>} - A Sep12 customer instance.
    * @throws {KYCServerNotFoundError} - If the KYC server information is not available.
    */
-  async sep12(authToken: string): Promise<Sep12> {
+  async sep12(authToken: AuthToken): Promise<Sep12> {
     const tomlInfo = await this.sep1();
     const kycServer = tomlInfo?.kycServer;
     if (!kycServer) {
@@ -140,10 +140,10 @@ export class Anchor {
 
   /**
    * Create new customer object to handle customer records using the `sep12` method.
-   * @param {string} authToken - The authentication token.
+   * @param {AuthToken} authToken - The authentication token.
    * @returns {Promise<Customer>} - A Customer instance.
    */
-  async customer(authToken: string): Promise<Customer> {
+  async customer(authToken: AuthToken): Promise<Customer> {
     return this.sep12(authToken);
   }
 

src/walletSdk/Auth/index.ts

@@ -147,17 +147,16 @@ export class Sep10 {
         throw new MissingTokenError();
       }
 
-      const authToken: AuthToken = resp.data.token;
-      validateToken(authToken);
+      validateToken(resp.data.token);
 
-      return authToken;
+      return AuthToken.from(resp.data.token);
     } catch (e) {
       throw new ServerRequestFailedError(e);
     }
   }
 }
 
-const validateToken = (token: AuthToken) => {
+const validateToken = (token: string) => {
   const parsedToken = decode(token);
   if (!parsedToken) {
     throw new InvalidTokenError();

src/walletSdk/Customer/index.ts

@@ -7,6 +7,7 @@ import {
   GetCustomerResponse,
   AddCustomerResponse,
   AddCustomerParams,
+  AuthToken,
 } from "../Types";
 
 /**
@@ -24,17 +25,21 @@ export class Sep12 {
   /**
    * Creates a new instance of the Sep12 class.
    * @constructor
-   * @param {string} authToken - The authentication token for authenticating with the server.
+   * @param {AuthToken} authToken - The authentication token for authenticating with the server.
    * @param {string} baseUrl - The KYC url.
    * @param {AxiosInstance} httpClient - An Axios instance for making HTTP requests.
    */
-  constructor(authToken: string, baseUrl: string, httpClient: AxiosInstance) {
+  constructor(
+    authToken: AuthToken,
+    baseUrl: string,
+    httpClient: AxiosInstance,
+  ) {
     this.authToken = authToken;
     this.baseUrl = baseUrl;
     this.httpClient = httpClient;
     this.headers = {
       "Content-Type": "application/json",
-      Authorization: `Bearer ${this.authToken}`,
+      Authorization: `Bearer ${this.authToken.token}`,
     };
   }
 
@@ -66,9 +71,9 @@ export class Sep12 {
    * Add a new customer. Customer info is given in sep9Info param. If it
    * is binary type (eg. Buffer of an image) include it in sep9BinaryInfo.
    * @param {AddCustomerParams} params - The parameters for adding a customer.
-   * @param {CustomerInfoMap} params.sep9Info - Customer information. What fields you should
+   * @param {CustomerInfoMap} [params.sep9Info] - Customer information. What fields you should
    * give is indicated by the anchor.
-   * @param {CustomerInfoMap} params.sep9BinaryInfo - Customer information that is in binary
+   * @param {CustomerInfoMap} [params.sep9BinaryInfo] - Customer information that is in binary
    * format (eg. Buffer of an image).
    * @param {string} [params.type] - The type of the customer.
    * @param {string} [params.memo] - A memo associated with the customer.
@@ -106,9 +111,9 @@ export class Sep12 {
    * Updates an existing customer. Customer info is given in sep9Info param. If it
    * is binary type (eg. Buffer of an image) include it in sep9BinaryInfo.
    * @param {AddCustomerParams} params - The parameters for adding a customer.
-   * @param {CustomerInfoMap} params.sep9Info - Customer information. What fields you should
+   * @param {CustomerInfoMap} [params.sep9Info] - Customer information. What fields you should
    * give is indicated by the anchor.
-   * @param {CustomerInfoMap} params.sep9BinaryInfo - Customer information that is in binary
+   * @param {CustomerInfoMap} [params.sep9BinaryInfo] - Customer information that is in binary
    * format (eg. Buffer of an image).
    * @param {string} [params.id] - The id of the customer.
    * @param {string} [params.type] - The type of the customer.
@@ -157,10 +162,13 @@ export class Sep12 {
    * @param {string} accountAddress - The account address of the customer to delete.
    * @param {string} [memo] - An optional memo for customer identification.
    */
-  async delete(accountAddress: string, memo?: string) {
-    await this.httpClient.delete(`${this.baseUrl}/customer/${accountAddress}`, {
-      data: { memo },
-      headers: this.headers,
-    });
+  async delete(accountAddress?: string, memo?: string) {
+    await this.httpClient.delete(
+      `${this.baseUrl}/customer/${accountAddress || this.authToken.account}`,
+      {
+        data: { memo },
+        headers: this.headers,
+      },
+    );
   }
 }

src/walletSdk/Recovery/AccountRecover.ts

@@ -236,7 +236,7 @@ export abstract class AccountRecover {
         {
           headers: {
             "Content-Type": "application/json",
-            Authorization: `Bearer ${auth.authToken}`,
+            Authorization: `Bearer ${auth.authToken.token}`,
           },
         },
       );

src/walletSdk/Recovery/index.ts

@@ -156,7 +156,7 @@ export class Recovery extends AccountRecover {
           const resp = await this.httpClient.get(requestUrl, {
             headers: {
               "Content-Type": "application/json",
-              Authorization: `Bearer ${authToken}`,
+              Authorization: `Bearer ${authToken.token}`,
             },
           });
 
@@ -288,7 +288,7 @@ export class Recovery extends AccountRecover {
             {
               headers: {
                 "Content-Type": "application/json",
-                Authorization: `Bearer ${authToken}`,
+                Authorization: `Bearer ${authToken.token}`,
               },
             },
           );

src/walletSdk/Types/anchor.ts

@@ -1,6 +1,8 @@
 import { MemoType } from "stellar-sdk";
 import { Optional } from "utility-types";
 
+import { AuthToken } from "./auth";
+
 export interface AnchorServiceInfo {
   deposit: AssetInfoMap;
   withdraw: AssetInfoMap;
@@ -101,15 +103,15 @@ export interface Payment {
 }
 
 export type GetTransactionParams = {
-  authToken: string;
+  authToken: AuthToken;
   id?: string;
   stellarTransactionId?: string;
   externalTransactionId?: string;
   lang?: string;
 };
 
 export type GetTransactionsParams = {
-  authToken: string;
+  authToken: AuthToken;
   assetCode: string;
   noOlderThan?: string;
   limit?: number;

src/walletSdk/Types/auth.ts

@@ -1,4 +1,6 @@
 import { Transaction } from "stellar-sdk";
+import { decode } from "jws";
+
 import { WalletSigner } from "../Auth/WalletSigner";
 import { AccountKeypair } from "../Horizon/Account";
 
@@ -9,7 +11,39 @@ export type AuthenticateParams = {
   clientDomain?: string;
 };
 
-export type AuthToken = string;
+export class AuthToken {
+  public token: string;
+  public issuer: string;
+  public issuedAt: string;
+  public expiresAt: string;
+  public clientDomain: string;
+  private principalAccount: string;
+
+  get account(): string {
+    return this.principalAccount.split(":")[0];
+  }
+
+  get memo(): string {
+    const split = this.principalAccount.split(":");
+    if (split.length !== 2) {
+      return null;
+    }
+    return split[1];
+  }
+
+  static from = (str: string): AuthToken => {
+    const authToken = new AuthToken();
+
+    const decoded = decode(str);
+    authToken.issuer = decoded.payload.iss;
+    authToken.principalAccount = decoded.payload.sub;
+    authToken.issuedAt = decoded.payload.iat;
+    authToken.expiresAt = decoded.payload.exp;
+    authToken.clientDomain = decoded.payload.client_domain;
+    authToken.token = str;
+    return authToken;
+  };
+}
 
 export type ChallengeParams = {
   accountKp: AccountKeypair;