TezosKit 4.0.1

TezosKit 4.0.1

Maintained by Keefer Taylor.



TezosKit 4.0.1

  • By
  • Keefer Taylor

TezosKit

Build Status codecov Carthage Compatible Version License

TezosKit is a swift SDK that is compatible with the Tezos Blockchain. TezosKit implements complex interaction with the blockchain, including:

  • Performing preapplication for operations
  • Automatically revealing accounts as needed
  • Batching multiple operations

TezosKit provides native functionality to interact with a Tezos node or Conseil, an indexing service. TezosKit supports interaction with the chain via both closure based callbacks and Promises (PromiseKit) functionality.

TezosKit is compatible with both CocoaPods and Carthage. See the installation section below for specific instructions.

QuickStart

Wallets and Accounts

Accounts in Tezos are represented with Wallet objects.

To make a new wallet:

let wallet = Wallet()!
print("The wallet's mnemonic is \(wallet.mnemonic)")

To restore a wallet:

let mnemonic = ...
let wallet = Wallet(mnemonic: mnemonic)!

Interacting with the Tezos Node

The TezosNodeClient class supports interacting with a Tezos Node. Interaction can be done with closure callbacks or Promises.

let tezosNodeClient = TezosClient()

// Closure completion handler
tezosNodeClient.getBalance(address: "KT1BVAXZQUc4BGo3WTJ7UML6diVaEbe4bLZA") { result in
  switch result {
  case .success(let balance):
    print("The balance of the contract is \(balance.humanReadableRepresentation)")
  case .failure(let error):
    print("Error getting balance: \(error)")
  }
}

// PromiseKit Promises
tezosNodeClient.getBalance(address: "KT1BVAXZQUc4BGo3WTJ7UML6diVaEbe4bLZA").done { balance in
  print("The balance of the contract is \(balance.humanReadableRepresentation)")
} .catch { _ in
  print("Couldn't get balance.")
}

Learn more about interacting with a Tezos Node in the Tezos Node Documentation.

Interacting with Conseil

The ConseilClient class supports interacting with a Conseil service. Interaction can be done with closure callbacks or Promises.

let conseilClent = ConseilClient(...)
let address = "tz1iZEKy4LaAjnTmn2RuGDf2iqdAQKnRi8kY"

// Closure completion handler
conseilClient.originatedAccounts(from: address) { result in
  switch result {
    case .success(let originatedAccounts):
      print("Originated Accounts:")
      print(result)
    case .failure(let error):
      print("Error fetching originated accounts: \(error)")
  }
}

// PromiseKit Promises
conseilClient.originatedAccounts(from: address).done { result in
  print("Originated Accounts:")
  print(result)
} .catch { error in
  print("Error fetching originated accounts: \(error)")
}

Learn more about interacting with a Conseil Service in the Conseil Documentation.

Advanced Usage

TezosKit is highly extensible for the needs of any individual project. Projects can customize RPCs and operations that are sent to the node. You can learn more about customizing TezosKit's behavior in the Advanced Usage Documentation.

Installation

You may use either Carthage or Cocoapods to depend on TezosKit.

CocoaPods

TezosKit supports installation via CocoaPods. You can depened on TezosKit by adding the following to your Podfile:

pod "TezosKit"

Carthage

If you use Carthage to manage your dependencies, simply add TezosKit to your Cartfile:

github "keefertaylor/TezosKit"

If you use Carthage to build your dependencies, make sure you have added Base58Swift.framework, BigInt.framework, MnemonicKit.framework, and PromiseKit.framework, Sodium.framework and TezosCrypto.framework, to the "Linked Frameworks and Libraries" section of your target, and have included them in your Carthage framework copying build phase.

Bugs / Contributions

If you enounter bugs or missing features in TezosKit, please feel free to open a GitHub issue. You may want to check if the work you are suggesting is planned in future work.

Contributions and bug fixes are appreciated. Please open a PR for any missing or erroneous functionality for which you can contribute a fix.

License

TezosKit is licensed under the permissive MIT licence.

See Also

  • TezosCrypto: A swift implementation of Tezos Cryptography