Swift Package Index


A framework for communicating with a Stellar Horizon node


  • The latest stable release is 0.9.15. Released 2 years ago.
  • The last commit to master was over 1 year ago.

Swift Version Compatibility

  • 0.9.15 and master
    5.3
    5.2
    5.1
    5.0
    4.2
Full build results

Platform Compatibility

  • 0.9.15 and master
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS
Full build results

StellarKit

A framework for interacting with the Stellar blockchain network. StellarKit communicates with Horizon nodes.

Concepts

Accounts

Stellar represents an account as an ED25519 key-pair. The public key represents the account on the network, and the secret key is used only for signing transactions.

The textual representation of a public key uses the following format:

G<base32 representation of key + 2 byte CRC>

Example: GCDXVSRN7TORSWS6N3FEHV3KUKGK4F74ZJDRENEAKVDWXIEFR5BOKMGK

Assets

An asset represents a transferable unit. Stellar uses a native unit, called a Lumen, which is used for paying transaction fees and account maintenance. The network also supports non-native, or user-defined, assets, which are identified via a code and an issuer.

An asset issuer is an account which has been trusted to issue an asset.

Trust

In order to receive a non-native asset, an account must trust the issuer. This allows multiple assets with the same code to coexist.

Design

StellarKit exposes Stellar, which is a stateless struct with static methods. In addition to method-specific parameters, each method takes a parameter called node, of type Stellar.Node.

Stellar.Node
struct Node {
    let baseURL: URL
    let networkId: NetworkId
}
  • baseURL is the URL of the Horizon node. It is used to construct URLs for Horizon API end-points.
  • networkId identifies the Stellar network to which the Horizon node belongs.
NetworkId
enum NetworkId {
    case test
    case main
    case custom(String)
}

Stellar identifies a network via a pre-defined string. The Stellar Development Foundation runs two public networks. One is the live network, and the other is for testing. Developers may establish private networks, using their own identifiers.

  • test represents the Stellar Foundation's test net.
  • main represents the Stellar Foundation's public (live) net.
  • custom allows a user-defined identifier to be provided, to be used with private networks.
Account
public protocol Account {
    var publicKey: String? { get }

    var sign: (([UInt8]) throws -> [UInt8])? { get }
}

StellarKit does not contain an implementation of the account concept. Instead, it relies on the Account protocol to provide the required functionality.

  • publicKey is the string representation of the account's public key, as described in the Concepts section.
  • sign is a closure which accepts a Data object to be signed, and returns the signature.

This design allows StellarKit to remain agnostic with respect to encryption implementations and account storage mechanisms. It also avoids 3rd-party dependencies, as iOS (and macos) have no native implementations of ED25519 algorithms.

Promises

Most Stellar methods return a Promise, which is an abstraction over asynchronous processes which allows for chaining actions. StellarKit uses a minimal implementation provided by KinUtil, to avoid 3rd-party dependencies.

Functionality

At this time, StellarKit supports the following operations:

  • making payments
  • retrieving balances
  • trusting non-native assets
  • retrieving account details
  • observing changes

Inline documentation describes how to use each method.

Getting Started

The Stellar network is designed for the usage of non-native assets. This section describes how to prepare an account to send and receive such assets.

  1. Create the account on the network.

    This operation requires a funding account which has sufficient Lumens to provide the necessary reserve. It is customary to provide extra to allow the account to pay transaction fees. This operation is typically performed by a service, and is outside the scope of this framework.

  2. Trust the asset.

    This operation is performed by Stellar.trust(...).

    public static func trust(asset: Asset,
                             account: Account,
                             configuration: Configuration) -> Promise<String>