区块链Web3【免费下载链接】web3.jsCollection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.项目地址https://gitcode.com/gh_mirrors/we/web3.js点击查看免费下载导读本文以仓库中 packages/web3/CHANGELOG.md 为线索系统梳理 web3.js 4.x自 4.0.0-alpha 至 4.16.0中web3主包的每次版本迭代连接关闭、IPC 支持、命名空间导出、EIP-6963 多钱包发现、交易中间件、ignoreGasPricing、defaultReturnFormat、TypeScript 5 迁移等关键变更的来龙去脉与正确用法。文中每项结论均可在当前仓库源码、配置与测试中找到对应实现读者在读完本文后既能掌握 4.x 各版本的升级要点也能直接定位到具体实现文件继续深挖。版本总览一条贯穿 4.x 的演进主线web3是 web3.js 的伞形umbrella主包其职责是把web3-core、web3-eth、web3-net、web3-eth-contract、web3-eth-ens、web3-providers-*等子包组织为一个统一入口。当前仓库中 packages/web3/package.json 标注版本为4.16.0packages/web3/src/version.ts 中Web3PkgInfo.version也与之对应子包依赖版本集中在^4.xweb3-eth^4.11.1、web3-utils^4.3.3 等。CHANGELOG 记录了完整的演进时间线版本类型核心变化4.0.0-alpha.1Breaking移除对原始连接对象的暴露连接关闭改为currentProvider.disconnect()4.0.1-alpha.2 / alpha.5构建tsc 产物从dist/移至lib/移除package.json中的build入口4.0.1-rc.0导出默认导出对象全部补充命名导出按命名空间聚合导出4.0.1-rc.1模块新增 ESM/CJS 混合构建移除 IPC provider 内置依赖4.0.2导出导出Web3Context、Web3PluginBase、Web3EthPluginBase、Web3Validator4.0.3构造器支持Web3ContextInitOptions初始化参数修复web3.eth缺少 personal 类型4.1.0扩展最小化支持web3.extend4.3.0账户新增privateKeyToAddress、parseAndValidatePrivateKey、privateKeyToPublicKey4.6.0EIP-6963新增requestEIP6963Providers多 provider 发现工具4.9.0配置defaultReturnFormat全局配置上线4.10.0中间件TransactionMiddleware引入插件可经 context 复用既有包4.11.0合约populateTransaction、合约级交易中间件4.13.0EIP-6963requestEIP6963Providers返回Map回调参数类型调整4.14.0配置新增ignoreGasPricingEIP-6963 类型移出providers命名空间4.15.0过滤器导出createNewFilter等过滤方法新增decodeFunctionCall/decodeFunctionReturn4.16.0TS5全线升级 TypeScript 4 → 5签名相关类型移至web3-types从表中可以看到4.x 的演进主线是先稳固构建与导出体系4.0.x再丰富配置项与模块能力4.1 ~ 4.9随后引入插件/中间件生态4.10 ~ 4.11最后完善浏览器多钱包发现与类型体系4.13 ~ 4.16。一、Breaking Change连接关闭方式的迁移1.x 时代的旧用法在 web3.js 1.x 中用户可以直接访问原始连接对象并操作它web3.currentProvider.connection.close();CHANGELOG 明确指出这种直接操作内部连接对象的行为在 4.x 中不再暴露。4.x 的正确做法迁移后的等价写法web3.currentProvider.disconnect();注意disconnect存在于 provider 层面而非原始 socket 层面。这一点在集成测试中有直接验证packages/web3/test/integration/web3.test.ts 中通过断言确认web3Instance.provider?.disconnect、web3Instance.eth.provider?.disconnect、web3Instance.currentProvider?.disconnect均为函数并且 WebSocket、IPC、HTTP 三种 provider 路径下都有对应用例itIf(isWs)/itIf(isIpc)/itIf(isHttp)说明disconnect是各 provider 的统一能力。相关的迁移文档官方升级指南中对这一破坏性变更做了更全面的阐述可参考 docs/docs/guides/15_web3_upgrade_guide/providers_migration_guide.md 与 docs/docs/guides/15_web3_upgrade_guide/index.md。二、构建与模块体系lib/ 目录、混合构建与 IPC 调整构建产物迁移到 lib/4.0.1-alpha.2tsc编译产物从dist/目录移动到lib/#5739。4.0.1-alpha.5从package.json移除build入口#5755。当前 packages/web3/package.json 的exports字段与此一致types指向./lib/types/index.d.tsimport指向./lib/esm/index.jsESMrequire指向./lib/commonjs/index.jsCJS。混合构建ESM CJS4.0.1-rc.1引入 hybrid build#5904并且不再需要对 nodejs 的net和fs模块做 polyfill#5978。构建脚本同样印证了这一点packages/web3/package.json 中build:cjs使用tsc --build tsconfig.cjs.jsonbuild:esm使用tsconfig.esm.jsonbuild:types使用tsconfig.types.json产物目录分别写入lib/commonjs与lib/esm。仓库顶层 config/tsconfig.cjs.json、config/tsconfig.esm.json、config/tsconfig.types.json 即各包共用的三套编译配置模板。IPC provider 不再是内置依赖同一版本#5978移除了内置的 IPC provider 依赖IPC 路径不再作为web3的默认可用 provider 类型。若确需 IPC官方给出的路径是import { IpcProvider } from web3-providers-ipc; const web3 new Web3(new IpcProvider(/Users/myuser/Library/Ethereum/geth.ipc)); // mac 路径这与 packages/web3/src/index.ts 中对外导出集合一致providers命名空间仅包含 HttpProvider 与 WebSocketProvider 相关导出经由 packages/web3/src/providers.exports.ts而web3-providers-ipc需要用户自行安装后手动实例化它也出现在 packages/web3/package.json 的 devDependencies 中用于测试场景。三、导出体系的重构命名导出、命名空间与扁平导出默认导出对象全部补充命名导出#57714.0.1-rc.0 起每个包中默认导出的对象同时提供具名导出。例如web3-core默认导出的Web3Context等对象都可以按名字直接导入。命名空间聚合导出require(web3)现在返回按命名空间组织的全部导出对象。当前 packages/web3/src/index.ts 中可以看到这套命名空间结构export * as core from web3-core; export * as errors from web3-errors; export * as eth from ./eth.exports.js; export * as net from web3-net; export * as providers from ./providers.exports.js; export * as rpcMethods from web3-rpc-methods; export * as types from web3-types; export * as utils from web3-utils; export * as validator from web3-validator;同时 packages/web3/src/index.ts 提供了顶层扁平导出如Web3、Web3Context、Web3PluginBase、Web3EthPluginBase、Web3PromiEvent、Web3Eth、Contract、Iban、Personal、Net、HttpProvider、WebSocketProvider、Web3Validator。web3-types 与 web3-errors 的扁平导出index.ts 还做了额外扁平导出所有来自web3-types和web3-errors的类型与常量在命名空间之外再暴露一层使开发者可以直接写function f(): Web3Api而无需前缀types.。这与 CHANGELOG 4.0.1-rc.0 中为web3-types、web3-errors和web3添加类型与常量扁平导出的记录一一对应。更多导出扩展4.0.2从web3-core导出Web3Context、Web3PluginBase、Web3EthPluginBase从web3-validator导出Web3Validator#6165。4.16.0导出Web3Account、Wallet以及签名相关类型#7374签名相关类型从web3-eth-accounts移至web3-types原位置保留 re-export 以向后兼容。四、构造器与配置Web3ContextInitOptions 与全局配置项构造器支持 Web3ContextInitOptions#62624.0.3起Web3构造器除了接受undefined、string、SupportedProvidersEthExecutionAPI之外还接受Web3ContextInitOptionsEthExecutionAPI, CustomRegisteredSubscription。在 packages/web3/src/web3.ts 中可以看到构造器对参数的分流处理字符串或受支持的 provider → 写入contextInitOptions.provider对象 → 整体作为Web3ContextInitOptions空值 → 输出警告 web3.js is running without provider...。registeredSubscriptions 默认注入#57924.0.1-rc.0 起web3 构造器默认注册标准订阅。源码中 packages/web3/src/web3.ts 将registeredSubscriptions来自web3-eth与用户自定义订阅合并contextInitOptions.registeredSubscriptions { // all the Eth standard subscriptions ...registeredSubscriptions, // overridden and combined with any custom subscriptions ...(contextInitOptions.registeredSubscriptions ?? {}), } as CustomRegisteredSubscription;这也是为何new Web3()后可直接使用logs、newHeads、newPendingTransactions等标准订阅同一版本移除了私有静态_contracts与静态setProvider#5792。配置项速查表在 packages/web3-core/src/web3_config.ts 中定义了完整的Web3ConfigOptions其中与 CHANGELOG 直接相关的关键配置默认值如下配置项默认值说明handleRevertfalse为sendTransaction/call等返回 revert 原因字符串defaultBlocklatest默认区块标签transactionConfirmationBlocks24交易确认区块数transactionPollingInterval1000轮询间隔mstransactionSendTimeout750 * 1000发送超时msdefaultChainmainnet默认链defaultHardforklondon默认硬分叉defaultTransactionType0x2默认交易类型EIP-1559contractDataInputFilldata合约 data/input 填充方式defaultReturnFormatDEFAULT_RETURN_FORMAT默认返回数据格式4.9.0 新增ignoreGasPricingfalse为 true 时不估算 gasPrice4.14.0 新增setConfig()是统一入口见 web3_config.ts对maxListenersWarningThreshold这类 key 还会额外同步到事件发射器这正是 4.12.0 中setConfig()修复setMaxListenerWarningThreshold#5079所涉及的行为。defaultReturnFormat全局返回格式#69474.9.0引入defaultReturnFormat配置项并统一加到web3-eth、web3-eth-contract、web3-eth-ens、web3-net中所有带ReturnType参数的方法。含义未显式指定返回格式时全局采用该格式如{ number: bigint, bytes: hex }。这在 web3_config.ts 中以 getter/setter 形式实现setter 会触发CONFIG_CHANGE事件。ignoreGasPricing跳过 gas 估算#73204.14.0新增ignoreGasPricing为true时不再估算 gasPrice。配置默认值为falseweb3_config.tsgetter/setter 位于 web3_config.tsweb3-eth的populateGasPricepackages/web3-eth/src/utils/send_tx_helper.ts在填充交易时会检查该配置。适用于希望完全自行指定 fee 字段、避免额外 RPC 调用如eth_gasPrice的场景。五、EIP-6963 多钱包发现从 requestEIP6963Providers 到类型调整EIP-6963 是浏览器端多个钱包共存时的标准发现协议替代旧式window.ethereum注入的竞态问题。web3.js 从4.6.0#起提供requestEIP6963Providers工具函数随后在 4.13.0、4.14.0 持续打磨类型。核心实现实现位于 packages/web3/src/web3_eip6963.ts核心机制export const requestEIP6963Providers async (): PromiseEIP6963ProviderResponse new Promise((resolve, reject) { if (typeof window undefined) { reject(new Error(window object not available, EIP-6963 is intended to be used within a browser)); } window.addEventListener(Eip6963EventName.eip6963announceProvider, ((event) { eip6963ProvidersMap.set(event.detail.info.uuid, event.detail); const newEvent new CustomEvent(web3ProvidersMapUpdated, { detail: eip6963ProvidersMap }); window.dispatchEvent(newEvent); resolve(eip6963ProvidersMap); }) as EventListenerOrEventListenerObject); window.dispatchEvent(new Event(Eip6963EventName.eip6963requestProvider)); });要点必须运行在浏览器环境window存在否则 reject/throw监听eip6963:announceProvider按钱包uuid存入全局Map同时派发web3:providersMapUpdated事件通知监听者主动派发eip6963:requestProvider以触发钱包应答。4.13.0 的类型调整#7239 / #7242Web3.providers命名空间导出type EIP6963ProviderResponse Mapstring, EIP6963ProviderDetail静态Web3.requestEIP6963Providers返回类型改为PromiseEIP6963ProviderResponse静态Web3.onNewProviderDiscovered的回调参数由EIP6963AnnounceProviderEvent改为EIP6963ProvidersMapUpdateEvent。这些静态方法在 packages/web3/src/web3.ts 中注册Web3.requestEIP6963Providers requestEIP6963Providers;、Web3.onNewProviderDiscovered onNewProviderDiscovered;。4.14.0 的类型移出命名空间#7270EIP-6963 相关类型不再挂在providers命名空间下而是直接从web3导出index.ts中export * from ./web3_eip6963.js让导入更直观import { requestEIP6963Providers, onNewProviderDiscovered } from web3;测试佐证packages/web3/test/unit/web3eip6963.test.ts 覆盖了非浏览器环境 reject、eip6963:announceProvider事件触发后Map更新与 resolve、onNewProviderDiscovered回调触发等行为。文档侧可参考 docs/docs/guides/02_web3_providers_guide/eip6963.md。六、账户、ENS 与签名能力账户工具方法4.3.0#6620web3.eth.accounts新增privateKeyToAddress、parseAndValidatePrivateKey、privateKeyToPublicKey4.9.0#6762将Web3EthInterface.accounts的类型更新为包含这三个方法。实现位于 packages/web3-eth-accounts/src/account.ts账户模块的装配在 packages/web3/src/accounts.ts。签名相关4.15.0 / 4.16.04.15.0#7346hashMessage新增可选参数skipPrefix默认false新增signRaw用于不加前缀的原始消息签名。4.16.0#7374签名相关类型迁至web3-typesweb3-eth-accounts与原web3包中保留 re-export 以保证向后兼容。ENS 增强4.7.0 / 4.10.0getText、getName加入 ENS 与 Resolver 类#69144.10.0getText首参支持AddressgetName增加可选第二参checkInterfaceSupport修复getName的反向解析。七、交易与合约中间件、populateTransaction 与 gas 修复TransactionMiddleware 生态4.10.0 / 4.11.04.10.0#7088web3-eth的sendTransaction位于 packages/web3-eth/src/rpc_method_wrappers.ts接受可选TransactionMiddleware参数WebEth新增setTransactionMiddleware/getTransactionMiddleware实现自动透传。4.11.0#7138合约的deploy与send同样支持中间件且web3.eth.Contract会自动继承web3.eth上设置的中间件——这在 packages/web3/src/web3.ts 的ContractBuilder构造器中可见若eth.getTransactionMiddleware()非空则super.setTransactionMiddleware(...)。4.10.0#7088还让web3 中已注册的包可通过 context 被插件复用这为 tools/web3-plugin-example 这类插件开发提供了基础。populateTransaction4.11.0 / 4.12.0合约方法与contract.deploy(...)均新增populateTransaction#7124 / #7197用于在不发送交易的情况下产出完整的交易参数对象4.12.0 中deploy(...)的返回属性重构为由新类DeployerMethodClass组织packages/web3-eth-contract/src/contract-deployer-method-class.ts。gas 相关修复4.9.0#7043checkRevertBeforeSending在交易无data/input/gas时将gas填充为21000简单转账场景。对应实现见 packages/web3-eth/src/utils/send_tx_helper.ts。4.9.0#7050网络返回baseFeePerGas 0x0时用getGasPrice填充maxPriorityFeePerGas与maxFeePerGas。4.9.0#7000emitConfirmation、waitForTransactionReceipt、watchTransactionByPolling等方法新增customTransactionReceiptSchema参数。八、合约与 ABI解码、重载与 EIP 相关类型4.8.0#6950新增contract.deploy(...).decodeData(...)与contract.decodeMethodData(...)基于 ABI 解码数据。4.8.0#6922修复智能合约函数重载问题并在重载调用产生歧义时输出控制台警告#6942。4.11.0#7095修复 EIP-712 的encodeData更新web3-eth-accounts的baseTransaction方法。4.15.0#7345web3-eth-abi新增decodeFunctionCall与decodeFunctionReturn。4.8.0#6933getBlock返回值与withdrawalsSchema、blockSchema、blockHeaderSchema类型同步覆盖 EIP-4844 / EIP-4895 / EIP-4788 字段blob、withdrawals、parentBeaconBlockRoot 等web3-types的Withdrawals、Block、BlockHeaderOutput同步更新。相关实现可继续查阅 packages/web3-eth/src/schemas.ts 与 packages/web3-eth-abi/src。九、过滤器Filter方法导出4.15.0#7353Web3Eth与 packages/web3-eth/src/filtering_rpc_method_wrappers.ts 导出以下方法createNewPendingTransactionFiltercreateNewFiltercreateNewBlockFilteruninstallFiltergetFilterChangesgetFilterLogs同时web3-types新增FilterParams类型#7353用于构造过滤条件。十、工具链与依赖维护web3-utils / web3-validator 的关键修复toWei支持科学计数法、支持整数作为单位、对可能精度丢失的大数/大精度输入输出警告#6908 / #7053 / #6908fromWei在输入为0时返回0#7387多维定长数组在 ABI 解析时被正确处理#6798ABI 无name如 public mappings时 JSON schema 转换能正确分配 id#6981web3-validator移除了指向不存在 bundle 文件的browser入口#7015。实现入口分别在 packages/web3-utils/src/converters.ts、packages/web3-validator/src。TypeScript 4 → 5#72724.16.0将web3、web3-core、web3-eth、web3-eth-contract、web3-eth-accounts、web3-eth-abi、web3-errors、web3-utils、web3-rpc-providers全线升级至 TypeScript 5此前 4.0.2 已修复 TypeScript v5 下的编译问题#6195与types/ws问题#6205。错误与 provider 细节4.11.1修复Eip838ExecutionError构造器中data未定义的问题#6905。4.12.0web3-providers-http的ResponseError增加可选statusCode属性web3-errors同步见 packages/web3-errors/src/errors。4.12.1回滚TransactionFactory.registerTransactionType的全局extraTxTypes方案以解决 Next.js 兼容问题#7216。4.14.0syncing订阅支持 Besu / Nethermind 负载格式baseFeePerGas类型在web3.eth.getFeeHistory中改为number#7291。十一、其他值得关注的能力4.1.1#6336为 Web3 引入不同超时值的能力修复 #6190。4.1.2修复不正确的 provider 警告行为。4.4.0 ~ 4.5.0依赖更新细节见根 CHANGELOG即仓库根目录 CHANGELOG.md。4.16.0web3-account-abstraction发布 RC账户抽象相关能力。4.10.0web3-rpc-providers发布 RC4.12.0 增加Web3ExternalProvider/QuickNodeProvider的可选 provider 配置参数与 HTTP 传输限流错误更新。结语从 CHANGELOG 到源码的阅读路径packages/web3/CHANGELOG.md不只是版本流水账它事实上是理解 web3.js 4.x 架构决策的索引。推荐的阅读路径导出体系→ packages/web3/src/index.ts构造器与模块装配→ packages/web3/src/web3.tsEIP-6963 实现→ packages/web3/src/web3_eip6963.ts全局配置项→ packages/web3-core/src/web3_config.ts交易填充与 gas 逻辑→ packages/web3-eth/src/utils/send_tx_helper.ts行为验证→ packages/web3/test/integration/web3.test.ts、packages/web3/test/unit/web3eip6963.test.ts升级 1.x 项目的读者可配合 docs/docs/guides/15_web3_upgrade_guide/index.md 及其中各子指南accounts、contracts、providers 等迁移指南完成系统迁移EIP-6963 应用可参考 docs/docs/guides/02_web3_providers_guide/eip6963.md。赞分享区块链Web3【免费下载链接】web3.jsCollection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.项目地址https://gitcode.com/gh_mirrors/we/web3.js点击查看免费下载相关推荐web3.eth 迁移指南从 web3.js 1.x 升级到 4.x 的破坏性变更全解析web3.eth 迁移指南从 web3.js 1.x 升级到 4.x 的破坏性变更全解析 本指南是 web3.js 1.x 升级到 4.x 系列文档的核心部分区块链Web3web3.js 1.x 到 4.x 合约迁移指南web3.eth.Contract 全面升级解析web3.js 1.x 到 4.x 合约迁移指南web3.eth.Contract 全面升级解析 本文基于 web3.js 仓库中的 contracts_mi区块链Web3web3-eth-personal 4.x 版本演进全解析从 CHANGELOG 看 Ethereum 账户管理模块的架构重构与最佳实践web3 eth personal 4.x 版本演进全解析从 CHANGELOG 看 Ethereum 账户管理模块的架构重构与最佳实践 导读 web3 et区块链Web3创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考