Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

kinecosystem/kin-ios

Repository files navigation

Deprecation Warning

Kins's Agora powered SDKs have been deprecated and Agora replaced with Kinetic.

Kinetic

Kinetic is an open-source suite of tools that make it easy to build apps that integrate Solana.

It provides a consistent and clean abstraction over the Solana SDKs and enhances it with some commonly requested features like paying Solana fees on behalf of the user, tracking and timing the users transactions and sending out webhooks.

Kinetic is aimed at developers that want to build crypto-experiences for the users of their app, hiding a lot of the details about the blockchain out of sight for both the developer and the end user.

Learn more about Kinetic here.

See our new suite of Kinetic SDK's here.

Kin SDK iOS

Swift Version codecov CircleCI jazzy CocoaPods

Use the Kin SDK for iOS to enable the use of Kin inside of your app. Include only the functionality you need to provide the right experience to your users. Use just the base library to access the lightest-weight wrapper over the Kin cryptocurrency.

Looking for a quick way to start?

The quickest way to get started is by following the tutorial or by downloading the starter kit.

Repository Contents

Library Path Description
KinBase /KinBase The foundation library used by all other libraries in the system to support basic Kin operations:
  • Wallet creation and management
  • Send and receive Kin
KinDesign /KinDesign The shared KinDesign library components for creating consistent Kin user experiences. When creating a custom Kin experience, this library can be used to include standard UI components for displaying Kin prices, transactions, etc.
KinUX /KinUX The KinUX library provides an out of the box model UI for spending Kin within an iOS application. Specificy what you're buying, your account, tap confirm. Success.

Installation

In your Podfile

// If you just want to access the blockchain & no UI
pod 'KinBase', '~> 2.1.3'

// Add spend to use the modal spend flow to allow users to buy things with Kin
pod 'KinUX', '~> 2.1.3'

// Add design for direct access to UI views you can use in your own app
pod 'KinDesign', '~> 2.1.3'

Sample App

The /KinSampleApp directory includes a sample application. On the home screen of the sample app, you will see options to view Kin Wallet Demo and Kin Design Demo.

Documentation

Jazzy Documentation for all classes in all modules located here

Apps using legacy versions

For specific instructions related to migrating from older versions, see the migration help document.