chore: refacto for the advanced logic other extensions

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

@@ -5,10 +5,10 @@ import {
   RequestLogicTypes,
 } from '@requestnetwork/types';
 
-import contentData from './extensions/content-data';
+import ContentData from './extensions/content-data';
 import AddressBasedBtc from './extensions/payment-network/bitcoin/mainnet-address-based';
 import AddressBasedTestnetBtc from './extensions/payment-network/bitcoin/testnet-address-based';
-import declarative from './extensions/payment-network/declarative';
+import Declarative from './extensions/payment-network/declarative';
 import AddressBasedErc20 from './extensions/payment-network/erc20/address-based';
 import FeeProxyContractErc20 from './extensions/payment-network/erc20/fee-proxy-contract';
 import ProxyContractErc20 from './extensions/payment-network/erc20/proxy-contract';
@@ -25,9 +25,9 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
     addressBasedBtc: new AddressBasedBtc(),
     addressBasedErc20: new AddressBasedErc20(),
     addressBasedTestnetBtc: new AddressBasedTestnetBtc(),
-    contentData,
+    contentData: new ContentData(),
     anyToErc20Proxy: new AnyToErc20Proxy(),
-    declarative,
+    declarative: new Declarative(),
     ethereumInputData: new EthereumInputData(),
     feeProxyContractErc20: new FeeProxyContractErc20(),
     proxyContractErc20: new ProxyContractErc20(),
@@ -53,7 +53,7 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
   ): RequestLogicTypes.IExtensionStates {
     const id: ExtensionTypes.ID = extensionAction.id;
     const extension: ExtensionTypes.IExtension | undefined = {
-      [ExtensionTypes.ID.CONTENT_DATA]: contentData,
+      [ExtensionTypes.ID.CONTENT_DATA]: this.extensions.contentData,
       [ExtensionTypes.ID.PAYMENT_NETWORK_BITCOIN_ADDRESS_BASED]: this.extensions.addressBasedBtc,
       [ExtensionTypes.ID.PAYMENT_NETWORK_TESTNET_BITCOIN_ADDRESS_BASED]: this.extensions
         .addressBasedTestnetBtc,

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

@@ -119,8 +119,11 @@ export default abstract class AbstractExtension<TCreationParameters> {
    * @param request
    * @param extensionAction action to apply
    */
-  protected abstract validate(
-    request: RequestLogicTypes.IRequest,
-    extensionAction: ExtensionTypes.IAction,
-  ): void;
+  protected validate(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _request: RequestLogicTypes.IRequest,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _extensionAction: ExtensionTypes.IAction,
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+  ): void {}
 }

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

@@ -1,78 +1,69 @@
-import { ExtensionTypes, RequestLogicTypes } from '@requestnetwork/types';
-
-import Utils from '@requestnetwork/utils';
-
-/**
- * Implementation of the content data extension
- */
-const contentData: ExtensionTypes.ContentData.IContentData = {
-  applyActionToExtension,
-  createCreationAction,
-};
-export default contentData;
+import { ExtensionTypes } from '@requestnetwork/types';
+import AbstractExtension from './abstract-extension';
 
 const CURRENT_VERSION = '0.1.0';
 
 /**
- * Creates the extensionsData to create the extension content-data
- * Should be called to create the extensionsData of a request
- *
- * @param extensions IAdvancedLogicExtensionsCreationParameters extensions parameters to create
- *
- * @returns IExtensionCreationAction the extensionsData to be store in the request
- */
-function createCreationAction(
-  creationParameters: ExtensionTypes.ContentData.ICreationParameters,
-): ExtensionTypes.IAction {
-  if (!creationParameters.content) {
-    throw Error('No content has been given for the extension content-data');
-  }
-
-  return {
-    action: ExtensionTypes.ContentData.ACTION.CREATE,
-    id: ExtensionTypes.ID.CONTENT_DATA,
-    parameters: creationParameters,
-    version: CURRENT_VERSION,
-  };
-}
-
-/**
- * Applies the extension action to the request
- * Is called to interpret the extensions data when applying the transaction
- *
- * @param extensionsState IExtensionStates previous state of the extensions
- * @param extensionAction IAction action to apply
- * @param requestState IRequest request state read-only
- *
- * @returns state of the request updated
+ * Implementation of the content data extension
  */
-function applyActionToExtension(
-  extensionsState: RequestLogicTypes.IExtensionStates,
-  extensionAction: ExtensionTypes.IAction,
-  requestState: RequestLogicTypes.IRequest,
-): RequestLogicTypes.IExtensionStates {
-  if (extensionAction.action !== ExtensionTypes.ContentData.ACTION.CREATE) {
-    throw Error(`Unknown action: ${extensionAction.action}`);
+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);
   }
 
-  if (requestState.extensions[ExtensionTypes.ID.CONTENT_DATA]) {
-    throw Error(`This extension has already been created`);
-  }
+  /**
+   * Creates the extensionsData to create the extension content-data
+   * Should be called to create the extensionsData of a request
+   *
+   * @param extensions IAdvancedLogicExtensionsCreationParameters extensions parameters to create
+   *
+   * @returns IExtensionCreationAction the extensionsData to be store in the request
+   */
+  public createCreationAction(
+    creationParameters: TCreationParameters,
+  ): ExtensionTypes.IAction<TCreationParameters> {
+    if (!creationParameters.content) {
+      throw Error('No content has been given for the extension content-data');
+    }
 
-  if (!extensionAction.parameters.content) {
-    throw Error('No content has been given for the extension content-data');
+    return super.createCreationAction(
+      creationParameters,
+    ) as ExtensionTypes.IAction<TCreationParameters>;
   }
 
-  // Deep copy to not mutate the input parameter
-  const copiedExtensionState: RequestLogicTypes.IExtensionStates = Utils.deepCopy(extensionsState);
+  /**
+   * Applies a creation
+   *
+   * @param extensionAction action to apply
+   * @param timestamp
+   *
+   * @returns state of the extension created
+   */
+  protected applyCreation(
+    extensionAction: ExtensionTypes.IAction,
+    timestamp: number,
+  ): ExtensionTypes.IState {
+    if (!extensionAction.parameters.content) {
+      throw Error('No content has been given for the extension content-data');
+    }
 
-  copiedExtensionState[ExtensionTypes.ID.CONTENT_DATA] = {
-    events: [],
-    id: ExtensionTypes.ID.CONTENT_DATA,
-    type: ExtensionTypes.TYPE.CONTENT_DATA,
-    values: { content: extensionAction.parameters.content },
-    version: CURRENT_VERSION,
-  };
+    const genericCreationAction = super.applyCreation(extensionAction, timestamp);
 
-  return copiedExtensionState;
+    return {
+      ...genericCreationAction,
+      events: [],
+      id: this.extensionId,
+      type: this.extensionType,
+      values: {
+        ...genericCreationAction.values,
+        content: extensionAction.parameters.content,
+      },
+      version: this.currentVersion,
+    };
+  }
 }