Prepare Uninstallation

Prepare the uninstallation of a plugin

The prepareUninstallation method performs the prior steps so that a DAO proposal can eventually apply the removal of a Plugin. The proposal will need an Action calling the applyUninstallation function.

For more details see https://devs.aragon.org/docs/sdk/examples/encoders-decoders/apply-uninstallation#encoding

import { Client, PrepareUninstallationSteps } from "@aragon/sdk-client";
import {
  PrepareUninstallationParams,
  GasFeeEstimation,
} from "@aragon/sdk-client-common";
import { context } from "../index";

// Instantiate the general purpose client from the Aragon OSx SDK context.
const client: Client = new Client(context);

const prepareUninstallationParams: PrepareUninstallationParams = {
  daoAddressOrEns: "0x1234567890123456789012345678901234567890", // my-dao.dao.eth
  pluginAddress: "0x2345678901234567890123456789012345678901",
  uninstallationParams: [
    // Example parameters needed by the plugin's prepareUninstall function
    1234,
    "0x1234567890123456789012345678901234567890",
  ],
  uninstallationAbi: ["uint256", "adress"],
};

// Estimate how much gas the transaction will cost.
const estimatedGas: GasFeeEstimation =
  await client.estimation.prepareUninstallation(prepareUninstallationParams);
console.log({ avg: estimatedGas.average, max: estimatedGas.max });

// Deposit the ERC20 tokens.
const steps = client.methods.prepareUninstallation(prepareUninstallationParams);
for await (const step of steps) {
  try {
    switch (step.key) {
      case PrepareUninstallationSteps.PREPARING:
        console.log({ txHash: step.txHash });
        break;
      case PrepareUninstallationSteps.DONE:
        console.log({
          permissions: step.permissions,
          pluginAddress: step.pluginAddress,
          pluginRepo: step.pluginRepo,
          versionTag: step.versionTag,
        });
        break;
    }
  } catch (err) {
    console.error(err);
  }
}

Returns:

{
  txhash: "0xb1c14a49...3e8620b0f5832d61c"
}
{
  permissions: [
    {
      operation: 1, // revoke
      where: "0x12345...",
      who: "0x23456...",
      permissionId: "0x1234567890..."
    },
    {
      operation: 1, //REVOKE
      where: "0x3456...",
      who: "0x4567...",
      permissionId: "0x1234567890..."
    }
  ],
  pluginAddress: "0x1234567890...",
  pluginRepo: "0x1234567890..."
  versionTag: {
    build: 1,
    release: 1
  }
}