docs: Fullnode Typings [10] - Version retrieval (#1012)

Author: tuliomir

src/api/version.js

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) Hathor Labs and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { createRequestInstance } from './axiosInstance';
+import { ApiVersion } from '../types';
+
+/**
+ * Api calls for version
+ *
+ * @namespace ApiVersion
+ */
+
+const versionApi = {
+  /**
+   * Get version of full node running in connected server
+   *
+   * @param resolve Method to be called after response arrives
+   *
+   * @deprecated Use asyncGetVersion instead
+   * @return Promise that resolves to void (result is passed through callback)
+   * @memberof ApiVersion
+   * @inner
+   */
+  // TODO: This method uses a callback pattern but also returns a Promise, which is an anti-pattern
+  // NOTE: createRequestInstance has legacy typing (resolve?: null) that doesn't match actual usage.
+  getVersion(resolve: (data: ApiVersion) => void) {
+    return createRequestInstance(resolve as unknown as null)
+      .get<ApiVersion>(`version`)
+      .then(
+        res => {
+          resolve(res.data);
+        },
+        res => {
+          return Promise.reject(res);
+        }
+      );
+  },
+
+  /**
+   * Get version of full node running in connected server
+   *
+   * @return Promise resolving to the version data
+   * @memberof ApiVersion
+   * @inner
+   */
+  async asyncGetVersion(): Promise<ApiVersion> {
+    // FIXME: This function wraps a Promise around another Promise, which is an anti-pattern.
+    return new Promise((resolve, reject) => {
+      // NOTE: createRequestInstance has legacy typing (resolve?: null) that doesn't match actual usage.
+      createRequestInstance(resolve as unknown as null)
+        .get<ApiVersion>(`version`)
+        .then(
+          res => {
+            resolve(res.data);
+          },
+          err => {
+            reject(err);
+          }
+        );
+    });
+  },
+};
+
+export default versionApi;

src/api/version.ts

@@ -55,6 +55,7 @@ import {
 import { ErrorMessages } from '../errorMessages';
 import P2SHSignature from '../models/p2sh_signature';
 import {
+  ApiVersion,
   AddressScanPolicyData,
   AuthorityType,
   FullNodeVersionData,
@@ -448,8 +449,8 @@ class HathorWallet extends EventEmitter {
    * */
   // eslint-disable-next-line class-methods-use-this -- The server address is fetched directly from the configs
   async getVersionData(): Promise<FullNodeVersionData> {
-    const versionData: any = await new Promise((resolve, reject) => {
-      versionApi.getVersion(resolve).catch((error: any) => reject(error));
+    const versionData: ApiVersion = await new Promise((resolve, reject) => {
+      versionApi.getVersion(resolve).catch(error => reject(error));
     });
 
     return {
@@ -1612,7 +1613,7 @@ class HathorWallet extends EventEmitter {
    *   'password': password to decrypt xpriv information. Required if not set in object.
    *  }
    */
-  async start(optionsParams: any = {}): Promise<any> {
+  async start(optionsParams: any = {}): Promise<ApiVersion> {
     const options: any = { pinCode: null, password: null, ...optionsParams };
     const pinCode: any = options.pinCode || this.pinCode;
     const password: any = options.password || this.password;
@@ -1672,7 +1673,7 @@ class HathorWallet extends EventEmitter {
     this.walletStopped = false;
     this.setState(HathorWallet.CONNECTING);
 
-    const info = await new Promise((resolve, reject) => {
+    const info = await new Promise<ApiVersion>((resolve, reject) => {
       versionApi.getVersion(resolve).catch(error => reject(error));
     });
     if (info.network.indexOf(this.conn.network) >= 0) {

src/new/wallet.ts

@@ -481,7 +481,8 @@ export interface IFillTxOptions {
 export interface ApiVersion {
   version: string;
   network: string;
-  // min_weight: number; // DEPRECATED
+  /** @deprecated */
+  min_weight: number;
   min_tx_weight: number;
   min_tx_weight_coefficient: number;
   min_tx_weight_k: number;