Merge pull request #39 from ATOR-Development/37-set-relay-families-vi…

…a-addremove-batch-interfaces Update interfaces for setting relay families with add/remove
anyone-protocol · Jul 31, 2024 · 6712ec9 · 6712ec9
2 parents 03c488a + 5330dda
commit 6712ec9
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 18 deletions.
diff --git a/src/distribution/distribution.service.ts b/src/distribution/distribution.service.ts
@@ -510,14 +510,16 @@ export class DistributionService {
         }
 
         // NB: Only update relay families that need to be updated
-        const families = await this.getFamilies()
+        const currentFamilies = await this.getFamilies()
         const relaysWithFamilyUpdates: ValidatedRelay[] = []
         for (const relay of relays) {
             const incomingFamilyHash = (relay.family || [])
                 .slice()
                 .sort()
                 .join('')
-            const contractFamilyHash = (families[relay.fingerprint] || [])
+            const contractFamilyHash = (
+                currentFamilies[relay.fingerprint] || []
+            )
                 .slice()
                 .sort()
                 .join('')
@@ -527,16 +529,29 @@ export class DistributionService {
             } else {
                 results.push({
                     relay,
-                    result: 'AlreadyVerified' // TODO -> 'AlreadySetFamily' ?
+                    result: 'AlreadySetFamily'
                 })
             }
         }
 
         if (this.isLive === 'true') {
             try {
                 if (relaysWithFamilyUpdates.length > 0) {
+                    const addRemoveFamilies = relaysWithFamilyUpdates.map(
+                        ({ fingerprint, family }) => ({
+                            fingerprint,
+                            add: _.difference(
+                                family,
+                                currentFamilies[fingerprint]
+                            ),
+                            remove: _.difference(
+                                currentFamilies[fingerprint],
+                                family
+                            )
+                        })
+                    )
                     const familyBatches = _.chunk(
-                        relaysWithFamilyUpdates,
+                        addRemoveFamilies,
                         DistributionService.familiesPerBatch
                     )
 
@@ -548,10 +563,7 @@ export class DistributionService {
                         const response = await this.distributionContract
                             .writeInteraction<SetFamilies>({
                                 function: 'setFamilies',
-                                families: familyBatch.map(
-                                    ({ fingerprint, family }) =>
-                                        ({ fingerprint, family })
-                                )
+                                families: familyBatch
                             })
 
                         this.logger.log(

diff --git a/src/distribution/interfaces/distribution.ts b/src/distribution/interfaces/distribution.ts
@@ -130,7 +130,8 @@ export interface SetFamilies extends ContractFunctionInput {
   function: 'setFamilies'
   families: {
     fingerprint: Fingerprint
-    family: Fingerprint[]
+    add?: Fingerprint[]
+    remove?: Fingerprint[]
   }[]
 }
 

diff --git a/src/verification/dto/relay-verification-result.ts b/src/verification/dto/relay-verification-result.ts
@@ -4,3 +4,4 @@ export type RelayVerificationResult =
     | 'AlreadyRegistered'
     | 'HardwareProofFailed'
     | 'Failed'
+    | 'AlreadySetFamily'
diff --git a/src/verification/interfaces/relay-registry.ts b/src/verification/interfaces/relay-registry.ts
@@ -104,7 +104,8 @@ export interface SetFamilies extends ContractFunctionInput {
   function: 'setFamilies'
   families: {
     fingerprint: Fingerprint
-    family: Fingerprint[]
+    add?: Fingerprint[]
+    remove?: Fingerprint[]
   }[]
 }
 

diff --git a/src/verification/verification.service.ts b/src/verification/verification.service.ts
@@ -572,14 +572,16 @@ export class VerificationService {
         }
 
         // NB: Only update relay families that need to be updated
-        const families = await this.getFamilies()
+        const currentFamilies = await this.getFamilies()
         const relaysWithFamilyUpdates: ValidatedRelay[] = []
         for (const relay of relays) {
             const incomingFamilyHash = (relay.family || [])
                 .slice()
                 .sort()
                 .join('')
-            const contractFamilyHash = (families[relay.fingerprint] || [])
+            const contractFamilyHash = (
+                currentFamilies[relay.fingerprint] || []
+            )
                 .slice()
                 .sort()
                 .join('')
@@ -589,16 +591,29 @@ export class VerificationService {
             } else {
                 results.push({
                     relay,
-                    result: 'AlreadyVerified' // TODO -> 'AlreadySetFamily' ?
+                    result: 'AlreadySetFamily'
                 })
             }
         }
 
         if (this.isLive === 'true') {
             try {
                 if (relaysWithFamilyUpdates.length > 0) {
+                    const addRemoveFamilies = relaysWithFamilyUpdates.map(
+                        ({ fingerprint, family }) => ({
+                            fingerprint,
+                            add: _.difference(
+                                family,
+                                currentFamilies[fingerprint]
+                            ),
+                            remove: _.difference(
+                                currentFamilies[fingerprint],
+                                family
+                            )
+                        })
+                    )
                     const familyBatches = _.chunk(
-                        relaysWithFamilyUpdates,
+                        addRemoveFamilies,
                         VerificationService.familiesPerBatch
                     )
 
@@ -610,10 +625,7 @@ export class VerificationService {
                         const response = await this.relayRegistryContract
                             .writeInteraction<SetFamilies>({
                                 function: 'setFamilies',
-                                families: familyBatch.map(
-                                    ({ fingerprint, family }) =>
-                                        ({ fingerprint, family })
-                                )
+                                families: familyBatch
                             })
 
                         this.logger.log(