A cryptography lib built with Kotlin Multiplatform with support for the following targets:
- JS
- iOS
- Android
- JVM
Set variable GITHUB_ACTOR
with your GitHub Username and set variable GITHUB_TOKEN
with your GitHub Personal Access Token.
As an example we will go with Bash
- Open CMD.
- Run
sudo nano $HOME/.bash_profile
. - Insert
export GITHUB_ACTOR="YOUR GITHUB USERNAME"
- Insert
export GITHUB_TOKEN="YOUR GITHUB PERSONAL ACCESS TOKEN"
- Save profile and restart CMD to take effect.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install autoconf automake libtool
cs java --jvm adopt:1.11.0-11 --setup
after that java -version
should yield something like that
openjdk version "11.0.11" 2021-04-20
OpenJDK Runtime Environment (build 11.0.11+9)
OpenJDK 64-Bit Server VM (build 11.0.11+9, mixed mode)
In case of using macOS with M chip, make sure to install the arch64 version of Java
Install XCode from App Store.
Then approve xcodebuild license in your terminal. Like so:
$ sudo xcodebuild -license
Install Android SDK from SDK Manager (via Android Studio).
Then approve Android SDK license. Like so:
$ cd /Users/{{YOUR USER}}/Library/Android/sdk
$ tools/bin/sdkmanager --licenses
While there are many ways to install Android SDK this has proven to be the most reliable way. Standard IntelliJ with Android plugin may work. However, we've had several issues. Your mileage may vary.
For Ubuntu,
sudo apt update && sudo apt install android-sdk
Leaving the SDK at ~/Android/Sdk
Create a file named local.properties
in the root of Apollo.
Add your android sdk path to local.properties file
. Like so:
sdk.dir = /Users/{{YOUR USER}}/Library/Android/sdk
This will indicate to your IDE which android SDK to use.
Alternatively, you can add the following environment variable into your shell profile file:
$ export ANDROID_HOME='/Users/{{YOUR USER}}/Library/Android/sdk
You should be able to import and build the project in IntelliJ IDEA now.
Here is a list of common issues you might face and its solutions.
If you already added the environment variable to your CMD profile and still not being available.
Solution
- Restart your Device.
If you get error:
No binary for ChromeHeadless browser on your platform.
Please, set "CHROME_BIN" env variable.
java.lang.IllegalStateException: Errors occurred during launch of browser for testing.
- ChromeHeadless
Solution
- Install headless chrome or just Chrome browser
Solution
- Go to preference/settings and make sure to select the correct Java version 11.
if you get this error on macOS with M chip:
Could not find JNA native support
Solution
- Make sure that you are using Java version that is arch64.
In build.gradle.kts
files include the dependency
repositories {
mavenCentral()
}
For dependencies
dependencies {
implementation("org.hyperledger.identus:apollo:<latest version>")
}
Inside your Package.swift
file, add the following
dependencies: [
.package(
url: "git@github.com:hyperledger/identus-apollo.git",
from: "<latest version>"
)
]
The following instruction using Xcode 15
- Go the Release Page and check the latest version and download the
Apollo.xcframework.zip
file. - Uncompress the downloaded file.
- Add the
Apollo.xcframework
to your Xcode project. - When asked select Copy items if needed.
- Then go to the project configuration page in Xcode and check the Frameworks and Libraries section and add the
Apollo.xcframework
if not found then chooseEmbed & Sign
. - Then go to the build phase page and mark the framework as required.
[!WARNING]
For Intel iOS simulator: You need to add the following flag as YES EMBEDDED_CONTENT_CONTAINS_SWIFT=YES
on the target like so:
Package.swift
Package(
...
targets: .testTarget(
...
swiftSettings: [.define("EMBEDDED_CONTENT_CONTAINS_SWIFT=YES")]
...
)
)
Inside the package.json
{
"dependencies": {
"@atala/apollo": "<latest version>"
}
}
In the project build.gradle
allprojects {
repositories {
// along with all the other current existing repos add the following
mavenCentral()
}
}
In the module build.gradle
kotlin {
sourceSets {
commonMain {
dependencies {
// This following is just an example you can import it as per you needs
implementation 'org.hyperledger.identus:apollo:<latest version>'
}
}
}
}
In the project build.gradle.kts
allprojects {
repositories {
// along with all the other current existing repos add the following
mavenCentral()
}
}
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
// This following is just an example you can import it as per you needs
implementation("org.hyperledger.identus:apollo:<latest version>")
}
}
}
}
libraryDependencies += "org.hyperledger.identus" % "apollo-jvm" % "<latest version>"
Please have a look at unit tests, more samples will be added soon.
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely.