Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewbarba/lisk-swift
Swift 4 library for Lisk - Including Local Signing for maximum security
https://github.com/andrewbarba/lisk-swift
bitcoin cryptocurrency ios lisk lsk macos swift tvos watchos
Last synced: 2 months ago
JSON representation
Swift 4 library for Lisk - Including Local Signing for maximum security
- Host: GitHub
- URL: https://github.com/andrewbarba/lisk-swift
- Owner: AndrewBarba
- License: apache-2.0
- Created: 2017-12-11T17:06:13.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-15T16:52:02.000Z (over 6 years ago)
- Last Synced: 2024-05-02T06:00:55.551Z (8 months ago)
- Topics: bitcoin, cryptocurrency, ios, lisk, lsk, macos, swift, tvos, watchos
- Language: Swift
- Homepage: https://lisk.io
- Size: 1.65 MB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Lisk Swift
==========
[](https://www.bitrise.io/app/b15eedbea467ee22)
[](https://img.shields.io/cocoapods/v/Lisk.svg)
[](https://github.com/Carthage/Carthage)
[](http://twitter.com/andrew_barba)
Lisk Swift is a Swift 4 library for Lisk - the cryptocurrency and blockchain application platform. It allows developers to create offline transactions and broadcast them onto the network. It also allows developers to interact with the core Lisk API, for retrieval of collections and single records of data located on the Lisk blockchain. Its main benefit is that it does not require a locally installed Lisk node, and instead utilizes the existing peers on the network. It can be used on any environment that runs Swift 4, including iOS, tvOS, macOS, watchOS.
Lisk Swift is heavily inspired by [Lisk JS](https://github.com/LiskHQ/lisk-js)
## Features
- [x] Local Signing for maximum security
- [x] Targets Lisk 1.0.0 API
- [x] Directly based on lisk-js
- [x] Swift 4.0
- [x] Unit Tests (87% coverage)
- [x] Documentation
## API
- [Accounts](https://andrewbarba.github.io/lisk-swift/Structs/Accounts.html)
- [Blocks](https://andrewbarba.github.io/lisk-swift/Structs/Blocks.html)
- [Delegates](https://andrewbarba.github.io/lisk-swift/Structs/Delegates.html)
- [Loader](https://andrewbarba.github.io/lisk-swift/Structs/Loader.html)
- [Peers](https://andrewbarba.github.io/lisk-swift/Structs/Peers.html)
- [Signatures](https://andrewbarba.github.io/lisk-swift/Structs/Signatures.html)
- [Transactions](https://andrewbarba.github.io/lisk-swift/Structs/Transactions.html)
## Documentation
[https://andrewbarba.github.io/lisk-swift/](https://andrewbarba.github.io/lisk-swift/)
## Usage
### Import Framework
```swift
import Lisk
```
### Send LSK
```swift
let address = ...
let secret = ...
// Send LSK on the Mainnet
Transactions().transfer(lsk: 1.12, to: address, secret: secret) { response in
switch response {
case .success(let result):
print(result.transactionId)
case .error(let error):
print(error.message)
}
}
```
#### Send LSK on Testnet
```swift
let address = ...
let secret = ...
// Send LSK on the Testnet
Transactions(client: .testnet).transfer(lsk: 1.12, to: address, secret: secret) { response in
switch response {
case .success(let result):
print(result.transactionId)
case .error(let error):
print(error.message)
}
}
```
### Testnet
By default, all modules are initialized with an `APIClient` pointing to the Lisk Mainnet. You can optionally pass in a specific client to any modules constructor:
```swift
let mainTransactions = Transactions()
let testTransactions = Transactions(client: .testnet)
```
To default all modules to a specific client you can set the shared client:
```swift
APIClient.shared = .testnet
```
And then all modules initialized will default to Testnet:
```swift
// This will connect to Testnet
let transactions = Transactions()
```
## Requirements
- iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
- Xcode 9.0+
- Swift 4.0+
## Installation
### Swift Package Manager
```swift
// swift-tools-version:4.0
import PackageDescription
let package = Package(
name: "My Lisk App",
dependencies: [
.package(url: "https://github.com/AndrewBarba/lisk-swift.git", from: "1.0.0-beta")
]
)
```
### CocoaPods
> CocoaPods 1.1.0+ is required to build lisk-swift
```ruby
pod 'Lisk', '~> 1.0.0-beta'
```
### Carthage
```ogdl
github "AndrewBarba/lisk-swift" ~> 1.0.0-beta
```
## Thank You
To show support for continued development feel free to vote for my delegate: [andrew](https://explorer.lisk.io/delegate/14987768355736502769L)
Or donate LSK to `14987768355736502769L`