Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kinecosystem/kin-core-ios
An SDK for managing KIN on iOS.
https://github.com/kinecosystem/kin-core-ios
Last synced: 3 months ago
JSON representation
An SDK for managing KIN on iOS.
- Host: GitHub
- URL: https://github.com/kinecosystem/kin-core-ios
- Owner: kinecosystem
- License: other
- Archived: true
- Created: 2018-01-23T11:41:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-19T07:30:40.000Z (over 5 years ago)
- Last Synced: 2024-07-20T16:09:50.172Z (4 months ago)
- Language: Swift
- Size: 34.8 MB
- Stars: 11
- Watchers: 10
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.pdf
Awesome Lists containing this project
README
# KinSDK
A library for using Kin.
## Installation
#### CocoaPods
Add the following to your `Podfile`.
```
pod 'KinSDK'
```
#### Sub-project
1. Clone this repo (as a submodule or in a different directory, it's up to you).
```
git clone --recursive https://github.com/kinfoundation/kin-core-ios
```
2. Drag `KinSDK.xcodeproj` as a subproject.
3. In your main `.xcodeproj` file, select the desired target(s).
4. Go to **Build Phases**, expand Target Dependencies, and add `KinSDK`.
5. In Swift, `import KinSDK` and you are good to go! (We haven't yet tested Objective-C.)
This is how we did the Sample App - you might look at the setup for a concrete example.
## API Usage
The SDK exposes two classes, `KinClient`, and `KinAccount`.
### KinClient
`KinClient` stores the configuration for the network, and is responsible for managing accounts.
```swift
let kinClient = KinClient(with: URL, networkId: NetworkId)
```
##### Account Management
```swift
public func addAccount() throws -> KinAccount
public func deleteAccount(at index: Int) throws
public private(set) var accounts: KinAccounts
```
---
### KinAccount
Before an account can be used on the configured network, it must be funded with the native network currency. This step must be performed by a service, and is outside the scope of this SDK.
Before an account can receive KIN, it must be activated.
```swift
account.activate(completion: { txHash, error in
if error == nil {
// report success
}
})
```
##### KIN
To retrieve the account's current balance:
```swift
func balance(completion: @escaping BalanceCompletion)
```
To obtain a watcher object which will emit an event whenever the account's balance changes. See the Sample App for an example.
```swift
func watchBalance(_ balance: Decimal?) throws -> BalanceWatch
```
To send KIN to another user:
```swift
func sendTransaction(to recipient: String,
kin: Decimal,
memo: String?,
completion: @escaping TransactionCompletion)
```
The `memo` field can contain a string up to 28 characters in length. A typical usage is to include an order# that a service can use to verify payment.
---
##### Miscellaneous
```swift
var publicAddress: String { get }
```
The account's address on the network. This is the identifier used to specify the destination for a payment, or to request account creation from a service.
```swift
func status(completion: @escaping (AccountStatus?, Error?) -> Void)
```
Preparing an account for use is a two-step process.
1. Creating the account. This is done by an external service.
2. Activating the account. This is done using the API mentioned above.
To obtain the current status of the account, call the above API.
#### Other Methods
Both `KinClient` and `KinAccount` have other methods which should prove useful. Specifically, `KinAccount` has alternative methods for many operations that are either synchronous, or return a Promise, instead of using a completion handler.
## Error handling
`KinSDK` wraps errors in an operation-specific error for each method of `KinAccount`. The underlying error is the actual cause of failure.
### Common errors
`StellarError.missingAccount`: The account does not exist on the Stellar network. You must create the account by issuing a `CREATE_ACCOUNT` operation with `KinAccount.publicAddress` as the destination. This is done using an app-specific service, and is outside the scope of this SDK.
`StellarError.missingBalance`: For an account to receive KIN, it must trust the KIN Issuer. Call `KinAccount.activate()` to perform this operation.
## Contributing
Please review our [CONTRIBUTING.md](CONTRIBUTING.md) guide before opening issues and pull requests.
## License
This repository is licensed under the [Kin Ecosystem SDK License](LICENSE.pdf).