Merge pull request #138 from mckrava/feature/add-bridge-chains-proper…

…ty-support-social-remark

Feat: add definition of destination chain in SocialRemark

packages/utils/src/socialRemark/README.md

@@ -5,9 +5,9 @@ The SocialRemark protocol is designed to process cross-chain actions.
 ## SocialRemark message format
 
 - Domain Registration
-  `prot_name::version::action::op_id::target::domain_name::token`
+  `prot_name::version::destination::action::op_id::target::domain_name::token`
 - Energy Generation
-  `prot_name::version::action::op_id::target::energy_amount::token`
+  `prot_name::version::destination::action::op_id::target::energy_amount::token`
 
 A Remark message has 2 parts:
 - the core part (which is the same for all messages): `prot_name::version::action`
@@ -18,6 +18,8 @@ A Remark message has 2 parts:
 Core part options:
 - `prot_name` - The protocol name (the default valid value is `social`, but it can be configured with the `.setConfig()` method)
 - `version` - The protocol version (the current available version is `0.1`)
+- `destination` - The chain which will be used for cross-chain actions. User can use predefined chain IDs which are
+    exposed in SocialRemark utility library.
 - `action` - The message action (available actions: `DMN_REG`, `DMN_REG_OK`, `DMN_REG_REFUND`, `NRG_GEN`, `NRG_GEN_OK`, `NRG_GEN_REFUND`)
 
 Content options:
@@ -30,7 +32,7 @@ Content options:
 Here is a dummy example of a SocialRemark message:
 
 ```
-social::0.1::DMN_REG::0x44d8d9f1bc70e45eb773731f9ffc5d3646df56497c40cdfff37c8ceb71fa2-2104480009442407::3t5NA8UKsGzrCDMfp8XMEBghiYthWGXGsHbjtJY45NUJDY5P::somenewdomain.sub::DOT
+social::0.1::1::DMN_REG::0x44d8d9f1bc70e45eb773731f9ffc5d3646df56497c40cdfff37c8ceb71fa2-2104480009442407::3t5NA8UKsGzrCDMfp8XMEBghiYthWGXGsHbjtJY45NUJDY5P::somenewdomain.sub::DOT
 ```
 
 ## Usage examples:
@@ -48,8 +50,9 @@ SocialRemark.setConfig({ protNames: ['social_custom'] })
 
 const remarkSource: SubSclSource<'DMN_REG'> = {
   protName: 'social_custom',
-  action: 'DMN_REG',
   version: '0.1',
+  action: 'DMN_REG',
+  destination: 1,
   content: {
     opId: `${randomAsNumber()}`,
     domainName: `somenewdomain.sub`,

packages/utils/src/socialRemark/config.ts

@@ -1,13 +1,15 @@
 import {
   SocialRemarkMessageAction,
   SocialRemarkMessageProtocolName,
-  SocialRemarkMessageVersion
+  SocialRemarkMessageVersion,
+  SocialRemarkMessageDestination,
 } from './types'
 
 export type SocialRemarkConfigData = {
   protNames?: Array<SocialRemarkMessageProtocolName>
   actions?: SocialRemarkMessageAction[]
   versions?: SocialRemarkMessageVersion[]
+  destinations?: SocialRemarkMessageDestination[]
 }
 
 /**
@@ -27,7 +29,8 @@ export class SocialRemarkConfig {
       'NRG_GEN_OK',
       'NRG_GEN_REFUND'
     ],
-    versions: ['0.1']
+    versions: ['0.1'],
+    destinations: ['1', '2', '3']
   }
 
   static getInstance(): SocialRemarkConfig {

packages/utils/src/socialRemark/core.ts

@@ -2,7 +2,7 @@ import {
   REMARK_CONTENT_VERSION_ACTION_MAP,
   RemarkContentProps,
   SocialRemarkMessage,
-  SocialRemarkMessageAction,
+  SocialRemarkMessageAction, SocialRemarkMessageDestination,
   SocialRemarkMessageProtocolName,
   SocialRemarkMessageVersion,
   SubSclSource
@@ -34,24 +34,29 @@ export class SocialRemark {
     SocialRemarkConfig.getInstance().config.versions
   )
 
+  private destinations: Set<SocialRemarkMessageDestination> = new Set(
+    SocialRemarkConfig.getInstance().config.destinations
+  )
+
   private actions: Set<SocialRemarkMessageAction> = new Set(
     SocialRemarkConfig.getInstance().config.actions
   )
 
+
   private msgDelimiter: string = '::'
 
   /**
    * Get SocialRemark full data, if it's available. Otherwise, go throw error.
    */
-  public get message():
+  public get source():
     | SocialRemarkMessage<SocialRemarkMessageAction, boolean>
     | never {
     if (!this.msgParsed) throw new Error('Message is not available.')
     return this.msgParsed!
   }
 
   /**
-   * Get SocialRemark instance message content, if it's valid and available.
+   * Get SocialRemark instance source content, if it's valid and available.
    */
   public get content() {
     return this.msgParsed && this.msgParsed.valid
@@ -126,30 +131,31 @@ export class SocialRemark {
   }
 
   /**
-   * Encode SocialRemark message to remark string.
+   * Encode SocialRemark source to remark string.
    */
   public toMessage(): string {
     if (!this.isValidMessage)
       throw new Error('Remark is not valid for build message.')
 
     const msg: string[] = []
-    msg.push(this.message.protName)
-    msg.push(this.message.version)
-    msg.push(this.message.action)
+    msg.push(this.source.protName)
+    msg.push(this.source.version)
+    msg.push(this.source.destination)
+    msg.push(this.source.action)
 
     try {
       const contentPropsMap =
         // @ts-ignore
-        REMARK_CONTENT_VERSION_ACTION_MAP[this.message.version][
-          this.message.action
+        REMARK_CONTENT_VERSION_ACTION_MAP[this.source.version][
+          this.source.action
         ]
       for (const contentPropName in contentPropsMap) {
         // @ts-ignore
         msg[contentPropsMap[contentPropName]] = decorateRemarkContentValue(
-          this.message.action,
+          this.source.action,
           contentPropName as RemarkContentProps,
           // @ts-ignore
-          this.message.content[contentPropName]
+          this.source.content[contentPropName]
         )
       }
     } catch (e) {
@@ -177,14 +183,16 @@ export class SocialRemark {
       chunkedMsg.length === 0 ||
       !this.isValidProtName(chunkedMsg[0]) ||
       !this.isValidVersion(chunkedMsg[1]) ||
-      !this.isValidAction(chunkedMsg[2])
+      !this.isValidDestination(chunkedMsg[2]) ||
+      !this.isValidAction(chunkedMsg[3])
     )
       return
 
     this.msgParsed = {
       protName: chunkedMsg[0] as SocialRemarkMessageProtocolName,
       version: chunkedMsg[1] as SocialRemarkMessageVersion,
-      action: chunkedMsg[2] as SocialRemarkMessageAction,
+      destination: chunkedMsg[2] as SocialRemarkMessageDestination,
+      action: chunkedMsg[3] as SocialRemarkMessageAction,
       valid: false,
       content: null
     }
@@ -220,6 +228,9 @@ export class SocialRemark {
   private isValidVersion(src: string): boolean {
     return !!(src && this.versions.has(src as SocialRemarkMessageVersion))
   }
+  private isValidDestination(src: string): boolean {
+    return !!(src && this.destinations.has(src as SocialRemarkMessageDestination))
+  }
   private isValidAction(src: string): boolean {
     return !!(src && this.actions.has(src as SocialRemarkMessageAction))
   }
@@ -250,6 +261,15 @@ export class SocialRemark {
         )}"`
       )
 
+    if (!this.isValidDestination(rmrkSrc.destination))
+      throw new Error(
+        `Remark source is invalid - destination "${
+          rmrkSrc.destination
+        }" has been provided but expected - "${[...this.destinations.keys()].join(
+          ' || '
+        )}"`
+      )
+
     if (!this.isValidAction(rmrkSrc.action))
       throw new Error(
         `Remark source is invalid - action "${

packages/utils/src/socialRemark/index.ts

@@ -4,6 +4,7 @@ export {
   SubSclSource,
   SocialRemarkMessageContent,
   SocialRemarkMessageProtocolName,
+  SocialRemarkDestChainsNameId,
   SocialRemarkMessageAction,
   SocialRemarkMessageVersion,
   RemarkContentProps,

packages/utils/src/socialRemark/types.ts

@@ -47,6 +47,7 @@ export type RemarkContentProps =
   | keyof EnergyGenerateRefundContent;
 
 export type SocialRemarkMessageVersion = '0.1';
+export type SocialRemarkMessageDestination = '1' | '2' | '3';
 export type SocialRemarkMessageAction =
   | 'DMN_REG'
   | 'DMN_REG_OK'
@@ -59,6 +60,12 @@ export type SocialRemarkMessageProtocolName =
   | 'social'
   | string;
 
+export enum SocialRemarkDestChainsNameId {
+  subsocial = '1',
+  xsocial = '2',
+  soonsocial = '3',
+}
+
 export type SocialRemarkMessageContent<
   A extends SocialRemarkMessageAction | string
 > = A extends 'DMN_REG'
@@ -81,6 +88,7 @@ export type SocialRemarkMessage<
 > = {
   protName: SocialRemarkMessageProtocolName;
   version: SocialRemarkMessageVersion;
+  destination: SocialRemarkMessageDestination;
   action: A;
   valid: V; // TODO make this prop optional
   content: V extends true ? SocialRemarkMessageContent<A> : null;
@@ -102,40 +110,40 @@ type VersionActionPropsMap = Record<
 export const REMARK_CONTENT_VERSION_ACTION_MAP: VersionActionPropsMap = {
   '0.1': {
     DMN_REG: {
-      opId: 3,
-      target: 4,
-      domainName: 5,
-      token: 6
+      opId: 4,
+      target: 5,
+      domainName: 6,
+      token: 7
     },
     DMN_REG_OK: {
-      opId: 3,
-      target: 4,
-      domainName: 5,
-      token: 6
+      opId: 4,
+      target: 5,
+      domainName: 6,
+      token: 7
     },
     DMN_REG_REFUND: {
-      opId: 3,
-      target: 4,
-      domainName: 5,
-      token: 6
+      opId: 4,
+      target: 5,
+      domainName: 6,
+      token: 7
     },
     NRG_GEN: {
-      opId: 3,
-      target: 4,
-      energyAmount: 5,
-      token: 6
+      opId: 4,
+      target: 5,
+      energyAmount: 6,
+      token: 7
     },
     NRG_GEN_OK: {
-      opId: 3,
-      target: 4,
-      energyAmount: 5,
-      token: 6
+      opId: 4,
+      target: 5,
+      energyAmount: 6,
+      token: 7
     },
     NRG_GEN_REFUND: {
-      opId: 3,
-      target: 4,
-      energyAmount: 5,
-      token: 6
+      opId: 4,
+      target: 5,
+      energyAmount: 6,
+      token: 7
     }
   }
 };