refactor(svm): restructure utils into modular files under src folder #793

md0x · 2024-12-05T18:41:20Z

Changes proposed in this PR:

Relocate SVM utility functions to the src folder and reorganize them into separate files for improved maintainability and clarity.

…for better organization Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

linear · 2024-12-05T18:41:23Z

ACX-3476 Move all utils that should be in `src/` from the `/test` directory

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

…be-in-src-from-the-test-directory

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

Reinis-FRP · 2024-12-06T15:20:42Z

scripts/svm/queryFills.ts

+        { Property: "relayer", Value: new PublicKey(event.data.relayer).toString() },
+        { Property: "depositor", Value: new PublicKey(event.data.depositor).toString() },
+        { Property: "recipient", Value: new PublicKey(event.data.recipient).toString() },
+        { Property: "message", Value: event.data.message.toString() },


fill events don't have full message anymore. instead its messageHash

ye, this will be broken now if used. I think it could be due to a merge issue you had.

Reinis-FRP · 2024-12-06T15:21:13Z

scripts/svm/queryFills.ts

+          Property: "updatedRecipient",
+          Value: new PublicKey(event.data.relayExecutionInfo.updatedRecipient).toString(),
+        },
+        { Property: "updatedMessage", Value: event.data.relayExecutionInfo.updatedMessage.toString() },


updatedMessageHash

This was a mistake when merging/solving conflicts. Fixed now.

Reinis-FRP · 2024-12-06T15:23:13Z

scripts/svm/simpleFill.ts

@@ -36,7 +35,7 @@ const argv = yargs(hideBin(process.argv))
  .option("inputAmount", { type: "number", demandOption: true, describe: "Input amount" })
  .option("outputAmount", { type: "number", demandOption: true, describe: "Output amount" })
  .option("originChainId", { type: "string", demandOption: true, describe: "Origin chain ID" })
-  .option("depositId", { type: "string", demandOption: true, describe: "Deposit ID" })
+  .option("depositId", { type: "array", demandOption: true, describe: "Deposit ID" })


its too cumbersome to pass array in command line (need to repeat --depositId param for each byte. Better use string and parse it as hex (if it starts with 0x) or number

This was a mistake when merging/solving conflicts. Fixed now.

Reinis-FRP · 2024-12-06T15:27:31Z

scripts/svm/simpleFill.ts

@@ -50,7 +49,7 @@ async function fillV3Relay(): Promise<void> {
  const inputAmount = new BN(resolvedArgv.inputAmount);
  const outputAmount = new BN(resolvedArgv.outputAmount);
  const originChainId = new BN(resolvedArgv.originChainId);
-  const depositId = intToU8Array32(new BN(resolvedArgv.depositId));
+  const depositId = resolvedArgv.depositId;


why change this

Same :) This was a mistake when merging/solving conflicts. Fixed now.

Reinis-FRP · 2024-12-06T15:28:09Z

scripts/svm/queryFills.ts

    console.log("Fill events fetched successfully:");
    fillEvents.forEach((event, index) => {
      console.log(`Fill Event ${index + 1}:`);
      console.table([
-        { Property: "inputToken", Value: strPublicKey(event.data.inputToken) },
-        { Property: "outputToken", Value: strPublicKey(event.data.outputToken) },
+        { Property: "inputToken", Value: new PublicKey(event.data.inputToken).toString() },


why drop strPublicKey helper, we introduced this recently

Reinis-FRP · 2024-12-06T15:29:00Z

scripts/svm/simpleFill.ts

@@ -65,7 +64,7 @@ async function fillV3Relay(): Promise<void> {
    inputAmount,
    outputAmount,
    originChainId,
-    depositId,
+    depositId: depositId.map((id) => Number(id)),


this might be based on old version. we had it fixed recently

Reinis-FRP · 2024-12-06T15:29:13Z

scripts/svm/simpleFill.ts

@@ -155,7 +154,7 @@ async function fillV3Relay(): Promise<void> {
      state: statePda,
      signer: signer.publicKey,
      instructionParams: program.programId,
-      mint: outputToken,
+      mintAccount: outputToken,


should be mint

same comment as before, likely due to a merge issue.

Reinis-FRP · 2024-12-06T15:32:11Z

src/svm/conversionUtils.ts

+/**
+ * Converts an integer to a 32-byte Uint8Array.
+ */
+export function intToU8Array32(num: number): number[] {


we had this fn also handle BigInt numbers

Reinis-FRP · 2024-12-06T15:34:25Z

src/svm/relayHashUtils.ts

+/**
+ * Converts an EVM address to a Solana PublicKey.
+ */
+export const evmAddressToPublicKey = (address: string): PublicKey => {


this more belongs to conversionUtils

Reinis-FRP · 2024-12-06T15:34:32Z

src/svm/relayHashUtils.ts

+/**
+ * Converts a Solana PublicKey to an EVM address.
+ */
+export const publicKeyToEvmAddress = (publicKey: PublicKey | string): string => {


this more belongs to conversionUtils

chrismaree · 2024-12-06T15:54:09Z

src/svm/coders.ts

+    },
+  };
+
+  private static coderTypes: IdlTypeDef[] = [


this can all be linted a lot better. might be ok to ignore though and we can run a seperate linting task to collaps JS objects after the fact.

I've created a subtask to address this in the next PR. Thanks @chrismaree

chrismaree · 2024-12-06T15:55:03Z

src/svm/index.ts

@@ -0,0 +1,6 @@
+export * from "./relayHashUtils";


this is a great refactor.

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

…be-in-src-from-the-test-directory

Reinis-FRP

looking great!

refactor(svm): restructure utils into modular files under src folder …

7468827

…for better organization Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

md0x added 5 commits December 6, 2024 09:46

fix: imports

3ba41b1

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

Merge branch 'master' into pablo/acx-3476-move-all-utils-that-should-…

d70639d

…be-in-src-from-the-test-directory

fix: anchor

2889494

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

refactor: comments

3c8b690

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

fix: test

a5fb1de

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

md0x marked this pull request as ready for review December 6, 2024 14:28

md0x requested review from Reinis-FRP and chrismaree December 6, 2024 14:28

refactor: comments

431a657

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

Reinis-FRP reviewed Dec 6, 2024

View reviewed changes

md0x marked this pull request as draft December 6, 2024 15:32

Reinis-FRP reviewed Dec 6, 2024

View reviewed changes

chrismaree reviewed Dec 6, 2024

View reviewed changes

src/svm/index.ts

@@ -0,0 +1,6 @@

export * from "./relayHashUtils";

Copy link

Member

chrismaree Dec 6, 2024

Choose a reason for hiding this comment

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

this is a great refactor.

md0x reacted with heart emoji

fixes

4a74498

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

md0x marked this pull request as ready for review December 16, 2024 09:21

Merge branch 'master' into pablo/acx-3476-move-all-utils-that-should-…

fa3186d

…be-in-src-from-the-test-directory

md0x requested review from chrismaree and Reinis-FRP December 16, 2024 10:42

Reinis-FRP approved these changes Dec 16, 2024

View reviewed changes

md0x merged commit 42402b9 into master Dec 16, 2024
9 checks passed

md0x deleted the pablo/acx-3476-move-all-utils-that-should-be-in-src-from-the-test-directory branch December 16, 2024 12:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(svm): restructure utils into modular files under src folder #793

refactor(svm): restructure utils into modular files under src folder #793

md0x commented Dec 5, 2024 •

edited

Loading

linear bot commented Dec 5, 2024

Reinis-FRP Dec 6, 2024

chrismaree Dec 6, 2024

Reinis-FRP Dec 6, 2024

md0x Dec 16, 2024

Reinis-FRP Dec 6, 2024

md0x Dec 16, 2024

Reinis-FRP Dec 6, 2024

md0x Dec 16, 2024

Reinis-FRP Dec 6, 2024

md0x Dec 16, 2024

Reinis-FRP Dec 6, 2024

Reinis-FRP Dec 6, 2024

chrismaree Dec 6, 2024

Reinis-FRP Dec 6, 2024

Reinis-FRP Dec 6, 2024

Reinis-FRP Dec 6, 2024

chrismaree Dec 6, 2024

md0x Dec 16, 2024

chrismaree Dec 6, 2024

Reinis-FRP left a comment

refactor(svm): restructure utils into modular files under src folder #793

refactor(svm): restructure utils into modular files under src folder #793

Conversation

md0x commented Dec 5, 2024 • edited Loading

linear bot commented Dec 5, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Reinis-FRP left a comment

Choose a reason for hiding this comment

md0x commented Dec 5, 2024 •

edited

Loading