Featrue: Add initializeFrom encoders and decoders

modules/client/CHANGELOG.md

@@ -17,6 +17,8 @@ TEMPLATE:
 -->
 
 ## [UPCOMING]
+### Added
+- Added `initializeFrom` encoders and decoders 
 ### Fixes
 - Fix status calculation for token voting proposals
 - Make the `network` parameter required on `getPluginInstallItem`

modules/client/examples/01-client/01-create-dao.ts

@@ -13,8 +13,8 @@ import {
   CreateDaoParams,
   DaoCreationSteps,
   DaoMetadata,
-  TokenVotingPluginInstall,
   TokenVotingClient,
+  TokenVotingPluginInstall,
   VotingMode,
 } from "@aragon/sdk-client";
 import { GasFeeEstimation } from "@aragon/sdk-client-common";

modules/client/examples/01-client/05-get-daos.ts

@@ -11,8 +11,8 @@ Gets a list of DAOs from the Aragon OSx DAO registry.
 import {
   Client,
   DaoListItem,
-  DaoSortBy,
   DaoQueryParams,
+  DaoSortBy,
 } from "@aragon/sdk-client";
 import { SortDirection } from "@aragon/sdk-client-common";
 import { context } from "../index";

modules/client/examples/01-client/07-get-transfers.ts

@@ -13,8 +13,8 @@ By default, retrieves ETH, DAI, USDC and USDT, on Mainnet).
 
 import {
   Client,
-  TransferQueryParams,
   Transfer,
+  TransferQueryParams,
   TransferSortBy,
   TransferType,
 } from "@aragon/sdk-client";

modules/client/examples/01-client/11-prepare-uninstallation.ts

@@ -5,8 +5,8 @@ title: 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. 
+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
 

modules/client/examples/03-tokenVoting-client/index.ts

@@ -17,7 +17,6 @@ import { context } from "../index";
 
 // Instantiate the ContextPlugin from the Aragon OSx SDK context.
 
-
 // Create a TokenVoting client.
 const tokenVotingClient = new TokenVotingClient(context);
 console.log(tokenVotingClient);

modules/client/examples/05-encoders-decoders/04-revoke-permissions.ts

@@ -12,9 +12,9 @@ Revokes a permission to a given address (`who`) to perform an action on a contra
 
 import {
   Client,
+  Permissions,
   RevokePermissionDecodedParams,
   RevokePermissionParams,
-  Permissions,
 } from "@aragon/sdk-client";
 import { DaoAction } from "@aragon/sdk-client-common";
 import { context } from "../index";

modules/client/examples/05-encoders-decoders/05-register-standard-callback.ts

@@ -10,10 +10,7 @@ Register a new standard callback for the DAO.
 ### Encoding
 */
 
-import {
-  Client,
-  RegisterStandardCallbackParams,
-} from "@aragon/sdk-client";
+import { Client, RegisterStandardCallbackParams } from "@aragon/sdk-client";
 import { DaoAction } from "@aragon/sdk-client-common";
 import { context } from "../index";
 

modules/client/examples/05-encoders-decoders/06-withdraw.ts

@@ -17,10 +17,7 @@ In order for a withdrawal to be successful, the address executing it must have `
 #### Encoding
 */
 
-import {
-  Client,
-  WithdrawParams,
-} from "@aragon/sdk-client";
+import { Client, WithdrawParams } from "@aragon/sdk-client";
 import { DaoAction, TokenType } from "@aragon/sdk-client-common";
 import { context } from "../index";
 

modules/client/examples/05-encoders-decoders/07-update-metadata.ts

@@ -24,13 +24,13 @@ const metadataParams: DaoMetadata = {
   links: [
     {
       url: "https://discord.com/...",
-      name: "Discord"
+      name: "Discord",
     },
     {
       url: "https://twitter.com/...",
-      name: "Twitter"
-    }
-  ]
+      name: "Twitter",
+    },
+  ],
 };
 
 const daoAddressOrEns: string = "0x123458235832745982839878932332423"; // or my-dao.dao.eth
@@ -41,7 +41,7 @@ const ipfsUri: string = await client.methods.pinMetadata(metadataParams);
 // Update the metadata of a given DAO.
 const action: DaoAction = await client.encoding.updateDaoMetadataAction(
   daoAddressOrEns,
-  ipfsUri
+  ipfsUri,
 );
 console.log({ action });
 
@@ -62,9 +62,10 @@ Returns:
 */
 
 // Decodes the update metadata action.
-const decodedParams: DaoMetadata = await client.decoding.updateDaoMetadataAction(
-  action.data
-);
+const decodedParams: DaoMetadata = await client.decoding
+  .updateDaoMetadataAction(
+    action.data,
+  );
 console.log({ decodedParams });
 
 /* MARKDOWN
@@ -97,7 +98,7 @@ Decode an update metadata action and expect an IPFS URI containing the CID of th
 
 // Decodes the parameters of an update metadata raw action.
 const decodedParamsRaw: string = client.decoding.updateDaoMetadataRawAction(
-  action.data
+  action.data,
 );
 console.log({ decodedParamsRaw });
 

modules/client/examples/05-encoders-decoders/14-initialize-from.ts

@@ -0,0 +1,60 @@
+/* MARKDOWN
+---
+title: Initialize From
+---
+
+## Upgrade a DAO to a new version
+
+Encodes the action for upgrading the dao to a new version and passing initialization data of the new version.
+
+### Encoding
+*/
+
+import { Client, InitializeFromParams } from "@aragon/sdk-client";
+import { DaoAction } 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 ininitializeFrom() method
+const initializeFromParams: InitializeFromParams = {
+  previousVersion: [1, 0, 0],
+  initData: new Uint8Array([12, 34, 45, 85, 95, 45, 73]), // initialization data for the new version to be pased to upgradeToAndCall()
+};
+
+const daoAddressOrEns: string = "0x123123123123123123123123123123123123"; // "my-dao.eth"
+
+const action: DaoAction = client.encoding.initializeFromAction(
+  daoAddressOrEns,
+  initializeFromParams,
+);
+console.log(action);
+
+/* MARKDOWN
+  ```json
+  {
+    to: "0x123123123...",
+    value: 0n,
+    data: Uint8Array[12,34,45...]
+  }
+  ```
+
+  ### Decoding
+  */
+
+// Decodes the initialize from action.
+const decodedParams: InitializeFromParams = client.decoding
+  .initializeFromAction(action.data);
+console.log({ decodedParams });
+
+/* MARKDOWN
+  Returns:
+
+  ```json
+  {
+    previousVersion: [1, 0, 0],
+    initData: Uint8Array[12,34,45...]
+  }
+  ```
+  */

modules/client/src/addresslistVoting/client.ts

@@ -11,7 +11,11 @@ import { AddresslistVotingClientDecoding } from "./internal/client/decoding";
 import { AddresslistVotingClientEstimation } from "./internal/client/estimation";
 import { Networkish } from "@ethersproject/providers";
 import { AddresslistVotingPluginInstall } from "./types";
-import { ClientCore, Context, PluginInstallItem } from "@aragon/sdk-client-common";
+import {
+  ClientCore,
+  Context,
+  PluginInstallItem,
+} from "@aragon/sdk-client-common";
 
 /**
  * Provider a generic client with high level methods to manage and interact an Address List Voting plugin installed in a DAO

modules/client/src/client-common/types/common.ts

@@ -1,4 +1,3 @@
-
 // This file contains common types, interfaces, and enumerations
 
 export enum DaoRole {
@@ -9,12 +8,10 @@ export enum DaoRole {
   SET_SIGNATURE_VALIDATOR_ROLE = "SET_SIGNATURE_VALIDATOR_ROLE",
 }
 
-
 /**
  * Contains the general human readable information about the DAO
  */
 export type DaoConfig = {
   name: string;
   metadataUri: string;
 };
-

modules/client/src/client.ts

@@ -9,7 +9,7 @@ import {
   IClientEstimation,
   IClientMethods,
 } from "./internal/interfaces";
-import { Context, ClientCore } from "@aragon/sdk-client-common";
+import { ClientCore, Context } from "@aragon/sdk-client-common";
 
 /**
  * Provider a generic client with high level methods to manage and interact with DAO's

modules/client/src/internal/client/decoding.ts

@@ -3,6 +3,7 @@ import {
   DecodedApplyUninstallationParams,
   GrantPermissionDecodedParams,
   GrantPermissionWithConditionParams,
+  InitializeFromParams,
   RegisterStandardCallbackParams,
   RevokePermissionDecodedParams,
   UpgradeToAndCallParams,
@@ -278,6 +279,26 @@ export class ClientDecoding extends ClientCore implements IClientDecoding {
     };
   }
 
+  /**
+   * Decodes the initializeFrom params from an initializeFromAction
+   *
+   * @param {Uint8Array} data
+   * @return {*}  {InitializeFromParams}
+   * @memberof ClientDecoding
+   */
+  public initializeFromAction(data: Uint8Array): InitializeFromParams {
+    const daoInterface = DAO__factory.createInterface();
+    const hexBytes = bytesToHex(data);
+    const expectedFunction = daoInterface.getFunction(
+      "initializeFrom",
+    );
+    const result = daoInterface.decodeFunctionData(expectedFunction, hexBytes);
+    return {
+      previousVersion: result[0],
+      initData: hexToBytes(result[1]),
+    };
+  }
+
   /**
    * Returns the decoded function info given the encoded data of an action
    *

modules/client/src/internal/client/encoding.ts

@@ -2,6 +2,7 @@ import {
   ApplyUninstallationParams,
   GrantPermissionParams,
   GrantPermissionWithConditionParams,
+  InitializeFromParams,
   RegisterStandardCallbackParams,
   RevokePermissionParams,
   UpgradeToAndCallParams,
@@ -414,4 +415,28 @@ export class ClientEncoding extends ClientCore implements IClientEncoding {
       data: hexToBytes(hexBytes),
     };
   }
+
+  /**
+   * Computes an action to be passed to the upgradeToAndCallAction method when upgrading a DAO to a new version.
+   *
+   * @param {string} daoAddressOrEns
+   * @param {InitializeFromParams} params
+   * @return {*}
+   * @memberof ClientEncoding
+   */
+  public initializeFromAction(
+    daoAddressOrEns: string,
+    params: InitializeFromParams,
+  ) {
+    const daoInterface = DAO__factory.createInterface();
+    const hexBytes = daoInterface.encodeFunctionData("initializeFrom", [
+      params.previousVersion,
+      params.initData ?? new Uint8Array(),
+    ]);
+    return {
+      to: daoAddressOrEns,
+      value: BigInt(0),
+      data: hexToBytes(hexBytes),
+    };
+  }
 }

modules/client/src/internal/interfaces.ts

@@ -25,6 +25,7 @@ import {
   GrantPermissionParams,
   GrantPermissionWithConditionParams,
   HasPermissionParams,
+  InitializeFromParams,
   PluginQueryParams,
   PluginRepo,
   PluginRepoListItem,
@@ -127,6 +128,10 @@ export interface IClientEncoding {
     daoAddressOrEns: string,
     params: ApplyUninstallationParams,
   ) => DaoAction[];
+  initializeFromAction: (
+    daoAddressOrEns: string,
+    params: InitializeFromParams,
+  ) => DaoAction;
 }
 
 export interface IClientDecoding {
@@ -156,6 +161,9 @@ export interface IClientDecoding {
   applyUninstallationAction: (
     data: Uint8Array,
   ) => DecodedApplyUninstallationParams;
+  initializeFromAction: (
+    data: Uint8Array,
+  ) => InitializeFromParams;
 }
 
 export interface IClientEstimation {

modules/client/src/tokenVoting/internal/utils.ts

@@ -222,7 +222,11 @@ export function parseToken(
     | SubgraphErc721Token
     | SubgraphErc20WrapperToken,
 ): Erc20TokenDetails | Erc721TokenDetails | null {
-  let token: Erc721TokenDetails | Erc20TokenDetails| Erc20WrapperTokenDetails | null = null;
+  let token:
+    | Erc721TokenDetails
+    | Erc20TokenDetails
+    | Erc20WrapperTokenDetails
+    | null = null;
   if (subgraphToken.__typename === SubgraphContractType.ERC20) {
     token = {
       address: subgraphToken.id,

modules/client/src/types.ts

@@ -345,3 +345,8 @@ export type UpgradeToAndCallParams = {
   implementationAddress: string;
   data: Uint8Array;
 };
+
+export type InitializeFromParams = {
+  previousVersion: [number, number, number];
+  initData?: Uint8Array;
+};

modules/client/test/abi/ERC1967.ts

@@ -70,4 +70,4 @@ export const ERC1967ABI = [
     "stateMutability": "payable",
     "type": "receive",
   },
-];
+];

modules/client/test/abi/index.ts

@@ -1 +1 @@
-export * from './ERC1967'
+export * from "./ERC1967";

modules/client/test/helpers/build-daos.ts

@@ -4,9 +4,9 @@ import {
   Client,
   CreateDaoParams,
   DaoCreationSteps,
-  TokenVotingPluginInstall,
   MultisigClient,
   TokenVotingClient,
+  TokenVotingPluginInstall,
   VotingMode,
 } from "../../src";
 import {
@@ -112,7 +112,7 @@ export async function buildTokenVotingDAO(
           plugin,
           signer,
         );
-        const tokenAddress = await tokenVotingContract.getVotingToken()
+        const tokenAddress = await tokenVotingContract.getVotingToken();
 
         return {
           dao,