feat: adds blocklist to remove subdomains from indexing

packages/subgraph/CHANGELOG.md

@@ -5,11 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [UPCOMING]
+## [1.0.1]
 
 ### Added
 
 - Add `executable` attribute to `MultisigProposal`.
+- Added `subdomain_blocklist` for DAO indexing.
 
 ### Changed
 

packages/subgraph/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aragon/osx-subgraph",
-  "version": "0.10.0-alpha",
+  "version": "1.0.1",
   "description": "The Aragon OSx Subgraph",
   "homepage": "https://github.com/aragon/osx",
   "license": "AGPL-3.0-or-later",

packages/subgraph/src/registries/daoRegistry.ts

@@ -1,12 +1,22 @@
 import {DAORegistered} from '../../generated/DAORegistry/DAORegistry';
 import {DaoTemplate} from '../../generated/templates';
 import {Dao} from '../../generated/schema';
+import {dataSource} from '@graphprotocol/graph-ts';
+
+// blocklists of addresses for which we don't index the subdomain.
+// Put the reason next to the address as a comment
+const subdomain_blocklist_mainnet = [
+  '0x16070493aa513f91fc8957f14b7b7c6c0c41fbac' // domain squatting lido.dao.eth
+];
 
 export function handleDAORegistered(event: DAORegistered): void {
   let id = event.params.dao.toHexString(); // use dao address as id, because it should not repeat
   let entity = new Dao(id);
 
-  entity.subdomain = event.params.subdomain;
+  if (!isInSubdomainBlocklist(id)) {
+    entity.subdomain = event.params.subdomain;
+  }
+
   entity.creator = event.params.creator;
   entity.createdAt = event.block.timestamp;
 
@@ -15,3 +25,13 @@ export function handleDAORegistered(event: DAORegistered): void {
 
   entity.save();
 }
+
+// checks if a certain address is in the blocklist. Returns false by default
+function isInSubdomainBlocklist(address: string): bool {
+  // switch case doesn't work with assemblyscript
+  if (dataSource.network() == 'mainnet') {
+    return subdomain_blocklist_mainnet.includes(address);
+  }
+
+  return false;
+}

packages/subgraph/tests/registry/daoRegistry.test.ts

@@ -1,34 +1,74 @@
-import {assert, clearStore, test} from 'matchstick-as/assembly/index';
+import {
+  assert,
+  clearStore,
+  test,
+  dataSourceMock,
+  describe,
+  afterEach
+} from 'matchstick-as/assembly/index';
 import {Address} from '@graphprotocol/graph-ts';
 
 import {handleDAORegistered} from '../../src/registries/daoRegistry';
 import {DAO_ADDRESS, ADDRESS_ONE} from '../constants';
 import {createNewDaoEvent} from './utils';
+import {Dao} from '../../generated/schema';
 
-test('Run dao registry mappings with mock event', () => {
-  // create event
-  let newDaoEvent = createNewDaoEvent(DAO_ADDRESS, ADDRESS_ONE, 'mock-Dao');
-
-  // handle event
-  handleDAORegistered(newDaoEvent);
-
-  let entityID = Address.fromString(DAO_ADDRESS).toHexString();
-
-  // checks
-  assert.fieldEquals('Dao', entityID, 'id', entityID);
-  assert.fieldEquals(
-    'Dao',
-    entityID,
-    'creator',
-    Address.fromString(ADDRESS_ONE).toHexString()
-  );
-  assert.fieldEquals('Dao', entityID, 'subdomain', 'mock-Dao');
-  assert.fieldEquals(
-    'Dao',
-    entityID,
-    'createdAt',
-    newDaoEvent.block.timestamp.toString()
-  );
-
-  clearStore();
+describe('DAORegistry', () => {
+  afterEach(() => {
+    clearStore();
+  });
+
+  test('Run dao registry mappings with mock event', () => {
+    // create event
+    let newDaoEvent = createNewDaoEvent(DAO_ADDRESS, ADDRESS_ONE, 'mock-Dao');
+
+    // handle event
+    handleDAORegistered(newDaoEvent);
+
+    let entityID = Address.fromString(DAO_ADDRESS).toHexString();
+
+    // checks
+    assert.fieldEquals('Dao', entityID, 'id', entityID);
+    assert.fieldEquals(
+      'Dao',
+      entityID,
+      'creator',
+      Address.fromString(ADDRESS_ONE).toHexString()
+    );
+    assert.fieldEquals('Dao', entityID, 'subdomain', 'mock-Dao');
+    assert.fieldEquals(
+      'Dao',
+      entityID,
+      'createdAt',
+      newDaoEvent.block.timestamp.toString()
+    );
+  });
+
+  test("Don't store subdomain for blocklisted DAO", () => {
+    // Using an already blocklisted address for mainnet. This is unlikely to change
+    let entityID = '0x16070493aa513f91fc8957f14b7b7c6c0c41fbac';
+    // create event.
+    let newDaoEvent = createNewDaoEvent(entityID, ADDRESS_ONE, 'mock-Dao');
+    dataSourceMock.setNetwork('mainnet');
+
+    handleDAORegistered(newDaoEvent);
+
+    // checks
+    assert.fieldEquals('Dao', entityID, 'id', entityID);
+    assert.fieldEquals(
+      'Dao',
+      entityID,
+      'creator',
+      Address.fromString(ADDRESS_ONE).toHexString()
+    );
+    assert.fieldEquals(
+      'Dao',
+      entityID,
+      'createdAt',
+      newDaoEvent.block.timestamp.toString()
+    );
+
+    const daoEntity = Dao.load(entityID);
+    assert.assertNull(daoEntity!.subdomain);
+  });
 });