react-native-rgb 0.2.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 Orbis1
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,165 @@
+# react-native-rgb
+
+A React Native Turbo Module for the Bitcoin RGB Protocol. This library provides a high-level TypeScript API to manage RGB assets, keys, and wallets. It wraps the native [rgb-lib-swift](https://github.com/RGB-Tools/rgb-lib-swift) and [rgb-lib-kotlin](https://github.com/RGB-Tools/rgb-lib-kotlin) libraries.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+- [Running the Example](#running-the-example)
+- [Project Structure](#project-structure)
+- [Troubleshooting](#troubleshooting)
+
+## Features
+
+- **Full Asset Support**: Handle NIA, UDA, CFA, and IFA.
+- **Key Management**: BIP39 mnemonic support for key generation and restoration.
+- **Performance**: Built as a Turbo Module for efficient native communication.
+- **Type Safety**: Written in TypeScript.
+
+## Installation
+
+```bash
+yarn add react-native-rgb
+```
+
+### iOS Setup
+
+The native Rust framework (`rgb_libFFI.xcframework`) is automatically downloaded during `postinstall`. 
+
+```bash
+cd ios && pod install
+```
+
+### Android Setup
+
+The library requires `minSdkVersion` 24. Make sure your `android/build.gradle` includes JitPack if necessary for transitive dependencies:
+
+```gradle
+allprojects {
+    repositories {
+        maven { url 'https://jitpack.io' }
+    }
+}
+```
+
+## Quick Start
+
+### 1. Setup Keys
+```typescript
+import { generateKeys, BitcoinNetwork } from 'react-native-rgb';
+
+const keys = await generateKeys(BitcoinNetwork.TESTNET4);
+```
+
+### 2. Initialize Wallet
+```typescript
+import { Wallet } from 'react-native-rgb';
+
+const wallet = new Wallet(keys, { network: BitcoinNetwork.TESTNET4 });
+```
+
+### 3. Basic Operations
+```typescript
+// Bring the wallet online
+await wallet.goOnline('ssl://electrum.iriswallet.com:50053');
+
+// Issue a new NIA asset
+const asset = await wallet.issueAssetNia('TICKER', 'Name', 2, [1000]);
+
+// Check your balance
+const btcBalance = await wallet.getBtcBalance();
+```
+
+## Error Handling
+
+The library uses structured error handling with error codes for better error management. All methods that can fail will throw an `RgbError` with a specific error code.
+
+### Using RgbError
+
+```typescript
+import { Wallet, RgbError, RgbErrorCode } from 'react-native-rgb';
+
+try {
+  await wallet.goOnline('ssl://indexer.example.com:50053');
+} catch (error) {
+  // Convert React Native error to RgbError
+  const rgbError = RgbError.fromReactNativeError(error);
+  
+  if (rgbError instanceof RgbError) {
+    // Handle specific error codes
+    switch (rgbError.code) {
+      case RgbErrorCode.GO_ONLINE_ERROR:
+        console.error('Failed to connect:', rgbError.message);
+        // Handle connection error
+        break;
+      case RgbErrorCode.INITIALIZE_WALLET_ERROR:
+        console.error('Wallet initialization failed:', rgbError.message);
+        // Handle initialization error
+        break;
+      default:
+        console.error(`Error [${rgbError.code}]:`, rgbError.message);
+    }
+  } else {
+    // Handle generic errors
+    console.error('Unexpected error:', error);
+  }
+}
+```
+
+
+## API Reference
+
+### Keys & Wallet Setup
+- `generateKeys(network)` / `restoreKeys(network, mnemonic)`
+- `new Wallet(keys, options)`: Options include `network`, `maxAllocationsPerUtxo`, and `vanillaKeychain`.
+
+### Wallet
+- `goOnline(indexerUrl, skipSync?)`: Connect to infrastructure.
+- `sync()`: Manually trigger a blockchain sync.
+- `close()`: Shut down the wallet and free native resources.
+
+### Balance & Assets
+- `getBtcBalance()`: Returns `{ vanilla: Balance, colored: Balance }`.
+- `getAddress()`: Returns the funding address.
+- `getAssetBalance(assetId)` / `getAssetMetadata(assetId)`
+- `listAssets(filter[])`: List assets by schema (NIA, UDA, CFA, IFA).
+
+### Asset Issuance
+- `issueAssetNia(ticker, name, precision, amounts)`
+- `issueAssetCfa(name, details, precision, amounts, filePath?)`
+- `issueAssetUda(ticker, name, details, precision, mediaPath, attachments[])`
+- `issueAssetIfa(ticker, name, precision, amounts, ...)`
+
+### Sending & Receiving
+- `blindReceive(assetId, amount, duration, endpoints, confirmations)`: Get a blinded invoice.
+- `witnessReceive(...)`: Get a witness invoice.
+- `send(recipientMap, donation, feeRate, confirmations)`: Send RGB assets.
+- `sendBtc(address, amount, feeRate)`: Send regular Bitcoin.
+
+
+## Project Structure
+
+- `src/`: TypeScript source (Wallet class, Interfaces).
+- `android/` & `ios/`: Native Turbo Module implementations.
+- `scripts/`: Build and setup scripts.
+- `example/`: Sample React Native app.
+
+## Running the Example
+
+1. `yarn install` (root)
+2. `yarn prepare` (build library)
+3. `cd example && yarn install`
+4. `cd ios && pod install`
+5. `yarn ios` or `yarn android`
+
+## Troubleshooting
+
+- **iOS framework**: If a postinstall fails, run `node scripts/download-rgb-lib-ios.js` manually.
+- **Linker issues**: Ensure you use the `.xcworkspace` on iOS.
+- **Android SDK**: Must have `minSdkVersion >= 24`.
+
+## License
+
+MIT

package/Rgb.podspec

@@ -0,0 +1,23 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "Rgb"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://www.github.com/Orbis-1/react-native-rgb.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift,cpp}"
+  s.private_header_files = "ios/**/*.h"
+    
+  s.vendored_frameworks = "ios/rgb_libFFI.xcframework"
+  s.preserve_paths = "ios/rgb_libFFI.xcframework"
+
+  install_modules_dependencies(s)
+end

package/android/build.gradle

@@ -0,0 +1,80 @@
+buildscript {
+  ext.getExtOrDefault = {name ->
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['Rgb_' + name]
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.7.2"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+  }
+}
+
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+apply plugin: "com.facebook.react"
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["Rgb_" + name]).toInteger()
+}
+
+android {
+  namespace "com.rgb"
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  sourceSets {
+    main {
+      java.srcDirs += [
+        "generated/java",
+        "generated/jni"
+      ]
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+  implementation("org.rgbtools:rgb-lib-android:0.3.0-beta.4")
+  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3"
+  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1"
+}

package/android/gradle.properties

@@ -0,0 +1,5 @@
+Rgb_kotlinVersion=2.0.21
+Rgb_minSdkVersion=24
+Rgb_targetSdkVersion=34
+Rgb_compileSdkVersion=35
+Rgb_ndkVersion=27.1.12297006

package/android/src/main/AndroidManifest.xml

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

package/android/src/main/java/com/rgb/AppConstants.kt

@@ -0,0 +1,57 @@
+package com.rgb
+
+import android.content.Context
+import java.io.File
+
+object AppConstants {
+  const val rgbDirName = ""
+  var appContext: Context? = null
+  var rgbDir: File? = null
+  const val backupName = "%s.rgb_backup"
+
+  const val testnetElectrumURL = "ssl://electrum.iriswallet.com:50013"
+  const val testnet4ElectrumURL = "ssl://electrum.iriswallet.com:50053"
+
+  const val regtestElectrumURL = "electrum.rgbtools.org:50041"
+  const val mainnetElectrumUrl = "ssl://electrum.iriswallet.com:50003"
+
+  const val proxyConsignmentEndpoint = "rpcs://proxy.iriswallet.com/0.2/json-rpc"
+  const val rgbDefaultPrecision: UByte = 0U
+  const val defaultFeeRate = 50.0F
+
+  private val mainnetUrls = listOf(
+    "ssl://electrum.iriswallet.com:50003",
+    "https://blockstream.info/api"
+  )
+  private var callCount = 0
+
+  @JvmStatic
+  fun initContext(context: Context) {
+    appContext = context
+    rgbDir = File(context.filesDir, rgbDirName)
+  }
+
+  @JvmStatic
+  fun ensureInitialized(context: Context) {
+    if (appContext == null || rgbDir == null) {
+      initContext(context)
+    }
+  }
+
+  fun getElectrumUrl(network: String): String {
+    return when (network.uppercase()) {
+      "TESTNET" -> testnetElectrumURL
+      "TESTNET4" -> testnet4ElectrumURL
+      "REGTEST" -> regtestElectrumURL
+      "MAINNET" -> getNextMainnetUrl()
+      else -> testnetElectrumURL
+    }
+  }
+
+  private fun getNextMainnetUrl(): String {
+    val url = mainnetUrls[callCount % mainnetUrls.size]
+    callCount++
+    return url
+  }
+}
+