Merge pull request #96 from Acurast/develop

Develop

Author: AndreasGassmann

README.md

@@ -46,7 +46,14 @@ To use the Acurast CLI, type `acurast` followed by any of the available options
 
 - `new <project-name>` - Create a new Acurast project from a template.
 - `deploy [options] [project]` - Deploy the current project to the Acurast platform.
-- `deployments <'ls' | <id>> --cleanup` - List, view and clean up deployments.
+- `deployments [arg] [options]` - List, view, and manage deployments.
+  - `deployments ls` or `deployments list` - List all your deployments.
+  - `deployments <id>` - View details of a specific deployment.
+  - `deployments <id> --update-env-vars` - Update environment variables for a deployment.
+  - `deployments --cleanup` - Clean up old, finished deployments.
+  - `deployments <id> --cleanup` - Clean up a specific deployment.
+  - `deployments update script <deployment-id> <script-ipfs> [options]` - Update the script of a mutable deployment.
+  - `deployments update editor <deployment-id> <new-editor-address> [options]` - Transfer editor permissions for a mutable deployment.
 - `live [options] [project]` - Setup a "live-code-processor" and run your project on the processor in real time.
 - `init` - Create an acurast.json file and .env file.
 - `open` - Open the Acurast resources in your browser.
@@ -84,7 +91,9 @@ The acurast.json file is generated by running acurast init. Here is an example c
       "minProcessorReputation": 0,
       "maxCostPerExecution": 100000000000,
       "includeEnvironmentVariables": [],
-      "processorWhitelist": []
+      "processorWhitelist": [],
+      "mutability": "Immutable",
+      "reuseKeysFrom": null
     }
   }
 }
@@ -137,6 +146,14 @@ ACURAST_MNEMONIC=abandon abandon about ...
 - `minProcessorVersions`: The minimum processor versions that will be used for the deployment.
   - `android`: The minimum Android version.
   - `ios`: The minimum iOS version.
+- `mutability`: The mutability of the deployment. Controls whether the deployment can be modified after creation.
+  - `"Immutable"`: The deployment cannot be modified after creation (default).
+  - `"Mutable"`: The deployment can be modified after creation.
+- `reuseKeysFrom`: An optional array that allows reusing keys from a previous deployment, if that deployment was set to "Mutable". Format: `[MultiOrigin, string, number]` where:
+  - First element: The origin chain (currently only `"Acurast"` is supported)
+  - Second element: The address of the original deployer
+  - Third element: The deployment ID
+  - Example: `["Acurast", "5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL", 123456]`
 
 #### .env
 
@@ -221,6 +238,189 @@ When running `acurast deploy`, the environment variables will now automatically
 
 When running interval based deployments with multiple executions, the environment variables can be updated between executions. To do that, update the `.env` file and run `acurast deployments <id> -e`. This will update the environment variables for the deployment with the given ID.
 
+## Deployment Management
+
+The Acurast CLI provides comprehensive deployment management capabilities, including the ability to update mutable deployments and transfer editor permissions.
+
+### Basic Deployment Commands
+
+```bash
+# List all deployments
+acurast deployments ls
+
+# View a specific deployment
+acurast deployments "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456"
+
+# Update environment variables for a deployment
+acurast deployments "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456" --update-env-vars
+
+# Clean up old deployments
+acurast deployments --cleanup
+
+# Clean up a specific deployment
+acurast deployments "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456" --cleanup
+```
+
+**Note**: All deployment commands require the full deployment ID format: `"origin:address:number"`
+
+### Updating Mutable Deployments
+
+For deployments that were created with `"mutability": "Mutable"`, you can update the script and transfer editor permissions.
+
+#### Update Deployment Script
+
+**Command**: `acurast deployments update script <deployment-id> <script-ipfs> [options]`
+
+**Arguments**:
+
+- `<deployment-id>`: The deployment ID in format `"origin:address:number"` (e.g., `"Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456"`)
+- `<script-ipfs>`: IPFS hash of the new script (e.g., `"ipfs://QmNewScriptHash"`)
+
+**Options**:
+
+- `--dry-run`: Preview the update without applying
+- `--force`: Skip confirmation prompts
+
+**Examples**:
+
+```bash
+# Update script (dry run)
+acurast deployments update script "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456" "ipfs://QmNewScriptHash" --dry-run
+
+# Update script (actual)
+acurast deployments update script "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456" "ipfs://QmNewScriptHash"
+```
+
+**Requirements**:
+
+- The deployment must have `"mutability": "Mutable"`
+- You must be the current editor of the deployment
+- The script must be uploaded to IPFS and provided as an IPFS hash
+
+#### Transfer Editor Permissions
+
+**Command**: `acurast deployments update editor <deployment-id> <new-editor-address> [options]`
+
+**Arguments**:
+
+- `<deployment-id>`: The deployment ID in format `"origin:address:number"` (e.g., `"Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456"`)
+- `<new-editor-address>`: The AccountId32 address of the new editor
+
+**Options**:
+
+- `--dry-run`: Preview the transfer without executing
+- `--force`: Skip confirmation prompts
+
+**Examples**:
+
+```bash
+# Transfer editor permissions (dry run)
+acurast deployments update editor "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456" "5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL" --dry-run
+
+# Transfer editor permissions (actual)
+acurast deployments update editor "Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456" "5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL"
+```
+
+**Requirements**:
+
+- The deployment must have `"mutability": "Mutable"`
+- You must be the current editor of the deployment
+- The new editor address must be a valid AccountId32 format
+
+### Deployment ID Format
+
+The deployment ID is a unique identifier for each deployment on the Acurast platform. It follows the format:
+
+```
+"origin:address:number"
+```
+
+**Components**:
+
+- **`origin`**: The chain name where the deployment was created
+  - Currently only `"Acurast"` is supported
+  - This is case-sensitive
+- **`address`**: The AccountId32 address of the original deployer
+  - Must be a valid Substrate AccountId32 format (e.g., `5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL`)
+  - This is the address that deployed the job initially
+- **`number`**: The deployment number (u128)
+  - This is a sequential number assigned by the blockchain
+  - Must be a positive integer
+
+**Examples**:
+
+```bash
+# Valid deployment IDs
+"Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123456"
+"Acurast:5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY:1"
+"Acurast:5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty:999999"
+
+# Invalid deployment IDs
+"Acurast:invalid-address:123"  # Invalid address format
+"acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:123"  # Wrong case
+"Acurast:5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL:-1"  # Negative number
+```
+
+**Usage**:
+
+- **All deployment operations** require the full deployment ID format: `"origin:address:number"`
+- **Configuration** (reuseKeysFrom): You must use the full format as an array
+
+**Finding your deployment ID**:
+
+1. Run `acurast deployments ls` to see all your deployments
+2. The deployment ID will be displayed in the list
+3. For advanced operations, use the full format shown in the list
+
+### Validation and Error Handling
+
+The CLI provides comprehensive validation for all deployment management commands:
+
+- **Deployment ID validation**: Ensures proper format and valid components
+- **Address validation**: Verifies AccountId32 format for all addresses
+- **IPFS hash validation**: Ensures scripts are provided as valid IPFS hashes
+- **Permission validation**: Checks that you have the necessary permissions
+- **Mutability validation**: Ensures the deployment is mutable before allowing updates
+
+### Safety Features
+
+- **Dry-run mode**: Preview changes before applying them
+- **Confirmation prompts**: Require explicit confirmation for destructive operations
+- **Error messages**: Clear, descriptive error messages for validation failures
+- **Transaction feedback**: Display transaction hashes for successful operations
+
+## Deployment Features
+
+### Mutability
+
+The `mutability` field controls whether a deployment can be modified after it has been created:
+
+- **`"Immutable"`** (default): The deployment cannot be modified after creation. This is the recommended setting for production deployments as it ensures consistency and prevents harmful changes.
+
+- **`"Mutable"`**: The deployment can be modified after creation. This is an advanced feature and should only be used with careful consideration because misuse could result in harmful updates.
+
+### Key Reuse
+
+The `reuseKeysFrom` field allows you to reuse keys from a previous deployment. This is useful when you want to maintain the same cryptographic keys across deployments. To use this, the referenced deployment has to be "Mutable".
+
+**Format**: `[MultiOrigin, string, number]`
+
+- **First element**: The origin chain (currently only `"Acurast"` is supported)
+- **Second element**: The address of the original deployer (AccountId32 format)
+- **Third element**: The deployment ID (u128 number)
+
+**Example**:
+
+```json
+{
+  "reuseKeysFrom": [
+    "Acurast",
+    "5CiPPseXPECbkjWCa6MnjNokrgYjMqmKndv2rSnekmSK2DjL",
+    123456
+  ]
+}
+```
+
 ## Development
 
 To contribute to the development of Acurast CLI, follow these steps:

acurast.json

@@ -19,11 +19,38 @@
         "maxStorage": 0
       },
       "numberOfReplicas": 1,
-      "requiredModules": ["DataEncryption", "LLM"],
+      "requiredModules": [],
       "minProcessorReputation": 0,
       "maxCostPerExecution": 100000000000,
       "includeEnvironmentVariables": [],
-      "processorWhitelist": []
+      "processorWhitelist": [],
+      "mutability": "Immutable"
+    },
+    "test-single-onetime-mutable": {
+      "projectName": "test-single-onetime-with-key-reuse",
+      "fileUrl": "examples/test.js",
+      "network": "canary",
+      "onlyAttestedDevices": true,
+      "assignmentStrategy": {
+        "type": "Single"
+      },
+      "execution": {
+        "type": "onetime",
+        "maxExecutionTimeInMs": 60000
+      },
+      "maxAllowedStartDelayInMs": 10000,
+      "usageLimit": {
+        "maxMemory": 0,
+        "maxNetworkRequests": 0,
+        "maxStorage": 0
+      },
+      "numberOfReplicas": 1,
+      "requiredModules": [],
+      "minProcessorReputation": 0,
+      "maxCostPerExecution": 100000000000,
+      "includeEnvironmentVariables": [],
+      "processorWhitelist": [],
+      "mutability": "Mutable"
     },
     "test-single-onetime-with-env": {
       "projectName": "test-single-onetime-with-env",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@acurast/cli",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "A cli to interact with the Acurast Cloud.",
   "main": "dist/index.js",
   "bin": {

package.json

@@ -3,6 +3,7 @@ import {
   AssignmentStrategyVariant,
   DeploymentRuntime,
   JobRegistration,
+  ScriptMutability,
 } from '../types.js'
 import { deviceVersions } from './app-versions.js'
 
@@ -100,6 +101,7 @@ export const convertConfigToJob = (
   const minProcessorVersions = convertMinProcessorVersions(
     config.minProcessorVersions
   )
+  const mutability = config.mutability ?? ScriptMutability.Immutable
 
   const now = Date.now()
 
@@ -162,6 +164,8 @@ export const convertConfigToJob = (
     networkRequests: config.usageLimit.maxNetworkRequests,
     storage: config.usageLimit.maxStorage,
     requiredModules: config.requiredModules,
+    mutability,
+    reuseKeysFrom: config.reuseKeysFrom,
     extra: {
       requirements: {
         assignmentStrategy,

src/acurast/convertConfigToJob.ts

@@ -7,7 +7,7 @@ import {
   RestartPolicy,
 } from '../types.js'
 import { DeploymentStatus } from './types.js'
-import { registerJob } from './registerJob.js'
+import { deployJob } from './deployJob.js'
 import { getWallet } from '../util/getWallet.js'
 import type { EnvVar, JobId } from './env/types.js'
 import { setEnvVars } from '../util/setEnvVars.js'
@@ -176,7 +176,7 @@ export const createJob = async (
       statusCallback(status, data)
     }
 
-    const result = await registerJob(api, wallet, job, statusCallbackWrapper)
+    const result = await deployJob(api, wallet, job, statusCallbackWrapper)
 
     statusCallback(DeploymentStatus.Submit, { txHash: result })
   }

src/acurast/createJob.ts

@@ -8,7 +8,7 @@ import {
 } from '../types.js'
 import { DeploymentStatus } from './types.js'
 
-export const registerJob = (
+export const deployJob = (
   api: ApiPromise,
   injector: KeyringPair,
   job: JobRegistration,
@@ -106,9 +106,25 @@ export const registerJob = (
         // ),
       }),
     })
+
+    // Create the additional parameters for the deploy extrinsic
+    const mutability = api.createType(
+      'AcurastCommonScriptMutability',
+      job.mutability
+    )
+    const reuseKeysFrom = job.reuseKeysFrom
+      ? api.createType('Option<(AcurastCommonMultiOrigin, u128)>', [
+          api.createType('AcurastCommonMultiOrigin', {
+            acurast: job.reuseKeysFrom[1],
+          }),
+          api.createType('u128', job.reuseKeysFrom[2]),
+        ])
+      : api.createType('Option<(AcurastCommonMultiOrigin, u128)>', undefined)
+    const minMetrics = api.createType('Option<Vec<(u8, u128, u128)>>', [])
+
     try {
-      const unsub = await api.tx['acurast']
-        ['register'](jobRegistration)
+      const unsub = await api.tx['acurastMarketplace']
+        ['deploy'](jobRegistration, mutability, reuseKeysFrom, minMetrics)
         .signAndSend(
           injector,
           async ({ status, events, txHash, dispatchError }) => {
@@ -219,8 +235,8 @@ export const registerJob = (
         new DeploymentError(
           e instanceof Error
             ? e.message
-            : 'Unknown error during job registration',
-          'RegistrationError',
+            : 'Unknown error during job deployment',
+          'DeploymentError',
           { originalError: e }
         )
       )