Apply Update

Apply a Plugin Update

Encodes the action of applying a plugin update.

Encoding

import {
  ApplyUpdateParams,
  Client,
  DecodedApplyUpdateParams,
  PermissionIds,
} from "@aragon/sdk-client";
import { DaoAction, PermissionOperationType } from "@aragon/sdk-client-common";
import { context } from "../index";

// Instantiates an Aragon OSx SDK client.
const client: Client = new Client(context);

// This variable contains the values received on the prepareUpdate() method
const applyUpdateParams: ApplyUpdateParams = {
  permissions: [{
    operation: PermissionOperationType.REVOKE,
    permissionId: PermissionIds.EXECUTE_PERMISSION_ID,
    where: "0x1234567890123456789012345678901234567890",
    who: "0x2345678901234567890123456789012345678901",
  }],
  initData: new Uint8Array([12, 34, 45, 56]),
  helpers: [],
  versionTag: {
    build: 1,
    release: 1,
  },
  pluginRepo: "0x2345678901234567890123456789012345678901",
  pluginAddress: "0x1234567890123456789012345678901234567890",
};

const daoAddressOrEns: string = "0x123123123123123123123123123123123123"; // "my-dao.eth"

const actions: DaoAction[] = client.encoding.applyUpdateAndPermissionsActionBlock(
  daoAddressOrEns,
  applyUpdateParams,
);
console.log(actions);

Returns three actions:

• Grant root permission to the Plugin Setup Processor
• Ask it to apply the update
• Revoke the root permission to the Plugin Setup Processor

[
  {
    to: "0x123123123...",
    value: 0n,
    data: Uint8Array[12,34,45...]
  },
  {
    to: "0x123123123...",
    value: 0n,
    data: Uint8Array[12,34,45...]
  },
  {
    to: "0x123123123...",
    value: 0n,
    data: Uint8Array[12,34,45...]
  }
]

Decoding

// Decodes the apply update action for a Multisig plugin.
const decodedParams: DecodedApplyUpdateParams = client.decoding
  .applyUpdateAction(actions[1].data);
console.log({ decodedParams });

Returns:

{ decodedParams:
  {
    permissions: [{
      operation: 1, // REVOKE
      permissionId: Uint8Array([10,20,30]),
      where: "0x1234567890123456789012345678901234567890",
      who: "0x2345678901234567890123456789012345678901",
    }],
    versionTag: {
      build: 1,
      release: 1,
    },
    initData: Uint8Array[12,34,45...],
    helpers: [],
    pluginRepo: "0x2345678901234567890123456789012345678901",
    pluginAddress: "0x1234567890123456789012345678901234567890",
    };
  }
}