ZkSync formatters

.changeset/tiny-dolls-look.md

@@ -0,0 +1,5 @@
+---
+"viem": minor
+---
+
+Added ZkSync formatters.

src/actions/public/call.ts

@@ -151,12 +151,12 @@ export async function call<TChain extends Chain | undefined>(
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined
     const block = blockNumberHex || blockTag
 
-    const format =
-      client.chain?.formatters?.transactionRequest?.format ||
-      formatTransactionRequest
+    const chainFormat = client.chain?.formatters?.transactionRequest?.format
+    const format = chainFormat || formatTransactionRequest
+
     const request = format({
       // Pick out extra data that might exist on the chain's transaction request type.
-      ...extract(rest, { format }),
+      ...extract(rest, { format: chainFormat }),
       from: account?.address,
       accessList,
       data,

src/actions/public/estimateGas.ts

@@ -136,12 +136,12 @@ export async function estimateGas<
 
     assertRequest(args as AssertRequestParameters)
 
-    const format =
-      client.chain?.formatters?.transactionRequest?.format ||
-      formatTransactionRequest
+    const chainFormat = client.chain?.formatters?.transactionRequest?.format
+    const format = chainFormat || formatTransactionRequest
+
     const request = format({
       // Pick out extra data that might exist on the chain's transaction request type.
-      ...extract(rest, { format }),
+      ...extract(rest, { format: chainFormat }),
       from: account.address,
       accessList,
       data,

src/actions/public/simulateContract.ts

@@ -120,7 +120,7 @@ export async function simulateContract<
   TChain extends Chain | undefined,
   const TAbi extends Abi | readonly unknown[],
   TFunctionName extends string,
-  TChainOverride extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, TChain>,
   {

src/actions/test/sendUnsignedTransaction.ts

@@ -69,12 +69,12 @@ export async function sendUnsignedTransaction<
     ...rest
   } = args
 
-  const format =
-    client.chain?.formatters?.transactionRequest?.format ||
-    formatTransactionRequest
+  const chainFormat = client.chain?.formatters?.transactionRequest?.format
+  const format = chainFormat || formatTransactionRequest
+
   const request = format({
     // Pick out extra data that might exist on the chain's transaction request type.
-    ...extract(rest, { format }),
+    ...extract(rest, { format: chainFormat }),
     accessList,
     data,
     from,

src/actions/wallet/deployContract.ts

@@ -67,7 +67,7 @@ export function deployContract<
   const TAbi extends Abi | readonly unknown[],
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
 >(
   walletClient: Client<Transport, TChain, TAccount>,
   {

src/actions/wallet/prepareTransactionRequest.ts

@@ -119,7 +119,7 @@ export type PrepareTransactionRequestErrorType =
 export async function prepareTransactionRequest<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, TChain, TAccount>,
   args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>,

src/actions/wallet/sendTransaction.ts

@@ -124,7 +124,7 @@ export type SendTransactionErrorType =
 export async function sendTransaction<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, TChain, TAccount>,
   args: SendTransactionParameters<TChain, TAccount, TChainOverride>,
@@ -200,11 +200,12 @@ export async function sendTransaction<
       })
     }
 
-    const format =
-      chain?.formatters?.transactionRequest?.format || formatTransactionRequest
+    const chainFormat = client.chain?.formatters?.transactionRequest?.format
+    const format = chainFormat || formatTransactionRequest
+
     const request = format({
       // Pick out extra data that might exist on the chain's transaction request type.
-      ...extract(rest, { format }),
+      ...extract(rest, { format: chainFormat }),
       accessList,
       data,
       from: account.address,

src/actions/wallet/signTransaction.ts

@@ -106,7 +106,7 @@ export type SignTransactionErrorType =
 export async function signTransaction<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, TChain, TAccount>,
   args: SignTransactionParameters<TChain, TAccount, TChainOverride>,

src/actions/wallet/writeContract.ts

@@ -116,7 +116,7 @@ export async function writeContract<
   TAccount extends Account | undefined,
   const TAbi extends Abi | readonly unknown[],
   TFunctionName extends string,
-  TChainOverride extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, TChain, TAccount>,
   {

src/chains/definitions/zkSync.ts

@@ -1,33 +1,39 @@
 import { defineChain } from '../../utils/chain.js'
+import { formattersZkSync } from '../zksync/formatters.js'
 
-export const zkSync = /*#__PURE__*/ defineChain({
-  id: 324,
-  name: 'zkSync Era',
-  network: 'zksync-era',
-  nativeCurrency: {
-    decimals: 18,
-    name: 'Ether',
-    symbol: 'ETH',
-  },
-  rpcUrls: {
-    default: {
-      http: ['https://mainnet.era.zksync.io'],
-      webSocket: ['wss://mainnet.era.zksync.io/ws'],
+export const zkSync = /*#__PURE__*/ defineChain(
+  {
+    id: 324,
+    name: 'zkSync Era',
+    network: 'zksync-era',
+    nativeCurrency: {
+      decimals: 18,
+      name: 'Ether',
+      symbol: 'ETH',
     },
-    public: {
-      http: ['https://mainnet.era.zksync.io'],
-      webSocket: ['wss://mainnet.era.zksync.io/ws'],
+    rpcUrls: {
+      default: {
+        http: ['https://mainnet.era.zksync.io'],
+        webSocket: ['wss://mainnet.era.zksync.io/ws'],
+      },
+      public: {
+        http: ['https://mainnet.era.zksync.io'],
+        webSocket: ['wss://mainnet.era.zksync.io/ws'],
+      },
     },
-  },
-  blockExplorers: {
-    default: {
-      name: 'zkExplorer',
-      url: 'https://explorer.zksync.io',
+    blockExplorers: {
+      default: {
+        name: 'zkExplorer',
+        url: 'https://explorer.zksync.io',
+      },
     },
-  },
-  contracts: {
-    multicall3: {
-      address: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
+    contracts: {
+      multicall3: {
+        address: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
+      },
     },
   },
-})
+  {
+    formatters: formattersZkSync,
+  },
+)

src/chains/definitions/zkSyncTestnet.ts

@@ -1,30 +1,36 @@
 import { defineChain } from '../../utils/chain.js'
+import { formattersZkSync } from '../zksync/formatters.js'
 
-export const zkSyncTestnet = /*#__PURE__*/ defineChain({
-  id: 280,
-  name: 'zkSync Era Testnet',
-  network: 'zksync-era-testnet',
-  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
-  rpcUrls: {
-    default: {
-      http: ['https://testnet.era.zksync.dev'],
-      webSocket: ['wss://testnet.era.zksync.dev/ws'],
+export const zkSyncTestnet = /*#__PURE__*/ defineChain(
+  {
+    id: 280,
+    name: 'zkSync Era Testnet',
+    network: 'zksync-era-testnet',
+    nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
+    rpcUrls: {
+      default: {
+        http: ['https://testnet.era.zksync.dev'],
+        webSocket: ['wss://testnet.era.zksync.dev/ws'],
+      },
+      public: {
+        http: ['https://testnet.era.zksync.dev'],
+        webSocket: ['wss://testnet.era.zksync.dev/ws'],
+      },
     },
-    public: {
-      http: ['https://testnet.era.zksync.dev'],
-      webSocket: ['wss://testnet.era.zksync.dev/ws'],
+    blockExplorers: {
+      default: {
+        name: 'zkExplorer',
+        url: 'https://goerli.explorer.zksync.io',
+      },
     },
-  },
-  blockExplorers: {
-    default: {
-      name: 'zkExplorer',
-      url: 'https://goerli.explorer.zksync.io',
+    contracts: {
+      multicall3: {
+        address: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
+      },
     },
+    testnet: true,
   },
-  contracts: {
-    multicall3: {
-      address: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
-    },
+  {
+    formatters: formattersZkSync,
   },
-  testnet: true,
-})
+)

src/chains/utils/index.test.ts

@@ -10,6 +10,7 @@ test('exports', () => {
       "serializersCelo",
       "parseTransactionCelo",
       "formattersOptimism",
+      "formattersZkSync",
     ]
   `)
 })

src/chains/utils/index.ts

@@ -43,3 +43,17 @@ export type {
   OptimismTransactionReceipt,
   OptimismTransactionReceiptOverrides,
 } from '../optimism/types.js'
+
+export { formattersZkSync } from '../zksync/formatters.js'
+export type {
+  TransactionEIP712,
+  ZkSyncBlock,
+  ZkSyncBlockOverrides,
+  ZkSyncRpcTransaction,
+  ZkSyncRpcTransactionReceiptOverrides,
+  ZkSyncRpcTransactionRequest,
+  ZkSyncTransaction,
+  ZkSyncTransactionReceipt,
+  ZkSyncTransactionReceiptOverrides,
+  ZkSyncTransactionRequest,
+} from '../zksync/types.js'