import {z} from 'zod' export type GetApiTransactionsArgs = {filter?: string | undefined, type?: string | undefined, method?: string | undefined}; export type GetApiTransactionsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const integerStringNullable = z.string().nullable(); export const fee = z.object({type: z.enum(["maximum", "actual"]), value: integerStringNullable}); export const addressTag = z.object({address_hash: z.string(), display_name: z.string(), label: z.string()}); export const watchlistName = z.object({display_name: z.string(), label: z.string()}); export const addressParam = z.object({hash: z.string(), implementation_name: z.string(), name: z.string(), ens_domain_name: z.string().optional(), metadata: z.object({}).optional(), is_contract: z.boolean(), private_tags: z.array(addressTag), watchlist_names: z.array(watchlistName), public_tags: z.array(addressTag), is_verified: z.boolean()}); export const fullHash = z.string(); export const addressHash = z.string(); export const implementation = z.object({address_hash: addressHash, name: z.string().nullable()}); export const metadataTag = z.object({meta: z.record(z.string(), z.unknown()).nullable(), name: z.string(), ordinal: z.number().int(), slug: z.string(), tagType: z.enum(["name", "generic", "classifier", "information", "note", "protocol"])}); export const metadata = z.object({tags: z.array(metadataTag)}); export const tag = z.object({address_hash: addressHash, display_name: z.string(), label: z.string()}); export const proxyType = z.enum(["eip1167", "eip1967", "eip1822", "eip1967_oz", "eip1967_beacon", "master_copy", "basic_implementation", "basic_get_implementation", "comptroller", "eip2535", "clone_with_immutable_arguments", "eip7702", "resolved_delegate_proxy", "erc7760", "minimal_proxy"]).nullable(); export const address = z.object({ens_domain_name: z.string().nullable(), hash: addressHash, implementations: z.array(implementation), is_contract: z.boolean().nullable(), is_scam: z.boolean(), is_verified: z.boolean().nullable(), metadata: metadata.nullable(), name: z.string().nullable(), private_tags: z.array(tag).optional(), proxy_type: proxyType, public_tags: z.array(tag).optional(), reputation: z.enum(["ok", "scam"]), watchlist_names: z.array(watchlistName).optional()}); export const methodNameNullable = z.string().nullable(); export const timestampNullable = z.string().nullable(); export const floatStringNullable = z.string().nullable(); export const uRLNullable = z.string().nullable(); export const tokenType = z.enum(["ERC-20", "ERC-721", "ERC-1155", "ERC-404", "ERC-7984"]); export const token = z.object({address_hash: addressHash, bridge_type: z.enum(["omni", "amb"]).nullable().optional(), circulating_market_cap: floatStringNullable, circulating_supply: floatStringNullable, decimals: integerStringNullable, exchange_rate: floatStringNullable, foreign_address: z.string().nullable().optional(), holders_count: integerStringNullable, icon_url: uRLNullable, name: z.string().nullable(), origin_chain_id: integerStringNullable.optional(), reputation: z.enum(["ok", "scam"]).nullable(), symbol: z.string().nullable(), total_supply: integerStringNullable, type: tokenType.nullable(), volume_24h: floatStringNullable}); export const integerString = z.string(); export const tokenInstance = z.object({animation_media_type: z.enum(["image", "video", "html"]).nullable().optional(), animation_url: uRLNullable, external_app_url: uRLNullable, id: integerString, image_media_type: z.enum(["image", "video", "html"]).nullable().optional(), image_url: uRLNullable, is_unique: z.boolean().nullable(), media_type: z.string().nullable(), media_url: uRLNullable, metadata: z.record(z.string(), z.unknown()).nullable(), owner: address.nullable(), thumbnails: z.object({"250x250": z.string().optional(), "500x500": z.string().optional(), "60x60": z.string().optional(), original: z.string()}).nullable(), token: token.nullable(), token_type: tokenType.nullable().optional(), value: integerStringNullable.optional()}); export const totalERC721 = z.object({token_id: integerStringNullable, token_instance: tokenInstance.nullable()}); export const totalERC1155 = z.object({decimals: integerStringNullable, token_id: integerStringNullable, token_instance: tokenInstance.nullable(), value: integerStringNullable}); export const totalERC7984 = z.object({decimals: integerStringNullable, value: integerStringNullable}); export const total = z.object({decimals: integerStringNullable, value: integerStringNullable}); export const tokenTransfer = z.object({block_hash: fullHash, block_number: z.number().int(), from: address, log_index: z.number().int(), method: methodNameNullable, timestamp: timestampNullable, to: address, token: token, token_type: tokenType, total: z.union([totalERC721, totalERC1155, totalERC7984, total]).nullable(), transaction_hash: fullHash, type: z.enum(["token_burning", "token_minting", "token_spawning", "token_transfer"])}); export const transactionActionAaveV3LiquidationCall = z.object({data: z.object({}), protocol: z.string(), type: z.string()}); export const transactionActionAaveV3BSWRF = z.object({data: z.object({}), protocol: z.string(), type: z.string()}); export const transactionActionAaveV3EnableDisableCollateral = z.object({data: z.object({}), protocol: z.string(), type: z.string()}); export const transactionActionUniswapV3MintNFT = z.object({data: z.object({}), protocol: z.string(), type: z.string()}); export const transactionActionUniswapV3BCS = z.object({data: z.object({}), protocol: z.string(), type: z.string()}); export const transactionAction = z.union([transactionActionAaveV3LiquidationCall, transactionActionAaveV3BSWRF, transactionActionAaveV3EnableDisableCollateral, transactionActionUniswapV3MintNFT, transactionActionUniswapV3BCS]); export const decodedInput = z.object({method_call: z.string().nullable(), method_id: z.string().nullable(), parameters: z.array(z.object({name: z.string().optional(), type: z.string().optional(), value: z.union([z.object({}), z.array(z.union([z.object({}), z.array(z.string()), z.string()])), z.string()]).optional()}))}); export const transaction = z.object({timestamp: z.string(), fee: fee, gas_limit: z.number().int(), block_number: z.number().int(), status: z.string(), method: z.string(), confirmations: z.number().int(), type: z.number().int(), exchange_rate: z.string(), to: addressParam, transaction_burnt_fee: z.string(), max_fee_per_gas: z.string(), result: z.string(), hash: z.string(), gas_price: z.string(), priority_fee: z.string(), base_fee_per_gas: z.string(), from: addressParam, token_transfers: z.array(tokenTransfer), transaction_types: z.array(z.string()), gas_used: z.string(), created_contract: addressParam, position: z.number().int(), nonce: z.number().int(), has_error_in_internal_transactions: z.boolean(), actions: z.array(transactionAction), decoded_input: decodedInput, token_transfers_overflow: z.boolean(), raw_input: z.string(), value: z.string(), max_priority_fee_per_gas: z.string(), revert_reason: z.string(), confirmation_duration: z.object({}), transaction_tag: z.string()}); export const getApiTransactionsResponse = z.object({items: z.array(transaction), next_page_params: z.object({})}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * get transactions * * GET /transactions * * Also accepts auth: apiKeyAuth */ export const getApiTransactions = async (args: GetApiTransactionsArgs, options?: GetApiTransactionsOptions) => { const {baseUrl = "https://api.blockscout.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.filter != null) query.append("filter", String(args.filter)) if (args.type != null) query.append("type", String(args.type)) if (args.method != null) query.append("method", String(args.method)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/transactions${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiTransactionsResponse, await res.json()) };