diff --git a/app/build.gradle b/app/build.gradle index 0a834a88d3..82e421bdfc 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -125,7 +125,7 @@ dependencies { implementation 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0' implementation "com.orhanobut:hawk:2.0.1" implementation 'co.nstant.in:cbor:0.8' - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.2.2' implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.2.2" // implementation 'org.bitcoinj:bitcoinj-parent:0.14.7' //TODO: is this needed? diff --git a/blockchain/build.gradle b/blockchain/build.gradle index 26e6f2400c..ad3b46b318 100644 --- a/blockchain/build.gradle +++ b/blockchain/build.gradle @@ -31,7 +31,7 @@ dependencies { implementation project(':tangem-core') implementation project(':tangem-sdk') - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" implementation 'androidx.appcompat:appcompat:1.1.0' implementation 'androidx.core:core-ktx:1.1.0' diff --git a/build.gradle b/build.gradle index dde59cbded..c8bd6efacd 100644 --- a/build.gradle +++ b/build.gradle @@ -1,15 +1,15 @@ buildscript { - ext.kotlin_version = '1.3.61' + apply from: 'dependencies.gradle' + repositories { google() jcenter() maven { url 'https://maven.fabric.io/public' } } dependencies { - classpath 'com.android.tools.build:gradle:3.5.3' - classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" - classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' - classpath 'io.fabric.tools:gradle:1.31.0' + classpath "com.android.tools.build:gradle:$versions.build_gradle" + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin" + classpath "io.fabric.tools:gradle:1.31.0" } } diff --git a/dependencies.gradle b/dependencies.gradle new file mode 100644 index 0000000000..54a6d70a21 --- /dev/null +++ b/dependencies.gradle @@ -0,0 +1,4 @@ +ext.versions = [ + kotlin : '1.3.61', + build_gradle: '3.6.0', +] diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index cc53da309f..3e4d7dcd2a 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ -#Thu Aug 22 12:21:00 MSK 2019 +#Thu Feb 27 13:33:42 AST 2020 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip diff --git a/jitpack.gradle b/jitpack.gradle new file mode 100644 index 0000000000..cd263447fd --- /dev/null +++ b/jitpack.gradle @@ -0,0 +1,4 @@ +ext.jitpackSdk = [ + group: 'com.github.Tangem', + version : '0.2.1', +] \ No newline at end of file diff --git a/server-android/build.gradle b/server-android/build.gradle index 05ebb488ca..a853878415 100644 --- a/server-android/build.gradle +++ b/server-android/build.gradle @@ -1,6 +1,5 @@ apply plugin: 'com.android.library' apply plugin: 'kotlin-android' -apply plugin: 'com.github.dcendents.android-maven' group='com.tangem' @@ -41,7 +40,7 @@ dependencies { testImplementation 'junit:junit:4.12' androidTestImplementation 'androidx.test:runner:1.2.0' androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0' - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" } repositories { mavenCentral() diff --git a/tangem-card-old/build.gradle b/tangem-card-old/build.gradle index f0d27f4bee..affd0bb0f3 100644 --- a/tangem-card-old/build.gradle +++ b/tangem-card-old/build.gradle @@ -1,5 +1,4 @@ apply plugin: 'java-library' -apply plugin: 'com.github.dcendents.android-maven' group='com.tangem' diff --git a/tangem-core/build.gradle b/tangem-core/build.gradle index 55701789e1..a831d40268 100644 --- a/tangem-core/build.gradle +++ b/tangem-core/build.gradle @@ -1,12 +1,14 @@ apply plugin: "kotlin" apply plugin: 'org.jetbrains.dokka' +apply from: '../dependencies.gradle' +apply from: '../jitpack.gradle' -group = 'com.github.TangemCash' -version '0.1.0' +group = "$jitpackSdk.group" +version "$jitpackSdk.version" dependencies { implementation fileTree(dir: 'libs', include: ['*.jar']) - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" implementation "com.madgag.spongycastle:core:1.58.0.0" implementation "com.madgag.spongycastle:prov:1.58.0.0" implementation 'net.i2p.crypto:eddsa:0.3.0' @@ -19,14 +21,13 @@ sourceCompatibility = "8" targetCompatibility = "8" buildscript { - ext.kotlin_version = '1.3.61' ext.dokka_version = '0.10.0' repositories { mavenCentral() jcenter() } dependencies { - classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin" classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version" } } diff --git a/tangem-demo/build.gradle b/tangem-demo/build.gradle index d67d457b53..be66873c49 100644 --- a/tangem-demo/build.gradle +++ b/tangem-demo/build.gradle @@ -36,7 +36,7 @@ dependencies { implementation project(':tangem-sdk') implementation fileTree(dir: 'libs', include: ['*.jar']) - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" implementation 'androidx.appcompat:appcompat:1.1.0' implementation 'androidx.core:core-ktx:1.1.0' implementation 'androidx.constraintlayout:constraintlayout:1.1.3' diff --git a/tangem-sdk-android-config/README.md b/tangem-sdk-android-config/README.md new file mode 100644 index 0000000000..e4037ddaae --- /dev/null +++ b/tangem-sdk-android-config/README.md @@ -0,0 +1,231 @@ + +[![Release](https://jitpack.io/v/Tangem/tangem-sdk-android.svg)] + +# Welcome to Tangem + +The Tangem card is a self-custodial hardware wallet for blockchain assets. The main functions of Tangem cards are to securely create and store a private key from a blockchain wallet and sign blockchain transactions. The Tangem card does not allow users to import/export, backup/restore private keys, thereby guaranteeing that the wallet is unique and unclonable. + +- [Getting Started](#getting-started) + - [Requirements](#requirements) + - [Installation](#installation) +- [Usage](#usage) + - [Initialization](#initialization) + - [Card interaction](#card-interaction) + - [Scan card](#scan-card) + - [Sign](#sign) +- [Customization](#customization) + - [UI](#ui) + - [Tasks](#tasks) + - [Localization](#localization) + + +## Getting Started + +### Requirements +Android with minimal SDK version of 21 and a device with NFC support + +### Installation + +1) Add Tangem library to the project: + +Add to a project build.gradle file: + +```gradle +allprojects { + repositories { + maven { url "https://jitpack.io" } + } +} +``` + +And add Tangem library to the dependencies (in an app or module build.gradle file): + +```gradle +dependencies { + implementation "com.github.tangem.tangem-sdk-android:tangem-core:$latestVersionOfCore" + implementation "com.github.tangem.tangem-sdk-android:tangem-sdk:$latestVersionOfSdk" +} +``` +Tangem Core is a JVM library (without Android dependencies) that provides core functionality of interacting with Tangem cards. +Tangem Sdk is an Android library that implements NFC interaction between Android devices and Tangem cards and graphical interface for this interaction. + +2) Add res file ‘tech_filter’ with the following: + +```xml + + + android.nfc.tech.IsoDep + android.nfc.tech.Ndef + android.nfc.tech.NfcV + + +``` + +3) Add to Manifest: +```xml + + + + +``` + +## Usage + +Tangem SDK is a self-sufficient solution that implements a card abstraction model, methods of interaction with the card and interactions with the user via UI. + +### Initialization +To get started, you need to create an instance of the `CardManager` class. It provides the simple way of interacting with the card. +Our default implementation of `CardManager` requires `NfcReader` and `DefaultCardManagerDelegate`. + + +```kotlin +private val nfcManager = NfcManager() +private val cardManagerDelegate: DefaultCardManagerDelegate = DefaultCardManagerDelegate(nfcManager.reader) +private val cardManager = CardManager(nfcManager.reader, cardManagerDelegate) +``` + +NfcManager requires a reference to activity in order to use Android API for interacting with NFC. DefaultCardManagerDelegate requires a reference to activity in order to render views. + +```kotlin +nfcManager.setCurrentActivity(this) +cardManagerDelegate.activity = this +``` + +```kotlin +lifecycle.addObserver(NfcLifecycleObserver(nfcManager)) +``` + +Default implementation of `NfcManager`, `CardReader` and `CardManagerDelegate` allows you to start using CardManager in your application without any additional setup. + +You can also provide your implementations of `CardReader` and `CardManagerDelegate`. +You can read more about this in [Customization](#сustomization). + +### Tasks + +#### Scan card +To start using any card, you first need to read it using the `scanCard()` method. This method launches an NFC session, and once it’s connected with the card, it obtains the card data. Optionally, if the card contains a wallet (private and public key pair), it proves that the wallet owns a private key that corresponds to a public one. + +Example: + +```kotlin +cardManager.scanCard { taskEvent -> + when (taskEvent) { + is TaskEvent.Event -> { + when (taskEvent.data) { + is ScanEvent.OnReadEvent -> { + // Handle returned card data + cardId = (taskEvent.data as ScanEvent.OnReadEvent).card.cardId + // Switch to UI thread to show results in UI + runOnUiThread {} + } + is ScanEvent.OnVerifyEvent -> { + //Handle card verification + val isGenuine = (taskEvent.data as ScanEvent.OnVerifyEvent).isGenuine + } + } + } + is TaskEvent.Completion -> { + if (taskEvent.error != null) { + if (taskEvent.error is TaskError.UserCancelledError) { + // Handle case when user cancelled manually + } + // Handle other errors + } + // Handle completion + } + } +} + +``` + +Communication with the card is an asynchronous operation. In order to get a result for the method, you need to subscribe to the task callback. In order to render the callback results on UI, you need to switch to the main thread. + +Every task can invoke callback several times with different events: + +`Completion(val error: TaskError? = null)` – this event is triggered only once when task is completely finished. It means that it's the final callback. If error is not nil, then something went wrong during the operation. + +`Event(val data: T)` – this event is triggered when one of operations inside the task is completed. + +**Possible events of the Scan card task:** + +`OnReadEvent(val result: Card)` – this event is triggered after the card has been successfully read. In addition, the obtained card object is contained inside the enum. At this stage, the authenticity of the card is ***NOT*** verified. + +`OnVerifyEvent(val isGenuine: Boolean)` – this event is triggered when the card’s authenticity has been verified. If the card is authentic, isGenuine will be set to true, otherwise, it will be set to false. + +#### Sign +This method allows you to sign one or multiple hashes. Simultaneous signing of array of hashes in a single SIGN command is required to support Bitcoin-type multi-input blockchains (UTXO). The SIGN command will return a corresponding array of signatures. + +```kotlin +cardManager.sign( + hashes = arrayOf(hash1, hash2), + cardId = card.cardId) { taskEvent -> + when (taskEvent) { + is TaskEvent.Event -> { + // Handle sign response data + val signResponse = taskEvent.data + } + is TaskEvent.Completion -> { + if (taskEvent.error != null) { + if (taskEvent.error is TaskError.UserCancelledError) { + // Handle case when user cancelled manually + } + // Handle other errors + } + // Handle completion + } + } +} +``` + +## Customization +### UI +If the interaction with user is required, the SDK performs the entire cycle of this interaction. In order to change the appearance or behavior of the user UI, you can provide you own implementation of the `CardManagerDelegate` inteface. After this, initialize the `CardManager` class with your delegate class. + +```kolin +val myCardManagerDelegate = MyCardManagerDelegate() +val cardManager = CardManager(cardManagerDelegate = myCardManagerDelegate) +``` + +> If you pass null instead of `cardManagerDelegate`, the SDK won’t be able to process errors that require user intervention and return them to `.failure(let error)`. + +### Tasks +`CardManager` only covers general tasks. If you want to trigger card commands in a certain order, you need to create your own task. + +To do this, you need to create a subclass of the `Task` class, and override the `onRun(..)` method. + +Then call the `runTask(..)` method of the `CardManager` class with you task. + +```kotlin +val task = YourTask() +cardManager.runTask(task) { taskEvent -> + // Handle your events +} +``` +> For example, you want to read the card and immediately sign a transaction on it. In such a case, you need to inherit from the `Task` class and override the `onRun(..)` method, in which you implement the required behavior. + +It’s possible to run just one command without the need to create a separate task by using the `runCommand(..)` method. +> For example, if you need to read the card details, but don’t need to check the authenticity. +```kotlin +// Create command +val readCommand = ReadCardCommand() +// Run command with the callback +cardManager.runCommand(readCommand) { taskEvent -> + when (taskEvent) { + is TaskEvent.Event -> { + // Handle returned card data + val card: Card = taskEvent.data + } + is TaskEvent.Completion -> { + if (taskEvent.error != null) { + if (taskEvent.error is TaskError.UserCancelledError) { + // Handle case when user cancelled manually + } + // Handle other errors + } + // Handle completion + } + } +} +``` \ No newline at end of file diff --git a/tangem-sdk-android-config/build.gradle b/tangem-sdk-android-config/build.gradle new file mode 100644 index 0000000000..fd31859e1c --- /dev/null +++ b/tangem-sdk-android-config/build.gradle @@ -0,0 +1,26 @@ +buildscript { + apply from: 'dependencies.gradle' + + repositories { + google() + jcenter() + maven { url 'https://maven.fabric.io/public' } + } + dependencies { + classpath "com.android.tools.build:gradle:$versions.build_gradle" + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin" + classpath "com.github.dcendents:android-maven-gradle-plugin:2.1" + } +} + +allprojects { + repositories { + google() + jcenter() + maven { url 'https://jitpack.io' } + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/tangem-sdk-android-config/settings.gradle b/tangem-sdk-android-config/settings.gradle new file mode 100644 index 0000000000..a3bed452ff --- /dev/null +++ b/tangem-sdk-android-config/settings.gradle @@ -0,0 +1 @@ +include ':tangem-core', ':tangem-sdk', ':tangem-demo' diff --git a/tangem-sdk-old/build.gradle b/tangem-sdk-old/build.gradle index 9ca113d488..e7ef5a0015 100644 --- a/tangem-sdk-old/build.gradle +++ b/tangem-sdk-old/build.gradle @@ -1,6 +1,5 @@ apply plugin: 'com.android.library' apply plugin: 'kotlin-android' -apply plugin: 'com.github.dcendents.android-maven' group='com.tangem' @@ -51,7 +50,7 @@ dependencies { testImplementation 'junit:junit:4.12' androidTestImplementation 'androidx.test:runner:1.2.0' androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0' - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" } repositories { diff --git a/tangem-sdk/build.gradle b/tangem-sdk/build.gradle index f25dfed9f9..e16a3e03a0 100644 --- a/tangem-sdk/build.gradle +++ b/tangem-sdk/build.gradle @@ -1,9 +1,11 @@ apply plugin: 'com.android.library' apply plugin: 'kotlin-android' apply plugin: 'kotlin-android-extensions' +apply from: '../dependencies.gradle' +apply from: '../jitpack.gradle' -group = 'com.github.TangemCash' -version '0.1.0' +group = "$jitpackSdk.group" +version "$jitpackSdk.version" android { compileSdkVersion 29 @@ -38,7 +40,7 @@ android { dependencies { implementation project(':tangem-core') implementation fileTree(dir: 'libs', include: ['*.jar']) - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$versions.kotlin" implementation 'androidx.appcompat:appcompat:1.1.0' implementation 'com.google.android.material:material:1.1.0' implementation 'com.skyfishjy.ripplebackground:library:1.0.1'