SuiKit is a Swift SDK natively designed to make developing for the Sui Blockchain easy.

• Features
• ToDo
• Requirements
• Installation
  • Swift Package Manager
    • SPM Through Xcode Project
    • SPM Through Xcode Package
• Using SuiKit
• Development and Testing
• Next Steps
• Credits
• License

Features

• Submitting transactions.
• Transferring objects.
• Transfer Sui.
• Air drop Sui tokens.
• Merge and Split coins.
• Publish modules.
• Transfer objects.
• Execute move calls.
• Retrieving objects, transactions, checkpoints, coins, and events.
• Local Transaction Building.
• Local, custom, dev, test, and main net compatiblity.
• ED25519, SECP256K1, SECP256R1, and zkLogin Key and HD Wallet generation.
• SuiNS support.
• Kiosk Support.
• Native Swift BCS Implementation.
• Comprehensive Unit and End To End Test coverage.

ToDo

• Complete documentation of SuiKit.
• Implement Resolve Name Service Names.
• Reimplementation of GitHub Action workflows for Swift versions 5.9 - 6.0.
• Reimplementation of GraphQL Endpoints for Swift 6.0 Concurrency Restrictions

Requirements

Platform	Minimum Swift Version	Installation	Status
iOS 17.0+ / macOS 14.0+ / tvOS 17.0+ / watchOS 10.0+	5.9	Swift Package Manager	Fully Tested

Installation

Swift Package Manager

The Swift Package Manager allows for developers to easily integrate packages into their Xcode projects and packages; and is also fully integrated into the swift compiler.

SPM Through XCode Project

• File > Swift Packages > Add Package Dependency
• Add https://github.com/opendive/SuiKit.git
• Select "Up to next Major" with "1.2.2"

SPM Through Xcode Package

Once you have your Swift package set up, add the Git link within the dependencies value of your Package.swift file.

dependencies: [
    .package(url: "https://github.com/opendive/SuiKit.git", .upToNextMajor(from: "1.2.2"))
]

Using SuiKit

SuiKit is really easy to implement and use in your own projects. Simply provide the provider, transaction block, and account. Here's an example on how to transfer Sui tokens, which also utilizes the key generation functionality of the library

import SuiKit

do {
    // Create new wallet
    let newWallet = try Wallet()

    // Create Signer and Provider
    let provider = SuiProvider()
    let signer = RawSigner(account: newWallet.accounts[0], provider: provider)

    // Create transaction block
    var tx = try TransactionBlock()

    // Split coin and prepare transaction (e.g., sending 1K Droplets to an account)
    let coin = try tx.splitCoin(tx.gas, [try tx.pure(value: .number(1_000))])
    try tx.transferObjects([coin], try newWallet.accounts[0].address())

    // Execute transaction
    var result = try await signer.signAndExecuteTransaction(transactionBlock: &tx)
    result = try await provider.waitForTransaction(tx: result.digest)
    print(result)
} catch {
    print("Error: \(error)")
}

You can also read objects from the Sui blockchain. Below is an example on how to do so.

import SuiKit

do {
    // Create provider
    let provider = SuiProvier()

    // Get objects
    let txn = try await provider.getObjects(id: "0xB0B")
} catch {
    print("Error: \(error)")
}

As well here is how to use the move call function

import SuiKit
do {
    // Create new wallet
    let newWallet = try Wallet()

    // Create Signer and Provider
    let provider = SuiProvider()
    let signer = RawSigner(account: newWallet.accounts[0], provider: provider)

    // Create transaction block
    var tx = try TransactionBlock()

    // Prepare merge coin 
    try tx.moveCall(
        target: "OxB0B::nft::mint",
        arguments: [.input(try tx.pure(value: .string("Example NFT")))]
    )

    // Execute transaction
    var result = try await signer.signAndExecuteTransaction(transactionBlock: &tx)
    result = try await provider.waitForTransaction(tx: result.digest)
    print (result)
catch {
    print ("Error: (error)")
}

Also the developer is able to call functions with multiple return values

import SuiKit
do {
    // Create new wallet
    let newWallet = try Wallet()

    // Create Signer and Provider
    let provider = SuiProvider()
    let signer = RawSigner(account: newWallet.accounts[0], provider: provider)

    // Create transaction block
    var tx = try TransactionBlock()

    // Prepare merge coin 
    let result = try tx.moveCall(
        target: "OxB0B::nft::mint_multiple",
        arguments: [
            .input(try tx.pure(value: .string("Example NFT"))), 
            .input(try tx.pure(value: .number(2)))
        ],
        returnValueCount: 2
    )

    // Utilizing the multiple return values
    try tx.transferObjects([result[0], result[1]], try newWallet.accounts[0].address())

    // Execute transaction
    var result = try await signer.signAndExecuteTransaction(transactionBlock: &tx)
    result = try await provider.waitForTransaction(tx: result.digest)
    print (result)
catch {
    print ("Error: (error)")
}

And this is how to publish a package. (Note: it is recommended for this to be used in a CLI / MacOS enviornment)

import SuiKit 
import SwiftyJSON

do {
    // Import Package Module JSON
    guard let fileUrl = Bundle. main.ur(forResource: "Package", withExtension: "json") else {
        throw NSError(domain: "Package is missing", code: -1)
    }
    guard let fileCompiledData = try? Data(contentsOf: fileUrl) else {
        throw NSError(domain: "Package is corrupted", code: -1)
    }
    let fileData = JSON(fileCompiledData)

    // Create new wallet
    let newWallet = try Wallet()

    // Create Signer and Provider
    let provider = SuiProvider()
    let signer = RawSigner(account: newWallet.accounts[0], provider: provider)

    // Create transaction block
    var tx = try TransactionBlock()

    // Prepare Publish
    let publishObject = try tx.publish(
        modules: fileData["modules"].arrayValue as! [String], 
        dependencies: fileData["dependencies"].arrayValue as! [String]
    )

    // Prepare Transfer Object
    try tx.transferObjects([publishObject], try newWallet.accounts[0].address())

    // Execute transaction
    var result = try await signer.signAndExecuteTransaction(transactionBlock: &tx)
    result = try await provider.waitForTransaction(tx: result.digest)
    print(result)
} catch {
    print("Error: \(error)")
}

Development And Testing

We welcome anyone to contribute to the project through posting issues, if they encounter any bugs / glitches while using SuiKit; and as well with creating pull issues that add any additional features to SuiKit.

Next Steps

• In the near future, there will be full documentation outlining how a user can fully utilize SuiKit.
• As well, more features listed in ToDo will be fully implemented.
• More examples, from other platforms, will be uploaded for developers to be able to focus more on implementing the end user experience, and less time figuring out their project's architecture.

Credits

Credit goes to The Sui Foundation for providing the needed infrastructure for the Sui blockchain network, as well with their extensive RPC and Sui Move documentation.

License

SuiKit is released under the MIT license. As well, SuiKit utilizes some code from the web3swift package that enables functionality for SECP256K1 and BIP32 derivations. That following code is under the Apache 2.0 license. The licenses for both are included in this package under LICENSE.md and COPYING.