Merge pull request #472 from oasisprotocol/matevz/feature/rofl-remove-cleanup

cmd: Also remove the deployment from rofl.yaml when removing app

Author: matevz

cmd/rofl/mgmt.go

@@ -326,11 +326,15 @@ var (
 			npa := common.GetNPASelection(cfg)
 			txCfg := common.GetTransactionConfig()
 
-			var rawAppID string
+			var (
+				rawAppID   string
+				manifest   *buildRofl.Manifest
+				deployment *buildRofl.Deployment
+			)
 			if len(args) > 0 {
 				rawAppID = args[0]
 			} else {
-				_, deployment := roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
+				manifest, deployment = roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
 					NeedAppID: true,
 					NeedAdmin: true,
 				})
@@ -353,6 +357,12 @@ var (
 				cobra.CheckErr(err)
 			}
 
+			fmt.Printf("WARNING: Removing this ROFL app will DEREGISTER it, ERASE any on-chain secrets and local configuration!\n")
+			fmt.Printf("WARNING: THIS ACTION IS IRREVERSIBLE!\n")
+			if !common.GetAnswerYes() {
+				common.Confirm(fmt.Sprintf("Remove ROFL app '%s' deployed on network '%s'", appID, npa.NetworkName), "not removing")
+			}
+
 			// Prepare transaction.
 			tx := rofl.NewRemoveTx(nil, &rofl.Remove{
 				ID: appID,
@@ -363,6 +373,14 @@ var (
 			cobra.CheckErr(err)
 
 			common.BroadcastOrExportTransaction(ctx, npa, conn, sigTx, meta, nil)
+
+			// Update manifest to clear the corresponding deployment section.
+			if manifest != nil {
+				delete(manifest.Deployments, deploymentName)
+				if err = manifest.Save(); err != nil {
+					cobra.CheckErr(fmt.Errorf("failed to update manifest: %w", err))
+				}
+			}
 		},
 	}
 

docs/rofl.md

@@ -118,6 +118,13 @@ Run `rofl remove` to deregister your ROFL app:
 The deposit required to register the ROFL app will be returned to the current
 administrator account.
 
+:::danger Secrets will be permanently lost
+
+All secrets stored on-chain will be permanently lost when the ROFL app will be
+deregistered.
+
+:::
+
 ## Show ROFL information {#show}
 
 Run `rofl show` to obtain the information from the network on the ROFL admin

docs/setup.md

@@ -2,8 +2,8 @@
 
 ## Download and Run
 
-Download the latest release [here][cli-releases] and extract it to your
-favorite application folder.
+Download the latest release from our [GitHub repository][cli-releases] and
+extract it to your favorite application folder.
 
 :::info
 

examples/rofl/remove.out.static

@@ -1,3 +1,8 @@
+WARNING: Removing this ROFL app will DEREGISTER it, ERASE any on-chain secrets and local configuration!
+WARNING: THIS ACTION IS IRREVERSIBLE!
+? Remove ROFL app 'rofl1qzd82n99vtwesvcqjfyur4tcm45varz2due7s635' deployed on network 'testnet' Yes
+Unlock your account.
+? Passphrase:
 You are about to sign the following transaction:
 Format: plain
 Method: rofl.Remove