Merge pull request #417 from balancer/viem-client-type

Export PublicWalletClient
balancer · Sep 24, 2024 · 0e0f81d · 0e0f81d
2 parents 1d6af52 + 2d5928a
commit 0e0f81d
Show file tree

Hide file tree

Showing 19 changed files with 87 additions and 98 deletions.
diff --git a/.changeset/selfish-baboons-sort.md b/.changeset/selfish-baboons-sort.md
@@ -0,0 +1,5 @@
+---
+"@balancer/sdk": patch
+---
+
+Exposes PublicWalletClient type
diff --git a/src/entities/permit2Helper/index.ts b/src/entities/permit2Helper/index.ts
@@ -5,7 +5,12 @@ import {
     Permit2Batch,
     PermitDetails,
 } from './allowanceTransfer';
-import { BALANCER_BATCH_ROUTER, BALANCER_ROUTER, PERMIT2 } from '@/utils';
+import {
+    BALANCER_BATCH_ROUTER,
+    BALANCER_ROUTER,
+    PERMIT2,
+    PublicWalletClient,
+} from '@/utils';
 import {
     MaxAllowanceExpiration,
     MaxAllowanceTransferAmount,
@@ -33,7 +38,7 @@ export type Permit2 = {
 export class Permit2Helper {
     static async signAddLiquidityApproval(
         input: AddLiquidityBaseBuildCallInput & {
-            client: Client & WalletActions & PublicActions;
+            client: PublicWalletClient;
             owner: Address;
             nonces?: number[];
             expirations?: number[];
@@ -71,7 +76,7 @@ export class Permit2Helper {
 
     static async signSwapApproval(
         input: SwapBuildCallInputBase & {
-            client: Client & WalletActions & PublicActions;
+            client: PublicWalletClient;
             owner: Address;
             nonce?: number;
             expiration?: number;

diff --git a/src/entities/permitHelper/helper.ts b/src/entities/permitHelper/helper.ts
@@ -1,9 +1,8 @@
-import { Client, PublicActions, WalletActions } from 'viem';
-
 import { Address } from '@/types';
+import { PublicWalletClient } from '@/utils';
 
 export const getNonce = async (
-    client: Client & WalletActions & PublicActions,
+    client: PublicWalletClient,
     token: Address,
     owner: Address,
 ) => {

diff --git a/src/entities/permitHelper/index.ts b/src/entities/permitHelper/index.ts
@@ -1,8 +1,6 @@
-import { Client, PublicActions, WalletActions } from 'viem';
-
 import { weightedPoolAbi_V3 } from '@/abi';
 import { Hex } from '@/types';
-import { BALANCER_ROUTER, MAX_UINT256 } from '@/utils';
+import { BALANCER_ROUTER, MAX_UINT256, PublicWalletClient } from '@/utils';
 import { getNonce } from './helper';
 import { RemoveLiquidityBaseBuildCallInput } from '../removeLiquidity/types';
 import { getAmountsCall } from '../removeLiquidity/helper';
@@ -30,7 +28,7 @@ export type Permit = {
 export class PermitHelper {
     static signRemoveLiquidityApproval = async (
         input: RemoveLiquidityBaseBuildCallInput & {
-            client: Client & WalletActions & PublicActions;
+            client: PublicWalletClient;
             owner: Hex;
             nonce?: bigint;
             deadline?: bigint;
@@ -63,7 +61,7 @@ export class PermitHelper {
  * @param { Client & WalletActions & PublicActions } client - Wallet client to invoke for signing the permit message
  */
 const signPermit = async (
-    client: Client & WalletActions & PublicActions,
+    client: PublicWalletClient,
     token: Hex,
     owner: Hex,
     spender: Hex,
@@ -111,10 +109,7 @@ const signPermit = async (
     return { permitApproval, permitSignature };
 };
 
-const getDomain = async (
-    client: Client & WalletActions & PublicActions,
-    token: Hex,
-) => {
+const getDomain = async (client: PublicWalletClient, token: Hex) => {
     const [, name, version, chainId, verifyingContract, , ,] =
         await client.readContract({
             abi: weightedPoolAbi_V3,

diff --git a/src/entities/relayer/authorization.ts b/src/entities/relayer/authorization.ts
@@ -1,13 +1,5 @@
-import {
-    Client,
-    concat,
-    pad,
-    parseSignature,
-    PublicActions,
-    toHex,
-    WalletActions,
-} from 'viem';
-import { MAX_UINT256, VAULT } from '../../utils';
+import { concat, pad, parseSignature, toHex } from 'viem';
+import { MAX_UINT256, VAULT, PublicWalletClient } from '../../utils';
 import { Address, Hex } from '../../types';
 import { vaultV2Abi } from '../../abi';
 
@@ -47,7 +39,7 @@ export class RelayerAuthorization {
     };
 
     static signJoinAuthorization = (
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
         signerAddress: Address,
         allowedSender: Address,
         allowedCalldata: Hex,
@@ -65,7 +57,7 @@ export class RelayerAuthorization {
         );
 
     static signExitAuthorization = (
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
         signerAddress: Address,
         allowedSender: Address,
         allowedCalldata: Hex,
@@ -83,7 +75,7 @@ export class RelayerAuthorization {
         );
 
     static signSwapAuthorization = (
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
         signerAddress: Address,
         allowedSender: Address,
         allowedCalldata: Hex,
@@ -101,7 +93,7 @@ export class RelayerAuthorization {
         );
 
     static signBatchSwapAuthorization = (
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
         signerAddress: Address,
         allowedSender: Address,
         allowedCalldata: Hex,
@@ -119,7 +111,7 @@ export class RelayerAuthorization {
         );
 
     static signSetRelayerApprovalAuthorization = (
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
         signerAddress: Address,
         allowedSender: Address,
         allowedCalldata: Hex,
@@ -138,7 +130,7 @@ export class RelayerAuthorization {
 
     static signAuthorizationFor = async (
         type: RelayerAction,
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
         signerAddress: Address,
         allowedSender: Address,
         allowedCalldata: Hex,

diff --git a/src/entities/relayer/index.ts b/src/entities/relayer/index.ts
@@ -1,19 +1,16 @@
 import {
-    Client,
     concat,
     encodeFunctionData,
     hexToBigInt,
     pad,
-    PublicActions,
     slice,
     toHex,
-    WalletActions,
 } from 'viem';
 import { Address, Hex } from '../../types';
 import { batchRelayerLibraryAbi } from '../../abi/batchRelayerLibrary';
 import { RelayerAuthorization } from './authorization';
 import { vaultV2Abi } from '../../abi';
-import { MAX_UINT256 } from '../../utils';
+import { MAX_UINT256, PublicWalletClient } from '../../utils';
 
 export class Relayer {
     static CHAINED_REFERENCE_TEMP_PREFIX = '0xba10' as Hex; // Temporary reference: it is deleted after a read.
@@ -57,7 +54,7 @@ export class Relayer {
     static signRelayerApproval = async (
         relayerAddress: Address,
         signerAddress: Address,
-        client: Client & WalletActions & PublicActions,
+        client: PublicWalletClient,
     ): Promise<Hex> => {
         const approval = encodeFunctionData({
             abi: vaultV2Abi,

diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -5,3 +5,4 @@ export * from './math';
 export * from './pool';
 export * from './poolTypeMapper';
 export * from './sortByAddress';
+export * from './types';
diff --git a/src/utils/types.ts b/src/utils/types.ts
@@ -0,0 +1,3 @@
+import { PublicActions, WalletClient } from 'viem';
+
+export type PublicWalletClient = WalletClient & PublicActions;
diff --git a/test/entities/swaps/v2/swapV2.integration.test.ts b/test/entities/swaps/v2/swapV2.integration.test.ts
@@ -8,10 +8,7 @@ import {
     parseEther,
     publicActions,
     walletActions,
-    Client,
-    PublicActions,
     TestActions,
-    WalletActions,
 } from 'viem';
 import {
     CHAINS,
@@ -23,6 +20,7 @@ import {
     ExactOutQueryOutput,
     VAULT,
     Path,
+    PublicWalletClient,
 } from '@/index';
 
 import { ANVIL_NETWORKS, startFork } from 'test/anvil/anvil-global-setup';
@@ -44,7 +42,7 @@ const WETH = TOKENS[chainId].WETH;
 const vault = VAULT[chainId];
 
 describe('SwapV2', () => {
-    let client: Client & PublicActions & TestActions & WalletActions;
+    let client: PublicWalletClient & TestActions;
     let testAddress: Address;
     const pathBalWeth: Path = {
         protocolVersion: 2,

diff --git a/test/entities/swaps/v3/swapV3.integration.test.ts b/test/entities/swaps/v3/swapV3.integration.test.ts
@@ -8,10 +8,7 @@ import {
     parseEther,
     publicActions,
     walletActions,
-    Client,
-    PublicActions,
     TestActions,
-    WalletActions,
     Hex,
 } from 'viem';
 import {
@@ -25,6 +22,7 @@ import {
     BALANCER_ROUTER,
     BALANCER_BATCH_ROUTER,
     PERMIT2,
+    PublicWalletClient,
 } from '@/index';
 import { Path } from '@/entities/swap/paths/types';
 
@@ -54,7 +52,7 @@ const stataUSDC = TOKENS[chainId].stataUSDC;
 const stataDAI = TOKENS[chainId].stataDAI;
 
 describe('SwapV3', () => {
-    let client: Client & PublicActions & TestActions & WalletActions;
+    let client: PublicWalletClient & TestActions;
     let testAddress: Address;
     let rpcUrl: string;
     let snapshot: Hex;

diff --git a/test/lib/utils/helper.ts b/test/lib/utils/helper.ts
@@ -5,7 +5,6 @@ import {
     PublicActions,
     TestActions,
     TransactionReceipt,
-    WalletActions,
     concat,
     encodeAbiParameters,
     hexToBigInt,
@@ -26,6 +25,7 @@ import {
     PERMIT2,
     BALANCER_ROUTER,
     BALANCER_BATCH_ROUTER,
+    PublicWalletClient,
 } from '@/utils';
 
 export type TxOutput = {
@@ -35,7 +35,7 @@ export type TxOutput = {
 };
 
 export const hasApprovedToken = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     account: Address,
     token: Address,
     spender: Address,
@@ -53,7 +53,7 @@ export const hasApprovedToken = async (
 };
 
 export const hasApprovedTokenOnPermit2 = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     account: Address,
     token: Address,
     spender: Address,
@@ -72,7 +72,7 @@ export const hasApprovedTokenOnPermit2 = async (
 };
 
 export const approveToken = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     accountAddress: Address,
     tokenAddress: Address,
     protocolVersion: 2 | 3,
@@ -127,7 +127,7 @@ export const approveToken = async (
 };
 
 export const approveTokens = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     accountAddress: Address,
     tokens: Address[],
     protocolVersion: 2 | 3,
@@ -146,7 +146,7 @@ export const approveTokens = async (
 };
 
 export const approveSpenderOnTokens = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     accountAddress: Address,
     tokens: Address[],
     spender: Address,
@@ -167,7 +167,7 @@ export const approveSpenderOnTokens = async (
 };
 
 export const approveSpenderOnToken = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     account: Address,
     token: Address,
     spender: Address,
@@ -205,7 +205,7 @@ export const approveSpenderOnToken = async (
 };
 
 export const approveSpenderOnPermit2 = async (
-    client: Client & PublicActions & WalletActions,
+    client: PublicWalletClient,
     account: Address,
     token: Address,
     spender: Address,
@@ -287,7 +287,7 @@ export const getBalances = async (
  */
 export async function sendTransactionGetBalances(
     tokensForBalanceCheck: Address[],
-    client: Client & PublicActions & TestActions & WalletActions,
+    client: PublicWalletClient & TestActions,
     clientAddress: Address,
     to: Address,
     data: Address,
@@ -488,7 +488,7 @@ export async function findTokenBalanceSlot(
  * @param protocolVersion Balancer vault version
  */
 export const forkSetup = async (
-    client: Client & PublicActions & TestActions & WalletActions,
+    client: PublicWalletClient & TestActions,
     accountAddress: Address,
     tokens: Address[],
     slots: number[] | undefined,
@@ -530,7 +530,7 @@ export const forkSetup = async (
  * @param isVyperMapping Whether the storage uses Vyper or Solidity mapping
  */
 export const forkSetupCowAmm = async (
-    client: Client & PublicActions & TestActions & WalletActions,
+    client: PublicWalletClient & TestActions,
     accountAddress: Address,
     tokens: Address[],
     slots: number[] | undefined,
@@ -564,7 +564,7 @@ export const forkSetupCowAmm = async (
 export const getSlots = async (
     slots: number[] | undefined,
     tokens: Address[],
-    client: Client & PublicActions & TestActions & WalletActions,
+    client: PublicWalletClient & TestActions,
     accountAddress: Address,
     isVyperMapping: boolean[],
 ): Promise<number[]> => {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { PublicActions, WalletClient } from 'viem';

		export type PublicWalletClient = WalletClient & PublicActions;