@xchainjs/xchain-thornode 0.1.2 → 0.1.3

package/README.md

@@ -27,6 +27,23 @@ Request data from MimirApi
   const mimirResponse = await mimirApi.mimir()
   console.log(mimirResponse.data)
 
+```
+## Example - set custom header
+
+Request data from MimirApi
+
+```
+// THORNODE_API_9R_URL - default exported URL
+// import { MimirApi, THORNODE_API_9R_URL, Configuration } from '@xchainjs/xchain-thornode'
+
+  const baseUrl = THORNODE_API_9R_URL
+  const headers = {"x-client-id": "my-custom-val"}
+  const baseOptions = { headers }
+  const apiconfig = new Configuration({ basePath: baseUrl , baseOptions })
+  const mimirApi = new MimirApi(apiconfig)
+  const mimirResponse = await mimirApi.mimir()
+  console.log(mimirResponse.data)
+
 ```
 
 ## Documentation

package/lib/generated/thornodeApi/api.d.ts

@@ -2,7 +2,7 @@
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1234,6 +1234,56 @@ export interface QuoteSwapResponse {
      */
     'slippage_bps': number;
 }
+/**
+ *
+ * @export
+ * @interface Saver
+ */
+export interface Saver {
+    /**
+     *
+     * @type {string}
+     * @memberof Saver
+     */
+    'asset': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Saver
+     */
+    'asset_address': string;
+    /**
+     *
+     * @type {number}
+     * @memberof Saver
+     */
+    'last_add_height'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Saver
+     */
+    'last_withdraw_height'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Saver
+     */
+    'units': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Saver
+     */
+    'asset_deposit_value': string;
+}
+/**
+ *
+ * @export
+ * @interface SaverResponse
+ */
+export interface SaverResponse extends Array<LiquidityProvider> {
+}
 /**
  *
  * @export
@@ -2875,7 +2925,7 @@ export declare const SaversApiFp: (configuration?: Configuration | undefined) =>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    saver(asset: string, address: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<LiquidityProviderResponse>>;
+    saver(asset: string, address: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SaverResponse>>;
     /**
      * Returns all savers for the savers pool.
      * @param {string} asset
@@ -2883,7 +2933,7 @@ export declare const SaversApiFp: (configuration?: Configuration | undefined) =>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    savers(asset: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<LiquidityProviderResponse>>;
+    savers(asset: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SaverResponse>>;
 };
 /**
  * SaversApi - factory interface
@@ -2898,7 +2948,7 @@ export declare const SaversApiFactory: (configuration?: Configuration | undefine
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    saver(asset: string, address: string, height?: number | undefined, options?: any): AxiosPromise<LiquidityProviderResponse>;
+    saver(asset: string, address: string, height?: number | undefined, options?: any): AxiosPromise<SaverResponse>;
     /**
      * Returns all savers for the savers pool.
      * @param {string} asset
@@ -2906,7 +2956,7 @@ export declare const SaversApiFactory: (configuration?: Configuration | undefine
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    savers(asset: string, height?: number | undefined, options?: any): AxiosPromise<LiquidityProviderResponse>;
+    savers(asset: string, height?: number | undefined, options?: any): AxiosPromise<SaverResponse>;
 };
 /**
  * SaversApi - object-oriented interface
@@ -2924,7 +2974,7 @@ export declare class SaversApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SaversApi
      */
-    saver(asset: string, address: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiquidityProviderResponse, any>>;
+    saver(asset: string, address: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SaverResponse, any>>;
     /**
      * Returns all savers for the savers pool.
      * @param {string} asset
@@ -2933,7 +2983,7 @@ export declare class SaversApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SaversApi
      */
-    savers(asset: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiquidityProviderResponse, any>>;
+    savers(asset: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SaverResponse, any>>;
 }
 /**
  * TSSApi - axios parameter creator

package/lib/generated/thornodeApi/base.d.ts

@@ -2,14 +2,14 @@
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { Configuration } from "./configuration";
+import { Configuration } from './configuration';
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
 /**
@@ -50,6 +50,6 @@ export declare class BaseAPI {
  */
 export declare class RequiredError extends Error {
     field: string;
-    name: "RequiredError";
+    name: 'RequiredError';
     constructor(field: string, msg?: string);
 }

package/lib/generated/thornodeApi/common.d.ts

@@ -2,7 +2,7 @@
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/generated/thornodeApi/configuration.d.ts

@@ -2,7 +2,7 @@
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/generated/thornodeApi/index.d.ts

@@ -2,7 +2,7 @@
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/index.esm.js

@@ -26,7 +26,7 @@ function __awaiter(thisArg, _arguments, P, generator) {
 }
 
 /* tslint:disable */
-const BASE_PATH = "http://localhost".replace(/\/+$/, "");
+const BASE_PATH = 'http://localhost'.replace(/\/+$/, '');
 /**
  *
  * @export
@@ -39,6 +39,14 @@ class BaseAPI {
         if (configuration) {
             this.configuration = configuration;
             this.basePath = configuration.basePath || this.basePath;
+            if (this.basePath.includes('thornode.ninerealms.com')) {
+                if (!this.configuration.baseOptions)
+                    this.configuration.baseOptions = {};
+                if (!this.configuration.baseOptions.headers)
+                    this.configuration.baseOptions.headers = {};
+                if (!this.configuration.baseOptions.headers['x-client-id'])
+                    this.configuration.baseOptions.headers['x-client-id'] = 'xchainjs-client';
+            }
         }
     }
 }
@@ -52,7 +60,7 @@ class RequiredError extends Error {
     constructor(field, msg) {
         super(msg);
         this.field = field;
-        this.name = "RequiredError";
+        this.name = 'RequiredError';
     }
 }
 
@@ -3178,7 +3186,7 @@ class VaultsApi extends BaseAPI {
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/index.js

@@ -34,7 +34,7 @@ function __awaiter(thisArg, _arguments, P, generator) {
 }
 
 /* tslint:disable */
-const BASE_PATH = "http://localhost".replace(/\/+$/, "");
+const BASE_PATH = 'http://localhost'.replace(/\/+$/, '');
 /**
  *
  * @export
@@ -47,6 +47,14 @@ class BaseAPI {
         if (configuration) {
             this.configuration = configuration;
             this.basePath = configuration.basePath || this.basePath;
+            if (this.basePath.includes('thornode.ninerealms.com')) {
+                if (!this.configuration.baseOptions)
+                    this.configuration.baseOptions = {};
+                if (!this.configuration.baseOptions.headers)
+                    this.configuration.baseOptions.headers = {};
+                if (!this.configuration.baseOptions.headers['x-client-id'])
+                    this.configuration.baseOptions.headers['x-client-id'] = 'xchainjs-client';
+            }
         }
     }
 }
@@ -60,7 +68,7 @@ class RequiredError extends Error {
     constructor(field, msg) {
         super(msg);
         this.field = field;
-        this.name = "RequiredError";
+        this.name = 'RequiredError';
     }
 }
 
@@ -3186,7 +3194,7 @@ class VaultsApi extends BaseAPI {
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.100.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thornode",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "license": "MIT",
   "description": "Thornode module that exposes all thornode functions using openapi-generator-cli",
   "keywords": [
@@ -29,8 +29,8 @@
     "lint": "eslint \"{src,__tests__}/**/*.ts\" --fix --max-warnings 0",
     "prepublishOnly": "yarn run build",
     "test": "jest --passWithNoTests",
-    "generate:types": "yarn clean:types:thornode && yarn generate:types:thornode",
-    "generate:types:thornode": "TS_POST_PROCESS_FILE=./node_modules/.bin/prettier openapi-generator-cli generate -i https://gitlab.com/thorchain/thornode/-/raw/release-1.99.0/openapi/openapi.yaml -g typescript-axios -o ./src/generated/thornodeApi --skip-validate-spec --generate-alias-as-model",
+    "generate:types": "yarn clean:types:thornode && yarn generate:types:thornode && scripts/modifyBaseAPI.sh",
+    "generate:types:thornode": "TS_POST_PROCESS_FILE=./node_modules/.bin/prettier openapi-generator-cli generate -i https://gitlab.com/thorchain/thornode/-/raw/release-1.100.0/openapi/openapi.yaml -g typescript-axios -o ./src/generated/thornodeApi --skip-validate-spec --generate-alias-as-model",
     "clean:types:thornode": "rimraf ./src/generated/thornodeApi"
   },
   "devDependencies": {