@xchainjs/xchain-util - npm Package Compare versions

Comparing version 0.11.0 to 0.11.1

lib/index.d.ts

@@ -7,1 +7,2 @@ export * from './async';
 export * from './types';
+export * from './ninerealms';

lib/index.esm.js

@@ -630,3 +630,42 @@ import BigNumber from 'bignumber.js';
 
-export { AVAXChain, AssetAVAX, AssetAtom, AssetBCH, AssetBNB, AssetBTC, AssetCurrencySymbol, AssetDOGE, AssetETH, AssetLTC, AssetRune67C, AssetRuneB1A, AssetRuneERC20, AssetRuneERC20Testnet, AssetRuneNative, AvalancheChain, BCHChain, BNBChain, BTCChain, Chain, CosmosChain, DOGEChain, Denomination, ETHChain, LTCChain, RUNE_TICKER, THORChain, assetAmount, assetFromString, assetFromStringEx, assetToBase, assetToString, baseAmount, baseToAsset, bn, bnOrZero, chainToString, currencySymbolByAsset, delay, eqAsset, eqChain, fixedBN, formatAssetAmount, formatAssetAmountCurrency, formatBN, formatBNCurrency, formatBaseAmount, formatBaseAsAssetAmount, getContractAddressFromAsset, isAssetAmount, isAssetRuneNative, isBaseAmount, isBchChain, isBigNumberValue, isBnbChain, isBtcChain, isChain, isDogeChain, isEnabledChain, isEthChain, isLtcChain, isSynthAsset, isThorChain, isValidAsset, isValidBN, strip0x, trimZeros, validBNOrZero };
+const XCHAINJS_IDENTIFIER = 'xchainjs-client';
+const NINE_REALMS_CLIENT_HEADER = 'x-client-id';
+/**
+ * Middleware to add custom header to requests (9R endpoints only)
+ *
+ * @param request RequestArgs (rxjs/ajax) | AxiosRequestConfig (axios)
+ * @returns RequestArgs (rxjs/ajax) | AxiosRequestConfig (axios)
+ */
+const add9Rheader = (request) => {
+    var _a, _b;
+    try {
+        // URL throws an `TypeError` if `url` is not available and 'unknown-url' is set
+        // [TypeError: Invalid URL] input: 'unknown-url', code: 'ERR_INVALID_URL' }
+        const url = new URL((_a = request === null || request === void 0 ? void 0 : request.url) !== null && _a !== void 0 ? _a : 'unknown-url');
+        const headerAlreadyExists = request.headers && 'x-client-id' in request.headers;
+        if (url.host.includes('ninerealms') && !headerAlreadyExists) {
+            const headers = (_b = request === null || request === void 0 ? void 0 : request.headers) !== null && _b !== void 0 ? _b : {};
+            // Add custom header to request before returning it
+            const newRequest = Object.assign(Object.assign({}, request), { headers: Object.assign(Object.assign({}, headers), { [`${NINE_REALMS_CLIENT_HEADER}`]: `${XCHAINJS_IDENTIFIER}` }) });
+            // console.log(` Request ${newRequest.url} ${JSON.stringify(newRequest.headers)}`)
+            return newRequest;
+        }
+    }
+    catch (error) {
+        console.error(`Failed to add custom ${NINE_REALMS_CLIENT_HEADER} header`, error);
+    }
+    // If it errors, just return same request and keep it untouched (no change)
+    // console.log(` Request ${request.url} ${JSON.stringify(request.headers)}`)
+    return request;
+};
+/**
+ * Adds custom header to axios requests (9R endpoints only)
+ */
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
+const register9Rheader = (axios) => {
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+    axios.interceptors.request.use(add9Rheader, (error) => Promise.reject(error));
+};
+
+export { AVAXChain, AssetAVAX, AssetAtom, AssetBCH, AssetBNB, AssetBTC, AssetCurrencySymbol, AssetDOGE, AssetETH, AssetLTC, AssetRune67C, AssetRuneB1A, AssetRuneERC20, AssetRuneERC20Testnet, AssetRuneNative, AvalancheChain, BCHChain, BNBChain, BTCChain, Chain, CosmosChain, DOGEChain, Denomination, ETHChain, LTCChain, NINE_REALMS_CLIENT_HEADER, RUNE_TICKER, THORChain, XCHAINJS_IDENTIFIER, add9Rheader, assetAmount, assetFromString, assetFromStringEx, assetToBase, assetToString, baseAmount, baseToAsset, bn, bnOrZero, chainToString, currencySymbolByAsset, delay, eqAsset, eqChain, fixedBN, formatAssetAmount, formatAssetAmountCurrency, formatBN, formatBNCurrency, formatBaseAmount, formatBaseAsAssetAmount, getContractAddressFromAsset, isAssetAmount, isAssetRuneNative, isBaseAmount, isBchChain, isBigNumberValue, isBnbChain, isBtcChain, isChain, isDogeChain, isEnabledChain, isEthChain, isLtcChain, isSynthAsset, isThorChain, isValidAsset, isValidBN, register9Rheader, strip0x, trimZeros, validBNOrZero };
 //# sourceMappingURL=index.esm.js.map

lib/index.js

@@ -632,2 +632,41 @@ 'use strict';
 
+const XCHAINJS_IDENTIFIER = 'xchainjs-client';
+const NINE_REALMS_CLIENT_HEADER = 'x-client-id';
+/**
+ * Middleware to add custom header to requests (9R endpoints only)
+ *
+ * @param request RequestArgs (rxjs/ajax) | AxiosRequestConfig (axios)
+ * @returns RequestArgs (rxjs/ajax) | AxiosRequestConfig (axios)
+ */
+const add9Rheader = (request) => {
+    var _a, _b;
+    try {
+        // URL throws an `TypeError` if `url` is not available and 'unknown-url' is set
+        // [TypeError: Invalid URL] input: 'unknown-url', code: 'ERR_INVALID_URL' }
+        const url = new URL((_a = request === null || request === void 0 ? void 0 : request.url) !== null && _a !== void 0 ? _a : 'unknown-url');
+        const headerAlreadyExists = request.headers && 'x-client-id' in request.headers;
+        if (url.host.includes('ninerealms') && !headerAlreadyExists) {
+            const headers = (_b = request === null || request === void 0 ? void 0 : request.headers) !== null && _b !== void 0 ? _b : {};
+            // Add custom header to request before returning it
+            const newRequest = Object.assign(Object.assign({}, request), { headers: Object.assign(Object.assign({}, headers), { [`${NINE_REALMS_CLIENT_HEADER}`]: `${XCHAINJS_IDENTIFIER}` }) });
+            // console.log(` Request ${newRequest.url} ${JSON.stringify(newRequest.headers)}`)
+            return newRequest;
+        }
+    }
+    catch (error) {
+        console.error(`Failed to add custom ${NINE_REALMS_CLIENT_HEADER} header`, error);
+    }
+    // If it errors, just return same request and keep it untouched (no change)
+    // console.log(` Request ${request.url} ${JSON.stringify(request.headers)}`)
+    return request;
+};
+/**
+ * Adds custom header to axios requests (9R endpoints only)
+ */
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
+const register9Rheader = (axios) => {
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+    axios.interceptors.request.use(add9Rheader, (error) => Promise.reject(error));
+};
+
 exports.AVAXChain = AVAXChain;
@@ -655,4 +694,7 @@ exports.AssetAVAX = AssetAVAX;
 exports.LTCChain = LTCChain;
+exports.NINE_REALMS_CLIENT_HEADER = NINE_REALMS_CLIENT_HEADER;
 exports.RUNE_TICKER = RUNE_TICKER;
 exports.THORChain = THORChain;
+exports.XCHAINJS_IDENTIFIER = XCHAINJS_IDENTIFIER;
+exports.add9Rheader = add9Rheader;
 exports.assetAmount = assetAmount;
@@ -696,2 +738,3 @@ exports.assetFromString = assetFromString;
 exports.isValidBN = isValidBN;
+exports.register9Rheader = register9Rheader;
 exports.strip0x = strip0x;
@@ -698,0 +741,0 @@ exports.trimZeros = trimZeros;

package.json

 {
   "name": "@xchainjs/xchain-util",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Helper utilities for XChain clients",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

156808

increased by7.15%

Number of package files

22

increased by4.76%

Lines of code

1932

increased by5.29%

No dependency changes