react-native-pirate-wallet 0.2.1 → 0.3.2

package/README.md

@@ -76,8 +76,10 @@ await sdk.configureAccountStorage({
 - `scripts/`
 - `src/`
 
-The Android native libraries are distributed in the exact-version
-`react-native-pirate-wallet-android` companion package.
+Native libraries are distributed in exact-version Android ARM, Android x86_64,
+iOS device, iOS simulator arm64, and iOS simulator x86_64 companion packages.
+On macOS, CocoaPods combines the two thin simulator archives into the universal
+XCFramework slice expected by Xcode.
 
 ## Preparing native artifacts in this repo
 
@@ -89,8 +91,9 @@ bash scripts/prepare-react-native-plugin.sh
 
 That copies:
 
-- Android JNI libraries into `bindings/react-native-pirate-wallet-android/`
-- the iOS XCFramework into this package
+- Android JNI libraries into the two Android companion packages
+- the iOS device XCFramework slice and two thin simulator archives into the
+  three iOS companion packages
 
 There is also a minimal consumer app in:
 
@@ -289,13 +292,18 @@ Receive-address APIs are shielded and wallet-scoped:
   - returns generated external receive addresses
 - `listAddressBalances(walletId, keyId?)`
   - RPC: `list_address_balances`
-  - returns per-address balance entries
+  - without `keyId`, returns external receive-address balance entries only
+  - with `keyId`, also returns internal change-address entries for that key group
 
 These APIs return shielded receive addresses. Newly generated addresses use
-Sapling before Ironwood activation and Ironwood after activation. The current
-address can still be an older Sapling address until the wallet rotates, and
-`listAddresses(walletId)` can contain both Sapling and Ironwood receive
-addresses over time.
+Sapling before Ironwood activation and Ironwood after activation. At activation,
+both current- and next-address calls select Ironwood; existing Sapling addresses
+remain valid, so `listAddresses(walletId)` can contain both pools over time.
+
+Internal change is always included in `getBalance(walletId)`. Do not sum an
+unfiltered `listAddressBalances(walletId)` response to calculate the wallet
+total, because its default external-only view intentionally omits internal
+address rows.
 
 - `getBalance(walletId)`
   - RPC: `get_balance`
@@ -529,9 +537,10 @@ npm install react-native-pirate-wallet
 cd ios && pod install
 ```
 
-On Android, npm installs the exact-version
-`react-native-pirate-wallet-android` companion automatically. The wrapper
-autolinks as a standard React Native native module and adds the companion's JNI
-libraries to the build.
+On Android, npm installs the exact-version ARM and x86_64 companions
+automatically. The wrapper autolinks as a standard React Native native module
+and adds their JNI libraries to the build.
 
-On iOS, the podspec links the vendored `PirateWalletNative.xcframework`.
+On macOS, npm installs the exact-version device and simulator companions.
+During `pod install`, the podspec assembles and links
+`PirateWalletNative.xcframework` from those packages.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-pirate-wallet",
-  "version": "0.2.1",
+  "version": "0.3.2",
   "description": "React Native wrapper for the Pirate Unified Wallet native SDK surfaces",
   "keywords": [
     "react-native",
@@ -43,7 +43,6 @@
     "test": "node test/smoke.js",
     "verify:package": "node scripts/verify-package.js",
     "prepare:native": "node scripts/assemble-ios-framework.js",
-    "postinstall": "npm run prepare:native",
     "prepack": "node scripts/verify-package.js --publish-layout"
   },
   "engines": {
@@ -53,10 +52,11 @@
     "react-native": ">=0.71.0 <1.0.0"
   },
   "optionalDependencies": {
-    "react-native-pirate-wallet-android": "0.2.1",
-    "react-native-pirate-wallet-android-x86_64": "0.2.1",
-    "react-native-pirate-wallet-ios-device": "0.2.1",
-    "react-native-pirate-wallet-ios-simulator": "0.2.1"
+    "react-native-pirate-wallet-android": "0.3.2",
+    "react-native-pirate-wallet-android-x86_64": "0.3.2",
+    "react-native-pirate-wallet-ios-device": "0.3.2",
+    "react-native-pirate-wallet-ios-simulator-arm64": "0.3.2",
+    "react-native-pirate-wallet-ios-simulator-x86_64": "0.3.2"
   },
   "publishConfig": {
     "access": "public"

package/react-native-pirate-wallet.podspec

@@ -2,6 +2,16 @@ require "json"
 
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
+assembly_script = File.join(__dir__, "scripts", "assemble-ios-framework.js")
+framework_path = File.join(__dir__, "ios", "Frameworks", "PirateWalletNative.xcframework")
+
+# npm may block dependency lifecycle scripts, so assemble the split iOS binary
+# packages when CocoaPods actually needs the framework.
+Pod::Executable.execute_command("node", [assembly_script, "--force"])
+unless File.directory?(framework_path)
+  raise Pod::Informative, "PirateWalletNative.xcframework could not be assembled"
+end
+
 Pod::Spec.new do |s|
   s.name         = package["name"]
   s.version      = package["version"]

package/scripts/assemble-ios-framework.js

@@ -1,18 +1,23 @@
-'use strict';
+"use strict";
 
-const fs = require('fs');
-const path = require('path');
+const childProcess = require("child_process");
+const fs = require("fs");
+const path = require("path");
 
-const packageRoot = path.resolve(__dirname, '..');
-const frameworkName = 'PirateWalletNative.xcframework';
-const iosPackages = [
+const packageRoot = path.resolve(__dirname, "..");
+const frameworkName = "PirateWalletNative.xcframework";
+const devicePackage = {
+  name: "react-native-pirate-wallet-ios-device",
+  slice: "ios-arm64",
+};
+const simulatorPackages = [
   {
-    name: 'react-native-pirate-wallet-ios-device',
-    slice: 'ios-arm64',
+    name: "react-native-pirate-wallet-ios-simulator-arm64",
+    architecture: "arm64",
   },
   {
-    name: 'react-native-pirate-wallet-ios-simulator',
-    slice: 'ios-arm64_x86_64-simulator',
+    name: "react-native-pirate-wallet-ios-simulator-x86_64",
+    architecture: "x86_64",
   },
 ];
 
@@ -22,43 +27,41 @@ function candidatePackageJsonPaths(packageName) {
     candidates.push(
       require.resolve(`${packageName}/package.json`, {
         paths: [process.cwd(), packageRoot],
-      }),
+      })
     );
   } catch (_) {
     // The monorepo package is resolved below before it has been published.
   }
-  candidates.push(
-    path.resolve(packageRoot, '..', packageName, 'package.json'),
-  );
+  candidates.push(path.resolve(packageRoot, "..", packageName, "package.json"));
   return [...new Set(candidates)];
 }
 
 function resolvePackage(packageName, expectedVersion) {
   for (const packageJsonPath of candidatePackageJsonPaths(packageName)) {
-    if (!fs.statSync(packageJsonPath, {throwIfNoEntry: false})?.isFile()) {
+    if (!fs.statSync(packageJsonPath, { throwIfNoEntry: false })?.isFile()) {
       continue;
     }
-    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
     if (packageJson.name !== packageName) {
       continue;
     }
     if (packageJson.version !== expectedVersion) {
       throw new Error(
         `${packageName}@${packageJson.version} does not match ` +
-          `react-native-pirate-wallet@${expectedVersion}`,
+          `react-native-pirate-wallet@${expectedVersion}`
       );
     }
-    return path.dirname(packageJsonPath);
+    return { root: path.dirname(packageJsonPath), packageJson };
   }
   throw new Error(
     `${packageName}@${expectedVersion} is required to build ` +
-      'react-native-pirate-wallet for iOS',
+      "react-native-pirate-wallet for iOS"
   );
 }
 
 function linkTree(source, destination) {
-  fs.mkdirSync(destination, {recursive: true});
-  for (const entry of fs.readdirSync(source, {withFileTypes: true})) {
+  fs.mkdirSync(destination, { recursive: true });
+  for (const entry of fs.readdirSync(source, { withFileTypes: true })) {
     const sourcePath = path.join(source, entry.name);
     const destinationPath = path.join(destination, entry.name);
     if (entry.isDirectory()) {
@@ -71,7 +74,7 @@ function linkTree(source, destination) {
     try {
       fs.linkSync(sourcePath, destinationPath);
     } catch (error) {
-      if (!['EXDEV', 'EPERM', 'EACCES', 'EMLINK'].includes(error.code)) {
+      if (!["EXDEV", "EPERM", "EACCES", "EMLINK"].includes(error.code)) {
         throw error;
       }
       fs.copyFileSync(sourcePath, destinationPath);
@@ -79,45 +82,140 @@ function linkTree(source, destination) {
   }
 }
 
+function runXcrun(args) {
+  const result = childProcess.spawnSync("xcrun", args, { encoding: "utf8" });
+  if (result.error) {
+    throw result.error;
+  }
+  if (result.status !== 0) {
+    throw new Error(
+      `xcrun ${args.join(" ")} failed:\n${result.stderr || result.stdout}`
+    );
+  }
+  return result.stdout.trim();
+}
+
+function verifyArchitectures(archive, expected) {
+  const actual = runXcrun(["lipo", "-archs", archive]).split(/\s+/).sort();
+  const wanted = [...expected].sort();
+  if (JSON.stringify(actual) !== JSON.stringify(wanted)) {
+    throw new Error(
+      `${archive} has architectures ${actual.join(
+        ", "
+      )}; expected ${wanted.join(", ")}`
+    );
+  }
+}
+
+function assertMatchingFile(left, right, label) {
+  const leftData = fs.readFileSync(left);
+  const rightData = fs.readFileSync(right);
+  if (!leftData.equals(rightData)) {
+    throw new Error(`iOS binary packages contain different ${label}`);
+  }
+}
+
 function assemble() {
-  if (process.platform !== 'darwin' && !process.argv.includes('--force')) {
+  if (process.platform !== "darwin") {
+    if (process.argv.includes("--force")) {
+      throw new Error("iOS XCFramework assembly requires macOS and xcrun lipo");
+    }
     return;
   }
 
   const wrapperPackage = JSON.parse(
-    fs.readFileSync(path.join(packageRoot, 'package.json'), 'utf8'),
+    fs.readFileSync(path.join(packageRoot, "package.json"), "utf8")
   );
-  const resolved = iosPackages.map(({name, slice}) => {
-    const expectedVersion = wrapperPackage.optionalDependencies?.[name];
+  function resolveExact(descriptor) {
+    const expectedVersion =
+      wrapperPackage.optionalDependencies?.[descriptor.name];
     if (expectedVersion !== wrapperPackage.version) {
-      throw new Error(`${name} must use the exact wrapper version`);
+      throw new Error(`${descriptor.name} must use the exact wrapper version`);
     }
-    const root = resolvePackage(name, expectedVersion);
     return {
-      name,
-      slice,
-      framework: path.join(root, 'ios', 'Frameworks', frameworkName),
+      ...descriptor,
+      ...resolvePackage(descriptor.name, expectedVersion),
     };
-  });
+  }
 
-  const infoPlists = resolved.map(({framework}) =>
-    fs.readFileSync(path.join(framework, 'Info.plist')),
+  const device = resolveExact(devicePackage);
+  const simulators = simulatorPackages.map(resolveExact);
+  const deviceFramework = path.join(
+    device.root,
+    "ios",
+    "Frameworks",
+    frameworkName
   );
-  if (!infoPlists.slice(1).every(data => data.equals(infoPlists[0]))) {
-    throw new Error('iOS binary packages contain different XCFramework metadata');
+  const deviceSlice = path.join(deviceFramework, device.slice);
+  if (!fs.statSync(deviceSlice, { throwIfNoEntry: false })?.isDirectory()) {
+    throw new Error(
+      `${device.name} is missing XCFramework slice ${device.slice}`
+    );
   }
 
-  const output = path.join(packageRoot, 'ios', 'Frameworks', frameworkName);
-  fs.rmSync(output, {recursive: true, force: true});
-  fs.mkdirSync(output, {recursive: true});
-  fs.writeFileSync(path.join(output, 'Info.plist'), infoPlists[0]);
+  const simulatorInputs = simulators.map((simulator) => {
+    const metadata = simulator.packageJson.pirateWalletNative;
+    if (
+      metadata?.platform !== "ios-simulator" ||
+      JSON.stringify(metadata.architectures) !==
+        JSON.stringify([simulator.architecture])
+    ) {
+      throw new Error(
+        `${simulator.name} does not identify its expected simulator architecture`
+      );
+    }
+    const archive = path.join(simulator.root, "ios", "libpirate_ffi_native.a");
+    const headers = path.join(simulator.root, "ios", "Headers");
+    verifyArchitectures(archive, [simulator.architecture]);
+    return { ...simulator, archive, headers };
+  });
 
-  for (const {name, slice, framework} of resolved) {
-    const source = path.join(framework, slice);
-    if (!fs.statSync(source, {throwIfNoEntry: false})?.isDirectory()) {
-      throw new Error(`${name} is missing XCFramework slice ${slice}`);
+  const canonicalHeaders = path.join(deviceSlice, "Headers");
+  for (const simulator of simulatorInputs) {
+    for (const header of ["module.modulemap", "pirate_wallet_service.h"]) {
+      assertMatchingFile(
+        path.join(canonicalHeaders, header),
+        path.join(simulator.headers, header),
+        header
+      );
     }
-    linkTree(source, path.join(output, slice));
+  }
+
+  const frameworksRoot = path.join(packageRoot, "ios", "Frameworks");
+  fs.mkdirSync(frameworksRoot, { recursive: true });
+  const temporaryRoot = fs.mkdtempSync(
+    path.join(frameworksRoot, `${frameworkName}.tmp-`)
+  );
+  const output = path.join(frameworksRoot, frameworkName);
+  try {
+    fs.copyFileSync(
+      path.join(deviceFramework, "Info.plist"),
+      path.join(temporaryRoot, "Info.plist")
+    );
+    linkTree(deviceSlice, path.join(temporaryRoot, device.slice));
+
+    const simulatorSlice = path.join(
+      temporaryRoot,
+      "ios-arm64_x86_64-simulator"
+    );
+    linkTree(canonicalHeaders, path.join(simulatorSlice, "Headers"));
+    const universalArchive = path.join(
+      simulatorSlice,
+      "libpirate_ffi_native.a"
+    );
+    runXcrun([
+      "lipo",
+      "-create",
+      ...simulatorInputs.map((simulator) => simulator.archive),
+      "-output",
+      universalArchive,
+    ]);
+    verifyArchitectures(universalArchive, ["arm64", "x86_64"]);
+
+    fs.rmSync(output, { recursive: true, force: true });
+    fs.renameSync(temporaryRoot, output);
+  } finally {
+    fs.rmSync(temporaryRoot, { recursive: true, force: true });
   }
 }
 

package/scripts/verify-package.js

@@ -1,9 +1,9 @@
-'use strict';
+"use strict";
 
-const fs = require('fs');
-const path = require('path');
+const fs = require("fs");
+const path = require("path");
 
-const packageRoot = path.resolve(__dirname, '..');
+const packageRoot = path.resolve(__dirname, "..");
 
 function fail(message) {
   console.error(`[react-native-pirate-wallet] ${message}`);
@@ -12,7 +12,7 @@ function fail(message) {
 
 function requireFile(relativePath) {
   const absolutePath = path.join(packageRoot, relativePath);
-  if (!fs.statSync(absolutePath, {throwIfNoEntry: false})?.isFile()) {
+  if (!fs.statSync(absolutePath, { throwIfNoEntry: false })?.isFile()) {
     fail(`Required package file is missing: ${relativePath}`);
     return;
   }
@@ -28,96 +28,117 @@ function rejectPath(relativePath) {
 }
 
 function collectFiles(directory) {
-  if (!fs.statSync(directory, {throwIfNoEntry: false})?.isDirectory()) {
+  if (!fs.statSync(directory, { throwIfNoEntry: false })?.isDirectory()) {
     return [];
   }
 
-  return fs.readdirSync(directory, {withFileTypes: true}).flatMap(entry => {
+  return fs.readdirSync(directory, { withFileTypes: true }).flatMap((entry) => {
     const entryPath = path.join(directory, entry.name);
     return entry.isDirectory() ? collectFiles(entryPath) : [entryPath];
   });
 }
 
 const packageJson = JSON.parse(
-  fs.readFileSync(path.join(packageRoot, 'package.json'), 'utf8'),
+  fs.readFileSync(path.join(packageRoot, "package.json"), "utf8")
 );
 
-if (packageJson.name !== 'react-native-pirate-wallet') {
+if (packageJson.name !== "react-native-pirate-wallet") {
   fail(`Unexpected package name: ${packageJson.name}`);
 }
 if (!/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/.test(packageJson.version)) {
-  fail(`Package version is not valid semantic versioning: ${packageJson.version}`);
+  fail(
+    `Package version is not valid semantic versioning: ${packageJson.version}`
+  );
 }
 if (packageJson.private === true) {
-  fail('The publishable package must not be marked private');
+  fail("The publishable package must not be marked private");
 }
-if (packageJson.repository?.url !== 'https://github.com/PirateNetwork/Pirate-Unified-Light-Wallet.git') {
-  fail('The repository URL must match the GitHub repository used for npm provenance');
+if (
+  packageJson.repository?.url !==
+  "https://github.com/PirateNetwork/Pirate-Unified-Light-Wallet.git"
+) {
+  fail(
+    "The repository URL must match the GitHub repository used for npm provenance"
+  );
 }
-if (packageJson.publishConfig?.access !== 'public') {
-  fail('publishConfig.access must remain public');
+if (packageJson.publishConfig?.access !== "public") {
+  fail("publishConfig.access must remain public");
 }
 
 [
-  'LICENSE-MIT',
-  'README.md',
-  'react-native.config.js',
-  'react-native-pirate-wallet.podspec',
-  'scripts/assemble-ios-framework.js',
-  'scripts/resolve-android-packages.js',
-  'test/smoke.js',
-  'src/index.js',
-  'src/index.d.ts',
-  'android/src/main/AndroidManifest.xml',
-  'android/src/main/java/com/pirate/wallet/reactnative/PirateWalletReactNativeModule.kt',
-  'ios/PirateWalletReactNative.m',
-  'ios/PirateWalletReactNative.swift',
+  "LICENSE-MIT",
+  "README.md",
+  "react-native.config.js",
+  "react-native-pirate-wallet.podspec",
+  "scripts/assemble-ios-framework.js",
+  "scripts/resolve-android-packages.js",
+  "test/smoke.js",
+  "src/index.js",
+  "src/index.d.ts",
+  "android/src/main/AndroidManifest.xml",
+  "android/src/main/java/com/pirate/wallet/reactnative/PirateWalletReactNativeModule.kt",
+  "ios/PirateWalletReactNative.m",
+  "ios/PirateWalletReactNative.swift",
 ].forEach(requireFile);
 
-if (process.argv.includes('--publish-layout')) {
+if (process.argv.includes("--publish-layout")) {
   [
-    'android/.gradle',
-    'android/build',
-    'android/src/main/jniLibs',
-    'ios/Frameworks/PirateWalletNative.xcframework',
+    "android/.gradle",
+    "android/build",
+    "android/src/main/jniLibs",
+    "ios/Frameworks/PirateWalletNative.xcframework",
   ].forEach(rejectPath);
 }
 
 const binaryPackageNames = [
-  'react-native-pirate-wallet-android',
-  'react-native-pirate-wallet-android-x86_64',
-  'react-native-pirate-wallet-ios-device',
-  'react-native-pirate-wallet-ios-simulator',
+  "react-native-pirate-wallet-android",
+  "react-native-pirate-wallet-android-x86_64",
+  "react-native-pirate-wallet-ios-device",
+  "react-native-pirate-wallet-ios-simulator-arm64",
+  "react-native-pirate-wallet-ios-simulator-x86_64",
 ];
 for (const binaryPackageName of binaryPackageNames) {
   if (
-    packageJson.optionalDependencies?.[binaryPackageName] !== packageJson.version
+    packageJson.optionalDependencies?.[binaryPackageName] !==
+    packageJson.version
   ) {
     fail(`${binaryPackageName} must use the same exact version as the wrapper`);
   }
 }
 
 if (
-  !process.argv.includes('--publish-layout') &&
-  (process.platform === 'darwin' || process.argv.includes('--all-platforms'))
+  !process.argv.includes("--publish-layout") &&
+  (process.platform === "darwin" || process.argv.includes("--all-platforms"))
 ) {
   const staticLibraries = collectFiles(
-    path.join(packageRoot, 'ios', 'Frameworks', 'PirateWalletNative.xcframework'),
-  ).filter(file => file.endsWith('.a'));
+    path.join(
+      packageRoot,
+      "ios",
+      "Frameworks",
+      "PirateWalletNative.xcframework"
+    )
+  ).filter((file) => file.endsWith(".a"));
   if (staticLibraries.length !== 2) {
-    fail('The iOS XCFramework must contain device and simulator static libraries');
+    fail(
+      "The iOS XCFramework must contain device and simulator static libraries"
+    );
   }
   for (const library of staticLibraries) {
     if (fs.statSync(library).size === 0) {
-      fail(`The iOS static library is empty: ${path.relative(packageRoot, library)}`);
+      fail(
+        `The iOS static library is empty: ${path.relative(
+          packageRoot,
+          library
+        )}`
+      );
     }
   }
 }
 
 try {
-  const {resolveAndroidJniLibsPaths} = require('./resolve-android-packages');
+  const { resolveAndroidJniLibsPaths } = require("./resolve-android-packages");
   if (resolveAndroidJniLibsPaths().length !== 2) {
-    fail('Both Android binary packages must resolve');
+    fail("Both Android binary packages must resolve");
   }
 } catch (error) {
   fail(error.message);

package/test/smoke.js

@@ -48,6 +48,12 @@ function createMockNativeModule() {
           ])
         case 'get_active_wallet':
           return ok('wallet-1')
+        case 'current_receive_address':
+          assert.strictEqual(request.wallet_id, 'wallet-1')
+          return ok('pirate1current')
+        case 'next_receive_address':
+          assert.strictEqual(request.wallet_id, 'wallet-1')
+          return ok('pirate1next')
         case 'get_balance':
           return ok({ total: '1000', spendable: '900', pending: '100' })
         case 'format_amount':
@@ -158,6 +164,9 @@ async function main() {
   const latestBirthdayHeight = await sdk.getLatestBirthdayHeight('wallet-1')
   assert.strictEqual(latestBirthdayHeight, 345678)
 
+  assert.strictEqual(await sdk.getCurrentAddress('wallet-1'), 'pirate1current')
+  assert.strictEqual(await sdk.getNextAddress('wallet-1'), 'pirate1next')
+
   const groups = await sdk.advancedKeyManagement.listKeyGroups('wallet-1')
   assert.strictEqual(groups.length, 1)