feat(svm): svm spoke events client #899

md0x · 2025-02-25T16:13:28Z

Changes proposed in this PR:

Add SvmSpokeEventsClient, an events client that fetches CPI events from SvmSpoke by event type, with optional filtering by fromSlot and/or toSlot.

How to use it:

import { SvmSpokeClient } from "@across-protocol/contracts";
import { createSolanaRpc } from "@solana/web3-v2.js";
import { SvmSpokeEventsClient } from "./src/svm";

async function main() {
    const rpc = createSolanaRpc("YOUR_RPC_URL");
    const eventsClient = await SvmSpokeEventsClient.create(rpc);
    const fromSlot = BigInt(362424536);
    const toSlot = BigInt(363326129);
    const events = await eventsClient.queryEvents<SvmSpokeClient.FilledRelay>("FilledRelay", fromSlot, toSlot);
    console.log(events);
}

main();

Signed-off-by: Pablo Maldonado <[email protected]>

linear · 2025-02-25T16:13:31Z

ACX-3769 SVM Event query functions SDK

Signed-off-by: Pablo Maldonado <[email protected]>

md0x · 2025-02-25T17:58:04Z

package.json

@@ -12,6 +12,8 @@
    "node": ">=20.18.0"
  },
  "scripts": {
+    "build-bigint-buffer": "[ -d node_modules/bigint-buffer ] && command -v node-gyp > /dev/null && cd node_modules/bigint-buffer && node-gyp configure && node-gyp build || echo 'Skipping bigint-buffer build: folder or node-gyp not found'",


Same as in relayer to get rid of the bigint-buffer warning

md0x · 2025-02-25T17:59:29Z

package.json

@@ -105,7 +107,9 @@
    "@eth-optimism/sdk": "^3.3.1",
    "@ethersproject/bignumber": "^5.7.0",
    "@pinata/sdk": "^2.1.0",
-    "@solana/web3.js": "^2.0.0",
+    "@solana/web3-v2.js": "npm:@solana/web3.js@2",


We need to have both versions because the BorshEncoder uses v1 internally

Signed-off-by: Pablo Maldonado <[email protected]>

md0x · 2025-02-25T18:28:05Z

src/svm/utils/events.ts

+ * Gets the event name from a raw name.
+ */
+export function getEventName(rawName?: string): EventName {
+  if (!rawName) throw new Error("Raw name is undefined");


This should never happen so we throw an error

why accept optional param in the first place?

md0x · 2025-02-25T18:28:32Z

src/svm/utils/events.ts

+    case "TransferredOwnership":
+      return eventData as TransferredOwnershipEvent;
+    default:
+      throw new Error(`Unknown event name: ${name}`);


Signed-off-by: Pablo Maldonado <[email protected]>

Reinis-FRP · 2025-02-28T09:08:33Z

src/svm/eventsClient.ts

+import { getEventName, parseEventData } from "./utils/events";
+import { isDevnet } from "./utils/helpers";
+
+type GetTransactionReturnType = ReturnType<GetTransactionApi["getTransaction"]>;


This might be bit risky as this infers the union of all overloads. E.g. if the caller passed { encoding: "base58" } then returned transaction property would be of type Base58EncodedDataResponse and the event client would error when trying to access something like txResult.transaction.message.accountKeys.

I think the above does not exactly apply to us as we are calling getTransaction without setting encoding, so it matches the optional json overload which has the props we are trying to access. But maybe its worth adding a comment on this for safer code maintenance.

Good call. I've added a type wrapper to extract only the "json" encoded return type.

Reinis-FRP · 2025-02-28T09:54:13Z

src/svm/eventsClient.ts

+  ): Promise<{ program: Address; data: EventData; name: EventName }[]> {
+    if (!txResult) return [];
+
+    const eventAuthorities: Map<string, Address> = new Map();


is mapping necessary? we only have single program in this method

Reinis-FRP · 2025-02-28T10:13:52Z

src/svm/eventsClient.ts

+          programId == ixProgramId &&
+          eventAuthorities.get(ixProgramId.toString()) == singleIxAccount


should these use strict evaluation ===?

Reinis-FRP · 2025-02-28T10:29:31Z

src/svm/eventsClient.ts

+          const name = getEventName(event?.name);
+          events.push({
+            program: programId,
+            data: parseEventData(event?.data),
+            name,
+          });


maybe parsing should be in separate function that caller can try to parse. getEventName and parseEventData would not work if the caller passed other program than spoke pool

alternatively, we could omit passing program from all private methods and use only the spoke pool

Reinis-FRP · 2025-02-28T10:46:34Z

src/svm/eventsClient.ts

+    fromSlot?: bigint,
+    toSlot?: bigint,
+    options: GetSignaturesForAddressConfig = { limit: 1000 },
+    finality: Commitment = "confirmed"


nit: can we better use commitment for the parameter name.

Reinis-FRP · 2025-02-28T10:57:16Z

src/svm/eventsClient.ts

+    program: Address,
+    anchorIdl: Idl,


these might be not necessary as we use them in private methods and it should work only for the spoke pool program. Except, maybe keep program address, but that is useful only if the public create method allowed passing a custom spoke address.

Reinis-FRP · 2025-02-28T11:09:03Z

src/svm/eventsClient.ts

+    options: GetSignaturesForAddressConfig = { limit: 1000 },
+    finality: Commitment = "confirmed"


does it make sense to pass separate commitment in the finality parameter (used in getTransaction calls) from options.commitment that gets used in getSignaturesForAddress calls?

Reinis-FRP · 2025-02-28T11:31:00Z

src/svm/eventsClient.ts

+        const events = await this.readEventsFromSignature(signatureTransaction.signature, program, anchorIdl, finality);
+        return events.map((event) => ({
+          ...event,
+          confirmationStatus: signatureTransaction.confirmationStatus || "Unknown",


maybe pass the Commitment | null type as is?

Reinis-FRP · 2025-02-28T11:31:22Z

src/svm/eventsClient.ts

+        return events.map((event) => ({
+          ...event,
+          confirmationStatus: signatureTransaction.confirmationStatus || "Unknown",
+          blockTime: signatureTransaction.blockTime || unixTimestamp(BigInt(0)),


maybe pass UnixTimestamp | null type as is?

Signed-off-by: Pablo Maldonado <[email protected]>

nicholaspai · 2025-02-28T16:14:05Z

src/svm/eventsClient.ts

+
+    while (hasMoreSignatures) {
+      const signatures: GetSignaturesForAddressApiResponse = await this.rpc
+        .getSignaturesForAddress(this.svmSpokeAddress, currentOptions)


Is a signature any transaction sent to the svmSpokeAddress?

nicholaspai · 2025-02-28T16:15:03Z

src/svm/eventsClient.ts

+    options: GetSignaturesForAddressConfig = { limit: 1000, commitment: "confirmed" }
+  ): Promise<EventWithData<T>[]> {
+    const events = await this.queryAllEvents(fromSlot, toSlot, options);
+    return events.filter((event) => event.name === eventName) as EventWithData<T>[];


So there's no way to query the rpc for just the eventName? You always need to query all events and then filter from there?

Seems expensive but if we're smart about setting from/toSlot we can cache the results

nicholaspai

i just left some questions for my own knowledge

md0x added 5 commits February 24, 2025 11:37

feat(svm): add solana event fetching utils

b02c143

Signed-off-by: Pablo Maldonado <[email protected]>

fix: lint

600fcab

Signed-off-by: Pablo Maldonado <[email protected]>

fix: lint 2

0e1dde4

Signed-off-by: Pablo Maldonado <[email protected]>

feat: event mapping

c553a9f

Signed-off-by: Pablo Maldonado <[email protected]>

feat(svm): svm spoke events client

0ff8eb7

Signed-off-by: Pablo Maldonado <[email protected]>

feat: bump version

bcf1fdb

Signed-off-by: Pablo Maldonado <[email protected]>

md0x commented Feb 25, 2025

View reviewed changes

md0x added 3 commits February 25, 2025 19:00

fix: lint

9964733

Signed-off-by: Pablo Maldonado <[email protected]>

feat: add missing event and private function

b23a150

Signed-off-by: Pablo Maldonado <[email protected]>

fix: lint

80d9af5

Signed-off-by: Pablo Maldonado <[email protected]>

md0x commented Feb 25, 2025

View reviewed changes

md0x added 2 commits February 25, 2025 19:37

fix: lint types

405c4e9

Signed-off-by: Pablo Maldonado <[email protected]>

feat: use codama client types

9bcad79

Signed-off-by: Pablo Maldonado <[email protected]>

md0x marked this pull request as ready for review February 25, 2025 19:04

md0x requested review from Reinis-FRP, nicholaspai, mrice32, pxrl and james-a-morris February 25, 2025 19:04

md0x added 3 commits February 26, 2025 12:50

feat: simplify types

b07b9b4

Signed-off-by: Pablo Maldonado <[email protected]>

Merge branch 'master' into pablo/acx-3769-svm-event-query-functions-sdk

3605de1

feat: bump contracts

885b792

Signed-off-by: Pablo Maldonado <[email protected]>

Reinis-FRP reviewed Feb 28, 2025

View reviewed changes

md0x added 4 commits February 28, 2025 16:40

fix: fixes

cf3ba96

Signed-off-by: Pablo Maldonado <[email protected]>

feat: optimise

716ad49

Signed-off-by: Pablo Maldonado <[email protected]>

feat: remove unnecessary async

93ceb30

Signed-off-by: Pablo Maldonado <[email protected]>

feat: infer return type

82e8d17

Signed-off-by: Pablo Maldonado <[email protected]>

md0x requested a review from Reinis-FRP February 28, 2025 16:11

nicholaspai reviewed Feb 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(svm): svm spoke events client #899

feat(svm): svm spoke events client #899

md0x commented Feb 25, 2025 •

edited

Loading

linear bot commented Feb 25, 2025

md0x Feb 25, 2025

md0x Feb 25, 2025

md0x Feb 25, 2025 •

edited

Loading

Reinis-FRP Feb 28, 2025

md0x Feb 25, 2025

Reinis-FRP Feb 28, 2025

md0x Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

Reinis-FRP Feb 28, 2025

nicholaspai Feb 28, 2025

nicholaspai Feb 28, 2025

nicholaspai left a comment

		programId == ixProgramId &&
		eventAuthorities.get(ixProgramId.toString()) == singleIxAccount

		options: GetSignaturesForAddressConfig = { limit: 1000 },
		finality: Commitment = "confirmed"

feat(svm): svm spoke events client #899

Are you sure you want to change the base?

feat(svm): svm spoke events client #899

Conversation

md0x commented Feb 25, 2025 • edited Loading

linear bot commented Feb 25, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

md0x Feb 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicholaspai left a comment

Choose a reason for hiding this comment

md0x commented Feb 25, 2025 •

edited

Loading

md0x Feb 25, 2025 •

edited

Loading