@bennyblader/ddk-rn 0.1.4 → 0.2.0

package/README.md

@@ -1,33 +1,206 @@
-# ddk-rn
+# @bennyblader/ddk-rn
 
-rust-dlc bindings for react-native
+React Native bindings for the DLC Dev Kit (DDK) - UniFFI-based native bindings for React Native applications.
 
 ## Installation
 
-```sh
-npm install ddk-rn
+```bash
+npm install @bennyblader/ddk-rn
+# or
+pnpm add @bennyblader/ddk-rn
 ```
 
-## Usage
+## Quick Start
 
+```typescript
+import { version, createFundTxLockingScript } from '@bennyblader/ddk-rn';
 
-```js
-import { multiply } from 'ddk-rn';
+console.log(`DDK Version: ${version()}`);
+```
+
+For complete API documentation, see the [main README](../README.md#api-reference).
+
+## Development
+
+### Prerequisites
 
-// ...
+- Node.js >= 14
+- Rust >= 1.70
+- pnpm
+- UniFFI React Native: `npm install -g uniffi-bindgen-react-native`
+- iOS: Xcode 14+, CocoaPods
+- Android: Android Studio, NDK
 
-const result = multiply(3, 7);
+### Building from Source
+
+```bash
+# Install dependencies
+pnpm install
+
+# Generate all bindings and build native libraries
+just uniffi
+
+# Note: After building, manually fix the include path in cpp/bennyblader-ddk-rn.cpp
+# Change: #include "/ddk_ffi.hpp"
+# To: #include "ddk_ffi.hpp"
 ```
 
+### Just Commands
 
-## Contributing
+```bash
+# Complete build (generates bindings + builds iOS/Android)
+just uniffi
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+# Generate JSI bindings only
+just uniffi-jsi
 
-## License
+# Generate TurboModule specifications
+just uniffi-turbo
 
-MIT
+# Build iOS libraries
+just build-ios
+
+# Build Android libraries
+just build-android
+
+# Setup example app
+just example
+
+# iOS example setup
+just example-ios
+
+# Android example build
+just example-android
+
+# Clean all generated files
+just clean
+
+# Release new version
+just release
+
+# Create release archives
+just release-archives
+```
+
+### Project Structure
+
+```
+ddk-rn/
+├── src/                # Generated TypeScript bindings
+│   ├── index.tsx       # Main entry point (generated)
+│   └── ddk_ffi*.ts     # Type definitions (generated)
+├── cpp/                # Generated C++ JSI bindings
+│   ├── ddk_ffi.hpp     # C++ header (generated)
+│   ├── ddk_ffi.cpp     # C++ implementation (generated)
+│   └── *.cpp/.h        # TurboModule files (generated)
+├── ios/                # iOS native module
+│   ├── DdkRn.xcframework/ # iOS framework (generated)
+│   └── *.swift/.m      # iOS bridge code
+├── android/            # Android native module
+│   └── src/main/
+│       ├── java/       # Kotlin/Java bridge code
+│       └── jniLibs/    # Native libraries (generated)
+├── example/            # Example React Native app
+├── scripts/            # Build and release scripts
+└── ubrn.config.yaml    # UniFFI React Native configuration
+```
+
+### Platform Support
+
+| Platform      | Architecture | Status       |
+| ------------- | ------------ | ------------ |
+| iOS           | ARM64        | ✅ Supported |
+| iOS Simulator | x64/ARM64    | ✅ Supported |
+| Android       | ARM64-v8a    | ✅ Supported |
+| Android       | ARMv7        | ✅ Supported |
+| Android       | x86_64       | ✅ Supported |
+
+### Building the Example App
+
+#### iOS
+
+```bash
+# Install iOS dependencies with new architecture
+just example-ios
+
+# Run the app
+cd example
+npx react-native run-ios
+```
+
+#### Android
 
----
+```bash
+# Build Android app
+just example-android
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+# Run the app
+cd example
+npx react-native run-android
+```
+
+### Release Process
+
+To release a new version:
+
+```bash
+just release
+```
+
+This will:
+
+1. Build all native bindings
+2. Run tests
+3. Update version
+4. Create release commit and tag
+5. Push to GitHub
+6. Publish to npm
+
+### API Compatibility
+
+The React Native bindings maintain 100% API compatibility with the UniFFI definitions. All functions are generated directly from the UDL file ensuring consistency across platforms.
+
+### Known Issues
+
+1. **Manual Include Path Fix**: After running `just uniffi`, you must manually fix the include path in `cpp/bennyblader-ddk-rn.cpp`:
+   - Change: `#include "/ddk_ffi.hpp"`
+   - To: `#include "ddk_ffi.hpp"`
+
+2. **New Architecture**: The library requires React Native's new architecture to be enabled:
+   - iOS: Set `RCT_NEW_ARCH_ENABLED=1`
+   - Android: Set `newArchEnabled=true` in `gradle.properties`
+
+## Troubleshooting
+
+### iOS Build Issues
+
+If you encounter build issues on iOS:
+
+```bash
+cd example/ios
+pod deintegrate
+pod install
+```
+
+### Android Build Issues
+
+Clean and rebuild Android:
+
+```bash
+cd example/android
+./gradlew clean
+./gradlew build
+```
+
+### Missing Bindings
+
+If bindings are missing, regenerate them:
+
+```bash
+just clean
+just uniffi
+```
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bennyblader/ddk-rn",
-  "version": "0.1.4",
-  "description": "rust-dlc bindings for react-native",
+  "version": "0.2.0",
+  "description": "dlcdevkit bindings for react-native",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",
@@ -21,20 +21,27 @@
   "files": [
     "src",
     "lib",
-    "android",
-    "ios",
     "cpp",
+    "android/build.gradle",
+    "android/CMakeLists.txt",
+    "android/cpp-adapter.cpp",
+    "android/gradle.properties",
+    "android/proguard-rules.pro",
+    "android/src/main/AndroidManifest.xml",
+    "android/src/main/AndroidManifestNew.xml",
+    "android/src/main/java",
+    "ios/DdkRn.h",
+    "ios/DdkRn.mm",
     "scripts/postinstall.js",
     "*.podspec",
     "react-native.config.json",
-    "!ios/build",
-    "!ios/*.xcframework",
-    "!android/build",
-    "!android/gradle",
-    "!android/gradlew",
-    "!android/gradlew.bat",
-    "!android/local.properties",
-    "!android/src/main/jniLibs",
+    "README.md",
+    "!**/*.a",
+    "!**/*.so",
+    "!**/*.dylib",
+    "!**/*.framework",
+    "!**/*.xcframework",
+    "!**/jniLibs",
     "!**/__tests__",
     "!**/__fixtures__",
     "!**/__mocks__",
@@ -77,7 +84,6 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^17.0.2",
-    "@evilmartians/lefthook": "^1.5.0",
     "@react-native-community/cli": "15.0.0-alpha.2",
     "@react-native/eslint-config": "^0.73.1",
     "@release-it/conventional-changelog": "^9.0.2",
@@ -104,12 +110,15 @@
     "react": "*",
     "react-native": "*"
   },
-  "packageManager": "yarn@3.6.1",
   "jest": {
-    "preset": "react-native",
+    "testEnvironment": "node",
     "modulePathIgnorePatterns": [
       "<rootDir>/example/node_modules",
       "<rootDir>/lib/"
+    ],
+    "testMatch": [
+      "**/__tests__/**/*.js",
+      "**/?(*.)+(spec|test).js"
     ]
   },
   "commitlint": {

package/scripts/postinstall.js

@@ -5,25 +5,47 @@ const path = require('path');
 const https = require('https');
 const { execSync } = require('child_process');
 
-// Get package version to determine which release to download
-// __dirname is ddk-rn/scripts/, so package.json is at ../package.json
-const packageJsonPath = path.join(__dirname, '..', 'package.json');
-const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+const packageRoot = path.join(__dirname, '..');
+const packageJson = JSON.parse(fs.readFileSync(path.join(packageRoot, 'package.json'), 'utf8'));
 const version = packageJson.version;
 
 const GITHUB_REPO = 'bennyhodl/ddk-ffi';
 const RELEASE_TAG = `v${version}`;
 
-// Detect platform and architecture
-const platform = process.platform;
-const arch = process.arch;
+console.log(`📦 DDK-RN Post-install: Setting up native binaries for v${version}...`);
 
-console.log(`📦 Installing native binaries for ${platform}-${arch}...`);
+// Define all required files for verification
+const requiredFiles = {
+  'TypeScript bindings': [
+    'src/ddk_ffi.ts',
+    'src/ddk_ffi-ffi.ts',
+    'src/NativeDdkRn.ts',
+    'src/index.tsx'
+  ],
+  'C++ bindings': [
+    'cpp/ddk_ffi.hpp',
+    'cpp/ddk_ffi.cpp',
+    'cpp/bennyblader-ddk-rn.h',
+    'cpp/bennyblader-ddk-rn.cpp'
+  ],
+  'Android libraries': [
+    'android/src/main/arm64-v8a/libddk_ffi.a',
+    'android/src/main/armeabi-v7a/libddk_ffi.a',
+    'android/src/main/x86/libddk_ffi.a',
+    'android/src/main/x86_64/libddk_ffi.a'
+  ],
+  'iOS framework': [
+    'ios/DdkRn.xcframework/Info.plist',
+    'ios/DdkRn.xcframework/ios-arm64/libddk_ffi.a',
+    'ios/DdkRn.xcframework/ios-arm64-simulator/libddk_ffi.a'
+  ],
+  'JavaScript modules': [
+    'lib/commonjs/index.js',
+    'lib/module/index.js'
+  ]
+};
 
 // Create directories if they don't exist
-const androidLibsDir = path.join(__dirname, '..', 'android', 'src', 'main', 'jniLibs');
-const iosFrameworksDir = path.join(__dirname, '..', 'ios');
-
 function ensureDir(dir) {
   if (!fs.existsSync(dir)) {
     fs.mkdirSync(dir, { recursive: true });
@@ -32,7 +54,7 @@ function ensureDir(dir) {
 
 function downloadFile(url, dest) {
   return new Promise((resolve, reject) => {
-    console.log(`⬇️  Downloading ${url}`);
+    console.log(`⬇️  Downloading from ${url}...`);
     
     const file = fs.createWriteStream(dest);
     
@@ -71,60 +93,141 @@ function extractTarGz(tarPath, extractDir) {
   }
 }
 
+function verifyAllFiles() {
+  console.log('\n🔍 Verifying all required files...');
+  
+  let allFilesPresent = true;
+  const platform = process.platform;
+  
+  for (const [category, files] of Object.entries(requiredFiles)) {
+    // Skip iOS files on non-macOS platforms
+    if (category === 'iOS framework' && platform !== 'darwin') {
+      console.log(`\n⚠️  Skipping ${category} verification (not on macOS)`);
+      continue;
+    }
+    
+    console.log(`\n📋 Checking ${category}...`);
+    
+    for (const file of files) {
+      const filePath = path.join(packageRoot, file);
+      if (fs.existsSync(filePath)) {
+        console.log(`  ✅ ${file}`);
+      } else {
+        console.error(`  ❌ Missing: ${file}`);
+        allFilesPresent = false;
+      }
+    }
+  }
+  
+  return allFilesPresent;
+}
+
 async function downloadAndExtractBinaries() {
+  const platform = process.platform;
+  
   try {
-    // Download Android JNI libraries
+    // Download Android native libraries
+    const androidLibsDir = path.join(packageRoot, 'android', 'src', 'main');
+    ensureDir(androidLibsDir);
+    
     const androidArchiveUrl = `https://github.com/${GITHUB_REPO}/releases/download/${RELEASE_TAG}/android-jni-libs.tar.gz`;
-    const androidTarPath = path.join(__dirname, '..', 'android-jni-libs.tar.gz');
+    const androidTarPath = path.join(packageRoot, 'android-jni-libs.tar.gz');
     
-    ensureDir(androidLibsDir);
+    console.log('\n📱 Setting up Android native libraries...');
     await downloadFile(androidArchiveUrl, androidTarPath);
-    extractTarGz(androidTarPath, path.join(__dirname, '..', 'android', 'src', 'main'));
-    fs.unlinkSync(androidTarPath); // Clean up
+    extractTarGz(androidTarPath, androidLibsDir);
+    fs.unlinkSync(androidTarPath); // Clean up tar file
     
-    // Download iOS XCFramework (only on macOS for iOS development)
+    // Download iOS XCFramework (only on macOS)
     if (platform === 'darwin') {
+      const iosFrameworksDir = path.join(packageRoot, 'ios');
+      ensureDir(iosFrameworksDir);
+      
       const iosArchiveUrl = `https://github.com/${GITHUB_REPO}/releases/download/${RELEASE_TAG}/ios-xcframeworks.tar.gz`;
-      const iosTarPath = path.join(__dirname, '..', 'ios-xcframeworks.tar.gz');
+      const iosTarPath = path.join(packageRoot, 'ios-xcframeworks.tar.gz');
       
-      ensureDir(iosFrameworksDir);
+      console.log('\n🍎 Setting up iOS framework...');
       await downloadFile(iosArchiveUrl, iosTarPath);
       extractTarGz(iosTarPath, iosFrameworksDir);
-      fs.unlinkSync(iosTarPath); // Clean up
+      fs.unlinkSync(iosTarPath); // Clean up tar file
     } else {
-      console.log('⚠️  Skipping iOS binaries (not on macOS)');
+      console.log('\n⚠️  Skipping iOS framework (not on macOS)');
     }
     
-    console.log('🎉 All native binaries installed successfully!');
-    
   } catch (error) {
-    console.error('❌ Failed to install native binaries:', error.message);
+    console.error('\n❌ Failed to download native binaries:', error.message);
     console.error('');
-    console.error('📋 Manual installation:');
+    console.error('📋 Manual installation instructions:');
     console.error(`   1. Download binaries from: https://github.com/${GITHUB_REPO}/releases/tag/${RELEASE_TAG}`);
     console.error('   2. Extract android-jni-libs.tar.gz to android/src/main/');
     console.error('   3. Extract ios-xcframeworks.tar.gz to ios/ (macOS only)');
     console.error('');
+    console.error('Or report this issue at: https://github.com/bennyhodl/ddk-ffi/issues');
     
-    // Don't fail the installation - let users manually install if needed
+    // Don't fail the installation completely
     process.exit(0);
   }
 }
 
-// Check if binaries already exist (skip if they do)
-const androidLibExists = fs.existsSync(path.join(androidLibsDir, 'arm64-v8a'));
-const iosFrameworkExists = fs.existsSync(path.join(iosFrameworksDir, 'DdkFFI.xcframework'));
-
-if (androidLibExists && (platform !== 'darwin' || iosFrameworkExists)) {
-  console.log('✅ Native binaries already installed, skipping download.');
-  process.exit(0);
-}
-
-// Only download if we're not in a CI environment or explicit opt-in
-if (process.env.CI && !process.env.DOWNLOAD_BINARIES) {
-  console.log('⚠️  Skipping binary download in CI environment.');
-  console.log('   Set DOWNLOAD_BINARIES=1 to force download in CI.');
-  process.exit(0);
+async function main() {
+  const platform = process.platform;
+  
+  // Skip in CI unless explicitly requested
+  if (process.env.CI && !process.env.DOWNLOAD_BINARIES) {
+    console.log('⚠️  Skipping binary download in CI environment.');
+    console.log('   Set DOWNLOAD_BINARIES=1 to force download in CI.');
+    process.exit(0);
+  }
+  
+  // Check if binaries already exist
+  const androidLibExists = fs.existsSync(path.join(packageRoot, 'android', 'src', 'main', 'arm64-v8a', 'libddk_ffi.a'));
+  const iosFrameworkExists = fs.existsSync(path.join(packageRoot, 'ios', 'DdkRn.xcframework'));
+  
+  let needsDownload = false;
+  
+  if (!androidLibExists) {
+    console.log('📱 Android libraries not found, will download...');
+    needsDownload = true;
+  }
+  
+  if (platform === 'darwin' && !iosFrameworkExists) {
+    console.log('🍎 iOS framework not found, will download...');
+    needsDownload = true;
+  }
+  
+  if (needsDownload) {
+    await downloadAndExtractBinaries();
+  } else {
+    console.log('✅ Native binaries already present.');
+  }
+  
+  // Fix the C++ include path issue if needed
+  const cppFile = path.join(packageRoot, 'cpp', 'bennyblader-ddk-rn.cpp');
+  if (fs.existsSync(cppFile)) {
+    let content = fs.readFileSync(cppFile, 'utf8');
+    if (content.includes('#include "/ddk_ffi.hpp"')) {
+      content = content.replace('#include "/ddk_ffi.hpp"', '#include "ddk_ffi.hpp"');
+      fs.writeFileSync(cppFile, content);
+      console.log('\n🔧 Fixed include path in C++ bindings');
+    }
+  }
+  
+  // Verify all files are present
+  const allFilesPresent = verifyAllFiles();
+  
+  if (!allFilesPresent) {
+    console.error('\n❌ Some required files are missing!');
+    console.error('The package installation may have failed.');
+    console.error('Please report this issue at: https://github.com/bennyhodl/ddk-ffi/issues');
+    process.exit(1);
+  }
+  
+  console.log('\n✅ All required files verified!');
+  console.log('🎉 DDK-RN is ready to use!\n');
 }
 
-downloadAndExtractBinaries();
+// Run the main function
+main().catch(error => {
+  console.error('❌ Unexpected error:', error);
+  process.exit(1);
+});

package/LICENSE

@@ -1,20 +0,0 @@
-MIT License
-
-Copyright (c) 2025 benny b
-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.