feat: add act commands (#569)

* feat: apply act.patch

* fix: download test

* fix: lint warning

* feat: migrate form @upcoming/bee-js to @ethersphere/bee-js v9.0.2, upload with same act-history test

* feat: add act upload test with another file and with same history address

---------

Co-authored-by: Ferenc Sárai <[email protected]>

Author: ferencsarai

README.md

@@ -19,6 +19,11 @@ the [releases tab](https://github.com/ethersphere/swarm-cli/releases).
   - [Uploading a File](#uploading-a-file)
   - [Creating an Identity](#creating-an-identity)
   - [Uploading to a Feed](#uploading-to-a-feed)
+  - [Upload file with ACT](#upload-file-with-act)
+  - [Download file with ACT](#download-file-with-act)
+  - [Create grantees list](#create-grantees-list)
+  - [Get grantees list](#get-grantees-list)
+  - [Patch grantees list](#patch-grantees-list)
 - [Description](#description)
   - [Installation](#installation)
     - [From npm](#from-npm)
@@ -68,6 +73,64 @@ the [releases tab](https://github.com/ethersphere/swarm-cli/releases).
 
 ![Swarm CLI Feed Upload Command](./docs/feed-upload.gif)
 
+## Upload a file with ACT
+
+```sh
+swarm-cli upload <file> --act --stamp <postage_batch_id>
+```
+
+## Download a file with ACT
+
+```sh
+swarm-cli download <swarm_hash> <file> --act --act-history-address <swarm_history_address> --act-publisher <public_key>
+```
+
+## Create a grantees list
+
+```sh
+swarm-cli grantee create grantees.json --stamp <postage_batch_id>
+```
+
+`grantees.json`:
+
+```json
+{ "grantees": [
+    "02ceff1422a7026ba54ad89967d81f2805a55eb3d05f64eb5c49ea6024212b12e8",
+    "02ceff1422a7026ba54ad89967d81f2805a55eb3d05f64eb5c49ea6024212b12e9",
+    "02ceff1422a7026ba54ad89967d81f2805a55eb3d05f64eb5c49ea6024212b12ee"
+]
+}
+```
+
+## Get a grantees list
+
+```sh
+swarm-cli grantee get <grantee_reference>
+```
+
+## Patch a grantees list
+
+```sh
+swarm-cli  grantee patch grantees-patch.json \
+    --reference <grantee_reference> \
+    --history <grantee_history_reference> \
+    --stamp <postage_batch_id>
+```
+
+`grantees-patch.json`:
+
+```json
+{
+    "add": [
+        "02ceff1422a7026ba54ad89967d81f2805a55eb3d05f64eb5c49ea6024212b12e7"
+    ],
+    "revoke": [
+        "02ceff1422a7026ba54ad89967d81f2805a55eb3d05f64eb5c49ea6024212b12e9",
+        "02ceff1422a7026ba54ad89967d81f2805a55eb3d05f64eb5c49ea6024212b12ee"
+    ]
+}
+```
+
 # Description
 
 > Manage your Bee node and interact with the Swarm network via the CLI
@@ -124,6 +187,7 @@ stamp      Buy, list and show postage stamps
 pss        Send, receive, or subscribe to PSS messages
 manifest   Operate on manifests
 utility    Utility commands for managing wallets
+grantee    Create, Get, Patch grantee list
 
 Run 'swarm-cli GROUP --help' to see available commands in a group
 

package-lock.json

@@ -62,8 +62,8 @@
     "typescript": "^4.8.4"
   },
   "dependencies": {
-    "@ethersphere/bee-js": "^9.0.1",
-    "cafe-utility": "^27.14.2",
+    "@ethersphere/bee-js": "^9.0.2",
+    "cafe-utility": "^27.14.0",
     "chalk": "^2.4.2",
     "cli-progress": "^3.11.2",
     "ethereumjs-wallet": "^1.0.2",

package.json

@@ -14,10 +14,20 @@ export class Download extends RootCommand implements LeafCommand {
   public manifestDownload!: ManifestDownload
 
   private address!: BzzAddress
+  private actReqHeaders: Record<string, string> = {}
 
   public async run(): Promise<void> {
     super.init()
 
+    if (this.manifestDownload.act) {
+      this.actReqHeaders = {
+        'Swarm-Act': 'true',
+        'Swarm-Act-Timestamp': this.manifestDownload.actTimestamp,
+        'Swarm-Act-History-Address': this.manifestDownload.actHistoryAddress,
+        'Swarm-Act-Publisher': this.manifestDownload.actPublisher,
+      }
+    }
+
     this.address = await makeBzzAddress(this.bee, this.manifestDownload.bzzUrl)
 
     if (await this.isManifest()) {
@@ -29,7 +39,15 @@ export class Download extends RootCommand implements LeafCommand {
   }
 
   private async downloadData(): Promise<void> {
-    const response = await this.bee.downloadData(this.address.hash)
+    const downloadOptions = this.manifestDownload.act
+      ? {
+          actPublisher: this.manifestDownload.actPublisher,
+          actHistoryAddress: this.manifestDownload.actHistoryAddress,
+          actTimestamp: this.manifestDownload.actTimestamp,
+        }
+      : undefined
+
+    const response = await this.bee.downloadData(this.address.hash, downloadOptions)
 
     if (this.manifestDownload.stdout) {
       process.stdout.write(response.toUtf8())

src/command/download.ts

@@ -0,0 +1,40 @@
+import { Argument, LeafCommand, Option } from 'furious-commander'
+import { GranteeCommand } from './grantee-command'
+import { stampProperties } from '../../utils/option'
+import { createKeyValue } from '../../utils/text'
+import fs from 'fs'
+
+export class Create extends GranteeCommand implements LeafCommand {
+  public readonly name = 'create'
+  public readonly description = 'Create grantee list'
+  private actReqHeaders: Record<string, string> = {}
+
+  @Argument({
+    key: 'path',
+    description: 'Path to the file with grantee list',
+    required: true,
+    autocompletePath: true,
+    conflicts: 'stdin',
+  })
+  public path!: string
+
+  @Option({ key: 'stdin', type: 'boolean', description: 'Take data from standard input', conflicts: 'path' })
+  public stdin!: boolean
+
+  @Option(stampProperties)
+  public stamp!: string
+
+  public async run(): Promise<void> {
+    await super.init()
+    this.actReqHeaders = {
+      'Swarm-Act': 'true',
+    }
+    const granteesFile = fs.readFileSync(this.path, 'utf8')
+    const createGrantees = JSON.parse(granteesFile)
+    const grantees = createGrantees.grantees
+
+    const response = await this.bee.createGrantees(this.stamp, grantees)
+    this.console.log(createKeyValue('Grantee reference', response.ref.toHex()))
+    this.console.log(createKeyValue('Grantee history reference', response.historyref.toHex()))
+  }
+}

src/command/grantee/create.ts

@@ -0,0 +1,24 @@
+import { Argument, LeafCommand } from 'furious-commander'
+import { GranteeCommand } from './grantee-command'
+import { createKeyValue } from '../../utils/text'
+
+export class Get extends GranteeCommand implements LeafCommand {
+  public readonly name = 'get'
+  public readonly description = 'Get grantee list'
+
+  @Argument({
+    key: 'reference',
+    description: 'Grantee list reference',
+    required: true,
+    conflicts: 'stdin',
+  })
+  public reference!: string
+
+  public async run(): Promise<void> {
+    await super.init()
+    const response = await this.bee.getGrantees(this.reference)
+    this.console.log(
+      createKeyValue('Grantee public keys', response.grantees.map(grantee => grantee.toCompressedHex()).join('\n')),
+    )
+  }
+}

src/command/grantee/get.ts

@@ -0,0 +1,3 @@
+import { RootCommand } from '../root-command'
+
+export class GranteeCommand extends RootCommand {}

src/command/grantee/grantee-command.ts

@@ -0,0 +1,12 @@
+import { GroupCommand } from 'furious-commander'
+import { Create } from './create'
+import { Get } from './get'
+import { Patch } from './patch'
+
+export class Grantee implements GroupCommand {
+  public readonly name = 'grantee'
+
+  public readonly description = 'Create, Get, Patch grantee list'
+
+  public subCommandClasses = [Create, Get, Patch]
+}

src/command/grantee/index.ts

@@ -0,0 +1,58 @@
+import { Argument, LeafCommand, Option } from 'furious-commander'
+import { GranteeCommand } from './grantee-command'
+import { stampProperties } from '../../utils/option'
+import { createKeyValue } from '../../utils/text'
+import fs from 'fs'
+
+export class Patch extends GranteeCommand implements LeafCommand {
+  public readonly name = 'patch'
+  public readonly description = 'Patch grantee list'
+  private actReqHeaders: Record<string, string> = {}
+
+  @Argument({
+    key: 'path',
+    description: 'Path to the JSON file with grantee patch (add, revoke)',
+    required: true,
+    autocompletePath: true,
+    conflicts: 'stdin',
+  })
+  public path!: string
+
+  @Option({ key: 'stdin', type: 'boolean', description: 'Take data from standard input', conflicts: 'path' })
+  public stdin!: boolean
+
+  @Option(stampProperties)
+  public stamp!: string
+
+  @Option({
+    key: 'reference',
+    type: 'string',
+    description: 'Encrypted grantee list reference with 128 characters length',
+    length: 128,
+    required: true,
+  })
+  public eref!: string
+
+  @Option({
+    key: 'history',
+    type: 'string',
+    description: 'Swarm address reference to the ACT history entry',
+    length: 64,
+    required: true,
+  })
+  public history!: string
+
+  public async run(): Promise<void> {
+    await super.init()
+    this.actReqHeaders = {
+      'Swarm-Act': 'true',
+      'Swarm-Act-Timestamp': Date.now().toString(),
+    }
+    const patchContent = fs.readFileSync(this.path, 'utf8')
+    const patch = JSON.parse(patchContent)
+
+    const response = await this.bee.patchGrantees(this.stamp, this.eref, this.history, patch, this.actReqHeaders)
+    this.console.log(createKeyValue('Grantee reference', response.ref.toHex()))
+    this.console.log(createKeyValue('Grantee history reference', response.historyref.toHex()))
+  }
+}

src/command/grantee/patch.ts

@@ -23,6 +23,20 @@ export class Download extends RootCommand implements LeafCommand {
   @Option({ key: 'stdout', type: 'boolean', description: 'Print to stdout (single files only)' })
   public stdout!: boolean
 
+  @Option({ key: 'act', type: 'boolean', description: 'Download with ACT', default: false })
+  public act!: boolean
+
+  @Option({ key: 'act-timestamp', type: 'string', description: 'ACT history timestamp', default: '1' })
+  public actTimestamp!: string
+
+  // required if act is true
+  @Option({ key: 'act-history-address', type: 'string', description: 'ACT history address', required: { when: 'act' } })
+  public actHistoryAddress!: string
+
+  // required if act is true
+  @Option({ key: 'act-publisher', type: 'string', description: 'ACT publisher', required: { when: 'act' } })
+  public actPublisher!: string
+
   public async run(): Promise<void> {
     super.init()