Skip to content

WalletConnect/wallet-connect-swift

 
 

Repository files navigation

WalletConnect

Codacy Badge CI

WalletConnect Swift SDK, implements 1.0.0 websocket based protocol.

Demo video

Requirements

  • iOS 11
  • Xcode 10.2
  • Swift 5

Features

  • Connect and disconnect
  • Approve / Reject / Kill session
  • Approve and reject eth_sign / personal_sign / eth_signTypedData
  • Approve and reject eth_signTransaction / eth_sendTransaction
  • Approve and reject bnb_sign (binance dex orders)
  • session persistent / recovery

Todo:

  • push notification (APNS)

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

WalletConnect is available through CocoaPods, Carthage and Swift Package Manager.

CocoaPods

To install it, simply add the following line to your Podfile:

pod 'WalletConnect', git: 'https://github.com/trustwallet/wallet-connect-swift', branch: 'master'

Carthage

Add following line to your Cartfile:

github "trustwallet/wallet-connect-swift"

Swift Package Manager

Add .package(url:_:) to your Package.swift:

dependencies: [
    .package(url: "https://github.com/trustwallet/wallet-connect-swift", .branch("master")),
],

Usage

parse session from scanned QR code:

let string = "wc:..."
guard let session = WCSession.from(string: string) else {
    // invalid session
    return
}
// handle session

configure and handle incoming message:

let interactor = WCInteractor(session: session, meta: clientMeta)
interactor.onSessionRequest = { [weak self] (id, peer) in
    // ask for user consent
}

interactor.onDisconnect = { [weak self] (error) in
    // handle disconnect
}

interactor.eth.onSign = { [weak self] (id, payload) in
    // handle eth_sign, personal_sign, eth_signTypedData
}

interactor.eth.onTransaction = { [weak self] (id, event, transaction) in
    // handle eth_signTransaction / eth_sendTransaction
}

interactor.bnb.onSign = { [weak self] (id, order) in
    // handle bnb_sign
}

approve session

interactor.approveSession(accounts: accounts, chainId: chainId).done {
    print("<== approveSession done")
}.cauterize()

approve request

interactor.approveRequest(id: id, result: result.hexString).done {
    print("<== approveRequest done")
}.cauterize()

approve binance dex orders

interactor?.approveBnbOrder(id: id, signed: signed).done({ confirm in
    print("<== approveBnbOrder", confirm)
}).cauterize()

Author

hewigovens

License

WalletConnect is available under the MIT license. See the LICENSE file for more info.

About

WalletConnect Swift client SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Swift 97.9%
  • Ruby 1.4%
  • Objective-C 0.7%