Merge pull request #4727 from zeeshanakram3/ephesus_updateFromMaster

Ephesus: Update from `master`

Author: Leszek Wiesner

.gitignore

@@ -45,4 +45,6 @@ runtime-inputs/
 
 .my_setup
 
-devops/infrastructure
+devops/infrastructure
+
+joystream.tar.gz

RUNTIME-CONTRIBUTING.md

@@ -26,7 +26,7 @@ $ npm install -g @joystream/cli
 $ joystream-cli COMMAND
 running command...
 $ joystream-cli (-v|--version|version)
-@joystream/cli/1.2.0 darwin-x64 node-v14.16.1
+@joystream/cli/1.2.0 darwin-x64 node-v14.18.0
 $ joystream-cli --help [COMMAND]
 USAGE
   $ joystream-cli COMMAND
@@ -175,6 +175,9 @@ When using the CLI for the first time there are a few common steps you might wan
 - [`joystream-cli membership:updateAccounts`](#joystream-cli-membershipupdateaccounts)
 - [`joystream-cli sign-offline:signUnsignedTx`](#joystream-cli-sign-offlinesignunsignedtx)
 - [`joystream-cli staking:validate`](#joystream-cli-stakingvalidate)
+- [`joystream-cli util:decodeMessage`](#joystream-cli-utildecodemessage)
+- [`joystream-cli util:encodeMessage`](#joystream-cli-utilencodemessage)
+- [`joystream-cli util:messageStructure`](#joystream-cli-utilmessagestructure)
 - [`joystream-cli working-groups:application WGAPPLICATIONID`](#joystream-cli-working-groupsapplication-wgapplicationid)
 - [`joystream-cli working-groups:apply`](#joystream-cli-working-groupsapply)
 - [`joystream-cli working-groups:cancelOpening OPENINGID`](#joystream-cli-working-groupscancelopening-openingid)
@@ -2106,6 +2109,84 @@ OPTIONS
 
 _See code: [src/commands/staking/validate.ts](https://github.com/Joystream/joystream/blob/master/cli/src/commands/staking/validate.ts)_
 
+## `joystream-cli util:decodeMessage`
+
+Decode a protobuf message (from hex to json)
+
+```
+USAGE
+  $ joystream-cli util:decodeMessage
+
+OPTIONS
+  --hex=hex
+      (required) Hex-encoded protobuf message'
+
+  --type=(AppActionMetadata|AppAction|BountyMetadata|BountyWorkData|ChannelMetadata|ChannelPayoutsMetadata|CouncilCandid
+  acyNoteMetadata|ForumPostMetadata|ForumThreadMetadata|MembershipMetadata|ReactVideo|ReactComment|CreateComment|EditCom
+  ment|DeleteComment|PinOrUnpinComment|ModerateComment|BanOrUnbanMemberFromChannel|VideoReactionsPreference|CreateVideoC
+  ategory|MakeChannelPayment|AppMetadata|CreateApp|UpdateApp|MemberRemarked|ChannelModeratorRemarked|ChannelOwnerRemarke
+  d|PersonMetadata|ProposalsDiscussionPostMetadata|SeriesMetadata|SeasonMetadata|GeoCoordiantes|NodeLocationMetadata|Sto
+  rageBucketOperatorMetadata|DistributionBucketOperatorMetadata|GeographicalArea|DistributionBucketFamilyMetadata|Publis
+  hedBeforeJoystream|License|MediaType|SubtitleMetadata|VideoMetadata|ContentMetadata|OpeningMetadata|UpcomingOpeningMet
+  adata|ApplicationMetadata|WorkingGroupMetadata|SetGroupMetadata|AddUpcomingOpening|RemoveUpcomingOpening|WorkingGroupM
+  etadataAction|ModeratePost|RemarkMetadataAction)
+      Type of the message
+```
+
+_See code: [src/commands/util/decodeMessage.ts](https://github.com/Joystream/joystream/blob/master/cli/src/commands/util/decodeMessage.ts)_
+
+## `joystream-cli util:encodeMessage`
+
+Encode a protobuf message (from json to hex)
+
+```
+USAGE
+  $ joystream-cli util:encodeMessage
+
+OPTIONS
+  -i, --input=input
+      Path to a file containing a JSON-encoded message
+
+  --jsonString=jsonString
+      JSON-encoded message input (eg. '{"videoId":1}'
+
+  --type=(AppActionMetadata|AppAction|BountyMetadata|BountyWorkData|ChannelMetadata|ChannelPayoutsMetadata|CouncilCandid
+  acyNoteMetadata|ForumPostMetadata|ForumThreadMetadata|MembershipMetadata|ReactVideo|ReactComment|CreateComment|EditCom
+  ment|DeleteComment|PinOrUnpinComment|ModerateComment|BanOrUnbanMemberFromChannel|VideoReactionsPreference|CreateVideoC
+  ategory|MakeChannelPayment|AppMetadata|CreateApp|UpdateApp|MemberRemarked|ChannelModeratorRemarked|ChannelOwnerRemarke
+  d|PersonMetadata|ProposalsDiscussionPostMetadata|SeriesMetadata|SeasonMetadata|GeoCoordiantes|NodeLocationMetadata|Sto
+  rageBucketOperatorMetadata|DistributionBucketOperatorMetadata|GeographicalArea|DistributionBucketFamilyMetadata|Publis
+  hedBeforeJoystream|License|MediaType|SubtitleMetadata|VideoMetadata|ContentMetadata|OpeningMetadata|UpcomingOpeningMet
+  adata|ApplicationMetadata|WorkingGroupMetadata|SetGroupMetadata|AddUpcomingOpening|RemoveUpcomingOpening|WorkingGroupM
+  etadataAction|ModeratePost|RemarkMetadataAction)
+      Type of the message
+```
+
+_See code: [src/commands/util/encodeMessage.ts](https://github.com/Joystream/joystream/blob/master/cli/src/commands/util/encodeMessage.ts)_
+
+## `joystream-cli util:messageStructure`
+
+Show message structure (available fields, their types and indexes)
+
+```
+USAGE
+  $ joystream-cli util:messageStructure
+
+OPTIONS
+  --type=(AppActionMetadata|AppAction|BountyMetadata|BountyWorkData|ChannelMetadata|ChannelPayoutsMetadata|CouncilCandid
+  acyNoteMetadata|ForumPostMetadata|ForumThreadMetadata|MembershipMetadata|ReactVideo|ReactComment|CreateComment|EditCom
+  ment|DeleteComment|PinOrUnpinComment|ModerateComment|BanOrUnbanMemberFromChannel|VideoReactionsPreference|CreateVideoC
+  ategory|MakeChannelPayment|AppMetadata|CreateApp|UpdateApp|MemberRemarked|ChannelModeratorRemarked|ChannelOwnerRemarke
+  d|PersonMetadata|ProposalsDiscussionPostMetadata|SeriesMetadata|SeasonMetadata|GeoCoordiantes|NodeLocationMetadata|Sto
+  rageBucketOperatorMetadata|DistributionBucketOperatorMetadata|GeographicalArea|DistributionBucketFamilyMetadata|Publis
+  hedBeforeJoystream|License|MediaType|SubtitleMetadata|VideoMetadata|ContentMetadata|OpeningMetadata|UpcomingOpeningMet
+  adata|ApplicationMetadata|WorkingGroupMetadata|SetGroupMetadata|AddUpcomingOpening|RemoveUpcomingOpening|WorkingGroupM
+  etadataAction|ModeratePost|RemarkMetadataAction)
+      Type of the message
+```
+
+_See code: [src/commands/util/messageStructure.ts](https://github.com/Joystream/joystream/blob/master/cli/src/commands/util/messageStructure.ts)_
+
 ## `joystream-cli working-groups:application WGAPPLICATIONID`
 
 Shows an overview of given application by Working Group Application ID

cli/README.md

@@ -143,6 +143,9 @@
       },
       "sign-offline": {
         "description": "Sign unsigned transactions, created with 'advanced-transactions', offline"
+      },
+      "util": {
+        "description": "General Joystream utilities"
       }
     }
   },

cli/package.json

@@ -0,0 +1,52 @@
+import { flags } from '@oclif/command'
+import * as allMessages from '@joystream/metadata-protobuf'
+import allMessagesJson from '@joystream/metadata-protobuf/json'
+import { AnyMetadataClass } from '@joystream/metadata-protobuf/types'
+import DefaultCommandBase from './DefaultCommandBase'
+
+type MessageTypeName = keyof typeof allMessages & keyof typeof allMessagesJson & string
+
+/**
+ * Abstract base class for commands that require a single protobuf message context.
+ */
+export default abstract class ProtobufMessageCommandBase extends DefaultCommandBase {
+  protected MessageClass!: AnyMetadataClass<unknown>
+  protected messageJson!: Record<string, unknown>
+  protected type!: keyof typeof allMessages
+
+  static flags = {
+    type: flags.enum<MessageTypeName>({
+      options: Object.keys(allMessages) as MessageTypeName[],
+      required: false,
+      description: 'Type of the message',
+    }),
+  }
+
+  async init(): Promise<void> {
+    await super.init()
+    let {
+      flags: { type },
+    } = this.parse(this.constructor as typeof ProtobufMessageCommandBase)
+
+    if (!type) {
+      type = await this.promptForMessageType()
+    }
+
+    this.type = type
+    this.messageJson = allMessagesJson[type]
+    this.MessageClass = allMessages[type]
+  }
+
+  async promptForMessageType(message = 'Choose a message type'): Promise<MessageTypeName> {
+    return this.simplePrompt<MessageTypeName>({
+      type: 'list',
+      choices: Object.keys(allMessages)
+        .sort()
+        .map((c) => ({
+          value: c,
+          name: c,
+        })),
+      message,
+    })
+  }
+}

cli/src/base/ProtobufMessageCommandBase.ts

@@ -0,0 +1,28 @@
+import { flags } from '@oclif/command'
+import { hexToU8a, isHex } from '@polkadot/util'
+import ExitCodes from '../../ExitCodes'
+import { metaToObject } from '@joystream/metadata-protobuf/utils'
+import ProtobufMessageCommandBase from '../../base/ProtobufMessageCommandBase'
+
+export default class DecodeMessageCommand extends ProtobufMessageCommandBase {
+  static description = 'Decode a protobuf message (from hex to json)'
+
+  static flags = {
+    ...super.flags,
+    hex: flags.string({
+      required: true,
+      description: `Hex-encoded protobuf message'`,
+    }),
+  }
+
+  async run(): Promise<void> {
+    const { hex } = this.parse(DecodeMessageCommand).flags
+    if (!isHex(hex)) {
+      this.error('Invalid hex string provided', { exit: ExitCodes.InvalidInput })
+    }
+    const jsonObj = metaToObject(this.MessageClass, this.MessageClass.decode(hexToU8a(hex)))
+    this.jsonPrettyPrint(JSON.stringify(jsonObj))
+
+    this.output(JSON.stringify(jsonObj))
+  }
+}

cli/src/commands/util/decodeMessage.ts

@@ -0,0 +1,36 @@
+import { flags } from '@oclif/command'
+import { metadataToBytes } from '../../helpers/serialization'
+import { getInputJson } from '../../helpers/InputOutput'
+import ExitCodes from '../../ExitCodes'
+import ProtobufMessageCommandBase from '../../base/ProtobufMessageCommandBase'
+
+export default class EncodeMessageCommand extends ProtobufMessageCommandBase {
+  static description = 'Encode a protobuf message (from json to hex)'
+
+  static flags = {
+    ...super.flags,
+    jsonString: flags.string({
+      required: false,
+      description: `JSON-encoded message input (eg. '${JSON.stringify({ videoId: 1 })}'`,
+      exclusive: ['input'],
+    }),
+    input: flags.string({
+      char: 'i',
+      required: false,
+      description: `Path to a file containing a JSON-encoded message`,
+      exclusive: ['jsonString'],
+    }),
+  }
+
+  async run(): Promise<void> {
+    const { jsonString, input } = this.parse(EncodeMessageCommand).flags
+    const jsonObj = input
+      ? await getInputJson(input)
+      : jsonString
+      ? JSON.parse(jsonString)
+      : this.error('Either --input or --jsonString must be provided!', { exit: ExitCodes.InvalidInput })
+    const bytes = metadataToBytes(this.MessageClass, jsonObj)
+
+    this.output(bytes.toHex())
+  }
+}

cli/src/commands/util/encodeMessage.ts

@@ -0,0 +1,10 @@
+import ProtobufMessageCommandBase from '../../base/ProtobufMessageCommandBase'
+
+export default class MessageStructureCommand extends ProtobufMessageCommandBase {
+  static description = 'Show message structure (available fields, their types and indexes)'
+  static flags = { ...super.flags }
+
+  async run(): Promise<void> {
+    this.output(JSON.stringify(this.messageJson, null, 4))
+  }
+}

cli/src/commands/util/messageStructure.ts

@@ -1,3 +1,4 @@
 node_modules/
 lib/
 compiled/
+src/json/*.json

metadata-protobuf/.gitignore

@@ -2,3 +2,4 @@ lib/
 doc/
 proto/
 compiled/
+src/json/messages.json