web3swift

web3swift 是一个用于与以太坊网络交互的 iOS 工具包。

加入我们的 discord 或 Telegram，如果您需要支持或想为 web3swift 开发做贡献！

• 核心功能
• 安装
  • Swift Package
  • CocoaPods
• 使用示例
  • 发送以太币
  • 合约读取方法
  • 写入交易并调用智能合约方法
  • 向节点发送网络请求
• 从源代码构建
  • SPM
• 系统要求
• 文档
• 正在使用 web3swift 的项目
• 支持
• 贡献
  • 贡献
• 鸣谢
• 安全漏洞披露
• 许可证

• ⚡ web3.js 功能的 Swift 实现
• 💭 通过 JSON RPC 与远程节点交互
• 🔐 本地 keystore 管理（兼容 geth）
• 🤖 智能合约 ABI 解析
• 🔓ABI 解码（V2 版本支持从公共函数返回结构体。属于 0.4.22 Solidity 编译器的一部分）
• 🕸 以太坊名称服务 (ENS) 支持 - 一种安全且去中心化的方式，使用简单、人类可读的名称来寻址链上和链下资源
• 🔄 智能合约交互（读取/写入）
• ⛩ Infura 支持
• ⚒ 将 TxPool 内容解析为原生值（以太坊地址和交易）- 轻松获取待处理交易
• 🖇 事件循环功能
• 🕵️‍♂️ 可以添加或删除“中间件”，在“组装前”、“组装后”和“提交前”阶段拦截、修改甚至取消交易工作流程
• ✅严格遵循标准（BIP、EIP 等）
  • BIP32（HD 钱包）、BIP39（助记词）、BIP44（密钥生成前缀）
• EIP-20（代币标准接口 - ERC-20）、EIP-67（标准 URI 方案）、EIP-155（重放攻击保护）、EIP-2718（类型化交易信封）、EIP-1559（Gas 费市场变更）
  • 以及其他许多标准 （有关这些 EIP 的详细信息，请查看 文档 页面）：EIP-165、EIP-681、EIP-721、EIP-777、EIP-820、EIP-888、EIP-1155、EIP-1376、EIP-1400、EIP-1410、EIP-1594、EIP-1633、EIP-1643、EIP-1644、EIP-4361 (SIWE)、ST-20
• RLP 编码
• Base58 编码方案
• 以太坊单位的格式化转换
• 全面的单元和集成测试覆盖

Swift Package Manager 是一个用于自动化 Swift 代码分发的工具，它与 Swift 构建系统良好集成。

一旦您设置了 Swift 包，添加 web3swift 作为依赖项就像将其添加到您的 Package.swift 的 dependencies 值一样简单。

dependencies: [
    .package(url: "https://github.com/web3swift-team/web3swift.git", .upToNextMajor(from: "3.0.0"))
]

或者，如果您的项目不是包，请按照这些指南了解 如何将 Swift Package 添加到您的 Xcode 项目中。

在导入部分

import web3swift
import Web3Core

CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令安装它

$ sudo gem install cocoapods

要使用 CocoaPods 将 web3swift 集成到您的 Xcode 项目中，请在您的 Podfile 中指定它

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'

target '<Your Target Name>' do
    use_frameworks!
    pod 'web3swift'
end

然后，运行以下命令

$ pod install

警告：CocoaPods 是一个用于管理 iOS 开发中依赖项的强大工具，但它也有一些限制，妨碍我们在此处提供一流的支持。我们强烈建议首先使用 SPM，因为使用 CocoaPods 会延迟向您交付新的更新和错误修复。

let transaction: CodableTransaction = .emptyTransaction
transaction.from = from ?? transaction.sender // `sender` one is if you have private key of your wallet address, so public key e.g. your wallet address could be interpreted
transaction.value = value
transaction.gasLimitPolicy = .manual(78423)
transaction.gasPricePolicy = .manual(20000000000)
web3.eth.send(transaction)

let contract = web3.contract(Web3.Utils.erc20ABI, at: receipt.contractAddress!)!
let readOp = contract.createReadOperation("name")!
readOp.transaction.from = EthereumAddress("0xe22b8979739D724343bd002F9f432F5990879901")
let response = try await readTX.callContractMethod()

let abiString = "[]" // some ABI string
let bytecode = Data.fromHex("") // some ABI bite sequence
let contract = web3.contract(abiString, at: nil, abiVersion: 2)!
let parameters: [Any] = [...]
let deployOp = contract.prepareDeploy(bytecode: bytecode, constructor: contract.contract.constructor, parameters: parameters)!
deployOp.transaction.from = "" // your address
deployOp.transaction.gasLimitPolicy = .manual(3000000)
let result = try await deployTx.writeToChain(password: "web3swift")

func feeHistory(blockCount: UInt, block: BlockNumber, percentiles:[Double]) async throws -> Web3.Oracle.FeeHistory {
    let requestCall: APIRequest = .feeHistory(blockCount, block, percentiles)
    let response: APIResponse<Web3.Oracle.FeeHistory> = try await APIRequest.sendRequest(with: web3.provider, for: requestCall) /// explicitly declaring `Result` type is **required**.
    return response.result
}

git clone https://github.com/web3swift-team/web3swift.git
cd web3swift
swift build

• iOS 13.0 / macOS 10.15
• Xcode 12.5
• Swift 5.5

文档正在建设中👷🏻👷🏼‍♀️。我们正在尽力详细注释所有公共 API，但最终目标仍然遥远。但在最近的次要更新之一中，我们将为已完成的文档量带来 DocC 支持。并且非常欢迎您在这方面的 PR。

请查看我们的客户 wiki 页面。

如果您需要支持或想为 web3swift 开发做贡献，请加入我们的 discord 和 Telegram！

• 如果您需要帮助，请查看我们的 FAQ 或 打开一个 issue。
• 如果您想查看 web3swift 的最佳实践，请查看正在使用 web3swift 的项目。
• 如果您发现了一个错误，打开一个 issue。

为了进行本地开发并运行本地测试，我们建议使用 ganache，这也是 CI 在运行 github actions 时使用的工具。

// To install
$ npm install ganache --global

// To run
$ ganache

这将创建一个本地区块链以及一些在我们的测试中使用的测试帐户。请确保 ganache 在其默认端口 8546 上运行。要在测试用例中更改端口，请找到 LocalTestCase.swift 并修改静态 url 变量。

我们正在使用 pre-commit 在创建提交之前在本地运行验证。请安装 pre-commit 并从项目根目录运行 pre-commit install。之后，每次提交之前，git hook 将运行并执行 codespell、swiftlint 和其他检查。

想要改进吗？太棒了：那么这对您来说是个好消息：我们准备通过 @gitcoin bot 为您的贡献付费！

• 如果您有功能请求，请打开一个 issue。
• 如果您想贡献，请提交一个 pull request。

1. 非常欢迎您参与并通过贡献获得赏金！您的贡献将通过 @gitcoin Grant 计划获得报酬。
2. 查找或创建一个 issue
3. 您可以在 Gitcoin Bounties 列表中找到开放的赏金
4. 在分支中提交修复或新功能，推送您的更改
5. 提交一个 pull request 到 develop 分支
   1. 请提供详细的描述，以帮助我们更快地处理它。

@skywinder 负责开源，并且不要求使用 web3swift 库的用户付费。我们希望继续尽一切努力推动发展。

• 通过 @gitcoin Grant 计划支持我们
• 以太币钱包地址：0x6A3738c6299f45c31697aceA647D49EdCC9C28A4

• Alex Vlasov, @shamatar - 用于初始实现
• Petr Korolev, @skywinder - 引导和持续支持
• Anton Grigorev, @baldyash - 核心贡献者，使用它并进行了许多改进
• Yaroslav Yashin @yaroslavyaroslav - 3.0.0 及更高版本的核心贡献者。
• 感谢 web3swift 不断增长的贡献者列表。

如果您认为自己发现了 web3swift 的安全漏洞，应尽快通过电子邮件 web3swift@oxor.io 报告。请不要将其发布到公共 issue 跟踪器。

web3swift 在 Apache License 2.0 许可证下可用。有关详细信息，请参阅 LICENSE。