🧹 Solana: Move common signer functionality into devtools (#724)

.changeset/fuzzy-fans-give.md

@@ -0,0 +1,6 @@
+---
+"@layerzerolabs/devtools-evm": patch
+"@layerzerolabs/devtools": patch
+---
+
+Move common signer functionality into devtools

packages/devtools-evm/src/signer/sdk.ts

@@ -5,8 +5,7 @@ import SafeApiKit from '@safe-global/api-kit'
 import { MetaTransactionData, OperationType, SafeTransaction } from '@safe-global/safe-core-sdk-types'
 import type { EndpointId } from '@layerzerolabs/lz-definitions'
 import {
-    formatEid,
-    formatOmniPoint,
+    OmniSignerBase,
     type OmniTransactionResponse,
     type OmniSigner,
     type OmniTransaction,
@@ -15,23 +14,13 @@ import assert from 'assert'
 
 import { ethers } from 'ethers'
 
-export abstract class OmniSignerEVMBase implements OmniSigner {
+export abstract class OmniSignerEVMBase extends OmniSignerBase implements OmniSigner {
     protected constructor(
-        public readonly eid: EndpointId,
+        eid: EndpointId,
         public readonly signer: Signer
-    ) {}
-
-    protected assertTransaction(transaction: OmniTransaction) {
-        assert(
-            transaction.point.eid === this.eid,
-            `Could not use signer for ${formatEid(this.eid)} to sign a transaction for ${formatOmniPoint(
-                transaction.point
-            )}`
-        )
+    ) {
+        super(eid)
     }
-
-    abstract sign(transaction: OmniTransaction): Promise<string>
-    abstract signAndSend(transaction: OmniTransaction): Promise<OmniTransactionResponse>
 }
 
 /**

packages/devtools/src/transactions/signer.ts

@@ -3,13 +3,40 @@ import type {
     OmniSigner,
     OmniSignerFactory,
     OmniTransaction,
+    OmniTransactionResponse,
     OmniTransactionWithError,
     OmniTransactionWithReceipt,
     OmniTransactionWithResponse,
 } from './types'
 import { formatEid, formatOmniPoint } from '@/omnigraph/format'
 import { groupTransactionsByEid } from './utils'
 import { EndpointId } from '@layerzerolabs/lz-definitions'
+import assert from 'assert'
+
+/**
+ * Base class for all signers containing common functionality
+ */
+export abstract class OmniSignerBase implements OmniSigner {
+    protected constructor(public readonly eid: EndpointId) {}
+
+    abstract sign(transaction: OmniTransaction): Promise<string>
+
+    abstract signAndSend(transaction: OmniTransaction): Promise<OmniTransactionResponse>
+
+    /**
+     * helper method to ensure that the transaction we are trying to sign is on a correct network
+     *
+     * @param {OmniTransaction} transaction
+     */
+    protected assertTransaction(transaction: OmniTransaction) {
+        assert(
+            transaction.point.eid === this.eid,
+            `Could not use signer for ${formatEid(this.eid)} to sign a transaction for ${formatOmniPoint(
+                transaction.point
+            )}`
+        )
+    }
+}
 
 export type SignAndSendResult = [
     // All the successful transactions

packages/devtools/src/transactions/types.ts

@@ -1,5 +1,6 @@
 import { OmniPoint } from '@/omnigraph/types'
 import { EndpointBasedFactory } from '@/types'
+import { EndpointId } from '@layerzerolabs/lz-definitions'
 
 export interface OmniTransaction {
     point: OmniPoint
@@ -34,6 +35,8 @@ export interface OmniTransactionReceipt {
 }
 
 export interface OmniSigner<TResponse extends OmniTransactionResponse = OmniTransactionResponse> {
+    eid: EndpointId
+
     sign: (transaction: OmniTransaction) => Promise<string>
     signAndSend: (transaction: OmniTransaction) => Promise<TResponse>