NimiqClient 0.0.2

NimiqClient 0.0.2

×

由 rraallvv 维护。

NimiqClient 0.0.2

  • 由
  • Nimiq 社区

Nimiq Swift 客户端

Build Status Swift PM Cocoapods version Platforms

是 Nimiq RPC 客户端规范 Swift 实现。

使用

使用 NimiqClient 对象向 Nimiq 节点发送请求。

let config = Config(
    scheme: "http",
    host: "127.0.0.1",
    port: 8648,
    user: "luna",
    password: "moon"
)

let client = NimiqClient(config: config)

客户端设置完成后，我们可以通过合适参数调用方法向 Nimiq 节点发送请求。

如果初始化时未传入 config 对象，则将使用 Nimiq 节点的默认设置。

let client = NimiqClient()

// make rpc call to get the block number
let blockNumber = client.blockNumber()

print(blockNumber) // displays the block number, for example 748883

API

完整的 API 文档可在 /docs 文件夹中找到。

请查看 Nimiq RPC 规范 以了解幕后 RPC 调用。

安装

Swift 包管理器

推荐通过 Swift 包管理器 (SPM) 安装 Nimiq Swift 客户端。SPM 是 Xcode 内置的一个依赖管理工具，允许您直接从 IDE 中添加 Swift 包作为依赖项。

在 Xcode 中从您的项目或工作区进入 文件 > Swift 包 > 添加包依赖。如果是一个工作区，请选择要添加包依赖的项目。然后输入此包的仓库 URL（例如 https://github.com/rraallvv/NimiqClientSwift）。从包提供的版本中选择一个版本号，然后点击下一步。然后选择要包含依赖项的目标产品。

CocoaPods

此外，您还可以使用 CocoaPods 安装 Nimiq Swift 客户端。CocoaPods 是一个针对 Xcode 项目的命令行界面依赖管理工具。

如果您尚未安装 CocoaPods，请先进行安装

# Install CocoaPods
$ sudo gem install cocoapods

为了在项目中启用 CocoaPods，关闭 Xcode 并在项目目录中运行

$ pod init

然后您可以通过修改创建的 Podfile 将 Nimiq Swift 客户端作为依赖项添加。要打开文件进行编辑，从命令行运行 open -a Xcode Podfile 并按照如下方式进行编辑

target "MyApp" do
    pod 'NimiqClient'
end

最后，使用 CocoaPods 命令行安装所有依赖项

pod install

有关如何安装 CocoaPods 以及如何配置 Xcode 项目的依赖项的更多信息，请参阅 CocoaPods.org。

贡献

此实现最初由 rraallvv 贡献。

请以拉取请求的形式提交您的贡献。

有关想法，请参考 问题跟踪器。

开发

在克隆存储库后，打开 NimiqClient/NimiqClient.xcworkspace 中的工作区文件，而不是项目文件。

完成，祝您编码愉快！

测试

测试存放在/Tests文件夹中，并可以从Xcode中运行。

文档

文档通过从仓库根目录运行Jazzy自动生成。要安装Jazzy运行

$ gem install jazzy

要生成文档运行

$ jazzy

许可证

MIT