https://github.com/near/near-api-swift

Interact with NEAR blockchain from iOS and OS X apps using Swift
https://github.com/near/near-api-swift

blockchain ios nearprotocol swift

Last synced: 3 months ago
JSON representation

Interact with NEAR blockchain from iOS and OS X apps using Swift

• Host: GitHub
• URL: https://github.com/near/near-api-swift
• Owner: near
• License: mit
• Created: 2019-10-28T19:58:03.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-03T11:58:47.000Z (7 months ago)
• Last Synced: 2024-05-18T01:20:50.958Z (6 months ago)
• Topics: blockchain, ios, nearprotocol, swift
• Language: Swift
• Homepage:
• Size: 294 KB
• Stars: 22
• Watchers: 12
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-near - near-api-swift

README

        
# nearclientios

[![Build Status](https://travis-ci.com/nearprotocol/near-client-ios.svg?branch=master)](https://travis-ci.com/nearprotocol/near-client-ios)

[![Version](https://img.shields.io/cocoapods/v/nearclientios.svg?style=flat)](https://cocoapods.org/pods/nearclientios)

[![License MIT](https://img.shields.io/github/license/nearprotocol/near-client-ios)](https://github.com/nearprotocol/near-client-ios/blob/master/LICENSE)

[![Platform](https://img.shields.io/cocoapods/p/nearclientios.svg?style=flat)](https://cocoapods.org/pods/nearclientios)

## Example

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

# Usage

```swift

import nearclientios

class ViewController: UIViewController, WalletSignInDelegate {

  private var walletAccount: WalletAccount?

  private var near: Near?

  override func viewDidLoad() {

    super.viewDidLoad()

    let keyStore = KeychainKeyStore(keychain: .init(service: "example.keystore"))

    let config = NearConfig(

      networkId: "testnet", // "default" for mainnet 

      nodeUrl: URL(string: "https://rpc.testnet.near.org")!, // "https://rpc.mainnet.near.org" for mainnet

      masterAccount: nil,

      keyPath: nil,

      helperUrl: nil,

      initialBalance: nil,

      providerType: .jsonRPC(URL(string: "https://rpc.testnet.near.org")!), // "https://rpc.mainnet.near.org" for mainnet

      signerType: .inMemory(keyStore),

      keyStore: keyStore,

      contractName: nil,

      walletUrl: "https://wallet.testnet.near.org" // "https://wallet.near.org" for mainnet

    )

    near = try Near(config: config)

    walletAccount = try! WalletAccount(near: near!, authService: DefaultAuthService.shared) // a failed try here represents a configuration error, not a runtime error. It's safe to store a `WalletAccount!`.

    let appName = UIApplication.name ?? "signInTitle"

    DefaultAuthService.shared.walletSignIn = self

    try! await walletAccount!.requestSignIn(contractId: nil, title: appName, presentingViewController: self)

  }

  func completeSignIn(url: URL) async {

    try! await walletAccount?.completeSignIn(url: url)

    MainActor.run {

      //do any additional UI work on the main thread after sign in is complete

    }

  }

}

```

## Requirements

nearclientios makes use of Swift's async/await and thus requires iOS 13.

## Installation

### CocoaPods

nearclientios is available through [CocoaPods](https://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

pod 'nearclientios'

```

### Swift Package Manager

Once you have your Swift package set up, you can add nearclientios as a dependency in Package.swift.

```swift

dependencies: [

  .package(url: "https://github.com/near/near-api-swift", .upToNextMajor(from: "1.0.29"))

]

```

## Examples

* [Basic nearclientios function calls](https://github.com/LyubomyrBurday/near_basic)

## Author

NEAR Inc

## License

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