fix near typing

packages/currency/src/chains/ChainsAbstract.ts

@@ -41,8 +41,8 @@ export abstract class ChainsAbstract<
    * Check if chainName lives amongst the list of supported chains by this chain type.
    * Throws in the case it's not supported.
    */
-  public assertChainSupported(chainName: string): asserts chainName is CHAIN_NAME {
-    if (!(this.chainNames as string[]).includes(chainName))
+  public assertChainSupported(chainName?: string): asserts chainName is CHAIN_NAME {
+    if (!chainName || !(this.chainNames as string[]).includes(chainName))
       throw new Error(`Unsupported chain ${chainName}`);
   }
 

packages/currency/src/chains/near/index.ts

@@ -7,8 +7,8 @@ import * as NearTestnetDefinition from './data/near-testnet';
 export type NearChain = Chain;
 
 export const chains: Record<CurrencyTypes.NearChainName, NearChain> = {
-  aurora: NearDefinition, // FIXME: aurora should be removed from near chains (it is a mistake)
-  'aurora-testnet': NearTestnetDefinition, // FIXME: aurora should be removed from near chains (it is a mistake)
-  near: NearDefinition,
+  aurora: NearDefinition,
+  'aurora-testnet': NearTestnetDefinition,
+  // near: NearDefinition, // TODO: add support for near
   'near-testnet': NearTestnetDefinition,
 };

packages/payment-detection/src/near/near-conversion-detector.ts

@@ -28,10 +28,13 @@ export class NearConversionNativeTokenPaymentDetector extends AnyToNativeDetecto
     super(args);
   }
 
-  public static getContractName = (chainName: string, paymentNetworkVersion = '0.1.0'): string => {
+  public static getContractName = (
+    chainName: CurrencyTypes.NearChainName,
+    paymentNetworkVersion = '0.1.0',
+  ): string => {
     const version =
       NearConversionNativeTokenPaymentDetector.getVersionOrThrow(paymentNetworkVersion);
-    const versionMap: Record<string, Record<string, string>> = {
+    const versionMap: Record<CurrencyTypes.NearChainName, Record<string, string>> = {
       aurora: { '0.1.0': 'native.conversion.reqnetwork.near' },
       'aurora-testnet': {
         '0.1.0': 'native.conversion.reqnetwork.testnet',
@@ -63,7 +66,7 @@ export class NearConversionNativeTokenPaymentDetector extends AnyToNativeDetecto
     address: string | undefined,
     paymentReference: string,
     requestCurrency: RequestLogicTypes.ICurrency,
-    paymentChain: CurrencyTypes.EvmChainName,
+    paymentChain: CurrencyTypes.NearChainName,
     paymentNetwork: ExtensionTypes.IState<ExtensionTypes.PnAnyToEth.ICreationParameters>,
   ): Promise<PaymentTypes.AllNetworkRetrieverEvents<PaymentTypes.ETHPaymentNetworkEvent>> {
     if (!address) {

packages/payment-detection/src/near/near-detector.ts

@@ -28,9 +28,12 @@ export class NearNativeTokenPaymentDetector extends NativeTokenPaymentDetector {
     super(args);
   }
 
-  public static getContractName = (chainName: string, paymentNetworkVersion = '0.2.0'): string => {
+  public static getContractName = (
+    chainName: CurrencyTypes.NearChainName,
+    paymentNetworkVersion = '0.2.0',
+  ): string => {
     const version = NearNativeTokenPaymentDetector.getVersionOrThrow(paymentNetworkVersion);
-    const versionMap: Record<string, Record<string, string>> = {
+    const versionMap: Record<CurrencyTypes.NearChainName, Record<string, string>> = {
       aurora: { '0.1.0': 'requestnetwork.near', '0.2.0': 'requestnetwork.near' },
       'aurora-testnet': {
         '0.1.0': 'dev-1626339335241-5544297',

packages/payment-detection/src/near/retrievers/near-info-retriever.ts

@@ -1,5 +1,6 @@
 import { PaymentTypes } from '@requestnetwork/types';
 import { getTheGraphNearClient, TheGraphClient } from '../../thegraph';
+import { NearChains } from '@requestnetwork/currency';
 
 // FIXME#1: when Near subgraphes can retrieve a txHash, replace the custom IPaymentNetworkEvent with PaymentTypes.ETHPaymentNetworkEvent
 interface NearSubGraphPaymentEvent extends PaymentTypes.IETHPaymentEventParameters {
@@ -25,7 +26,9 @@ export class NearInfoRetriever {
     protected eventName: PaymentTypes.EVENTS_NAMES,
     network: string,
   ) {
-    if (network !== 'aurora' && network !== 'aurora-testnet' && network !== 'near-testnet') {
+    try {
+      NearChains.assertChainSupported(network);
+    } catch {
       throw new Error('Near input data info-retriever only works with Near mainnet and testnet');
     }
 

packages/payment-processor/src/payment/near-conversion.ts

@@ -15,7 +15,7 @@ import {
   processNearPaymentWithConversion,
 } from './utils-near';
 import { IConversionPaymentSettings } from '.';
-import { CurrencyManager, UnsupportedCurrencyError } from '@requestnetwork/currency';
+import { CurrencyManager, NearChains, UnsupportedCurrencyError } from '@requestnetwork/currency';
 
 /**
  * Processes the transaction to pay a request in NEAR with on-chain conversion.
@@ -48,6 +48,7 @@ export async function payNearConversionRequest(
   if (!network || !isNearNetwork(network)) {
     throw new Error('Should be a Near network');
   }
+  NearChains.assertChainSupported(network);
 
   const amountToPay = getAmountToPay(request, amount).toString();
   const version = getPaymentExtensionVersion(request);

packages/payment-processor/src/payment/near-input-data.ts

@@ -4,12 +4,13 @@ import { WalletConnection } from 'near-api-js';
 import { ClientTypes, ExtensionTypes } from '@requestnetwork/types';
 
 import {
-  getRequestPaymentValues,
-  validateRequest,
   getAmountToPay,
   getPaymentExtensionVersion,
+  getRequestPaymentValues,
+  validateRequest,
 } from './utils';
 import { INearTransactionCallback, isNearNetwork, processNearPayment } from './utils-near';
+import { NearChains } from '@requestnetwork/currency';
 
 /**
  * processes the transaction to pay a Near request.
@@ -27,6 +28,7 @@ export async function payNearInputDataRequest(
     throw new Error('request.currencyInfo should be a Near network');
   }
 
+  NearChains.assertChainSupported(request.currencyInfo.network);
   validateRequest(request, ExtensionTypes.PAYMENT_NETWORK_ID.NATIVE_TOKEN);
 
   const { paymentReference, paymentAddress } = getRequestPaymentValues(request);

packages/payment-processor/src/payment/utils-near.ts

@@ -1,15 +1,16 @@
 import { BigNumber, BigNumberish, ethers } from 'ethers';
-import { Contract } from 'near-api-js';
-import { Near, WalletConnection } from 'near-api-js';
+import { Contract, Near, WalletConnection } from 'near-api-js';
 import {
-  NearNativeTokenPaymentDetector,
   NearConversionNativeTokenPaymentDetector,
+  NearNativeTokenPaymentDetector,
 } from '@requestnetwork/payment-detection';
+import { NearChains } from '@requestnetwork/currency';
+import { CurrencyTypes } from '@requestnetwork/types';
 
 /**
  * Callback arguments for the Near web wallet.
  * @member callbackUrl called upon transaction approval
- * @member callbackMeta (according to Near docs: `meta` will be attached to the `callbackUrl` as a url search param)
+ * @member meta (according to Near docs: `meta` will be attached to the `callbackUrl` as a url search param)
  */
 export interface INearTransactionCallback {
   callbackUrl?: string;
@@ -26,10 +27,12 @@ export const isValidNearAddress = async (nearNetwork: Near, address: string): Pr
 };
 
 export const isNearNetwork = (network?: string): boolean => {
-  return (
-    !!network &&
-    (network === 'near-testnet' || network === 'aurora-testnet' || network === 'aurora')
-  );
+  try {
+    NearChains.assertChainSupported(network);
+    return true;
+  } catch {
+    return false;
+  }
 };
 
 export const isNearAccountSolvent = (
@@ -52,7 +55,7 @@ const GAS_LIMIT_CONVERSION_TO_NATIVE = GAS_LIMIT.mul(2).toString();
 
 export const processNearPayment = async (
   walletConnection: WalletConnection,
-  network: string,
+  network: CurrencyTypes.NearChainName,
   amount: BigNumberish,
   to: string,
   paymentReference: string,
@@ -104,7 +107,7 @@ export const processNearPayment = async (
  */
 export const processNearPaymentWithConversion = async (
   walletConnection: WalletConnection,
-  network: string,
+  network: CurrencyTypes.NearChainName,
   amount: BigNumberish,
   to: string,
   paymentReference: string,

packages/types/src/currency-types.ts

@@ -33,9 +33,9 @@ export type BtcChainName = 'mainnet' | 'testnet';
  * List of supported NEAR chains
  */
 export type NearChainName =
-  | 'aurora' // FIXME: aurora should be removed from near chains (it is a mistake)
-  | 'aurora-testnet' // FIXME: aurora should be removed from near chains (it is a mistake)
-  | 'near'
+  | 'aurora'
+  | 'aurora-testnet'
+  // | 'near'  // TODO: add support for near
   | 'near-testnet';
 
 export type ChainName = EvmChainName | BtcChainName | NearChainName;