feat: getBytecode

.changeset/violet-vans-attack.md

@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Added `getBytecode`.

site/.vitepress/sidebar.ts

@@ -401,7 +401,7 @@ export const sidebar: DefaultTheme.Sidebar = {
               link: '/docs/contract/deployContract',
             },
             {
-              text: 'getBytecode 🚧',
+              text: 'getBytecode',
               link: '/docs/contract/getBytecode',
             },
             {

src/actions/index.test.ts

@@ -20,6 +20,7 @@ test('exports actions', () => {
       "getBlockNumber": [Function],
       "getBlockNumberCache": [Function],
       "getBlockTransactionCount": [Function],
+      "getBytecode": [Function],
       "getChainId": [Function],
       "getFeeHistory": [Function],
       "getFilterChanges": [Function],

src/actions/index.ts

@@ -10,6 +10,7 @@ export {
   getBlockNumber,
   getBlockNumberCache,
   getBlockTransactionCount,
+  getBytecode,
   getChainId,
   getFeeHistory,
   getFilterChanges,
@@ -44,6 +45,8 @@ export type {
   GetBlockResponse,
   GetBlockTransactionCountArgs,
   GetBlockTransactionCountResponse,
+  GetBytecodeArgs,
+  GetBytecodeResponse,
   GetFeeHistoryArgs,
   GetFeeHistoryResponse,
   GetFilterChangesArgs,

src/actions/public/getBytecode.ts

@@ -0,0 +1,32 @@
+import { PublicClient } from '../../clients'
+import { Address, BlockTag, Hex } from '../../types'
+import { numberToHex } from '../../utils'
+
+export type GetBytecodeArgs = {
+  address: Address
+} & (
+  | {
+      blockNumber?: never
+      blockTag?: BlockTag
+    }
+  | {
+      blockNumber?: bigint
+      blockTag?: never
+    }
+)
+
+export type GetBytecodeResponse = Hex | undefined
+
+export async function getBytecode(
+  client: PublicClient,
+  { address, blockNumber, blockTag = 'latest' }: GetBytecodeArgs,
+): Promise<GetBytecodeResponse> {
+  const blockNumberHex =
+    blockNumber !== undefined ? numberToHex(blockNumber) : undefined
+  const hex = await client.request({
+    method: 'eth_getCode',
+    params: [address, blockNumberHex || blockTag],
+  })
+  if (hex === '0x') return undefined
+  return hex
+}

src/actions/public/index.test.ts

@@ -16,6 +16,7 @@ test('exports actions', () => {
       "getBlockNumber": [Function],
       "getBlockNumberCache": [Function],
       "getBlockTransactionCount": [Function],
+      "getBytecode": [Function],
       "getChainId": [Function],
       "getFeeHistory": [Function],
       "getFilterChanges": [Function],

src/actions/public/index.ts

@@ -41,6 +41,9 @@ export type {
   GetBlockTransactionCountResponse,
 } from './getBlockTransactionCount'
 
+export { getBytecode } from './getBytecode'
+export type { GetBytecodeArgs, GetBytecodeResponse } from './getBytecode'
+
 export { getChainId } from './getChainId'
 
 export { getFeeHistory } from './getFeeHistory'

src/index.test.ts

@@ -111,6 +111,7 @@ test('exports actions', () => {
       "getBlock": [Function],
       "getBlockNumber": [Function],
       "getBlockTransactionCount": [Function],
+      "getBytecode": [Function],
       "getChainId": [Function],
       "getContractAddress": [Function],
       "getCreate2Address": [Function],

src/index.ts

@@ -18,6 +18,8 @@ export type {
   GetBlockResponse,
   GetBlockTransactionCountArgs,
   GetBlockTransactionCountResponse,
+  GetBytecodeArgs,
+  GetBytecodeResponse,
   GetFeeHistoryArgs,
   GetFeeHistoryResponse,
   GetFilterChangesArgs,
@@ -90,6 +92,7 @@ export {
   getBlock,
   getBlockNumber,
   getBlockTransactionCount,
+  getBytecode,
   getChainId,
   getFeeHistory,
   getFilterChanges,