@xchainjs/xchain-thornode 0.1.0-alpha3 → 0.1.0-alpha4

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# v0.0.1.0-alpha4 (2022-08-20)
+
+## Update
+
+- Update to latest THORNode 1.95.0
+- Generate files from `*.yaml` (to avoid extra step of convertion to `*.json`)
+- Remove `yamljs`
+
+# v0.0.1.0-alpha3 (2022-07-21)
+
+???
+
+# v0.0.1.0-alpha2 (2022-07-7)
+
+## Fix
+
+- Fix `OutboundProcess and ScheduledOutbound` exported interfaces, by preprocessing yaml->json (https://github.com/OpenAPITools/openapi-generator/issues/1593)
+
+# v0.0.1.0-alpha (2022-07-4)
+
+## Module Created

package/README.md

@@ -4,10 +4,9 @@ Thornode Module for XChainJS Clients
 
 ## Modules
 
-Thornode module has been created using openapi-generator-cli to auto-generate rest api reading from "https://thornode.ninerealms.com/thorchain/doc/openapi.yaml" 
+Thornode module has been created using openapi-generator-cli to auto-generate rest api reading from "https://gitlab.com/thorchain/thornode/-/raw/release-{version}/openapi/openapi.yaml"
 This library exposes all the Api's outlined in the swagger doc "https://thornode.ninerealms.com/thorchain/doc"
 
-
 ## Installation
 
 ```
@@ -15,6 +14,7 @@ yarn add @xchainjs/xchain-thornode
 ```
 
 ## Examples
+
 Request data from MimirApi
 
 ```

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

@@ -692,6 +692,43 @@ export declare const ObservedTxStatusEnum: {
     readonly Incomplete: "incomplete";
 };
 export declare type ObservedTxStatusEnum = typeof ObservedTxStatusEnum[keyof typeof ObservedTxStatusEnum];
+/**
+ *
+ * @export
+ * @interface POLResponse
+ */
+export interface POLResponse {
+    /**
+     * total amount of RUNE deposited into the pools
+     * @type {string}
+     * @memberof POLResponse
+     */
+    'rune_deposited': string;
+    /**
+     * total amount of RUNE withdrawn from the pools
+     * @type {string}
+     * @memberof POLResponse
+     */
+    'rune_withdrawn': string;
+    /**
+     * total value of protocol\'s LP position in RUNE value
+     * @type {string}
+     * @memberof POLResponse
+     */
+    'value': string;
+    /**
+     * profit and loss of protocol owned liquidity
+     * @type {string}
+     * @memberof POLResponse
+     */
+    'pnl': string;
+    /**
+     * current amount of rune deposited
+     * @type {string}
+     * @memberof POLResponse
+     */
+    'current_deposit': string;
+}
 /**
  *
  * @export
@@ -1938,6 +1975,61 @@ export declare class NodesApi extends BaseAPI {
      */
     nodes(height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Node[], any>>;
 }
+/**
+ * POLApi - axios parameter creator
+ * @export
+ */
+export declare const POLApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Returns protocol owned liquidity overview statistics.
+     * @param {number} [height] optional block height, defaults to current tip
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pol: (height?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * POLApi - functional programming interface
+ * @export
+ */
+export declare const POLApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Returns protocol owned liquidity overview statistics.
+     * @param {number} [height] optional block height, defaults to current tip
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pol(height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<POLResponse>>;
+};
+/**
+ * POLApi - factory interface
+ * @export
+ */
+export declare const POLApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Returns protocol owned liquidity overview statistics.
+     * @param {number} [height] optional block height, defaults to current tip
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pol(height?: number | undefined, options?: any): AxiosPromise<POLResponse>;
+};
+/**
+ * POLApi - object-oriented interface
+ * @export
+ * @class POLApi
+ * @extends {BaseAPI}
+ */
+export declare class POLApi extends BaseAPI {
+    /**
+     * Returns protocol owned liquidity overview statistics.
+     * @param {number} [height] optional block height, defaults to current tip
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof POLApi
+     */
+    pol(height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<POLResponse, any>>;
+}
 /**
  * PoolsApi - axios parameter creator
  * @export
@@ -2194,7 +2286,7 @@ export declare const TSSApiFp: (configuration?: Configuration | undefined) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    keysignPubkey(height: number, pubkey: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<KeysignResponse>>;
+    keysignPubkey(height: number, pubkey: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
     /**
      * Returns keygen and keysign metrics for current vaults.
      * @param {number} [height] optional block height, defaults to current tip
@@ -2230,7 +2322,7 @@ export declare const TSSApiFactory: (configuration?: Configuration | undefined,
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    keysignPubkey(height: number, pubkey: string, options?: any): AxiosPromise<KeysignResponse>;
+    keysignPubkey(height: number, pubkey: string, options?: any): AxiosPromise<void>;
     /**
      * Returns keygen and keysign metrics for current vaults.
      * @param {number} [height] optional block height, defaults to current tip
@@ -2270,7 +2362,7 @@ export declare class TSSApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TSSApi
      */
-    keysignPubkey(height: number, pubkey: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KeysignResponse, any>>;
+    keysignPubkey(height: number, pubkey: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Returns keygen and keysign metrics for current vaults.
      * @param {number} [height] optional block height, defaults to current tip

package/lib/index.esm.js

@@ -1407,6 +1407,99 @@ class NodesApi extends BaseAPI {
         return NodesApiFp(this.configuration).nodes(height, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * POLApi - axios parameter creator
+ * @export
+ */
+const POLApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns protocol owned liquidity overview statistics.
+         * @param {number} [height] optional block height, defaults to current tip
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pol: (height, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/thorchain/pol`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            if (height !== undefined) {
+                localVarQueryParameter['height'] = height;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * POLApi - functional programming interface
+ * @export
+ */
+const POLApiFp = function (configuration) {
+    const localVarAxiosParamCreator = POLApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns protocol owned liquidity overview statistics.
+         * @param {number} [height] optional block height, defaults to current tip
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pol(height, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.pol(height, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * POLApi - factory interface
+ * @export
+ */
+const POLApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = POLApiFp(configuration);
+    return {
+        /**
+         * Returns protocol owned liquidity overview statistics.
+         * @param {number} [height] optional block height, defaults to current tip
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pol(height, options) {
+            return localVarFp.pol(height, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * POLApi - object-oriented interface
+ * @export
+ * @class POLApi
+ * @extends {BaseAPI}
+ */
+class POLApi extends BaseAPI {
+    /**
+     * Returns protocol owned liquidity overview statistics.
+     * @param {number} [height] optional block height, defaults to current tip
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof POLApi
+     */
+    pol(height, options) {
+        return POLApiFp(this.configuration).pol(height, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * PoolsApi - axios parameter creator
  * @export
@@ -2646,4 +2739,4 @@ class Configuration {
 
 const THORNODE_API_9R_URL = 'https://thornode.ninerealms.com/';
 
-export { Configuration, HealthApi, HealthApiAxiosParamCreator, HealthApiFactory, HealthApiFp, LiquidityProvidersApi, LiquidityProvidersApiAxiosParamCreator, LiquidityProvidersApiFactory, LiquidityProvidersApiFp, MimirApi, MimirApiAxiosParamCreator, MimirApiFactory, MimirApiFp, NetworkApi, NetworkApiAxiosParamCreator, NetworkApiFactory, NetworkApiFp, NodeStatusEnum, NodesApi, NodesApiAxiosParamCreator, NodesApiFactory, NodesApiFp, ObservedTxStatusEnum, PoolsApi, PoolsApiAxiosParamCreator, PoolsApiFactory, PoolsApiFp, QueueApi, QueueApiAxiosParamCreator, QueueApiFactory, QueueApiFp, THORNODE_API_9R_URL, TSSApi, TSSApiAxiosParamCreator, TSSApiFactory, TSSApiFp, ThornamesApi, ThornamesApiAxiosParamCreator, ThornamesApiFactory, ThornamesApiFp, TransactionsApi, TransactionsApiAxiosParamCreator, TransactionsApiFactory, TransactionsApiFp, VaultTypeEnum, VaultsApi, VaultsApiAxiosParamCreator, VaultsApiFactory, VaultsApiFp };
+export { Configuration, HealthApi, HealthApiAxiosParamCreator, HealthApiFactory, HealthApiFp, LiquidityProvidersApi, LiquidityProvidersApiAxiosParamCreator, LiquidityProvidersApiFactory, LiquidityProvidersApiFp, MimirApi, MimirApiAxiosParamCreator, MimirApiFactory, MimirApiFp, NetworkApi, NetworkApiAxiosParamCreator, NetworkApiFactory, NetworkApiFp, NodeStatusEnum, NodesApi, NodesApiAxiosParamCreator, NodesApiFactory, NodesApiFp, ObservedTxStatusEnum, POLApi, POLApiAxiosParamCreator, POLApiFactory, POLApiFp, PoolsApi, PoolsApiAxiosParamCreator, PoolsApiFactory, PoolsApiFp, QueueApi, QueueApiAxiosParamCreator, QueueApiFactory, QueueApiFp, THORNODE_API_9R_URL, TSSApi, TSSApiAxiosParamCreator, TSSApiFactory, TSSApiFp, ThornamesApi, ThornamesApiAxiosParamCreator, ThornamesApiFactory, ThornamesApiFp, TransactionsApi, TransactionsApiAxiosParamCreator, TransactionsApiFactory, TransactionsApiFp, VaultTypeEnum, VaultsApi, VaultsApiAxiosParamCreator, VaultsApiFactory, VaultsApiFp };

package/lib/index.js

@@ -1415,6 +1415,99 @@ class NodesApi extends BaseAPI {
         return NodesApiFp(this.configuration).nodes(height, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * POLApi - axios parameter creator
+ * @export
+ */
+const POLApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns protocol owned liquidity overview statistics.
+         * @param {number} [height] optional block height, defaults to current tip
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pol: (height, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/thorchain/pol`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            if (height !== undefined) {
+                localVarQueryParameter['height'] = height;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * POLApi - functional programming interface
+ * @export
+ */
+const POLApiFp = function (configuration) {
+    const localVarAxiosParamCreator = POLApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns protocol owned liquidity overview statistics.
+         * @param {number} [height] optional block height, defaults to current tip
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pol(height, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.pol(height, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios__default['default'], BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * POLApi - factory interface
+ * @export
+ */
+const POLApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = POLApiFp(configuration);
+    return {
+        /**
+         * Returns protocol owned liquidity overview statistics.
+         * @param {number} [height] optional block height, defaults to current tip
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pol(height, options) {
+            return localVarFp.pol(height, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * POLApi - object-oriented interface
+ * @export
+ * @class POLApi
+ * @extends {BaseAPI}
+ */
+class POLApi extends BaseAPI {
+    /**
+     * Returns protocol owned liquidity overview statistics.
+     * @param {number} [height] optional block height, defaults to current tip
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof POLApi
+     */
+    pol(height, options) {
+        return POLApiFp(this.configuration).pol(height, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * PoolsApi - axios parameter creator
  * @export
@@ -2677,6 +2770,10 @@ exports.NodesApiAxiosParamCreator = NodesApiAxiosParamCreator;
 exports.NodesApiFactory = NodesApiFactory;
 exports.NodesApiFp = NodesApiFp;
 exports.ObservedTxStatusEnum = ObservedTxStatusEnum;
+exports.POLApi = POLApi;
+exports.POLApiAxiosParamCreator = POLApiAxiosParamCreator;
+exports.POLApiFactory = POLApiFactory;
+exports.POLApiFp = POLApiFp;
 exports.PoolsApi = PoolsApi;
 exports.PoolsApiAxiosParamCreator = PoolsApiAxiosParamCreator;
 exports.PoolsApiFactory = PoolsApiFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thornode",
-  "version": "0.1.0-alpha3",
+  "version": "0.1.0-alpha4",
   "license": "MIT",
   "description": "Thornode module that exposes all thornode functions using openapi-generator-cli",
   "keywords": [
@@ -29,14 +29,11 @@
     "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:convertToJson && yarn generate:types:thornode && yarn clean:types:tempFiles",
-    "generate:types:convertToJson": "curl 'https://gitlab.com/thorchain/thornode/-/raw/357456ea9e71cb2e846157b169bb5581b4075d0f/openapi/openapi.yaml' > ./input.yaml && yaml2json ./input.yaml --pretty > ./input.json",
-    "generate:types:thornode": "TS_POST_PROCESS_FILE=./node_modules/.bin/prettier openapi-generator-cli generate -i ./input.json -g typescript-axios -o ./src/generated/thornodeApi --reserved-words-mappings  in=in",
-    "clean:types:tempFiles": "rimraf ./input.yaml ./input.json",
+    "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.95.0/openapi/openapi.yaml -g typescript-axios -o ./src/generated/thornodeApi --skip-validate-spec",
     "clean:types:thornode": "rimraf ./src/generated/thornodeApi"
   },
   "devDependencies": {
-    "yamljs": "^0.3.0",
     "@openapitools/openapi-generator-cli": "^2.5.1",
     "rimraf": "~3.0.2"
   },