viem 2.5.0 → 2.6.1

package/chains/definitions/iotexTestnet.ts

@@ -20,4 +20,5 @@ export const iotexTestnet = /*#__PURE__*/ defineChain({
       url: 'https://testnet.iotexscan.io',
     },
   },
+  testnet: true,
 })

package/chains/definitions/kcc.ts

@@ -0,0 +1,30 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const kcc = /*#__PURE__*/ defineChain({
+  id: 321,
+  name: 'KCC Mainnet',
+  network: 'KCC Mainnet',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'KCS',
+    symbol: 'KCS',
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://kcc-rpc.com'],
+    },
+    public: {
+      http: ['https://kcc-rpc.com'],
+    },
+  },
+  blockExplorers: {
+    default: { name: 'KCC Explorer', url: 'https://explorer.kcc.io' },
+  },
+  contracts: {
+    multicall3: {
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
+      blockCreated: 11760430,
+    },
+  },
+  testnet: false,
+})

package/chains/definitions/oortmainnetDev.ts

@@ -0,0 +1,24 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const oortMainnetDev = /*#__PURE__*/ defineChain({
+  id: 9700,
+  name: 'OORT MainnetDev',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'OORT',
+    symbol: 'OORT',
+  },
+  rpcUrls: {
+    default: { http: ['https://dev-rpc.oortech.com'] },
+  },
+  blockExplorers: {
+    oort: {
+      name: 'OORT MainnetDev Explorer',
+      url: 'https://dev-scan.oortech.com',
+    },
+    default: {
+      name: 'OORT MainnetDev Explorer',
+      url: 'https://dev-scan.oortech.com',
+    },
+  },
+})

package/chains/definitions/zkSync.ts

@@ -19,8 +19,9 @@ export const zkSync = /*#__PURE__*/ defineChain({
   },
   blockExplorers: {
     default: {
-      name: 'zkExplorer',
-      url: 'https://explorer.zksync.io',
+      name: 'Etherscan',
+      url: 'https://era.zksync.network/',
+      apiUrl: 'https://api-era.zksync.network/api',
     },
   },
   contracts: {

package/chains/index.ts

@@ -17,6 +17,7 @@ export { baseGoerli } from './definitions/baseGoerli.js'
 export { baseSepolia } from './definitions/baseSepolia.js'
 export { bearNetworkChainMainnet } from './definitions/bearNetworkChainMainnet.js'
 export { bearNetworkChainTestnet } from './definitions/bearNetworkChainTestnet.js'
+export { berachainTestnet } from './definitions/berachainTestnet.js'
 export { bitTorrent } from './definitions/bitTorrent.js'
 export { bitTorrentTestnet } from './definitions/bitTorrentTestnet.js'
 export { blastSepolia } from './definitions/blastSepolia.js'
@@ -77,6 +78,7 @@ export { haqqTestedge2 } from './definitions/haqqTestedge2.js'
 export { holesky } from './definitions/holesky.js'
 export { kava } from './definitions/kava.js'
 export { kavaTestnet } from './definitions/kavaTestnet.js'
+export { kcc } from './definitions/kcc.js'
 export { klaytn } from './definitions/klaytn.js'
 export { klaytnBaobab } from './definitions/klaytnBaobab.js'
 export { kroma } from './definitions/kroma.js'
@@ -117,6 +119,7 @@ export { optimismGoerli } from './definitions/optimismGoerli.js'
 export { optimismSepolia } from './definitions/optimismSepolia.js'
 export { opBNB } from './definitions/opBNB.js'
 export { opBNBTestnet } from './definitions/opBNBTestnet.js'
+export { oortMainnetDev } from './definitions/oortmainnetDev.js'
 export { palm } from './definitions/palm.js'
 export { palmTestnet } from './definitions/palmTestnet.js'
 export { pgn } from './definitions/pgn.js'

package/chains/zksync/actions/sendEip712Transaction.ts

@@ -0,0 +1,129 @@
+import type { Account } from '../../../accounts/types.js'
+import { parseAccount } from '../../../accounts/utils/parseAccount.js'
+import { getChainId } from '../../../actions/public/getChainId.js'
+import { prepareTransactionRequest } from '../../../actions/wallet/prepareTransactionRequest.js'
+import { sendRawTransaction } from '../../../actions/wallet/sendRawTransaction.js'
+import type {
+  SendTransactionErrorType,
+  SendTransactionParameters as SendTransactionParameters_,
+  SendTransactionReturnType,
+} from '../../../actions/wallet/sendTransaction.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import { AccountNotFoundError } from '../../../errors/account.js'
+import { BaseError } from '../../../errors/base.js'
+import type { Chain } from '../../../types/chain.js'
+import { assertCurrentChain } from '../../../utils/chain/assertCurrentChain.js'
+import {
+  type GetTransactionErrorParameters,
+  getTransactionError,
+} from '../../../utils/errors/getTransactionError.js'
+import { getAction } from '../../../utils/getAction.js'
+import { type ChainEIP712 } from '../types/chain.js'
+import { assertEip712Request } from '../utils/assertEip712Request.js'
+import { signTransaction } from './signTransaction.js'
+
+export type SendEip712TransactionParameters<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = SendTransactionParameters_<TChain, TAccount, TChainOverride>
+
+export type SendEip712TransactionReturnType = SendTransactionReturnType
+
+export type SendEip712TransactionErrorType = SendTransactionErrorType
+
+/**
+ * Creates, signs, and sends a new EIP712 transaction to the network.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link SendEip712TransactionParameters}
+ * @returns The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link SendTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { zkSync } from 'viem/chains'
+ * import { sendEip712Transaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   chain: zkSync,
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await sendEip712Transaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zkSync } from 'viem/chains'
+ * import { sendEip712Transaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: zkSync,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await sendEip712Transaction(client, {
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ */
+export async function sendEip712Transaction<
+  TChain extends ChainEIP712 | undefined,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined = undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  args: SendEip712TransactionParameters<TChain, TAccount, TChainOverride>,
+): Promise<SendEip712TransactionReturnType> {
+  const { chain = client.chain } = args
+
+  if (!args.account)
+    throw new AccountNotFoundError({
+      docsPath: '/docs/actions/wallet/sendTransaction',
+    })
+  const account = parseAccount(args.account)
+
+  try {
+    assertEip712Request(args)
+
+    // Prepare the request for signing (assign appropriate fees, etc.)
+    const request = await prepareTransactionRequest(client, {
+      ...args,
+      parameters: ['gas', 'nonce'],
+    } as any)
+
+    let chainId: number | undefined
+    if (chain !== null) {
+      chainId = await getAction(client, getChainId, 'getChainId')({})
+      assertCurrentChain({
+        currentChainId: chainId,
+        chain,
+      })
+    }
+
+    const serializedTransaction = await signTransaction(client, {
+      ...request,
+      chainId,
+    } as any)
+
+    return await getAction(
+      client,
+      sendRawTransaction,
+      'sendRawTransaction',
+    )({
+      serializedTransaction,
+    })
+  } catch (err) {
+    throw getTransactionError(err as BaseError, {
+      ...(args as GetTransactionErrorParameters),
+      account,
+      chain: chain as Chain,
+    })
+  }
+}

package/chains/zksync/actions/sendTransaction.ts

@@ -0,0 +1,78 @@
+import type { Account } from '../../../accounts/types.js'
+import { sendTransaction as sendTransaction_ } from '../../../actions/wallet/sendTransaction.js'
+import type {
+  SendTransactionErrorType as SendTransactionErrorType_,
+  SendTransactionParameters as SendTransactionParameters_,
+  SendTransactionReturnType as SendTransactionReturnType_,
+} from '../../../actions/wallet/sendTransaction.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import { type ChainEIP712 } from '../types/chain.js'
+import { isEIP712Transaction } from '../utils/isEip712Transaction.js'
+import { sendEip712Transaction } from './sendEip712Transaction.js'
+
+export type SendTransactionParameters<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = SendTransactionParameters_<TChain, TAccount, TChainOverride>
+
+export type SendTransactionReturnType = SendTransactionReturnType_
+
+export type SendTransactionErrorType = SendTransactionErrorType_
+
+/**
+ * Creates, signs, and sends a new transaction to the network.
+ *
+ * - Docs: https://viem.sh/docs/zksync/actions/sendTransaction
+ * - JSON-RPC Methods:
+ *   - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction)
+ *   - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link SendTransactionParameters}
+ * @returns The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link SendTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { zkSync } from 'viem/chains'
+ * import { sendTransaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   chain: zkSync,
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await sendTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zkSync } from 'viem/chains'
+ * import { sendTransaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: zkSync,
+ *   transport: http(),
+ * })
+ * const hash = await sendTransaction(client, {
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ */
+export async function sendTransaction<
+  TChain extends ChainEIP712 | undefined,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined = undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  args: SendTransactionParameters<TChain, TAccount, TChainOverride>,
+): Promise<SendTransactionReturnType> {
+  if (isEIP712Transaction(args)) return sendEip712Transaction(client, args)
+  return sendTransaction_(client, args)
+}

package/chains/zksync/actions/signEip712Transaction.ts

@@ -0,0 +1,150 @@
+import type { Account } from '../../../accounts/types.js'
+import { parseAccount } from '../../../accounts/utils/parseAccount.js'
+import { getChainId } from '../../../actions/public/getChainId.js'
+import type {
+  SignTransactionErrorType,
+  SignTransactionReturnType,
+} from '../../../actions/wallet/signTransaction.js'
+import { signTypedData } from '../../../actions/wallet/signTypedData.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import { AccountNotFoundError } from '../../../errors/account.js'
+import { BaseError } from '../../../errors/base.js'
+import type { GetAccountParameter } from '../../../types/account.js'
+import type {
+  ExtractChainFormatterParameters,
+  GetChainParameter,
+} from '../../../types/chain.js'
+import type { UnionOmit } from '../../../types/utils.js'
+import { assertCurrentChain } from '../../../utils/chain/assertCurrentChain.js'
+import { getAction } from '../../../utils/getAction.js'
+import type { ChainEIP712 } from '../types/chain.js'
+import type { TransactionRequestEIP712 } from '../types/transaction.js'
+import {
+  type AssertEip712RequestParameters,
+  assertEip712Request,
+} from '../utils/assertEip712Request.js'
+
+type FormattedTransactionRequest<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = ExtractChainFormatterParameters<
+  TChain,
+  'transactionRequest',
+  TransactionRequestEIP712
+>
+
+export type SignEip712TransactionParameters<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = UnionOmit<
+  FormattedTransactionRequest<
+    TChainOverride extends ChainEIP712 ? TChainOverride : TChain
+  >,
+  'from'
+> &
+  GetAccountParameter<TAccount> &
+  GetChainParameter<TChain, TChainOverride>
+
+export type SignEip712TransactionReturnType = SignTransactionReturnType
+
+export type SignEip712TransactionErrorType = SignTransactionErrorType
+
+/**
+ * Signs an EIP712 transaction.
+ *
+ * @param args - {@link SignTransactionParameters}
+ * @returns The signed serialized tranasction. {@link SignTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { zkSync } from 'viem/chains'
+ * import { signEip712Transaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   chain: zkSync,
+ *   transport: custom(window.ethereum),
+ * })
+ * const signature = await signEip712Transaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: 1n,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zkSync } from 'viem/chains'
+ * import { signEip712Transaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: zkSync,
+ *   transport: custom(window.ethereum),
+ * })
+ * const signature = await signEip712Transaction(client, {
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: 1n,
+ * })
+ */
+export async function signEip712Transaction<
+  TChain extends ChainEIP712 | undefined,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  args: SignEip712TransactionParameters<TChain, TAccount, TChainOverride>,
+): Promise<SignEip712TransactionReturnType> {
+  const {
+    account: account_ = client.account,
+    chain = client.chain,
+    ...transaction
+  } = args
+
+  if (!account_)
+    throw new AccountNotFoundError({
+      docsPath: '/docs/actions/wallet/signTransaction',
+    })
+  const account = parseAccount(account_)
+
+  assertEip712Request({
+    account,
+    chain,
+    ...(args as AssertEip712RequestParameters),
+  })
+
+  if (!chain?.custom?.getEip712Domain)
+    throw new BaseError('`getEip712Domain` not found on chain.')
+  if (!chain?.serializers?.transaction)
+    throw new BaseError('transaction serializer not found on chain.')
+
+  const chainId = await getAction(client, getChainId, 'getChainId')({})
+  if (chain !== null)
+    assertCurrentChain({
+      currentChainId: chainId,
+      chain: chain,
+    })
+
+  const eip712Domain = chain?.custom.getEip712Domain({
+    ...transaction,
+    chainId,
+    from: account.address,
+    type: 'eip712',
+  })
+
+  const customSignature = await signTypedData(client, {
+    ...eip712Domain,
+    account,
+  })
+
+  return chain?.serializers?.transaction(
+    {
+      chainId,
+      ...transaction,
+      customSignature,
+      type: 'eip712',
+    },
+    { r: '0x0', s: '0x0', v: 0n },
+  )
+}

package/chains/zksync/actions/signTransaction.ts

@@ -0,0 +1,95 @@
+import type { Account } from '../../../accounts/types.js'
+import { signTransaction as signTransaction_ } from '../../../actions/wallet/signTransaction.js'
+import type {
+  SignTransactionErrorType as SignTransactionErrorType_,
+  SignTransactionReturnType as SignTransactionReturnType_,
+} from '../../../actions/wallet/signTransaction.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { GetAccountParameter } from '../../../types/account.js'
+import type {
+  ExtractChainFormatterParameters,
+  GetChainParameter,
+} from '../../../types/chain.js'
+import type { UnionOmit } from '../../../types/utils.js'
+import type { ChainEIP712 } from '../types/chain.js'
+import type { TransactionRequestEIP712 } from '../types/transaction.js'
+import { isEIP712Transaction } from '../utils/isEip712Transaction.js'
+import { signEip712Transaction } from './signEip712Transaction.js'
+
+type FormattedTransactionRequest<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = ExtractChainFormatterParameters<
+  TChain,
+  'transactionRequest',
+  TransactionRequestEIP712
+>
+
+export type SignTransactionParameters<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = UnionOmit<
+  FormattedTransactionRequest<
+    TChainOverride extends ChainEIP712 ? TChainOverride : TChain
+  >,
+  'from'
+> &
+  GetAccountParameter<TAccount> &
+  GetChainParameter<TChain, TChainOverride>
+
+export type SignTransactionReturnType = SignTransactionReturnType_
+
+export type SignTransactionErrorType = SignTransactionErrorType_
+
+/**
+ * Signs a transaction.
+ *
+ * - Docs: https://viem.sh/docs/zksync/actions/signTransaction
+ *
+ * @param args - {@link SignTransactionParameters}
+ * @returns The signed serialized tranasction. {@link SignTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { zkSync } from 'viem/chains'
+ * import { signTransaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   chain: zkSync,
+ *   transport: custom(window.ethereum),
+ * })
+ * const signature = await signTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: 1n,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zkSync } from 'viem/chains'
+ * import { signTransaction } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: zkSync,
+ *   transport: custom(window.ethereum),
+ * })
+ * const signature = await signTransaction(client, {
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: 1n,
+ * })
+ */
+export async function signTransaction<
+  TChain extends ChainEIP712 | undefined,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainEIP712 | undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  args: SignTransactionParameters<TChain, TAccount, TChainOverride>,
+): Promise<SignTransactionReturnType> {
+  if (isEIP712Transaction(args)) return signEip712Transaction(client, args)
+  return await signTransaction_(client, args as any)
+}

package/chains/zksync/chainConfig.ts

@@ -1,7 +1,11 @@
 import { formatters } from './formatters.js'
 import { serializers } from './serializers.js'
+import { getEip712Domain } from './utils/getEip712Domain.js'
 
 export const chainConfig = {
   formatters,
   serializers,
+  custom: {
+    getEip712Domain,
+  },
 } as const

package/chains/zksync/chains.ts

@@ -0,0 +1,3 @@
+export { zkSync } from '../definitions/zkSync.js'
+export { zkSyncTestnet } from '../definitions/zkSyncTestnet.js'
+export { zkSyncSepoliaTestnet } from '../definitions/zkSyncSepoliaTestnet.js'