F/os 587 abstract actions and callback ids

subgraph/CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added `generateActionEntityId` and `generateStandardCAllbackEntityId`.
 - Added `generatePermissionId` and `generatePluginPermissionId`.
 - Added `generatePluginRepoEntityId`, `generatePluginSetupEntityId`, `generatePluginInstallationEntityId`, `generatePluginPreparationEntityId`, `generatePluginReleaseEntityId`, and `generatePluginVersionEntityId`.
 

subgraph/src/ids/callbacks.ts

@@ -0,0 +1,16 @@
+import {Address, Bytes} from '@graphprotocol/graph-ts';
+
+/**
+ * Generates a unique StandardCallback ID using the given parameters.
+ *
+ * @param dao - Address of the DAO
+ * @param interfaceId - Interface ID of the emitted event
+ * @returns A concatenated ID string for the StandardCallback entity.
+ */
+export function generateStandardCallbackEntityId(
+  dao: Address,
+  interfaceId: Bytes
+): string {
+  const ids = [dao.toHexString(), interfaceId.toHexString()];
+  return ids.join('_');
+}

subgraph/src/ids/proposal.ts

@@ -0,0 +1,14 @@
+/**
+ * Generates a unique action ID using the given parameters.
+ *
+ * @param proposalId - The id of the proposal that the action belongs to.
+ * @param index - The index of the action within the proposal.
+ * @returns A concatenated ID string for the Action entity.
+ */
+export function generateActionEntityId(
+  proposalEntityId: string,
+  index: i32
+): string {
+  const ids = [proposalEntityId, index.toString()];
+  return ids.join('_');
+}

subgraph/tests/constants.ts

@@ -6,3 +6,5 @@ export const DUMMY_BYTES32_HEX =
   '0x0000000000000000000000000000000000000000000000000000000000000000';
 export const DUMMY_INSTALLATION_ID =
   '0x000f1e7f040a60eb32b1b2348cf41924f85e221648a4d0a5ba66d2dea1122ee6';
+
+export const DUMMY_PROPOSAL_ID = [ADDRESS_ZERO, DUMMY_BYTES32_HEX].join('_');

subgraph/tests/ids/callbacks.test.ts

@@ -0,0 +1,18 @@
+import {generateStandardCallbackEntityId} from '../../src/ids/callbacks';
+import {ADDRESS_ONE, DUMMY_BYTES32_HEX} from '../constants';
+import {Address, Bytes} from '@graphprotocol/graph-ts';
+import {assert, describe, test} from 'matchstick-as/assembly/index';
+
+describe('Standard Callback Entity ID generation', () => {
+  test('`generateStandardCallbackEntityId` should return the expected ID', () => {
+    const dao = Address.fromString(ADDRESS_ONE);
+    const interfaceId = Bytes.fromHexString(DUMMY_BYTES32_HEX);
+
+    const expectedId = `${dao.toHexString()}_${interfaceId.toHexString()}`;
+
+    assert.stringEquals(
+      generateStandardCallbackEntityId(dao, interfaceId),
+      expectedId
+    );
+  });
+});

subgraph/tests/ids/proposal.test.ts

@@ -0,0 +1,14 @@
+import {generateActionEntityId} from '../../src/ids/proposal';
+import {DUMMY_PROPOSAL_ID} from '../constants';
+import {assert, describe, test} from 'matchstick-as/assembly/index';
+
+describe('Proposal ID generation', () => {
+  test('`generateActionEntityId` should return the id representation of an action', () => {
+    const proposalId = DUMMY_PROPOSAL_ID;
+    const index = 0;
+
+    const expectedId = `${proposalId}_${index}`;
+
+    assert.stringEquals(generateActionEntityId(proposalId, index), expectedId);
+  });
+});