refactor: check for contract deployment before creating pn

packages/advanced-logic/src/advanced-logic.ts

@@ -4,7 +4,7 @@ import {
   IdentityTypes,
   RequestLogicTypes,
 } from '@requestnetwork/types';
-import { ICurrencyManager, CurrencyManager } from '@requestnetwork/currency';
+import { CurrencyManager, ICurrencyManager } from '@requestnetwork/currency';
 
 import ContentData from './extensions/content-data';
 import AddressBasedBtc from './extensions/payment-network/bitcoin/mainnet-address-based';
@@ -16,12 +16,14 @@ import ProxyContractErc20 from './extensions/payment-network/erc20/proxy-contrac
 import Erc777Stream from './extensions/payment-network/erc777/stream';
 import FeeProxyContractEth from './extensions/payment-network/ethereum/fee-proxy-contract';
 import EthereumInputData from './extensions/payment-network/ethereum/input-data';
-import NearNative from './extensions/payment-network/near-native';
+import NearNative from './extensions/payment-network/near/near-native';
+import NearTestnetNative from './extensions/payment-network/near/near-testnet-native';
 import AnyToErc20Proxy from './extensions/payment-network/any-to-erc20-proxy';
 import AnyToEthProxy from './extensions/payment-network/any-to-eth-proxy';
-import NativeTokenPaymentNetwork from './extensions/payment-network/native-token';
-import AnyToNear from './extensions/payment-network/any-to-near';
-import AnyToNativeTokenPaymentNetwork from './extensions/payment-network/any-to-native';
+import AnyToNear from './extensions/payment-network/near/any-to-near';
+import AnyToNearTestnet from './extensions/payment-network/near/any-to-near-testnet';
+import NativeToken from './extensions/payment-network/native-token';
+import AnyToNative from './extensions/payment-network/any-to-native';
 
 /**
  * Module to manage Advanced logic extensions
@@ -37,13 +39,13 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
     anyToErc20Proxy: AnyToErc20Proxy;
     declarative: Declarative;
     ethereumInputData: EthereumInputData;
-    nativeToken: NativeTokenPaymentNetwork[];
+    nativeToken: NativeToken[];
     feeProxyContractErc20: FeeProxyContractErc20;
     proxyContractErc20: ProxyContractErc20;
     erc777Stream: Erc777Stream;
     feeProxyContractEth: FeeProxyContractEth;
     anyToEthProxy: AnyToEthProxy;
-    anyToNativeToken: AnyToNativeTokenPaymentNetwork[];
+    anyToNativeToken: AnyToNative[];
   };
 
   constructor(currencyManager?: ICurrencyManager) {
@@ -63,10 +65,11 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
       erc777Stream: new Erc777Stream(),
       feeProxyContractEth: new FeeProxyContractEth(),
       anyToEthProxy: new AnyToEthProxy(currencyManager),
-      nativeToken: [new NearNative()],
-      anyToNativeToken: [new AnyToNear(currencyManager)],
+      nativeToken: [new NearNative(), new NearTestnetNative()],
+      anyToNativeToken: [new AnyToNear(currencyManager), new AnyToNearTestnet(currencyManager)],
     };
   }
+
   /**
    * Applies the extension action to the request extensions state
    *
@@ -138,6 +141,14 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
     return extension;
   }
 
+  public getNativeTokenExtensionForNetwork(
+    network: string,
+  ): ExtensionTypes.IExtension<ExtensionTypes.PnReferenceBased.ICreationParameters> | undefined {
+    return this.extensions.nativeToken.find((nativeTokenExtension) =>
+      nativeTokenExtension.supportedNetworks.includes(network),
+    );
+  }
+
   protected getNativeTokenExtensionForActionAndState(
     extensionAction: ExtensionTypes.IAction,
     requestState: RequestLogicTypes.IRequest,
@@ -152,24 +163,23 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
       );
     }
     const network = requestState.currency.network ?? extensionAction.parameters.paymentNetworkName;
-    return network
-      ? this.extensions.nativeToken.find((nativeTokenExtension) =>
-          nativeTokenExtension.supportedNetworks.includes(network),
-        )
-      : undefined;
+    return network ? this.getNativeTokenExtensionForNetwork(network) : undefined;
+  }
+
+  public getAnyToNativeTokenExtensionForNetwork(
+    network: string,
+  ): ExtensionTypes.IExtension<ExtensionTypes.PnAnyToEth.ICreationParameters> | undefined {
+    return this.extensions.anyToNativeToken.find((anyToNativeTokenExtension) =>
+      anyToNativeTokenExtension.supportedNetworks.includes(network),
+    );
   }
 
   protected getAnyToNativeTokenExtensionForActionAndState(
     extensionAction: ExtensionTypes.IAction,
     requestState: RequestLogicTypes.IRequest,
   ): ExtensionTypes.IExtension<ExtensionTypes.PnAnyToEth.ICreationParameters> | undefined {
     const network = this.getNetwork(extensionAction, requestState);
-
-    return network
-      ? this.extensions.anyToNativeToken.find((anyToNativeTokenExtension) =>
-          anyToNativeTokenExtension.supportedNetworks.includes(network),
-        )
-      : undefined;
+    return network ? this.getAnyToNativeTokenExtensionForNetwork(network) : undefined;
   }
 
   protected getNetwork(

packages/advanced-logic/src/extensions/abstract-extension.ts

@@ -4,13 +4,13 @@ import Utils from '@requestnetwork/utils';
 /**
  * Abstract class to create extension
  */
-export abstract class AbstractExtension<TCreationParameters> {
+export abstract class AbstractExtension<TCreationParameters> implements ExtensionTypes.IExtension {
   protected actions: ExtensionTypes.SupportedActions;
 
-  public constructor(
-    public extensionType: ExtensionTypes.TYPE,
-    public extensionId: ExtensionTypes.ID,
-    public currentVersion: string,
+  protected constructor(
+    public readonly extensionType: ExtensionTypes.TYPE,
+    public readonly extensionId: ExtensionTypes.ID,
+    public readonly currentVersion: string,
   ) {
     this.actions = {};
   }
@@ -119,7 +119,6 @@ export abstract class AbstractExtension<TCreationParameters> {
    * It is called at the beginning of every applyActionToExtension()
    * It must throw in case of error
    *
-   * @param request
    * @param extensionAction action to apply
    */
   protected validate(

packages/advanced-logic/src/extensions/content-data.ts

@@ -9,11 +9,8 @@ const CURRENT_VERSION = '0.1.0';
 export default class ContentDataExtension<
   TCreationParameters extends ExtensionTypes.ContentData.ICreationParameters = ExtensionTypes.ContentData.ICreationParameters,
 > extends AbstractExtension<TCreationParameters> {
-  public constructor(
-    public extensionId: ExtensionTypes.ID = ExtensionTypes.ID.CONTENT_DATA,
-    public currentVersion: string = CURRENT_VERSION,
-  ) {
-    super(ExtensionTypes.TYPE.CONTENT_DATA, extensionId, currentVersion);
+  public constructor() {
+    super(ExtensionTypes.TYPE.CONTENT_DATA, ExtensionTypes.ID.CONTENT_DATA, CURRENT_VERSION);
   }
 
   /**
@@ -40,7 +37,6 @@ export default class ContentDataExtension<
    * Applies a creation
    *
    * @param extensionAction action to apply
-   * @param timestamp
    *
    * @returns state of the extension created
    */

packages/advanced-logic/src/extensions/payment-network/address-based.ts

@@ -10,11 +10,10 @@ import DeclarativePaymentNetwork from './declarative';
 export default abstract class AddressBasedPaymentNetwork<
   TCreationParameters extends ExtensionTypes.PnAddressBased.ICreationParameters = ExtensionTypes.PnAddressBased.ICreationParameters,
 > extends DeclarativePaymentNetwork<TCreationParameters> {
-  public constructor(
-    public extensionId: ExtensionTypes.ID,
-    public currentVersion: string,
-    public supportedNetworks: string[],
-    public supportedCurrencyType: RequestLogicTypes.CURRENCY,
+  protected constructor(
+    extensionId: ExtensionTypes.ID,
+    currentVersion: string,
+    public readonly supportedCurrencyType: RequestLogicTypes.CURRENCY,
   ) {
     super(extensionId, currentVersion);
     this.actions = {
@@ -29,7 +28,7 @@ export default abstract class AddressBasedPaymentNetwork<
   /**
    * Creates the extensionsData for address based payment networks
    *
-   * @param extensions extensions parameters to create
+   * @param creationParameters extensions parameters to create
    *
    * @returns IExtensionCreationAction the extensionsData to be stored in the request
    */
@@ -58,7 +57,7 @@ export default abstract class AddressBasedPaymentNetwork<
   /**
    * Creates the extensionsData to add a payment address
    *
-   * @param extensions extensions parameters to create
+   * @param addPaymentAddressParameters extensions parameters to create
    *
    * @returns IAction the extensionsData to be stored in the request
    */
@@ -82,7 +81,7 @@ export default abstract class AddressBasedPaymentNetwork<
   /**
    * Creates the extensionsData to add a refund address
    *
-   * @param extensions extensions parameters to create
+   * @param addRefundAddressParameters extensions parameters to create
    *
    * @returns IAction the extensionsData to be stored in the request
    */
@@ -140,23 +139,8 @@ export default abstract class AddressBasedPaymentNetwork<
     };
   }
 
-  protected isValidAddress(address: string, networkName?: string): boolean {
-    if (networkName) {
-      return this.isValidAddressForNetwork(address, networkName);
-    }
-    return this.supportedNetworks.some((network) =>
-      this.isValidAddressForNetwork(address, network),
-    );
-  }
-
-  protected isValidAddressForNetwork(address: string, network: string): boolean {
+  protected isValidAddress(address: string): boolean {
     switch (this.supportedCurrencyType) {
-      case RequestLogicTypes.CURRENCY.BTC:
-        return this.isValidAddressForSymbolAndNetwork(
-          address,
-          network === 'testnet' ? 'BTC-testnet' : 'BTC',
-          network,
-        );
       case RequestLogicTypes.CURRENCY.ETH:
       case RequestLogicTypes.CURRENCY.ERC20:
       case RequestLogicTypes.CURRENCY.ERC777:
@@ -182,7 +166,7 @@ export default abstract class AddressBasedPaymentNetwork<
   }
 
   /**
-   * Applies add payment address
+   * Applies the add payment address action
    *
    * @param extensionState previous state of the extension
    * @param extensionAction action to apply
@@ -200,7 +184,7 @@ export default abstract class AddressBasedPaymentNetwork<
   ): ExtensionTypes.IState {
     if (
       extensionAction.parameters.paymentAddress &&
-      !this.isValidAddress(extensionAction.parameters.paymentAddress, requestState.currency.network)
+      !this.isValidAddress(extensionAction.parameters.paymentAddress)
     ) {
       throw new InvalidPaymentAddressError(extensionAction.parameters.paymentAddress);
     }
@@ -247,7 +231,7 @@ export default abstract class AddressBasedPaymentNetwork<
   ): ExtensionTypes.IState {
     if (
       extensionAction.parameters.refundAddress &&
-      !this.isValidAddress(extensionAction.parameters.refundAddress, requestState.currency.network)
+      !this.isValidAddress(extensionAction.parameters.refundAddress)
     ) {
       throw Error('refundAddress is not a valid address');
     }
@@ -290,9 +274,6 @@ export default abstract class AddressBasedPaymentNetwork<
     if (!network) {
       throw Error('network is required');
     }
-    if (network && this.supportedNetworks && !this.supportedNetworks.includes(network)) {
-      throw new UnsupportedNetworkError(network, this.supportedNetworks);
-    }
   }
 }
 

packages/advanced-logic/src/extensions/payment-network/any-to-erc20-proxy.ts

@@ -14,12 +14,7 @@ export default class AnyToErc20ProxyPaymentNetwork extends Erc20FeeProxyPaymentN
     extensionId: ExtensionTypes.ID = ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ERC20_PROXY,
     currentVersion: string = CURRENT_VERSION,
   ) {
-    super(
-      extensionId,
-      currentVersion,
-      conversionSupportedNetworks,
-      RequestLogicTypes.CURRENCY.ERC20,
-    );
+    super(extensionId, currentVersion);
   }
 
   /**
@@ -121,8 +116,6 @@ export default class AnyToErc20ProxyPaymentNetwork extends Erc20FeeProxyPaymentN
   /**
    * Validate the extension action regarding the currency and network
    * It must throw in case of error
-   *
-   * @param request
    */
   protected validate(
     request: RequestLogicTypes.IRequest,

packages/advanced-logic/src/extensions/payment-network/any-to-eth-proxy.ts

@@ -1,20 +1,12 @@
-import {
-  conversionSupportedNetworks,
-  ICurrencyManager,
-  UnsupportedCurrencyError,
-} from '@requestnetwork/currency';
+import { ICurrencyManager, UnsupportedCurrencyError } from '@requestnetwork/currency';
 import { ExtensionTypes, RequestLogicTypes } from '@requestnetwork/types';
 import EthereumFeeProxyPaymentNetwork from './ethereum/fee-proxy-contract';
 
 const CURRENT_VERSION = '0.2.0';
 
 export default class AnyToEthProxyPaymentNetwork extends EthereumFeeProxyPaymentNetwork {
-  public constructor(
-    private currencyManager: ICurrencyManager,
-    extensionId: ExtensionTypes.ID = ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ETH_PROXY,
-    currentVersion: string = CURRENT_VERSION,
-  ) {
-    super(extensionId, currentVersion, conversionSupportedNetworks);
+  public constructor(private currencyManager: ICurrencyManager) {
+    super(ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ETH_PROXY, CURRENT_VERSION);
   }
 
   /**
@@ -77,8 +69,6 @@ export default class AnyToEthProxyPaymentNetwork extends EthereumFeeProxyPayment
   /**
    * Validate the extension action regarding the currency and network
    * It must throw in case of error
-   *
-   * @param request
    */
   protected validate(
     request: RequestLogicTypes.IRequest,
@@ -95,10 +85,6 @@ export default class AnyToEthProxyPaymentNetwork extends EthereumFeeProxyPayment
       );
     }
 
-    if (!conversionSupportedNetworks.includes(network)) {
-      throw new Error(`The network (${network}) is not supported for this payment network.`);
-    }
-
     const currency = this.currencyManager.fromStorageCurrency(request.currency);
     if (!currency) {
       throw new UnsupportedCurrencyError(request.currency);

packages/advanced-logic/src/extensions/payment-network/any-to-native.ts

@@ -1,38 +1,34 @@
 import { FeeReferenceBasedPaymentNetwork } from './fee-reference-based';
 import { ExtensionTypes, RequestLogicTypes } from '@requestnetwork/types';
-import { InvalidPaymentAddressError } from './address-based';
+import { InvalidPaymentAddressError, UnsupportedNetworkError } from './address-based';
 
 export default abstract class AnyToNativeTokenPaymentNetwork extends FeeReferenceBasedPaymentNetwork {
-  public constructor(
+  protected constructor(
     extensionId: ExtensionTypes.ID,
     currentVersion: string,
-    supportedNetworks: string[],
+    public readonly supportedNetworks: string[],
   ) {
-    super(extensionId, currentVersion, supportedNetworks, RequestLogicTypes.CURRENCY.ETH);
+    super(extensionId, currentVersion, RequestLogicTypes.CURRENCY.ETH);
   }
 
   public createCreationAction(
     creationParameters: ExtensionTypes.PnAnyToAnyConversion.ICreationParameters,
   ): ExtensionTypes.IAction<ExtensionTypes.PnAnyToAnyConversion.ICreationParameters> {
     const network = creationParameters.network;
     this.throwIfInvalidNetwork(network);
-
     if (
       creationParameters.paymentAddress &&
-      !this.isValidAddress(creationParameters.paymentAddress, network)
+      !this.isValidAddress(creationParameters.paymentAddress)
     ) {
       throw new InvalidPaymentAddressError(creationParameters.paymentAddress);
     }
     if (
       creationParameters.refundAddress &&
-      !this.isValidAddress(creationParameters.refundAddress, network)
+      !this.isValidAddress(creationParameters.refundAddress)
     ) {
       throw new InvalidPaymentAddressError(creationParameters.refundAddress, 'refundAddress');
     }
-    if (
-      creationParameters.feeAddress &&
-      !this.isValidAddress(creationParameters.feeAddress, network)
-    ) {
+    if (creationParameters.feeAddress && !this.isValidAddress(creationParameters.feeAddress)) {
       throw new InvalidPaymentAddressError(creationParameters.feeAddress, 'feeAddress');
     }
     if (creationParameters.maxRateTimespan && creationParameters.maxRateTimespan < 0) {
@@ -42,7 +38,18 @@ export default abstract class AnyToNativeTokenPaymentNetwork extends FeeReferenc
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  protected abstract isValidAddress(_address: string, _networkName?: string): boolean;
+  protected isValidAddress(_address: string): boolean {
+    throw new Error(
+      `Default implementation of isValidAddress() does not support native tokens. Please override this method.`,
+    );
+  }
+
+  protected throwIfInvalidNetwork(network?: string): asserts network is string {
+    super.throwIfInvalidNetwork(network);
+    if (this.supportedNetworks && !this.supportedNetworks.includes(network)) {
+      throw new UnsupportedNetworkError(network, this.supportedNetworks);
+    }
+  }
 }
 
 export class InvalidMaxRateTimespanError extends Error {