UNPKG

viem

Version:

TypeScript Interface for Ethereum

45 lines 1.79 kB
import type { Address } from 'abitype'; import type { Client } from '../../clients/createClient.js'; import type { Transport } from '../../clients/transports/createTransport.js'; import type { ErrorType } from '../../errors/utils.js'; import type { BlockTag } from '../../types/block.js'; import type { Chain } from '../../types/chain.js'; import type { Hex } from '../../types/misc.js'; import type { RequestErrorType } from '../../utils/buildRequest.js'; import { type NumberToHexErrorType } from '../../utils/encoding/toHex.js'; export type GetCodeParameters = { address: Address; } & ({ blockNumber?: undefined; blockTag?: BlockTag | undefined; } | { blockNumber?: bigint | undefined; blockTag?: undefined; }); export type GetCodeReturnType = Hex | undefined; export type GetCodeErrorType = NumberToHexErrorType | RequestErrorType | ErrorType; /** * Retrieves the bytecode at an address. * * - Docs: https://viem.sh/docs/contract/getCode * - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode) * * @param client - Client to use * @param parameters - {@link GetCodeParameters} * @returns The contract's bytecode. {@link GetCodeReturnType} * * @example * import { createPublicClient, http } from 'viem' * import { mainnet } from 'viem/chains' * import { getCode } from 'viem/contract' * * const client = createPublicClient({ * chain: mainnet, * transport: http(), * }) * const code = await getCode(client, { * address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', * }) */ export declare function getCode<chain extends Chain | undefined>(client: Client<Transport, chain>, { address, blockNumber, blockTag }: GetCodeParameters): Promise<GetCodeReturnType>; //# sourceMappingURL=getCode.d.ts.map