@solana-mobile/seed-vault-lib 0.4.0 → 0.4.1

package/LICENSE

@@ -1,13 +1,13 @@
-Copyright 2022 Solana Mobile Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
+Copyright 2022 Solana Mobile Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
 limitations under the License.

package/README.md

@@ -2,10 +2,18 @@
 
 A React Native wrapper of the Seed Vault SDK.
 
+## Community Maintained
+
+This React Native library is a community-maintained wrapper around the [Seed Vault SDK](../../../README.md). It is not actively maintained or production-tested by Solana Mobile.
+
+Contributions are welcome and encouraged! If you encounter bugs or need new features, please open a PR — this library improves when the community that depends on it helps build it.
+
+If you need a production-grade integration, we recommend using the native Java/Kotlin Seed Vault SDK directly.
+
 # Usage
 
 ### Check if Seed Vault is Available
-We first need to check if the seed vault service is available on the device. Currently only Saga implementes a seed vault. 
+We first need to check if the seed vault service is available on the device. Currently only devices from Solana Mobile implement a seed vault. 
 ```javascript
 const allowSimulated = false; // use true to allow simulated seed vault (for dev/testing)
 const seedVaultAvailable = await SolanaMobileSeedVaultLib.isSeedVaultAvailable(allowSimulated);
@@ -39,7 +47,7 @@ if (permissionResult === PermissionsAndroid.RESULTS.GRANTED) {
 }
 ```
 
-Read more about requesting Android Permission in React Natvie [here](https://reactnative.dev/docs/permissionsandroid).
+Read more about requesting Android Permission in React Native [here](https://reactnative.dev/docs/permissionsandroid).
 
 ### Authorize a Seed
 Before our app can access any seeds in the seed vault, we must first request authorization for our app to use a seed from the user.

package/android/gradlew.bat

@@ -1,89 +1,89 @@
-@rem
-@rem Copyright 2015 the original author or authors.
-@rem
-@rem Licensed under the Apache License, Version 2.0 (the "License");
-@rem you may not use this file except in compliance with the License.
-@rem You may obtain a copy of the License at
-@rem
-@rem      https://www.apache.org/licenses/LICENSE-2.0
-@rem
-@rem Unless required by applicable law or agreed to in writing, software
-@rem distributed under the License is distributed on an "AS IS" BASIS,
-@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-@rem See the License for the specific language governing permissions and
-@rem limitations under the License.
-@rem
-
-@if "%DEBUG%" == "" @echo off
-@rem ##########################################################################
-@rem
-@rem  Gradle startup script for Windows
-@rem
-@rem ##########################################################################
-
-@rem Set local scope for the variables with windows NT shell
-if "%OS%"=="Windows_NT" setlocal
-
-set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
-set APP_BASE_NAME=%~n0
-set APP_HOME=%DIRNAME%
-
-@rem Resolve any "." and ".." in APP_HOME to make it shorter.
-for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
-
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
-
-@rem Find java.exe
-if defined JAVA_HOME goto findJavaFromJavaHome
-
-set JAVA_EXE=java.exe
-%JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
-
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto execute
-
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:execute
-@rem Setup the command line
-
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
-
-
-@rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
-
-:end
-@rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

package/android/src/main/AndroidManifest.xml

@@ -1 +1 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"/>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"/>

package/android/src/main/java/com/solanamobile/seedvault/model/SigningRequest.kt

@@ -1,45 +1,45 @@
-package com.solanamobile.seedvault.model
-
-import android.net.Uri
-import android.util.Base64
-import com.solanamobile.seedvault.SigningRequest
-import kotlinx.serialization.KSerializer
-import kotlinx.serialization.Serializable
-import kotlinx.serialization.builtins.serializer
-import kotlinx.serialization.descriptors.SerialDescriptor
-import kotlinx.serialization.encoding.Decoder
-import kotlinx.serialization.encoding.Encoder
-
-@Serializable
-data class SigningRequestSurrogate(
-    val payload: String,
-    val requestedSignatures: List<@Serializable(with = UriAsStringSerializer::class) Uri>
-)
-
-object SigningRequestSerializer : KSerializer<SigningRequest> {
-    override val descriptor: SerialDescriptor = SigningRequestSurrogate.serializer().descriptor
-
-    override fun serialize(encoder: Encoder, value: SigningRequest) {
-        encoder.encodeSerializableValue(SigningRequestSurrogate.serializer(),
-            SigningRequestSurrogate(Base64.encodeToString(value.payload, Base64.NO_WRAP), value.requestedSignatures)
-        )
-    }
-
-    override fun deserialize(decoder: Decoder): SigningRequest =
-        decoder.decodeSerializableValue(SigningRequestSurrogate.serializer()).let {
-            val payload = Base64.decode(it.payload, Base64.DEFAULT)
-            SigningRequest(payload, ArrayList(it.requestedSignatures))
-        }
-}
-
-object UriAsStringSerializer : KSerializer<Uri> {
-    override val descriptor: SerialDescriptor
-        get() = String.serializer().descriptor
-
-    override fun serialize(encoder: Encoder, value: Uri) {
-        encoder.encodeString(value.toString())
-    }
-
-    override fun deserialize(decoder: Decoder): Uri =
-        Uri.parse(decoder.decodeString())
+package com.solanamobile.seedvault.model
+
+import android.net.Uri
+import android.util.Base64
+import com.solanamobile.seedvault.SigningRequest
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.builtins.serializer
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+@Serializable
+data class SigningRequestSurrogate(
+    val payload: String,
+    val requestedSignatures: List<@Serializable(with = UriAsStringSerializer::class) Uri>
+)
+
+object SigningRequestSerializer : KSerializer<SigningRequest> {
+    override val descriptor: SerialDescriptor = SigningRequestSurrogate.serializer().descriptor
+
+    override fun serialize(encoder: Encoder, value: SigningRequest) {
+        encoder.encodeSerializableValue(SigningRequestSurrogate.serializer(),
+            SigningRequestSurrogate(Base64.encodeToString(value.payload, Base64.NO_WRAP), value.requestedSignatures)
+        )
+    }
+
+    override fun deserialize(decoder: Decoder): SigningRequest =
+        decoder.decodeSerializableValue(SigningRequestSurrogate.serializer()).let {
+            val payload = Base64.decode(it.payload, Base64.DEFAULT)
+            SigningRequest(payload, ArrayList(it.requestedSignatures))
+        }
+}
+
+object UriAsStringSerializer : KSerializer<Uri> {
+    override val descriptor: SerialDescriptor
+        get() = String.serializer().descriptor
+
+    override fun serialize(encoder: Encoder, value: Uri) {
+        encoder.encodeString(value.toString())
+    }
+
+    override fun deserialize(decoder: Decoder): Uri =
+        Uri.parse(decoder.decodeString())
 }

package/android/src/main/java/com/solanamobile/seedvault/reactnative/Extensions.kt

@@ -1,99 +1,99 @@
-package com.solanamobile.seedvault.reactnative
-
-import com.facebook.react.bridge.*
-import kotlinx.serialization.json.JsonArray
-import kotlinx.serialization.json.JsonNull
-import kotlinx.serialization.json.JsonObject
-import kotlinx.serialization.json.JsonPrimitive
-import kotlinx.serialization.json.add
-import kotlinx.serialization.json.boolean
-import kotlinx.serialization.json.booleanOrNull
-import kotlinx.serialization.json.buildJsonArray
-import kotlinx.serialization.json.buildJsonObject
-import kotlinx.serialization.json.double
-import kotlinx.serialization.json.doubleOrNull
-import kotlinx.serialization.json.int
-import kotlinx.serialization.json.intOrNull
-import kotlinx.serialization.json.put
-
-// Converts a React ReadableArray into a Kotlin ByteArray.
-// Expects ReadableArray to be an Array of ints, where each int represents a byte.
-internal fun ReadableArray.toByteArray(): ByteArray =
-    ByteArray(size()) { index ->
-        getInt(index).toByte()
-    }
-
-// Converts a Kotlin ByteArray into a React ReadableArray of ints.
-internal fun ByteArray.toWritableArray(): ReadableArray =
-    Arguments.createArray().apply {
-        forEach {
-            this.pushInt(it.toInt())
-        }
-    }
-    
-internal fun ReadableMap.toJson(): JsonObject = buildJsonObject {
-    keySetIterator().let { iterator ->
-        while (iterator.hasNextKey()) {
-            val key = iterator.nextKey()
-            when (getType(key)) {
-                ReadableType.Array -> put(key, getArray(key)!!.toJson())
-                ReadableType.Boolean -> put(key, getBoolean(key))
-                ReadableType.Map -> put(key, getMap(key)!!.toJson())
-                ReadableType.Null -> put(key, JsonNull)
-                ReadableType.Number -> put(key, getDouble(key))
-                ReadableType.String -> put(key, getString(key))
-            }
-        }
-    }
-}
-
-internal fun ReadableArray.toJson(): JsonArray = buildJsonArray {
-    for (i in 0 until size()) {
-        when (getType(i)) {
-            ReadableType.Array -> add(getArray(i)!!.toJson())
-            ReadableType.Boolean -> add(getBoolean(i))
-            ReadableType.Map -> add(getMap(i)!!.toJson())
-            ReadableType.Null -> {}
-            ReadableType.Number -> add(getDouble(i))
-            ReadableType.String -> add(getString(i))
-        }
-    }
-}
-
-internal fun JsonObject.toReadableMap(): ReadableMap {
-    val map: WritableMap = WritableNativeMap()
-    val iterator = keys.iterator()
-    while (iterator.hasNext()) {
-        val key = iterator.next()
-        when (val value = this[key]) {
-            is JsonPrimitive -> when {
-                value.booleanOrNull != null -> map.putBoolean(key, value.boolean)
-                value.doubleOrNull != null -> map.putDouble(key, value.double)
-                value.intOrNull != null -> map.putInt(key, value.int)
-                value.isString -> map.putString(key, value.content)
-            }
-            is JsonArray -> map.putArray(key, value.toReadableArray())
-            is JsonObject -> map.putMap(key, value.toReadableMap())
-            else -> map.putString(key, value.toString())
-        }
-    }
-    return map
-}
-
-internal fun JsonArray.toReadableArray(): ReadableArray {
-    val array: WritableArray = WritableNativeArray()
-    for (i in 0 until size) {
-        when (val value = this[i]) {
-            is JsonPrimitive -> when {
-                value.booleanOrNull != null -> array.pushBoolean(value.boolean)
-                value.doubleOrNull != null -> array.pushDouble(value.double)
-                value.intOrNull != null -> array.pushInt(value.int)
-                value.isString -> array.pushString(value.toString())
-            }
-            is JsonArray -> array.pushArray(value.toReadableArray())
-            is JsonObject -> array.pushMap(value.toReadableMap())
-            else -> array.pushString(value.toString())
-        }
-    }
-    return array
+package com.solanamobile.seedvault.reactnative
+
+import com.facebook.react.bridge.*
+import kotlinx.serialization.json.JsonArray
+import kotlinx.serialization.json.JsonNull
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.JsonPrimitive
+import kotlinx.serialization.json.add
+import kotlinx.serialization.json.boolean
+import kotlinx.serialization.json.booleanOrNull
+import kotlinx.serialization.json.buildJsonArray
+import kotlinx.serialization.json.buildJsonObject
+import kotlinx.serialization.json.double
+import kotlinx.serialization.json.doubleOrNull
+import kotlinx.serialization.json.int
+import kotlinx.serialization.json.intOrNull
+import kotlinx.serialization.json.put
+
+// Converts a React ReadableArray into a Kotlin ByteArray.
+// Expects ReadableArray to be an Array of ints, where each int represents a byte.
+internal fun ReadableArray.toByteArray(): ByteArray =
+    ByteArray(size()) { index ->
+        getInt(index).toByte()
+    }
+
+// Converts a Kotlin ByteArray into a React ReadableArray of ints.
+internal fun ByteArray.toWritableArray(): ReadableArray =
+    Arguments.createArray().apply {
+        forEach {
+            this.pushInt(it.toInt())
+        }
+    }
+    
+internal fun ReadableMap.toJson(): JsonObject = buildJsonObject {
+    keySetIterator().let { iterator ->
+        while (iterator.hasNextKey()) {
+            val key = iterator.nextKey()
+            when (getType(key)) {
+                ReadableType.Array -> put(key, getArray(key)!!.toJson())
+                ReadableType.Boolean -> put(key, getBoolean(key))
+                ReadableType.Map -> put(key, getMap(key)!!.toJson())
+                ReadableType.Null -> put(key, JsonNull)
+                ReadableType.Number -> put(key, getDouble(key))
+                ReadableType.String -> put(key, getString(key))
+            }
+        }
+    }
+}
+
+internal fun ReadableArray.toJson(): JsonArray = buildJsonArray {
+    for (i in 0 until size()) {
+        when (getType(i)) {
+            ReadableType.Array -> add(getArray(i)!!.toJson())
+            ReadableType.Boolean -> add(getBoolean(i))
+            ReadableType.Map -> add(getMap(i)!!.toJson())
+            ReadableType.Null -> {}
+            ReadableType.Number -> add(getDouble(i))
+            ReadableType.String -> add(getString(i))
+        }
+    }
+}
+
+internal fun JsonObject.toReadableMap(): ReadableMap {
+    val map: WritableMap = WritableNativeMap()
+    val iterator = keys.iterator()
+    while (iterator.hasNext()) {
+        val key = iterator.next()
+        when (val value = this[key]) {
+            is JsonPrimitive -> when {
+                value.booleanOrNull != null -> map.putBoolean(key, value.boolean)
+                value.doubleOrNull != null -> map.putDouble(key, value.double)
+                value.intOrNull != null -> map.putInt(key, value.int)
+                value.isString -> map.putString(key, value.content)
+            }
+            is JsonArray -> map.putArray(key, value.toReadableArray())
+            is JsonObject -> map.putMap(key, value.toReadableMap())
+            else -> map.putString(key, value.toString())
+        }
+    }
+    return map
+}
+
+internal fun JsonArray.toReadableArray(): ReadableArray {
+    val array: WritableArray = WritableNativeArray()
+    for (i in 0 until size) {
+        when (val value = this[i]) {
+            is JsonPrimitive -> when {
+                value.booleanOrNull != null -> array.pushBoolean(value.boolean)
+                value.doubleOrNull != null -> array.pushDouble(value.double)
+                value.intOrNull != null -> array.pushInt(value.int)
+                value.isString -> array.pushString(value.toString())
+            }
+            is JsonArray -> array.pushArray(value.toReadableArray())
+            is JsonObject -> array.pushMap(value.toReadableMap())
+            else -> array.pushString(value.toString())
+        }
+    }
+    return array
 }

package/android/src/main/java/com/solanamobile/seedvault/reactnative/SeedVaultLibReactNativePackage.kt

@@ -1,16 +1,16 @@
-package com.solanamobile.seedvault.reactnative
-
-import com.facebook.react.ReactPackage
-import com.facebook.react.bridge.NativeModule
-import com.facebook.react.bridge.ReactApplicationContext
-import com.facebook.react.uimanager.ViewManager
-
-class SeedVaultLibReactNativePackage : ReactPackage {
-    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
-        return listOf(SolanaMobileSeedVaultLibModule(reactContext))
-    }
-
-    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
-        return emptyList()
-    }
+package com.solanamobile.seedvault.reactnative
+
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
+
+class SeedVaultLibReactNativePackage : ReactPackage {
+    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
+        return listOf(SolanaMobileSeedVaultLibModule(reactContext))
+    }
+
+    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
+        return emptyList()
+    }
 }