feat: publicActionsL1 decorator for zkSync

site/pages/zksync/actions/getAllowanceL1.md

@@ -0,0 +1,110 @@
+---
+description: Determines the amount of approved tokens for a specific L1 bridge.
+---
+
+# getAllowanceL1
+
+Determines the amount of approved tokens for a specific L1 bridge.
+
+## Usage
+
+:::code-group
+
+```ts [example.ts]
+import { account, publicClient } from './config'
+
+const allowance = await publicClient.getAllowanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D',
+    account
+})
+```
+
+```ts [config.ts]
+import { createPublicClient, custom } from 'viem'
+import { privateKeyToAccount } from 'viem/accounts'
+import { mainnet } from 'viem/chains'
+import { publicActionsL1 } from 'viem/zksync'
+
+export const publicClient = createPublicClient({
+  chain: mainnet,
+  transport: custom(window.ethereum)
+}).extend(publicActionsL1())
+
+// JSON-RPC Account
+export const account = '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+// Local Account
+export const account = privateKeyToAccount(...)
+```
+
+:::
+
+## Returns
+
+`bigint`
+
+Returns the amount of approved tokens.
+
+## Parameters
+
+### token
+
+- **Type:** `Address`
+
+The Ethereum address of the token.
+
+```ts
+const allowance = await publicClient.getAllowanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B', // [!code focus]
+    bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+    blockTag: 'latest',
+})
+```
+
+### bridgeAddress
+
+- **Type:** `Address`
+
+The address of the bridge contract to be used.
+
+```ts
+const allowance = await publicClient.getAllowanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B', 
+    bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D', // [!code focus]
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+    blockTag: 'latest', 
+})
+```
+
+### account
+
+- **Type:** `Account | Address`
+
+The Account used for check.
+
+Accepts a [JSON-RPC Account](/docs/clients/wallet#json-rpc-accounts) or [Local Account (Private Key, etc)](/docs/clients/wallet#local-accounts-private-key-mnemonic-etc).
+
+```ts
+const allowance = await publicClient.getAllowanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266' // [!code focus]
+    blockTag: 'latest',
+})
+```
+
+### blockTag (optional)
+
+- **Type:** `BlockTag | undefined`
+
+In which block an allowance should be checked on. The latest processed one is the default option.
+
+```ts
+const allowance = await publicClient.getAllowanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+    blockTag: 'latest', // [!code focus]
+})
+```

site/pages/zksync/actions/getBalanceL1.md

@@ -0,0 +1,99 @@
+---
+description: Returns the amount of the token held by the account on the L1 network.
+---
+
+# getBalanceL1
+
+Returns the amount of the token held by the account on the L1 network.
+
+## Usage
+
+:::code-group
+
+```ts [example.ts (Token balance)]
+import { account, publicClient } from './config'
+
+const balance = await publicClient.getBalanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    account
+})
+```
+
+```ts [example.ts (ETH balance)]
+import { account, publicClient } from './config'
+
+const balance = await publicClient.getBalanceL1({
+    account
+})
+```
+
+```ts [config.ts]
+import { createPublicClient, custom } from 'viem'
+import { privateKeyToAccount } from 'viem/accounts'
+import { mainnet } from 'viem/chains'
+import { publicActionsL1 } from 'viem/zksync'
+
+export const publicClient = createPublicClient({
+  chain: mainnet,
+  transport: custom(window.ethereum)
+}).extend(publicActionsL1())
+
+// JSON-RPC Account
+export const account = '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+// Local Account
+export const account = privateKeyToAccount(...)
+```
+
+:::
+
+## Returns
+
+`bigint`
+
+Returns the amount of the tokens.
+
+## Parameters
+
+### token (optional)
+
+- **Type:** `Address`
+
+The address of the token. Defaults to ETH if not provided.
+
+```ts
+const balance = await publicClient.getBalanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B', // [!code focus]
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+    blockTag: 'latest',
+})
+```
+
+### account
+
+- **Type:** `Account | Address`
+
+The Account used for check.
+
+Accepts a [JSON-RPC Account](/docs/clients/wallet#json-rpc-accounts) or [Local Account (Private Key, etc)](/docs/clients/wallet#local-accounts-private-key-mnemonic-etc).
+
+```ts
+const balance = await publicClient.getBalanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266' // [!code focus]
+    blockTag: 'latest',
+})
+```
+
+### blockTag (optional)
+
+- **Type:** `BlockTag | undefined`
+
+In which block an balance should be checked on. The latest processed one is the default option.
+
+```ts
+const balance = await publicClient.getBalanceL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+    blockTag: 'latest', // [!code focus]
+})
+```

site/pages/zksync/actions/getBalanceOfTokenL1.md

@@ -0,0 +1,91 @@
+---
+description: Retrieve the token balance held by the contract on L1.
+---
+
+# getBalanceOfTokenL1
+
+Retrieve the token balance held by the contract on L1.
+
+## Usage
+
+:::code-group
+
+```ts [example.ts]
+import { account, publicClient } from './config'
+
+const balance = await publicClient.getBalanceOfTokenL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    account
+})
+```
+
+```ts [config.ts]
+import { createPublicClient, custom } from 'viem'
+import { privateKeyToAccount } from 'viem/accounts'
+import { mainnet } from 'viem/chains'
+import { publicActionsL1 } from 'viem/zksync'
+
+export const publicClient = createPublicClient({
+  chain: mainnet,
+  transport: custom(window.ethereum)
+}).extend(publicActionsL1())
+
+// JSON-RPC Account
+export const account = '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+// Local Account
+export const account = privateKeyToAccount(...)
+```
+
+:::
+
+## Returns
+
+`bigint`
+
+Returns the amount of the tokens.
+
+## Parameters
+
+### token
+
+- **Type:** `Address`
+
+The address of the token.
+
+```ts
+const balance = await publicClient.getBalanceOfTokenL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B', // [!code focus]
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+    blockTag: 'latest',
+})
+```
+
+### account
+
+- **Type:** `Account | Address`
+
+The Account used for check.
+
+Accepts a [JSON-RPC Account](/docs/clients/wallet#json-rpc-accounts) or [Local Account (Private Key, etc)](/docs/clients/wallet#local-accounts-private-key-mnemonic-etc).
+
+```ts
+const balance = await publicClient.getBalanceOfTokenL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266' // [!code focus]
+    blockTag: 'latest',
+})
+```
+
+### blockTag (optional)
+
+- **Type:** `BlockTag | undefined`
+
+In which block an balance should be checked on. The latest processed one is the default option.
+
+```ts
+const balance = await publicClient.getBalanceOfTokenL1({
+    token: '0x5C221E77624690fff6dd741493D735a17716c26B',
+    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
+    blockTag: 'latest', // [!code focus]
+})
+```

site/pages/zksync/client.md

@@ -36,7 +36,7 @@ A suite of [Wallet Actions](/zksync/actions/sendTransaction) for suited for deve
 import { eip712WalletActions } from 'viem/zksync'
 ```
 
-### Sending transactions using paymaster
+#### Sending transactions using paymaster
 
 [Read more](./actions/sendTransaction.md)
 
@@ -50,7 +50,7 @@ const hash = await walletClient.sendTransaction({
 })
 ```
 
-### Calling contracts
+#### Calling contracts
 
 [Read more](../docs/contract/writeContract.md)
 
@@ -62,6 +62,14 @@ const { request } = await publicClient.simulateContract(walletClient, {
   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
   functionName: 'mint',
   args: [69420],
-}
+});
 const hash = await walletClient.writeContract(request)
 ```
+
+### `publicActionsL1`
+
+A suite of [Public Actions](/zksync/actions/getAllowanceL1) suited for development with **Layer 1** chains. These actions provide functionalities specific to public clients operating at the Layer 1 level, enabling them to interact seamlessly with Layer 2 protocols.
+
+```ts
+import { publicActionsL1 } from 'viem/zksync'
+```

site/sidebar.ts

@@ -1269,7 +1269,7 @@ export const sidebar = {
         ],
       },
       {
-        text: 'Actions',
+        text: 'EIP 712 Actions',
         items: [
           {
             text: 'deployContract',
@@ -1289,6 +1289,23 @@ export const sidebar = {
           },
         ],
       },
+      {
+        text: 'L1 Public Actions',
+        items: [
+          {
+            text: 'getBalanceL1',
+            link: '/zksync/actions/getBalanceL1',
+          },
+          {
+            text: 'getBalanceOfTokenL1',
+            link: '/zksync/actions/getBalanceOfTokenL1',
+          },
+          {
+            text: 'getAllowanceL1',
+            link: '/zksync/actions/getAllowanceL1',
+          },
+        ],
+      },
     ],
   },
 } as const satisfies Sidebar