Skip to content

feat: events service private event support #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: feat/private-event-utilities
Choose a base branch
from
Open

feat: events service private event support #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55195b7
feat: events service private event support
zeluisping Oct 21, 2025
d775fc6
chore: don't poll nor watch for public event of privatised event
zeluisping Oct 22, 2025
9b03073
chore: construct PrivateEntryPointAbi for better type-safety
zeluisping Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
200 changes: 75 additions & 125 deletions packages/executor/src/services/EventsService/versions/0.0.7.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,111 +1,22 @@
import { IDbController, Logger } from "@skandha/types/lib";
import {
AccountDeployedEvent,
SignatureAggregatorChangedEvent,
UserOperationEventEvent,
} from "@skandha/types/lib/contracts/EPv7/core/EntryPoint";
import { MempoolEntryStatus } from "@skandha/types/lib/executor";
import { ReputationService } from "../../ReputationService";
import { MempoolService } from "../../MempoolService";
import { ExecutorEvent, ExecutorEventBus } from "../../SubscriptionService";
import { EntryPoint__factory } from "@skandha/types/lib/contracts/EPv7/factories/core";
import { GetContractReturnType, Hex, PublicClient, Log, parseAbi } from "viem";

type UserOperationEventAbi = {
Copy link

@seromenho seromenho Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't get rid of these events ABIs. When parsing a private event, the inner event follows this ABI.

anonymous: false,
inputs: [
{
indexed: true,
internalType: "bytes32",
name: "userOpHash",
type: "bytes32",
},
{
indexed: true,
internalType: "address",
name: "sender",
type: "address",
},
{
indexed: true,
internalType: "address",
name: "paymaster",
type: "address",
},
{
indexed: false,
internalType: "uint256",
name: "nonce",
type: "uint256",
},
{
indexed: false,
internalType: "bool",
name: "success",
type: "bool",
},
{
indexed: false,
internalType: "uint256",
name: "actualGasCost",
type: "uint256",
},
{
indexed: false,
internalType: "uint256",
name: "actualGasUsed",
type: "uint256",
},
],
name: "UserOperationEvent",
type: "event",
};

type AccountDeployedEventAbi = {
anonymous: false,
inputs: [
{
indexed: true,
internalType: "bytes32",
name: "userOpHash",
type: "bytes32",
},
{
indexed: true,
internalType: "address",
name: "sender",
type: "address",
},
{
indexed: false,
internalType: "address",
name: "factory",
type: "address",
},
{
indexed: false,
internalType: "address",
name: "paymaster",
type: "address",
},
],
name: "AccountDeployed",
type: "event",
};

type SignatureAggregatorChangedEventAbi = {
anonymous: false,
inputs: [
{
indexed: true,
internalType: "address",
name: "aggregator",
type: "address",
},
],
name: "SignatureAggregatorChanged",
type: "event",
};
import { GetContractReturnType, Hex, PublicClient, Log, parseAbi, AbiEvent } from "viem";
import {
ACCOUNT_DEPLOYED_EVENT_HASH,
AccountDeployedAbi,
PrivateEventAbi,
SignatureAggregatorChangedAbi,
USER_OPERATION_EVENT_HASH,
UserOperationEventAbi,
} from '../../../utils/abi-events'
import { isPrivateEventLogWithArgs, unwrapPrivateEvent } from '../../../utils/unwrapPrivateEvent'

type EventLog<ABI extends AbiEvent> = Log<bigint, number, false, ABI>
const PrivateEntryPointAbi = <const>[ PrivateEventAbi, ...EntryPoint__factory.abi ]

export class EntryPointV7EventsService {
private lastBlock: bigint = BigInt(0);
Expand Down Expand Up @@ -151,8 +62,8 @@ export class EntryPointV7EventsService {
}
const logs = await publicClient.getLogs({
events: parseAbi([
'event UserOperationEvent(bytes32 indexed userOpHash, address indexed sender, address indexed paymaster, uint256 nonce, bool success, uint256 actualGasCost, uint256 actualGasUsed)',
'event AccountDeployed(bytes32 indexed userOpHash, address indexed sender, address factory, address paymaster)',
// PrivateEvent: UserOperationEvent, AccountDeployed
'event PrivateEvent(address[] allowedViewers, bytes32 indexed eventType, bytes payload)',
Copy link

@seromenho seromenho Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pollEvents uses the regular publicClient, which doesn't have Silent Data auth headers, and private events doesn't work

'event SignatureAggregatorChanged(address indexed aggregator)'
]),
address: this.entryPoint,
Expand Down Expand Up @@ -181,23 +92,17 @@ export class EntryPointV7EventsService {

initEventListener(): void {
if(!this.disableWatchContractevent) {
// Watching PrivateEvent for: UserOperationEvent and AccountDeployed
this.publicClient.watchContractEvent({
abi: EntryPoint__factory.abi,
eventName: "UserOperationEvent",
abi: PrivateEntryPointAbi,
address: this.entryPoint,
eventName: "PrivateEvent",
args: {
eventType: [ACCOUNT_DEPLOYED_EVENT_HASH, USER_OPERATION_EVENT_HASH]
},
onLogs: async (args) => {
const ev = args[args.length - 1];
await this.handleUserOperationEvent(ev);
}
});

this.publicClient.watchContractEvent({
abi: EntryPoint__factory.abi,
address: this.entryPoint,
eventName: "AccountDeployed",
onLogs: async (args) => {
const ev = args[args.length - 1];
await this.handleAccountDeployedEvent(ev);
await this.handleEvent(ev);
}
});

Expand All @@ -218,10 +123,19 @@ export class EntryPointV7EventsService {
}

async handleEvent(
ev: Log<bigint, number, false, UserOperationEventAbi> |
Log<bigint, number, false, AccountDeployedEventAbi> |
Log<bigint, number, false, SignatureAggregatorChangedEventAbi>
originalEvent: (
| EventLog<PrivateEventAbi>
| EventLog<SignatureAggregatorChangedAbi>
)
): Promise<void> {
const ev = originalEvent.eventName === 'PrivateEvent'
? this.handlePrivateEventUnwrap(originalEvent)
: originalEvent

if (ev === null) {
return;
}

switch (ev.eventName) {
case "UserOperationEvent":
await this.handleUserOperationEvent(ev);
Expand All @@ -235,8 +149,44 @@ export class EntryPointV7EventsService {
}
}

handlePrivateEventUnwrap(
ev: EventLog<PrivateEventAbi>
): (
| EventLog<UserOperationEventAbi>
| EventLog<AccountDeployedAbi>
) | null {
if (!isPrivateEventLogWithArgs(ev)) {
this.logger.error("Invalid PrivateEvent: missing required fields");
return null
}

const wrappedEventHashToAbi = {
Copy link

@seromenho seromenho Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can live outside of the function scope.

[USER_OPERATION_EVENT_HASH]: UserOperationEventAbi,
[ACCOUNT_DEPLOYED_EVENT_HASH]: AccountDeployedAbi,
}
const abi = wrappedEventHashToAbi[ev.args.eventType]

// if abi is not on the list, then we do not care about this event
if (!abi) {
return null
}

try {
// type cast to unwrap EventLog<UserOperationEventAbi | AccountDeployedAbi>
return unwrapPrivateEvent(abi, ev) as (
Copy link

@seromenho seromenho Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the other comment. We should use the existing parseEvent.

| EventLog<UserOperationEventAbi>
| EventLog<AccountDeployedAbi>
)
} catch (error) {
this.logger.error(
`Failed to unwrap PrivateEvent for ${abi.name}: ${error instanceof Error ? error.message : JSON.stringify(error)}`
);
}
return null
}

async handleAggregatorChangedEvent(
ev: Log<bigint, number, false, SignatureAggregatorChangedEventAbi>
ev: EventLog<SignatureAggregatorChangedAbi>
): Promise<void> {
this.eventAggregator = ev.args.aggregator ?? null;
this.eventAggregatorTxHash = ev.transactionHash;
Expand All @@ -248,8 +198,8 @@ export class EntryPointV7EventsService {
// aggregator event is sent once per events bundle for all UserOperationEvents in this bundle.
// it is not sent at all if the transaction is handleOps
getEventAggregator(
ev: Log<bigint, number, false, SignatureAggregatorChangedEventAbi> |
Log<bigint, number, false, UserOperationEventAbi>
ev: EventLog<SignatureAggregatorChangedAbi> |
EventLog<UserOperationEventAbi>
): string | null {
if (ev.transactionHash !== this.eventAggregatorTxHash) {
this.eventAggregator = null;
Expand All @@ -260,13 +210,13 @@ export class EntryPointV7EventsService {

// AccountDeployed event is sent before each UserOperationEvent that deploys a contract.
async handleAccountDeployedEvent(
ev: Log<bigint, number, false, AccountDeployedEventAbi>
ev: EventLog<AccountDeployedAbi>
): Promise<void> {
await this.includedAddress(ev.args.factory ?? null);
}

async handleUserOperationEvent(
ev: Log<bigint, number, false, UserOperationEventAbi>
ev: EventLog<UserOperationEventAbi>
): Promise<void> {
const entry = await this.mempoolService.getEntryByHash(ev.args.userOpHash!);
if (entry) {
Expand Down