chore: add metadataHash to response (#334)

* chore: add metadataHash to response * chore: add metadataHash to response
aragon · May 9, 2024 · afcf672 · afcf672
1 parent d73b903
commit afcf672
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 3 deletions.
diff --git a/modules/client-common/CHANGELOG.md b/modules/client-common/CHANGELOG.md
@@ -19,6 +19,11 @@ TEMPLATE:
 
 ## [UPCOMING]
 
+- Added `metadataHash` field to proposal and dao objects.
+
+## [1.15.0]
+- Added `metadataHash` field to proposal and dao objects.
+
 ### Added
 
 - `getDefaultIpfsNodes` function to get the default IPFS nodes for a network

diff --git a/modules/client-common/package.json b/modules/client-common/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aragon/sdk-client-common",
   "author": "Aragon Association",
-  "version": "1.15.1",
+  "version": "1.15.2",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/sdk-client-common.esm.js",

diff --git a/modules/client-common/src/types.ts b/modules/client-common/src/types.ts
@@ -199,6 +199,7 @@ export type ProposalBase = {
   };
   creatorAddress: string;
   metadata: ProposalMetadata;
+  metadataHash: string;
   startDate: Date;
   endDate: Date;
   creationDate: Date;
@@ -219,6 +220,7 @@ export type ProposalListItemBase = {
   };
   creatorAddress: string;
   metadata: ProposalMetadataSummary;
+  metadataHash: string;
   startDate: Date;
   endDate: Date;
   status: ProposalStatus;

diff --git a/modules/client/CHANGELOG.md b/modules/client/CHANGELOG.md
@@ -18,6 +18,9 @@ TEMPLATE:
 -->
 
 ## [UPCOMING]
+
+- Added `metadataHash` field to proposal and dao objects.
+
 ## [1.23.2]
 
 ### Changed

diff --git a/modules/client/package.json b/modules/client/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aragon/sdk-client",
   "author": "Aragon Association",
-  "version": "1.23.3",
+  "version": "1.23.4",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/sdk-client.esm.js",
@@ -69,7 +69,7 @@
   "dependencies": {
     "@aragon/osx-commons-configs": "^0.4.0",
     "@aragon/osx-ethers": "1.3.0",
-    "@aragon/sdk-client-common": "^1.15.1",
+    "@aragon/sdk-client-common": "^1.15.2",
     "@aragon/sdk-ipfs": "^1.1.0",
     "@ethersproject/abstract-signer": "^5.5.0",
     "@ethersproject/bignumber": "^5.6.0",

diff --git a/modules/client/src/addresslistVoting/internal/utils.ts b/modules/client/src/addresslistVoting/internal/utils.ts
@@ -55,6 +55,7 @@ export function toAddresslistVotingProposal(
       resources: metadata.resources,
       media: metadata.media,
     },
+    metadataHash: proposal.metadata,
     startDate,
     endDate,
     creationDate,
@@ -118,6 +119,7 @@ export function toAddresslistVotingProposalListItem(
       title: metadata.title,
       summary: metadata.summary,
     },
+    metadataHash: proposal.metadata,
     startDate,
     endDate,
     status: computeProposalStatus(proposal),

diff --git a/modules/client/src/internal/utils.ts b/modules/client/src/internal/utils.ts
@@ -140,6 +140,7 @@ export function toDaoDetails(
       avatar: metadata.avatar || undefined,
       links: metadata.links,
     },
+    metadataHash: dao.metadata,
     creationDate: new Date(parseInt(dao.createdAt) * 1000),
     // TODO update when new subgraph schema is deployed
     // filter out plugins that are not applied
@@ -176,6 +177,7 @@ export function toDaoListItem(
       description: metadata.description,
       avatar: metadata.avatar || undefined,
     },
+    metadataHash: dao.metadata,
     plugins: dao.plugins.filter(
       (plugin) =>
         plugin.appliedPreparation && plugin.appliedVersion &&

diff --git a/modules/client/src/multisig/internal/utils.ts b/modules/client/src/multisig/internal/utils.ts
@@ -45,6 +45,7 @@ export function toMultisigProposal(
       resources: metadata.resources,
       media: metadata.media,
     },
+    metadataHash: proposal.metadata,
     settings: {
       onlyListed: proposal.plugin.onlyListed,
       minApprovals: proposal.minApprovals,
@@ -92,6 +93,7 @@ export function toMultisigProposalListItem(
       title: metadata.title,
       summary: metadata.summary,
     },
+    metadataHash: proposal.metadata,
     approvals: proposal.approvals.map(
       (a) => a.approver.address,
     ),

diff --git a/modules/client/src/tokenVoting/internal/utils.ts b/modules/client/src/tokenVoting/internal/utils.ts
@@ -78,6 +78,7 @@ export function toTokenVotingProposal(
       resources: metadata.resources,
       media: metadata.media,
     },
+    metadataHash: proposal.metadata,
     startDate,
     endDate,
     creationDate,
@@ -156,6 +157,7 @@ export function toTokenVotingProposalListItem(
       title: metadata.title,
       summary: metadata.summary,
     },
+    metadataHash: proposal.metadata,
     totalVotingWeight: BigInt(proposal.totalVotingPower),
     startDate,
     endDate,

diff --git a/modules/client/src/types.ts b/modules/client/src/types.ts
@@ -36,6 +36,7 @@ export type DaoDetails = {
   address: string;
   ensDomain: string;
   metadata: DaoMetadata;
+  metadataHash: string;
   creationDate: Date;
   plugins: InstalledPluginListItem[];
 };
@@ -48,6 +49,7 @@ export type DaoListItem = {
     description: string;
     avatar?: string;
   };
+  metadataHash: string;
   plugins: InstalledPluginListItem[];
 };