@scallop-io/sui-scallop-sdk 2.0.13-merge-split-ve-sca-alpha.5 → 2.1.0-alpha.1

package/src/models/scallopAddress.ts

@@ -1,15 +1,15 @@
-import { API_BASE_URL, USE_TEST_ADDRESS } from 'src/constants';
-import { type NetworkType } from '@scallop-io/sui-kit';
-import type {
-  ScallopAddressParams,
-  AddressesInterface,
-  AddressStringPath,
-  ScallopAddressInstanceParams,
-} from 'src/types';
-import { ScallopCache } from './scallopCache';
-import axios, { AxiosInstance } from 'axios';
-import { TEST_ADDRESSES } from 'src/constants/testAddress';
-import { queryKeys } from 'src/constants';
+import { NetworkType } from '@scallop-io/sui-kit';
+import { API_BASE_URL, queryKeys } from 'src/constants';
+import { AddressesInterface, AddressStringPath } from 'src/types';
+import ScallopAxios, { ScallopAxiosParams } from './scallopAxios';
+
+export type ScallopAddressParams = {
+  addressId?: string;
+  addressApiUrl?: string;
+  auth?: string;
+  network?: NetworkType;
+  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
+} & ScallopAxiosParams;
 
 const EMPTY_ADDRESSES: AddressesInterface = {
   core: {
@@ -335,9 +335,6 @@ const EMPTY_ADDRESSES: AddressesInterface = {
     table: '',
     treasury: '',
     config: '',
-    subsTable: '',
-    subsTableId: '',
-    subsWhitelist: '',
   },
   referral: {
     id: '',
@@ -419,72 +416,67 @@ const EMPTY_ADDRESSES: AddressesInterface = {
   },
 };
 
-/**
- * @description
- * It provides methods for managing addresses.
- *
- * @example
- * ```typescript
- * const scallopAddress = new ScallopAddress(<parameters>);
- * scallopAddress.<address functions>();
- * await scallopAddress.<address async functions>();
- * ```
- */
+class ScallopAddress {
+  private currentAddresses?: AddressesInterface;
+  private addressId?: string;
+  private network: NetworkType;
+  private auth: string;
 
-export class ScallopAddress {
-  private readonly _auth?: string;
-  private readonly _requestClient: AxiosInstance;
+  public readonly scallopAxios: ScallopAxios;
+  private readonly addressMap = new Map<NetworkType, AddressesInterface>();
+  private readonly defaultParamValues = {
+    addressId: '67c44a103fe1b8c454eb9699',
+    network: 'mainnet' as NetworkType,
+  } as const;
 
-  private _id?: string;
-  private _network: NetworkType;
-  private _currentAddresses?: AddressesInterface;
-  private _addressesMap: Map<NetworkType, AddressesInterface>;
-  public cache: ScallopCache;
+  constructor(params: ScallopAddressParams = {}) {
+    this.scallopAxios = new ScallopAxios({
+      ...this.defaultParamValues,
+      baseUrl: params.addressApiUrl || API_BASE_URL,
+      ...params,
+    });
 
-  public constructor(
-    params: ScallopAddressParams,
-    instance?: ScallopAddressInstanceParams
-  ) {
-    const { addressId, auth, network, forceAddressesInterface } = params;
-    this.cache = instance?.cache ?? new ScallopCache(params);
+    this.network = params.network ?? 'mainnet';
+    this.addressId = params.addressId ?? this.defaultParamValues.addressId;
+    this.auth = params.auth ?? '';
 
-    this._requestClient = axios.create({
-      baseURL: API_BASE_URL,
-      headers: {
-        'Content-Type': 'application/json',
-        Accept: 'application/json',
-      },
-      timeout: 8000,
-    });
-    if (auth) this._auth = auth;
+    if (params.forceAddressesInterface) {
+      this.initializeForcedAddresses(params.forceAddressesInterface);
+    }
+  }
 
-    this._id = addressId;
-    this._network = network ?? 'mainnet';
-    this._addressesMap = USE_TEST_ADDRESS
-      ? new Map([['mainnet', TEST_ADDRESSES]])
-      : new Map();
-    if (USE_TEST_ADDRESS) this._currentAddresses = TEST_ADDRESSES;
+  private initializeForcedAddresses(
+    forcedAddresses: Partial<Record<NetworkType, AddressesInterface>>
+  ): void {
+    const validNetworks: NetworkType[] = [
+      'localnet',
+      'devnet',
+      'testnet',
+      'mainnet',
+    ];
 
-    // Set the addresses from the forceInterface if it is provided.
-    if (forceAddressesInterface) {
-      for (const [network, addresses] of Object.entries<AddressesInterface>(
-        forceAddressesInterface
-      )) {
-        if (['localnet', 'devnet', 'testnet', 'mainnet'].includes(network)) {
-          if (network === this._network) this._currentAddresses = addresses;
-          this._addressesMap.set(network as NetworkType, addresses);
+    Object.entries(forcedAddresses).forEach(([network, addresses]) => {
+      if (validNetworks.includes(network as NetworkType)) {
+        const typedNetwork = network as NetworkType;
+        this.addressMap.set(typedNetwork, addresses);
+
+        if (typedNetwork === this.network) {
+          this.currentAddresses = addresses;
         }
       }
-    }
+    });
   }
 
-  /**
-   * Get addresses API id.
-   *
-   * @return The addresses API id.
-   */
-  public getId() {
-    return this._id || undefined;
+  get axiosClient() {
+    return this.scallopAxios;
+  }
+
+  get queryClient() {
+    return this.axiosClient.queryClient;
+  }
+
+  getId() {
+    return this.addressId;
   }
 
   /**
@@ -494,7 +486,7 @@ export class ScallopAddress {
    * @return The address at the provided path.
    */
   public get(path: AddressStringPath) {
-    if (this._currentAddresses) {
+    if (this.currentAddresses) {
       const value = path
         .split('.')
         .reduce(
@@ -502,7 +494,7 @@ export class ScallopAddress {
             typeof nestedAddressObj === 'object'
               ? nestedAddressObj[key]
               : nestedAddressObj,
-          this._currentAddresses
+          this.currentAddresses
         );
       return value || undefined;
     } else {
@@ -518,7 +510,7 @@ export class ScallopAddress {
    * @return The addresses.
    */
   public set(path: AddressStringPath, address: string) {
-    if (this._currentAddresses) {
+    if (this.currentAddresses) {
       const keys = path.split('.');
       keys.reduce((nestedAddressObj: any, key: string, index) => {
         if (index === keys.length - 1) {
@@ -526,9 +518,9 @@ export class ScallopAddress {
         } else {
           return nestedAddressObj[key];
         }
-      }, this._currentAddresses);
+      }, this.currentAddresses);
     }
-    return this._currentAddresses;
+    return this.currentAddresses;
   }
 
   /**
@@ -539,11 +531,11 @@ export class ScallopAddress {
    * @return Current addresses.
    */
   public switchCurrentAddresses(network: NetworkType) {
-    if (this._addressesMap.has(network)) {
-      this._currentAddresses = this._addressesMap.get(network);
-      this._network = network;
+    if (this.addressMap.has(network)) {
+      this.currentAddresses = this.addressMap.get(network);
+      this.network = network;
     }
-    return this._currentAddresses;
+    return this.currentAddresses;
   }
 
   /**
@@ -554,9 +546,9 @@ export class ScallopAddress {
    */
   public getAddresses(network?: NetworkType) {
     if (network) {
-      return this._addressesMap.get(network);
+      return this.addressMap.get(network);
     } else {
-      return this._currentAddresses ?? this._addressesMap.get(this._network);
+      return this.currentAddresses ?? this.addressMap.get(this.network);
     }
   }
 
@@ -569,9 +561,9 @@ export class ScallopAddress {
    * @return The addresses.
    */
   public setAddresses(addresses: AddressesInterface, network?: NetworkType) {
-    const targetNetwork = network || this._network;
-    if (targetNetwork === this._network) this._currentAddresses = addresses;
-    this._addressesMap.set(targetNetwork, addresses);
+    const targetNetwork = network || this.network;
+    if (targetNetwork === this.network) this.currentAddresses = addresses;
+    this.addressMap.set(targetNetwork, addresses);
   }
 
   /**
@@ -580,7 +572,7 @@ export class ScallopAddress {
    * @return All addresses.
    */
   public getAllAddresses() {
-    return Object.fromEntries(this._addressesMap);
+    return Object.fromEntries(this.addressMap);
   }
 
   /**
@@ -602,31 +594,31 @@ export class ScallopAddress {
    * @param params.memo - Add memo to the addresses created in the API.
    * @return All addresses.
    */
-  public async create(params?: {
+  async create(params?: {
     addresses?: AddressesInterface | undefined;
     network?: NetworkType | undefined;
     auth?: string | undefined;
     memo?: string | undefined;
   }) {
     const { addresses, network, auth, memo } = params ?? {};
-    const apiKey = auth || this._auth || undefined;
-    const targetNetwork = network || this._network;
+    const apiKey = auth || this.auth || undefined;
+    const targetNetwork = network || this.network;
     const targetAddresses =
       addresses ||
-      this._currentAddresses ||
-      this._addressesMap.get(targetNetwork) ||
+      this.currentAddresses ||
+      this.addressMap.get(targetNetwork) ||
       EMPTY_ADDRESSES;
 
     if (apiKey !== undefined) {
-      this._addressesMap.clear();
+      this.addressMap.clear();
       this.setAddresses(targetAddresses, targetNetwork);
-      const response = await this._requestClient.post(
+      const response = await this.axiosClient.post(
         `/addresses`,
-        JSON.stringify({ ...Object.fromEntries(this._addressesMap), memo }),
+        JSON.stringify({ ...Object.fromEntries(this.addressMap), memo }),
         {
           headers: {
             'Content-Type': 'application/json',
-            'api-key': auth || this._auth,
+            'api-key': auth || this.auth,
           },
         }
       );
@@ -636,11 +628,11 @@ export class ScallopAddress {
           response.data
         )) {
           if (['localnet', 'devnet', 'testnet', 'mainnet'].includes(network)) {
-            if (network === this._network) this._currentAddresses = addresses;
-            this._addressesMap.set(network as NetworkType, addresses);
+            if (network === this.network) this.currentAddresses = addresses;
+            this.addressMap.set(network as NetworkType, addresses);
           }
         }
-        this._id = response.data.id;
+        this.addressId = response.data.id;
         return this.getAllAddresses();
       } else {
         throw Error('Failed to create addresses.');
@@ -656,30 +648,24 @@ export class ScallopAddress {
    * @param id - The id of the addresses to get.
    * @return All addresses.
    */
-  public async read(id?: string) {
-    const addressId = id || this._id || undefined;
+  async read(id?: string) {
+    const addressId = id || this.addressId || undefined;
     if (addressId !== undefined) {
-      const response = await this.cache.queryClient.fetchQuery({
-        queryKey: queryKeys.api.getAddresses(addressId),
-        queryFn: async () => {
-          return await this._requestClient.get(`/addresses/${addressId}`, {
-            headers: {
-              'Content-Type': 'application/json',
-            },
-          });
-        },
-      });
+      const response = await this.axiosClient.get(
+        `/addresses/${addressId}`,
+        queryKeys.api.getAddresses({ addressId }) as string[]
+      );
 
       if (response.status === 200) {
         for (const [network, addresses] of Object.entries<AddressesInterface>(
           response.data
         )) {
           if (['localnet', 'devnet', 'testnet', 'mainnet'].includes(network)) {
-            if (network === this._network) this._currentAddresses = addresses;
-            this._addressesMap.set(network as NetworkType, addresses);
+            if (network === this.network) this.currentAddresses = addresses;
+            this.addressMap.set(network as NetworkType, addresses);
           }
         }
-        this._id = response.data.id;
+        this.addressId = response.data.id;
         return this.getAllAddresses();
       } else {
         throw Error('Failed to create addresses.');
@@ -709,7 +695,7 @@ export class ScallopAddress {
    * @param params.memo - Add memo to the addresses created in the API.
    * @return All addresses.
    */
-  public async update(params?: {
+  async update(params?: {
     id?: string;
     addresses?: AddressesInterface | undefined;
     network?: NetworkType | undefined;
@@ -717,29 +703,29 @@ export class ScallopAddress {
     memo?: string | undefined;
   }) {
     const { id, addresses, network, auth, memo } = params ?? {};
-    const apiKey = auth || this._auth || undefined;
-    const targetId = id || this._id || undefined;
-    const targetNetwork = network || this._network;
+    const apiKey = auth || this.auth || undefined;
+    const targetId = id || this.addressId || undefined;
+    const targetNetwork = network || this.network;
     const targetAddresses =
       addresses ||
-      this._currentAddresses ||
-      this._addressesMap.get(targetNetwork) ||
+      this.currentAddresses ||
+      this.addressMap.get(targetNetwork) ||
       EMPTY_ADDRESSES;
 
     if (targetId === undefined)
       throw Error('Require specific addresses id to be updated.');
     if (apiKey !== undefined) {
-      if (id !== this._id) {
-        this._addressesMap.clear();
+      if (id !== this.addressId) {
+        this.addressMap.clear();
       }
       this.setAddresses(targetAddresses, targetNetwork);
-      const response = await this._requestClient.put(
+      const response = await this.axiosClient.put(
         `/addresses/${targetId}`,
-        JSON.stringify({ ...Object.fromEntries(this._addressesMap), memo }),
+        JSON.stringify({ ...Object.fromEntries(this.addressMap), memo }),
         {
           headers: {
             'Content-Type': 'application/json',
-            'api-key': auth || this._auth,
+            'api-key': auth || this.auth,
           },
         }
       );
@@ -749,11 +735,11 @@ export class ScallopAddress {
           response.data
         )) {
           if (['localnet', 'devnet', 'testnet', 'mainnet'].includes(network)) {
-            if (network === this._network) this._currentAddresses = addresses;
-            this._addressesMap.set(network as NetworkType, addresses);
+            if (network === this.network) this.currentAddresses = addresses;
+            this.addressMap.set(network as NetworkType, addresses);
           }
         }
-        this._id = response.data.id;
+        this.addressId = response.data.id;
         return this.getAllAddresses();
       } else {
         throw Error('Failed to update addresses.');
@@ -770,27 +756,24 @@ export class ScallopAddress {
    * @param id - The id of the addresses to delete.
    * @param auth - The authentication API key.
    */
-  public async delete(id?: string, auth?: string) {
-    const apiKey = auth || this._auth || undefined;
-    const targetId = id || this._id || undefined;
+  async delete(id?: string, auth?: string) {
+    const apiKey = auth || this.auth || undefined;
+    const targetId = id || this.addressId || undefined;
 
     if (targetId === undefined)
       throw Error('Require specific addresses id to be deleted.');
     if (apiKey !== undefined) {
-      const response = await this._requestClient.delete(
-        `/addresses/${targetId}`,
-        {
-          headers: {
-            'Content-Type': 'application/json',
-            'api-key': auth || this._auth,
-          },
-        }
-      );
+      const response = await this.axiosClient.delete(`/addresses/${targetId}`, {
+        headers: {
+          'Content-Type': 'application/json',
+          'api-key': auth || this.auth,
+        },
+      });
 
       if (response.status === 200) {
-        this._id = undefined;
-        this._currentAddresses = undefined;
-        this._addressesMap.clear();
+        this.addressId = undefined;
+        this.currentAddresses = undefined;
+        this.addressMap.clear();
       } else {
         throw Error('Failed to delete addresses.');
       }
@@ -799,3 +782,5 @@ export class ScallopAddress {
     }
   }
 }
+
+export default ScallopAddress;

package/src/models/scallopAxios.ts

@@ -0,0 +1,185 @@
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import { QueryKey } from '@tanstack/query-core';
+import ScallopQueryClient, {
+  ScallopQueryClientParams,
+} from './scallopQueryClient';
+
+export type ScallopAxiosParams = {
+  baseUrl?: string;
+  axiosInstance?: AxiosInstance;
+  axiosTimeout?: number;
+} & ScallopQueryClientParams;
+
+class ScallopAxios extends ScallopQueryClient {
+  public readonly axiosInstance: AxiosInstance;
+
+  constructor(params: ScallopAxiosParams = {}) {
+    super(params);
+
+    this.axiosInstance =
+      params.axiosInstance ??
+      axios.create({
+        baseURL: params.baseUrl,
+        headers: {
+          'Content-Type': 'application/json',
+          Accept: 'application/json',
+        },
+        timeout: params.axiosTimeout ?? 8000,
+      });
+  }
+
+  // Overload signatures
+  post<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    data?: D,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+  post<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    queryKey: QueryKey,
+    data?: D,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+
+  // Implementation
+  async post<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    arg2?: QueryKey | D,
+    arg3?: AxiosRequestConfig<D> | D,
+    arg4?: AxiosRequestConfig<D>
+  ): Promise<R> {
+    // Determine which overload was called
+    if (Array.isArray(arg2)) {
+      // Second argument is queryKey (post with query)
+      const queryKey = arg2;
+      const data = arg3 as D;
+      const config = arg4;
+
+      return this.queryClient.fetchQuery({
+        queryKey,
+        queryFn: () =>
+          this.axiosInstance
+            .post<T>(url, data, config)
+            .then((response) => response as R),
+      });
+    } else {
+      // Normal post
+      const data = arg2 as D;
+      const config = arg3 as AxiosRequestConfig<D>;
+
+      return this.axiosInstance.post<T>(url, data, config) as unknown as R;
+    }
+  }
+
+  // Similar overloading for get
+  get<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+  get<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    queryKey: QueryKey,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+
+  async get<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    arg2?: QueryKey | AxiosRequestConfig<D>,
+    arg3?: AxiosRequestConfig<D>
+  ): Promise<R> {
+    if (Array.isArray(arg2)) {
+      // get with query
+      const queryKey = arg2;
+      const config = arg3;
+
+      return this.queryClient.fetchQuery({
+        queryKey,
+        queryFn: () =>
+          this.axiosInstance
+            .get<T>(url, config)
+            .then((response) => response as R),
+      });
+    } else {
+      // normal get
+      const config = arg2 as AxiosRequestConfig<D>;
+      return this.axiosInstance.get<T>(url, config) as unknown as R;
+    }
+  }
+
+  // Similar overloading for put
+  put<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    data?: D,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+  put<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    queryKey: QueryKey,
+    data?: D,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+
+  async put<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    arg2?: QueryKey | D,
+    arg3?: AxiosRequestConfig<D> | D,
+    arg4?: AxiosRequestConfig<D>
+  ): Promise<R> {
+    if (Array.isArray(arg2)) {
+      // put with query
+      const queryKey = arg2;
+      const data = arg3 as D;
+      const config = arg4;
+
+      return this.queryClient.fetchQuery({
+        queryKey,
+        queryFn: () =>
+          this.axiosInstance
+            .put<T>(url, data, config)
+            .then((response) => response as R),
+      });
+    } else {
+      // normal put
+      const data = arg2 as D;
+      const config = arg3 as AxiosRequestConfig<D>;
+
+      return this.axiosInstance.put<T>(url, data, config) as unknown as R;
+    }
+  }
+
+  // Similar overloading for delete
+  delete<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+  delete<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    queryKey: QueryKey,
+    config?: AxiosRequestConfig<D>
+  ): Promise<R>;
+  async delete<T = any, R = AxiosResponse<T>, D = any>(
+    url: string,
+    arg2?: QueryKey | AxiosRequestConfig<D>,
+    arg3?: AxiosRequestConfig<D>
+  ): Promise<R> {
+    if (Array.isArray(arg2)) {
+      // delete with query
+      const queryKey = arg2;
+      const config = arg3;
+
+      return this.queryClient.fetchQuery({
+        queryKey,
+        queryFn: () =>
+          this.axiosInstance
+            .delete<T>(url, config)
+            .then((response) => response as R),
+      });
+    } else {
+      // normal delete
+      const config = arg2 as AxiosRequestConfig<D>;
+      return this.axiosInstance.delete<T>(url, config) as unknown as R;
+    }
+  }
+}
+
+export default ScallopAxios;