@xchainjs/xchain-thornode 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -0,0 +1,53 @@
+# v0.1.4 (2022-12-08)
+
+## Update
+
+- Update to latest THORNode 1.101.0
+
+# v0.1.3 (2022-12-07)
+
+## Update
+
+- Update to latest THORNode 1.100.0
+- support custom headers
+- set default 'x-client-id' in all calls
+
+# v0.1.2 (2022-11-11)
+
+## Update
+
+- Update to latest THORNode 1.99.0
+
+# v0.1.1 (2022-10-24)
+
+## Update
+
+- Update to latest THORNode 1.98.0
+
+# v0.0.1.0 (2022-10-04)
+
+## Update
+
+- Update to latest THORNode 1.97.2
+
+# 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

@@ -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.101.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -92,7 +92,7 @@ export interface ConstantsResponse {
      * @type {{ [key: string]: string; }}
      * @memberof ConstantsResponse
      */
-    'int64_values'?: {
+    'int_64_values'?: {
         [key: string]: string;
     };
     /**
@@ -384,7 +384,7 @@ export interface LiquidityProvider {
      * @type {string}
      * @memberof LiquidityProvider
      */
-    'pending_tx_Id'?: string;
+    'pending_tx_id'?: string;
     /**
      *
      * @type {string}
@@ -397,13 +397,116 @@ export interface LiquidityProvider {
      * @memberof LiquidityProvider
      */
     'asset_deposit_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProvider
+     */
+    'rune_redeem_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProvider
+     */
+    'asset_redeem_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProvider
+     */
+    'luvi_deposit_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProvider
+     */
+    'luvi_redeem_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProvider
+     */
+    'luvi_growth_pct': string;
 }
 /**
  *
  * @export
- * @interface LiquidityProviderResponse
+ * @interface LiquidityProviderSummary
  */
-export interface LiquidityProviderResponse extends Array<LiquidityProvider> {
+export interface LiquidityProviderSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'asset': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'rune_address'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'asset_address'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof LiquidityProviderSummary
+     */
+    'last_add_height'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LiquidityProviderSummary
+     */
+    'last_withdraw_height'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'units': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'pending_rune': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'pending_asset': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'pending_tx_id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'rune_deposit_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof LiquidityProviderSummary
+     */
+    'asset_deposit_value': string;
+}
+/**
+ *
+ * @export
+ * @interface LiquidityProvidersResponse
+ */
+export interface LiquidityProvidersResponse extends Array<LiquidityProviderSummary> {
 }
 /**
  *
@@ -483,29 +586,35 @@ export interface NetworkResponse {
      */
     'bond_reward_rune': string;
     /**
-     * total bonded RUNE
+     * total of burned BEP2 RUNE
      * @type {string}
      * @memberof NetworkResponse
      */
-    'total_bond_units': string;
+    'burned_bep_2_rune': string;
     /**
-     * total reserve RUNE
+     * total of burned ERC20 RUNE
      * @type {string}
      * @memberof NetworkResponse
      */
-    'total_reserve': string;
+    'burned_erc_20_rune': string;
     /**
-     * total of burned BEP2 RUNE
+     * total bonded RUNE
      * @type {string}
      * @memberof NetworkResponse
      */
-    'burned_bep_2_rune': string;
+    'total_bond_units': string;
     /**
-     * total of burned ERC20 RUNE
+     * total reserve RUNE
      * @type {string}
      * @memberof NetworkResponse
      */
-    'burned_erc_20_rune': string;
+    'total_reserve': string;
+    /**
+     * Returns true if there exist RetiringVaults which have not finished migrating funds to new ActiveVaults
+     * @type {boolean}
+     * @memberof NetworkResponse
+     */
+    'vaults_migrating': boolean;
 }
 /**
  *
@@ -538,29 +647,35 @@ export interface Node {
      */
     'validator_cons_pub_key': string;
     /**
-     * current node bond
-     * @type {string}
+     * the block height at which the node became active
+     * @type {number}
      * @memberof Node
      */
-    'bond': string;
+    'active_block_height': number;
     /**
-     * the block height at which the node became active
+     * the block height of the current provided information for the node
      * @type {number}
      * @memberof Node
      */
-    'active_block_height': number;
+    'status_since': number;
     /**
      *
      * @type {string}
      * @memberof Node
      */
-    'bond_address': string;
+    'node_operator_address': string;
     /**
-     * the block height of the current provided information for the node
-     * @type {number}
+     * current node bond
+     * @type {string}
      * @memberof Node
      */
-    'status_since': number;
+    'total_bond': string;
+    /**
+     *
+     * @type {NodeBondProviders}
+     * @memberof Node
+     */
+    'bond_providers': NodeBondProviders;
     /**
      * the set of vault public keys of which the node is a member
      * @type {Array<string>}
@@ -627,12 +742,6 @@ export interface Node {
      * @memberof Node
      */
     'preflight_status': NodePreflightStatus;
-    /**
-     *
-     * @type {NodeBondProviders}
-     * @memberof Node
-     */
-    'bond_providers': NodeBondProviders;
 }
 export declare const NodeStatusEnum: {
     readonly Active: "Active";
@@ -667,13 +776,7 @@ export interface NodeBondProvider {
  */
 export interface NodeBondProviders {
     /**
-     *
-     * @type {string}
-     * @memberof NodeBondProviders
-     */
-    'node_address'?: string;
-    /**
-     *
+     * node operator fee in basis points
      * @type {string}
      * @memberof NodeBondProviders
      */
@@ -691,12 +794,6 @@ export interface NodeBondProviders {
  * @interface NodeJail
  */
 export interface NodeJail {
-    /**
-     *
-     * @type {string}
-     * @memberof NodeJail
-     */
-    'node_address'?: string;
     /**
      *
      * @type {number}
@@ -1234,6 +1331,68 @@ 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;
+    /**
+     *
+     * @type {string}
+     * @memberof Saver
+     */
+    'asset_redeem_value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Saver
+     */
+    'growth_pct': string;
+}
+/**
+ *
+ * @export
+ * @interface SaverResponse
+ */
+export interface SaverResponse extends Array<LiquidityProvider> {
+}
 /**
  *
  * @export
@@ -1509,16 +1668,16 @@ export interface TxSignersResponse {
     'txs': Array<ObservedTx>;
     /**
      *
-     * @type {Array<ObservedTx>}
+     * @type {Array<TxOutItem>}
      * @memberof TxSignersResponse
      */
-    'actions': Array<ObservedTx>;
+    'actions': Array<TxOutItem>;
     /**
      *
-     * @type {Array<string>}
+     * @type {Array<Tx>}
      * @memberof TxSignersResponse
      */
-    'out_txs': Array<string>;
+    'out_txs': Array<Tx>;
     /**
      * the thorchain height at which the outbound was finalised
      * @type {number}
@@ -1829,7 +1988,7 @@ export declare const LiquidityProvidersApiFp: (configuration?: Configuration | u
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    liquidityProvider(asset: string, address: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<LiquidityProviderResponse>>;
+    liquidityProvider(asset: string, address: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<LiquidityProvider>>;
     /**
      * Returns all liquidity provider information for an asset.
      * @param {string} asset
@@ -1837,7 +1996,7 @@ export declare const LiquidityProvidersApiFp: (configuration?: Configuration | u
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    liquidityProviders(asset: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<LiquidityProviderResponse>>;
+    liquidityProviders(asset: string, height?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<LiquidityProvidersResponse>>;
 };
 /**
  * LiquidityProvidersApi - factory interface
@@ -1852,7 +2011,7 @@ export declare const LiquidityProvidersApiFactory: (configuration?: Configuratio
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    liquidityProvider(asset: string, address: string, height?: number | undefined, options?: any): AxiosPromise<LiquidityProviderResponse>;
+    liquidityProvider(asset: string, address: string, height?: number | undefined, options?: any): AxiosPromise<LiquidityProvider>;
     /**
      * Returns all liquidity provider information for an asset.
      * @param {string} asset
@@ -1860,7 +2019,7 @@ export declare const LiquidityProvidersApiFactory: (configuration?: Configuratio
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    liquidityProviders(asset: string, height?: number | undefined, options?: any): AxiosPromise<LiquidityProviderResponse>;
+    liquidityProviders(asset: string, height?: number | undefined, options?: any): AxiosPromise<LiquidityProvidersResponse>;
 };
 /**
  * LiquidityProvidersApi - object-oriented interface
@@ -1878,7 +2037,7 @@ export declare class LiquidityProvidersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LiquidityProvidersApi
      */
-    liquidityProvider(asset: string, address: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiquidityProviderResponse, any>>;
+    liquidityProvider(asset: string, address: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiquidityProvider, any>>;
     /**
      * Returns all liquidity provider information for an asset.
      * @param {string} asset
@@ -1887,7 +2046,7 @@ export declare class LiquidityProvidersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof LiquidityProvidersApi
      */
-    liquidityProviders(asset: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiquidityProviderResponse, any>>;
+    liquidityProviders(asset: string, height?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiquidityProvidersResponse, any>>;
 }
 /**
  * MimirApi - axios parameter creator
@@ -2875,7 +3034,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 +3042,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 +3057,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 +3065,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 +3083,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 +3092,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,7 +2,7 @@
  * Thornode API
  * Thornode REST API.
  *
- * The version of the OpenAPI document: 1.99.0
+ * The version of the OpenAPI document: 1.101.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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.101.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.101.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.101.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/index.esm.js

@@ -3178,7 +3178,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.101.0
  * Contact: devs@thorchain.org
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/index.js

@@ -3186,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.101.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.4",
   "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.101.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": {