Skip to content

Commit 5700323

Browse files
committed
feat(data): feat(data) add semaphore event listeners
Add short descriptions to off listeners methods re #326
1 parent 026ea38 commit 5700323

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

packages/data/src/ethers.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,10 @@ export default class SemaphoreEthers {
306306
})
307307
}
308308

309+
/**
310+
* Removes all listeners for the GroupCreated event.
311+
* Stop receiving group creation notifications.
312+
*/
309313
offGropupCreated(): void {
310314
this._contract.removeAllListeners("GroupCreated")
311315
}
@@ -322,6 +326,10 @@ export default class SemaphoreEthers {
322326
})
323327
}
324328

329+
/**
330+
* Removes all listeners for the MemberAdded event.
331+
* Stop tracking when new members are added.
332+
*/
325333
offMemberAdded(): void {
326334
this._contract.removeAllListeners("MemberAdded")
327335
}
@@ -353,6 +361,10 @@ export default class SemaphoreEthers {
353361
)
354362
}
355363

364+
/**
365+
* Removes all listeners for the MemberUpdated event.
366+
* Stop receiving updates when members change their commitment.
367+
*/
356368
offMemberUpdated(): void {
357369
this._contract.removeAllListeners("MemberUpdated")
358370
}
@@ -369,6 +381,10 @@ export default class SemaphoreEthers {
369381
})
370382
}
371383

384+
/**
385+
* Removes all listeners for the MemberRemoved event.
386+
* Stop listening for member removals.
387+
*/
372388
offMemberRemoved(): void {
373389
this._contract.removeAllListeners("MemberRemoved")
374390
}
@@ -406,6 +422,10 @@ export default class SemaphoreEthers {
406422
)
407423
}
408424

425+
/**
426+
* Removes all listeners for the ProofValidated event.
427+
* Stop receiving proof validation notifications.
428+
*/
409429
offProofValidated(): void {
410430
this._contract.removeAllListeners("ProofValidated")
411431
}
@@ -420,6 +440,10 @@ export default class SemaphoreEthers {
420440
})
421441
}
422442

443+
/**
444+
* Removes all listeners for the GroupAdminUpdated event.
445+
* Stop tracking when a group's admin is updated.
446+
*/
423447
offGroupAdminUpdated(): void {
424448
this._contract.removeAllListeners("GroupAdminUpdated")
425449
}

0 commit comments

Comments
 (0)