Skip to content

Latest commit

 

History

History
122 lines (89 loc) · 3.83 KB

README.md

File metadata and controls

122 lines (89 loc) · 3.83 KB
Raw

How to install

A wrapper is a private pod, so private podspec must be set. Put at the top of the Podfile:

source 'https://github.com/hyperledger/indy-sdk.git'

Cocoapod will search for spec files in the root Specs folder.

Binaries

  • There are 2 types of automatically built archives containing libindy core library which can be used for your iOS application.

    • library built for aarch64-apple-ios target.
    • universal libindy built for all architectures.

    Add pod to target:

      pod 'libindy'

    These archives are located at https://repo.sovrin.org/ios/libindy/{release-channel}/libindy-core/.

  • There is manually built and published archive containing libindy objective C wrapper. This archive is located at https://repo.sovrin.org/ios/libindy/{release-channel}/indy-objc/.

    Add pod to target:

      pod 'libindy-objc'

{release channel} must be replaced with master, rc or stable to define corresponded release channel.

How to manually build

Core library

Note: Rust 1.46 forces building cdylib crate that causes linking errors. See rust-lang/rust#79373 for details. It will be fixed in 1.49, but until it is out we recommed to use 1.45

  1. Install Rust and rustup (https://www.rust-lang.org/install.html).

  2. Install toolchains using command:

    rustup target add aarch64-apple-ios x86_64-apple-ios

  3. Install cargo-lipo:

    cargo install cargo-lipo

  4. Install required native libraries and utilities:

    brew install libsodium
brew install zeromq
brew install openssl (1.0.2q can be any fresh version)

  5. Setup environment variables:

    export PKG_CONFIG_ALLOW_CROSS=1
export CARGO_INCREMENTAL=1

  6. Edit script ci/ios-build.sh: set the following variables to fit your environment:

    export OPENSSL_DIR=/usr/local/Cellar/openssl/1.0.2q
export LIBINDY_POD_VERSION=0.0.1

    OPENSSL_DIR - path to installed openssl library

    LIBINDY_POD_VERSION - version of libindy-core pod to be built

  7. Run the script Validate the output that all goes well.

    Parameters:

    • package - target package to build.
      • libindy
      • libnullpay
    • targets - target architectures.
      • one of aarch64-apple-ios x86_64-apple-ios
      • leave empty to build for all architectures.

  8. Go to Specs/libindy dir.

  9. Create directory with name defined in LIBINDY_POD_VERSION:

    mkdir LIBINDY_POD_VERSION

  10. Copy libindy.podspec.json to that new directory from some previous version.

  11. Edit this json -> change version field to LIBINDY_POD_VERSION.

  12. Add new directory and file inside to git repository.

  13. Commit to master branch.

  14. for all projects which using libindy do not forget to make:

    pod repo update
pod install

Wrapper Cocoapod

Run Archive process for Indy target. Custom post-action shell script universal_framework.sh will be triggered and you get universal framework. Then put it to folder: libindy-objc/Indy.framework and upload to repo.

Wrapper usage

Import header starting from 0.1.3:

#import <Indy/Indy.h>

For 0.1.1 and 0.1.2 versions:

#import <libindy/libindy.h>

All wrapper types and classes have prefix Indy.

Troubleshooting

  • Enable Logging - Use setLogger to pass a callback that will be used by Libindy to log a record.
  • IS-1058
    • OpenSSL cp: file.tgz: No such file or directory -
    sudo gem uninstall cocoapods-downloader
sudo gem install cocoapods-downloader -v 1.2.0
    • Multiple commands produce */Debug-iphonesimulator/Indy-demo.app/PlugIns/Indy-demoTests.xctest/Info.plist - remove Info.plist from there: Solution -> Target -> Build phases -> Copy Bundle Resources