OmiseGO iOS SDK
OmiseGO iOS SDK 允许开发者轻松与 OmiseGO eWallet 交互。此 SDK 被拆分为 3 个 Cocoapods 子规范:Core(核心)、Client(客户端)和 Admin(管理员)。Core 是一个通用依赖项,其中包含共享逻辑。客户端和管理员模块包含分别访问客户端或管理员 API 的特定逻辑。
目录
需求
- iOS 10.0+
- Xcode 10.2+
- Swift 5.0
此版本的 SDK 与 eWallet 的版本 1.2.0
兼容。
安装
CocoaPods
CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令安装它
gem install cocoapods
如果您正在使用 Cocoapods 整合 SDK,则可以利用 subspec 进行 SDK 特定部分的分离整合。
如果您只需要整合和支持 Client
API,那么您可以通过在 Podfile
中添加以下行来添加仅 Client
subspec
pod 'OmiseGO/Client'
或者如果您仅想支持 Admin
API,则可使用
pod 'OmiseGO/Admin'
或者如果您需要两者,简单使用
pod 'OmiseGO'
或者您也可以指定版本 ([了解更多关于 Podfile](https://guides.cocoapods.org.cn/using/the-podfile.html))
pod 'OmiseGO', '~> 1.2'
然后,运行以下命令
$ pod install
Carthage
Carthage 是 Cocoa 的简单、去中心化依赖管理器。
brew install carthage
要使用 Carthage 将OmiseGO SDK整合到您的 Xcode 项目中,请在您的 Cartfile
中添加以下行
github "omisego/ios-sdk"
然后,运行以下命令
carthage update --platform ios
将构建的 OmiseGO.framework
拖入您的 Xcode 项目。
使用方法
测试
为了运行实时测试(绑定到运行中的服务器),您需要填写相应变量的 plist 文件 secret.plist
。
注意:这些键也可以作为环境变量提供,这使得 CI 运行更容易、更安全,因为您无需在源代码中保留它们。
这些变量是
OMG_BASE_URL
OMG_WEBSOCKET_URL
OMG_API_KEY
OMG_AUTHENTICATION_TOKEN
OMG_TOKEN_ID
您可以使用以下命令例如运行测试
构建命令:xcodebuild -workspace "OmiseGO.xcworkspace" -scheme "OmiseGO" -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone X' OMG_BASE_URL="https://your.base.server.url" OMG_API_KEY="yourAPIKey" OMG_AUTHENTICATION_TOKEN="yourTestAuthenticationToken" OMG_TOKEN_ID="aTokenId" OMG_WEBSOCKET_URL="wss://your.base.socket.url" test
依赖项
运行SDK需要以下两个依赖项。
- Starscream 用于管理WebSocket
- BigInt 用于管理大数
贡献
查看如何参与贡献的说明。
许可证
OmiseGO iOS SDK 在Apache License下发布。