PublicOrWallet client abstraction on sdk calls

gelatodigital · Apr 4, 2024 · b7c796f · b7c796f
1 parent f87fd2a
commit b7c796f
Show file tree

Hide file tree

Showing 12 changed files with 63 additions and 55 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,3 @@
-import { WalletClient } from "viem";
-
 import * as library from "./lib";
 import { CallWithSyncFeeRequest } from "./lib/callWithSyncFee/types";
 import { SponsoredCallRequest } from "./lib/sponsoredCall/types";
@@ -18,6 +16,7 @@ import {
   Config,
   RelayRequestOptions,
   RelayResponse,
+  PublicOrWalletClient,
 } from "./lib/types";
 import {
   GELATO_RELAY_1BALANCE_ERC2771_ADDRESS,
@@ -135,7 +134,7 @@ export class GelatoRelay {
     request:
       | CallWithSyncFeeERC2771Request
       | CallWithSyncFeeConcurrentERC2771Request,
-    client: WalletClient,
+    client: PublicOrWalletClient,
     options?: RelayRequestOptions,
     sponsorApiKey?: string
   ): Promise<RelayResponse> => {
@@ -190,7 +189,7 @@ export class GelatoRelay {
    */
   sponsoredCallERC2771 = async (
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request,
-    client: WalletClient,
+    client: PublicOrWalletClient,
     sponsorApiKey: string,
     options?: RelayRequestOptions
   ): Promise<RelayResponse> => {
@@ -220,7 +219,7 @@ export class GelatoRelay {
    */
   getSignatureDataERC2771 = (
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request,
-    client: WalletClient,
+    client: PublicOrWalletClient,
     type: ERC2771Type
   ): Promise<SignatureData> =>
     library.getSignatureDataERC2771({ request, client, type }, this.#config);
@@ -235,7 +234,7 @@ export class GelatoRelay {
   getDataToSignERC2771 = (
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request,
     type: ERC2771Type,
-    client?: WalletClient
+    client?: PublicOrWalletClient
   ): Promise<PayloadToSign> =>
     library.getDataToSignERC2771({ request, client, type }, this.#config);
 

diff --git a/src/lib/erc2771/callWithSyncFeeERC2771/index.ts b/src/lib/erc2771/callWithSyncFeeERC2771/index.ts
@@ -1,5 +1,3 @@
-import { WalletClient } from "viem";
-
 import { post } from "../../../utils";
 import {
   ApiKey,
@@ -10,6 +8,7 @@ import {
   RelayCall,
   RelayRequestOptions,
   RelayResponse,
+  PublicOrWalletClient,
 } from "../../types";
 import {
   CallWithConcurrentERC2771Struct,
@@ -27,7 +26,7 @@ export const relayWithCallWithSyncFeeERC2771 = async (
     request:
       | CallWithSyncFeeERC2771Request
       | CallWithSyncFeeConcurrentERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     sponsorApiKey?: string;
     options?: RelayRequestOptions;
   },

diff --git a/src/lib/erc2771/getDataToSignERC2771/index.ts b/src/lib/erc2771/getDataToSignERC2771/index.ts
@@ -1,8 +1,6 @@
-import { WalletClient } from "viem";
-
 import { isConcurrentRequest } from "../../../utils";
 import { isNetworkSupported } from "../../network";
-import { Config } from "../../types";
+import { Config, PublicOrWalletClient } from "../../types";
 import {
   CallWithERC2771Request,
   ERC2771Type,
@@ -17,7 +15,7 @@ export async function getDataToSignERC2771(
   payload: {
     request: CallWithERC2771Request;
     type: ERC2771Type.CallWithSyncFee | ERC2771Type.SponsoredCall;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<SequentialPayloadToSign>;
@@ -28,7 +26,7 @@ export async function getDataToSignERC2771(
     type:
       | ERC2771Type.ConcurrentCallWithSyncFee
       | ERC2771Type.ConcurrentSponsoredCall;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<ConcurrentPayloadToSign>;
@@ -37,7 +35,7 @@ export async function getDataToSignERC2771(
   payload: {
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request;
     type: ERC2771Type;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<PayloadToSign>;
@@ -46,7 +44,7 @@ export async function getDataToSignERC2771(
   payload: {
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request;
     type: ERC2771Type;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<PayloadToSign> {

diff --git a/src/lib/erc2771/getSignatureDataERC2771/index.ts b/src/lib/erc2771/getSignatureDataERC2771/index.ts
@@ -1,7 +1,5 @@
-import { WalletClient } from "viem";
-
 import { isConcurrentRequest, signTypedDataV4 } from "../../../utils";
-import { Config } from "../../types";
+import { Config, PublicOrWalletClient } from "../../types";
 import {
   SignatureData,
   CallWithERC2771Request,
@@ -15,7 +13,7 @@ import { getDataToSignERC2771 } from "../getDataToSignERC2771/index.js";
 export async function getSignatureDataERC2771(
   payload: {
     request: CallWithERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     type: ERC2771Type.CallWithSyncFee | ERC2771Type.SponsoredCall;
   },
   config: Config
@@ -24,7 +22,7 @@ export async function getSignatureDataERC2771(
 export async function getSignatureDataERC2771(
   payload: {
     request: CallWithConcurrentERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     type:
       | ERC2771Type.ConcurrentCallWithSyncFee
       | ERC2771Type.ConcurrentSponsoredCall;
@@ -35,7 +33,7 @@ export async function getSignatureDataERC2771(
 export async function getSignatureDataERC2771(
   payload: {
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     type: ERC2771Type;
   },
   config: Config
@@ -44,7 +42,7 @@ export async function getSignatureDataERC2771(
 export async function getSignatureDataERC2771(
   payload: {
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     type: ERC2771Type;
   },
   config: Config

diff --git a/src/lib/erc2771/sponsoredCallERC2771/index.ts b/src/lib/erc2771/sponsoredCallERC2771/index.ts
@@ -1,5 +1,3 @@
-import { WalletClient } from "viem";
-
 import { isConcurrentRequest, post } from "../../../utils";
 import {
   ApiKey,
@@ -8,6 +6,7 @@ import {
   RelayCall,
   RelayRequestOptions,
   RelayResponse,
+  PublicOrWalletClient,
 } from "../../types";
 import {
   CallWithConcurrentERC2771Request,
@@ -23,7 +22,7 @@ import { safeTransformStruct } from "../utils/safeTransformStruct.js";
 export const relayWithSponsoredCallERC2771 = async (
   payload: {
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     sponsorApiKey: string;
     options?: RelayRequestOptions;
   },
@@ -35,7 +34,7 @@ export const relayWithSponsoredCallERC2771 = async (
 const sponsoredCallERC2771 = async (
   payload: {
     request: CallWithERC2771Request | CallWithConcurrentERC2771Request;
-    client: WalletClient;
+    client: PublicOrWalletClient;
     sponsorApiKey: string;
     options?: RelayRequestOptions;
   },

diff --git a/src/lib/erc2771/utils/populatePayloadToSign.ts b/src/lib/erc2771/utils/populatePayloadToSign.ts
@@ -1,5 +1,3 @@
-import { WalletClient } from "viem";
-
 import {
   CallWithConcurrentERC2771Request,
   CallWithERC2771Request,
@@ -8,10 +6,10 @@ import {
   PayloadToSign,
   SequentialPayloadToSign,
 } from "../types";
-import { Config } from "../../types";
+import { Config, PublicOrWalletClient } from "../../types";
 import {
   isConcurrentRequest,
-  isLocalSigner,
+  isWalletClient,
   populateOptionalUserParameters,
 } from "../../../utils";
 
@@ -25,7 +23,7 @@ export async function populatePayloadToSign(
     type:
       | ERC2771Type.ConcurrentCallWithSyncFee
       | ERC2771Type.ConcurrentSponsoredCall;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<ConcurrentPayloadToSign>;
@@ -34,7 +32,7 @@ export async function populatePayloadToSign(
   payload: {
     request: CallWithERC2771Request;
     type: ERC2771Type.CallWithSyncFee | ERC2771Type.SponsoredCall;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<SequentialPayloadToSign>;
@@ -43,7 +41,7 @@ export async function populatePayloadToSign(
   payload: {
     request: CallWithConcurrentERC2771Request | CallWithERC2771Request;
     type: ERC2771Type;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
   config: Config
 ): Promise<PayloadToSign> {
@@ -69,7 +67,7 @@ export async function populatePayloadToSign(
       {
         struct: safeStruct,
         type,
-        isSigner: client ? isLocalSigner(client) : undefined,
+        isSigner: client ? isWalletClient(client) : undefined,
       },
       config
     );
@@ -99,7 +97,7 @@ export async function populatePayloadToSign(
       {
         struct: safeStruct,
         type,
-        isSigner: client ? isLocalSigner(client) : undefined,
+        isSigner: client ? isWalletClient(client) : undefined,
       },
       config
     );

diff --git a/src/lib/types/index.ts b/src/lib/types/index.ts
@@ -1,4 +1,4 @@
-import { Hex, ByteArray } from "viem";
+import { Hex, ByteArray, WalletClient, PublicClient } from "viem";
 
 export enum RelayCall {
   CallWithSyncFee,
@@ -77,3 +77,5 @@ export type SafeRequestPayload<T> = {
     ? SafeRequestPayload<T[K]>
     : T[K];
 };
+
+export type PublicOrWalletClient = PublicClient | WalletClient;
diff --git a/src/utils/getPublicClient.ts b/src/utils/getPublicClient.ts
@@ -0,0 +1,15 @@
+import { PublicClient, publicActions } from "viem";
+
+import { PublicOrWalletClient } from "../lib/types";
+
+export const getPublicClient = (client: PublicOrWalletClient): PublicClient => {
+  let publicClient: PublicClient;
+  if (client.type === "walletClient") {
+    publicClient = client.extend(publicActions) as PublicClient;
+  } else {
+    // publicClient
+    publicClient = client as PublicClient;
+  }
+
+  return publicClient;
+};
diff --git a/src/utils/getUserNonce.ts b/src/utils/getUserNonce.ts
@@ -1,24 +1,25 @@
-import { WalletClient, publicActions, parseAbi } from "viem";
+import { parseAbi } from "viem";
 
 import { USER_NONCE_ABI } from "../constants";
-import { Config } from "../lib/types";
+import { Config, PublicOrWalletClient } from "../lib/types";
 import { ERC2771Type } from "../lib/erc2771/types";
 
 import { getGelatoRelayERC2771Address } from "./relayAddress";
+import { getPublicClient } from "./getPublicClient";
 
 export const getUserNonce = async (
   payload: {
     account: string;
     type: ERC2771Type;
-    client: WalletClient;
+    client: PublicOrWalletClient;
   },
   config: Config
 ): Promise<bigint> => {
   const { account, type, client } = payload;
 
   const chainId = BigInt(await client.getChainId());
 
-  const publicClient = client.extend(publicActions);
+  const publicClient = getPublicClient(client);
 
   const nonce = await publicClient.readContract({
     abi: parseAbi(USER_NONCE_ABI),

diff --git a/src/utils/isSigner.ts b/src/utils/isSigner.ts
@@ -1,5 +1,5 @@
-import { WalletClient } from "viem";
+import { PublicOrWalletClient } from "../lib/types";
 
-export const isLocalSigner = (client: WalletClient): boolean => {
-  return client?.account?.type === "local";
+export const isWalletClient = (client: PublicOrWalletClient): boolean => {
+  return client.type === "walletClient";
 };
diff --git a/src/utils/populateOptionalUserParameters.ts b/src/utils/populateOptionalUserParameters.ts
@@ -1,5 +1,3 @@
-import { WalletClient } from "viem";
-
 import { DEFAULT_DEADLINE_GAP } from "../constants";
 import {
   CallWithConcurrentERC2771Request,
@@ -8,7 +6,7 @@ import {
   CallWithERC2771RequestOptionalParameters,
   ERC2771Type,
 } from "../lib/erc2771/types";
-import { Config } from "../lib/types";
+import { Config, PublicOrWalletClient } from "../lib/types";
 
 import { calculateDeadline } from "./calculateDeadline";
 import { getUserNonce } from "./getUserNonce";
@@ -21,7 +19,7 @@ export async function populateOptionalUserParameters(
     type:
       | ERC2771Type.ConcurrentCallWithSyncFee
       | ERC2771Type.ConcurrentSponsoredCall;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
 
   config: Config
@@ -31,7 +29,7 @@ export async function populateOptionalUserParameters(
   payload: {
     request: CallWithERC2771Request;
     type: ERC2771Type.CallWithSyncFee | ERC2771Type.SponsoredCall;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
 
   config: Config
@@ -41,7 +39,7 @@ export async function populateOptionalUserParameters(
   payload: {
     request: CallWithConcurrentERC2771Request | CallWithERC2771Request;
     type: ERC2771Type;
-    client?: WalletClient;
+    client?: PublicOrWalletClient;
   },
 
   config: Config

diff --git a/src/utils/signTypedDataV4.ts b/src/utils/signTypedDataV4.ts
@@ -1,23 +1,24 @@
-import { WalletClient } from "viem";
-
+import { PublicOrWalletClient } from "../lib/types";
 import {
   CallWithSyncFeeERC2771PayloadToSign,
   SponsoredCallERC2771PayloadToSign,
   SponsoredCallConcurrentERC2771PayloadToSign,
   CallWithSyncFeeConcurrentERC2771PayloadToSign,
 } from "../lib/erc2771/types";
 
+import { isWalletClient } from "./isSigner";
+
 export const signTypedDataV4 = async (
-  client: WalletClient,
+  client: PublicOrWalletClient,
   payload:
     | SponsoredCallERC2771PayloadToSign
     | CallWithSyncFeeERC2771PayloadToSign
     | SponsoredCallConcurrentERC2771PayloadToSign
     | CallWithSyncFeeConcurrentERC2771PayloadToSign
 ): Promise<string> => {
-  if (!client.account) {
+  if (!isWalletClient(client) || !client.account) {
     throw new Error(
-      "Account not found on client. Please, provide an account during the client creation."
+      "The provided client is not a wallet client, or account not found on the client. Please, provide an account during the client creation."
     );
   }