chore: replaced references to chainlink with aggregators (#923)

Author: yomarion

packages/currency/src/chainlink-path-aggregators.ts renamed to packages/currency/src/conversion-aggregators.ts

@@ -9,29 +9,55 @@ import fantomAggregator from './aggregators/fantom.json';
 import nearAggregator from './aggregators/near.json';
 import nearTestnetAggregator from './aggregators/near-testnet.json';
 
+/**
+ * currencyFrom => currencyTo => cost
+ */
 export type CurrencyPairs = Record<string, Record<string, number>>;
-// List of currencies supported by network (can be generated from requestNetwork/toolbox/src/chainlinkConversionPathTools.ts)
-// Network => currencyFrom => currencyTo => cost
-// Must be updated every time an aggregator is added
-export const chainlinkCurrencyPairs: Record<string, CurrencyPairs> = {
+
+/**
+ * Aggregators maps define pairs of currencies for which an onchain oracle exists, by network.
+ *
+ * Network => currencyFrom => currencyTo => cost
+ */
+export type AggregatorsMap = Record<string, CurrencyPairs>;
+
+// Pairs supported by Chainlink (can be generated from requestNetwork/toolbox/src/chainlinkConversionPathTools.ts)
+const chainlinkCurrencyPairs: AggregatorsMap = {
   private: privateAggregator,
   rinkeby: rinkebyAggregator,
-  goerli: {},
   mainnet: mainnetAggregator,
   matic: maticAggregator,
   fantom: fantomAggregator,
-  // FIX ME: This fix enables to get these networks registered in chainlinkSupportedNetworks.
-  // Could be improved by removing the supported network check from the protocol
+};
+
+// Pairs supported by Flux Protocol
+const fluxCurrencyPairs: AggregatorsMap = {
+  aurora: nearAggregator,
+  'aurora-testnet': nearTestnetAggregator,
+};
+
+// FIX ME: This fix enables to get these networks registered in conversionSupportedNetworks.
+// Could be improved by removing the supported network check from the protocol
+const noConversionNetworks: AggregatorsMap = {
+  goerli: {},
   'arbitrum-rinkeby': {},
   'arbitrum-one': {},
   xdai: {},
   avalanche: {},
   bsc: {},
-  aurora: nearAggregator,
-  'aurora-testnet': nearTestnetAggregator,
 };
 
-export const chainlinkSupportedNetworks = Object.keys(chainlinkCurrencyPairs);
+/**
+ * Conversion paths per network used by default if no other path given to the Currency Manager.
+ * Must be updated every time an aggregator is added to one network.
+ */
+export const defaultConversionPairs: AggregatorsMap = {
+  ...chainlinkCurrencyPairs,
+  ...fluxCurrencyPairs,
+  ...noConversionNetworks,
+};
+
+export const conversionSupportedNetworks = Object.keys(defaultConversionPairs);
 
 /**
  * Gets the on-chain conversion path between two currencies.
@@ -47,7 +73,7 @@ export function getPath(
   currencyFrom: Pick<CurrencyDefinition, 'hash'>,
   currencyTo: Pick<CurrencyDefinition, 'hash'>,
   network = 'mainnet',
-  pairs = chainlinkCurrencyPairs,
+  pairs = defaultConversionPairs,
 ): string[] | null {
   if (!pairs[network]) {
     throw Error(`network ${network} not supported`);

packages/currency/src/currencyManager.ts

@@ -15,7 +15,7 @@ import {
   LegacyTokenMap,
   NativeCurrencyType,
 } from './types';
-import { chainlinkCurrencyPairs, CurrencyPairs, getPath } from './chainlink-path-aggregators';
+import { defaultConversionPairs, AggregatorsMap, getPath } from './conversion-aggregators';
 import { isValidNearAddress } from './currency-utils';
 
 const { BTC, ERC20, ERC777, ETH, ISO4217 } = RequestLogicTypes.CURRENCY;
@@ -26,17 +26,18 @@ const { BTC, ERC20, ERC777, ETH, ISO4217 } = RequestLogicTypes.CURRENCY;
 export class CurrencyManager<TMeta = unknown> implements ICurrencyManager<TMeta> {
   private readonly knownCurrencies: CurrencyDefinition<TMeta>[];
   private readonly legacyTokens: LegacyTokenMap;
-  private readonly conversionPairs: Record<string, CurrencyPairs>;
+  private readonly conversionPairs: AggregatorsMap;
 
   /**
    *
    * @param inputCurrencies The list of currencies known by the Manager.
    * @param legacyTokens A mapping of legacy currency name or network name, in the format { "chainName": {"TOKEN": ["NEW_TOKEN","NEW_CHAIN"]}}
+   * @param conversionPairs A mapping of possible conversions by network (network => currencyFrom => currencyTo => cost)
    */
   constructor(
     inputCurrencies: (CurrencyInput & { id?: string; meta?: TMeta })[],
     legacyTokens?: LegacyTokenMap,
-    conversionPairs?: Record<string, CurrencyPairs>,
+    conversionPairs?: AggregatorsMap,
   ) {
     this.knownCurrencies = [];
     for (const input of inputCurrencies) {
@@ -294,8 +295,8 @@ export class CurrencyManager<TMeta = unknown> implements ICurrencyManager<TMeta>
     };
   }
 
-  static getDefaultConversionPairs(): Record<string, CurrencyPairs> {
-    return chainlinkCurrencyPairs;
+  static getDefaultConversionPairs(): AggregatorsMap {
+    return defaultConversionPairs;
   }
 
   /**

packages/currency/src/index.ts

@@ -1,9 +1,6 @@
 export { getSupportedERC20Tokens } from './erc20';
 export { getSupportedERC777Tokens } from './erc777';
-export {
-  chainlinkSupportedNetworks as conversionSupportedNetworks,
-  CurrencyPairs,
-} from './chainlink-path-aggregators';
+export { conversionSupportedNetworks, CurrencyPairs } from './conversion-aggregators';
 export { getHash as getCurrencyHash } from './getHash';
 export { CurrencyManager } from './currencyManager';
 export * from './types';

packages/currency/test/chainlink-path-aggregators.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { CurrencyPairs, getPath } from '../src/chainlink-path-aggregators';
+import { CurrencyPairs, getPath } from '../src/conversion-aggregators';
 import { CurrencyManager } from '../src';
 const currencyManager = CurrencyManager.getDefault();
 const USD = currencyManager.from('USD')!;

packages/toolbox/src/chainlinkConversionPathTools.ts

@@ -178,7 +178,7 @@ export const listAggregators = async (options?: IOptions): Promise<void> => {
   // enables this usage:  yarn -s chainlinkPath mainnet  | clip
   console.error('#####################################################################');
   console.error('All aggregators nodes (currency) :');
-  console.error('../currency/src/chainlink-path-aggregators.ts');
+  console.error('../currency/src/conversion-aggregators.ts');
   console.log(JSON.stringify(aggregatorsNodesForDijkstra, null, 2));
 };
 

packages/toolbox/src/commands/chainlink/addAggregators.ts

@@ -75,8 +75,8 @@ export const handler = async (args: Options): Promise<void> => {
 
   if (!conversionSupportedNetworks.includes(network)) {
     console.warn(
-      `WARNING: ${network} is missing in chainlinkSupportedNetworks from the Currency package.`,
-      `Add '${network}: {}' to chainlinkCurrencyPairs, in currency/src/chainlink-path-aggregators.ts.`,
+      `WARNING: ${network} is missing in conversionSupportedNetworks from the Currency package.`,
+      `Add '${network}: {}' to chainlinkCurrencyPairs, in currency/src/conversion-aggregators.ts.`,
     );
   }