@lightninglabs/wavelength-react-native 0.1.1 → 0.1.2-rc4

package/android/src/main/java/engineering/lightning/wavelength/reactnative/WavelengthModule.kt

@@ -157,6 +157,8 @@ class WavelengthModule(reactContext: ReactApplicationContext) :
     val params = paramsJson.toByteArray(Charsets.UTF_8)
     return when (method) {
       "start" -> { Mobile.start(paramsJson); "" }
+      "startExternalSeedWallet" ->
+        Mobile.startExternalSeedWallet(params).toString(Charsets.UTF_8)
       "stop" -> { Mobile.stop(); "" }
       "getInfo" -> Mobile.getInfo().toString(Charsets.UTF_8)
       "status" -> Mobile.status().toString(Charsets.UTF_8)

package/dist/client.d.ts

@@ -32,10 +32,10 @@ export type NativeActivityEvent = {
  */
 export type SubscribeToNativeEvents = (listener: (event: NativeActivityEvent) => void) => () => void;
 /**
-* The React Native transport: implements {@link BaseWavelengthClient}'s pipe
-* over the gomobile Turbo Module. JSON strings cross the RN bridge, then the
-* shared base client normalizes responses and streamed entries in TS.
-*/
+ * The React Native transport: implements {@link BaseWavelengthClient}'s pipe
+ * over the gomobile Turbo Module. JSON strings cross the RN bridge, then the
+ * shared base client normalizes responses and streamed entries in TS.
+ */
 export declare class NativeWavelengthClient extends BaseWavelengthClient {
     protected readonly serverTransport: "grpc";
     private removeNativeListener;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAGrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EACV,qBAAqB,EAErB,YAAY,EACZ,aAAa,EACb,UAAU,EACX,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,yEAAyE;IACzE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,8CAA8C;IAC9C,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,+CAA+C;IAC/C,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,2DAA2D;IAC3D,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,oCAAoC;IACpC,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;IAChC,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,QAAQ,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,KAC3C,MAAM,IAAI,CAAC;AAEd;;;;EAIE;AACJ,qBAAa,sBAAuB,SAAQ,oBAAoB;IAE9D,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAG,MAAM,CAAU;IAErD,OAAO,CAAC,oBAAoB,CAA6B;IAGzD,OAAO,CAAC,OAAO,CAAoC;IAGnD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,uBAAuB,CAA0B;gBAGvD,MAAM,EAAE,sBAAsB,EAC9B,uBAAuB,EAAE,uBAAuB;IASlD,OAAO,CAAC,OAAO;IAQf,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAMP,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;cAOhD,YAAY,CAAC,CAAC,GAAG,OAAO,EACtC,MAAM,EAAE,YAAY,EACpB,MAAM,GAAE,OAAY,GACnB,OAAO,CAAC,CAAC,CAAC;cAkBG,kBAAkB,CAChC,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAmBhB,YAAY,IAAI,IAAI;IAwBpB,OAAO,CAAC,aAAa;IAgDrB,OAAO,IAAI,IAAI;CAOhB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAGrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EACV,qBAAqB,EAErB,YAAY,EACZ,aAAa,EACb,UAAU,EACX,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,yEAAyE;IACzE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,8CAA8C;IAC9C,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,+CAA+C;IAC/C,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,2DAA2D;IAC3D,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,oCAAoC;IACpC,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;IAChC,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,QAAQ,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,KAC3C,MAAM,IAAI,CAAC;AAEhB;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;IAE9D,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAG,MAAM,CAAU;IAErD,OAAO,CAAC,oBAAoB,CAA6B;IAGzD,OAAO,CAAC,OAAO,CAAoC;IAGnD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,uBAAuB,CAA0B;gBAGvD,MAAM,EAAE,sBAAsB,EAC9B,uBAAuB,EAAE,uBAAuB;IASlD,OAAO,CAAC,OAAO;IAQf,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAMP,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;cAOhD,YAAY,CAAC,CAAC,GAAG,OAAO,EACtC,MAAM,EAAE,YAAY,EACpB,MAAM,GAAE,OAAY,GACnB,OAAO,CAAC,CAAC,CAAC;cAkBG,kBAAkB,CAChC,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAmBhB,YAAY,IAAI,IAAI;IAwBpB,OAAO,CAAC,aAAa;IAgDrB,OAAO,IAAI,IAAI;CAOhB"}

package/dist/client.js

@@ -1,9 +1,9 @@
 import { BaseWavelengthClient, WavelengthError, errorMessage, } from '@lightninglabs/wavelength-core';
 /**
-* The React Native transport: implements {@link BaseWavelengthClient}'s pipe
-* over the gomobile Turbo Module. JSON strings cross the RN bridge, then the
-* shared base client normalizes responses and streamed entries in TS.
-*/
+ * The React Native transport: implements {@link BaseWavelengthClient}'s pipe
+ * over the gomobile Turbo Module. JSON strings cross the RN bridge, then the
+ * shared base client normalizes responses and streamed entries in TS.
+ */
 export class NativeWavelengthClient extends BaseWavelengthClient {
     // The embedded daemon runs natively, so it dials the servers over gRPC.
     serverTransport = 'grpc';

package/dist/index.d.ts

@@ -1,11 +1,12 @@
-import { type WavelengthClient, type PasskeyCeremony, type DistributiveOmit, type WalletEngine, type WalletEngineOptions } from '@lightninglabs/wavelength-core';
+import { type ExternalSeedWalletClient, type PasskeyCeremony, type DistributiveOmit, type WalletEngine, type WalletEngineOptions } from '@lightninglabs/wavelength-core';
 import { type NativePasskeyCeremonyOptions } from './passkey.ts';
 /**
- * Creates a {@link WavelengthClient} backed by the React Native transport: the
- * daemon compiled into the app via the gomobile bindings. Takes no options
- * today; an options parameter can be added later without a breaking change.
+ * Creates an {@link ExternalSeedWalletClient} backed by the React Native
+ * transport: the daemon compiled into the app via the gomobile bindings. Takes
+ * no options today; an options parameter can be added later without a breaking
+ * change.
  */
-export declare function createNativeClient(): WavelengthClient;
+export declare function createNativeClient(): ExternalSeedWalletClient;
 /**
  * Options for {@link createNativeWalletEngine}. See {@link WalletEngineOptions}
  * for the config/autoStart field docs; the type requires config when

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACzB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAEL,KAAK,4BAA4B,EAClC,MAAM,cAAc,CAAC;AAEtB;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,gBAAgB,CAWrD;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,CACtD,mBAAmB,EACnB,QAAQ,CACT,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,GAAE,yBAA8B,GACtC,YAAY,CAKd;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,4BAA4B,GACpC,eAAe,CAEjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnD;AAED,YAAY,EACV,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EACV,mBAAmB,EACnB,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAIrB,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACzB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAEL,KAAK,4BAA4B,EAClC,MAAM,cAAc,CAAC;AAEtB;;;;;GAKG;AACH,wBAAgB,kBAAkB,IAAI,wBAAwB,CAW7D;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,CACtD,mBAAmB,EACnB,QAAQ,CACT,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,GAAE,yBAA8B,GACtC,YAAY,CAKd;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,4BAA4B,GACpC,eAAe,CAEjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnD;AAED,YAAY,EACV,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EACV,mBAAmB,EACnB,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAIrB,cAAc,gCAAgC,CAAC"}

package/dist/index.js

@@ -4,9 +4,10 @@ import NativeWavelength from "./NativeWavelength.js";
 import { NativeWavelengthClient } from "./client.js";
 import { nativePasskeyCeremony, } from "./passkey.js";
 /**
- * Creates a {@link WavelengthClient} backed by the React Native transport: the
- * daemon compiled into the app via the gomobile bindings. Takes no options
- * today; an options parameter can be added later without a breaking change.
+ * Creates an {@link ExternalSeedWalletClient} backed by the React Native
+ * transport: the daemon compiled into the app via the gomobile bindings. Takes
+ * no options today; an options parameter can be added later without a breaking
+ * change.
  */
 export function createNativeClient() {
     // NativeModules.Wavelength is the interop view of the Turbo Module; the

package/ios/WavelengthModule.mm

@@ -106,6 +106,8 @@ RCT_EXPORT_MODULE(Wavelength)
 
     if ([method isEqualToString:@"start"]) {
       MobileStart(paramsJson, &error);
+    } else if ([method isEqualToString:@"startExternalSeedWallet"]) {
+      result = MobileStartExternalSeedWallet(params, &error);
     } else if ([method isEqualToString:@"stop"]) {
       MobileStop(&error);
     } else if ([method isEqualToString:@"getInfo"]) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightninglabs/wavelength-react-native",
-  "version": "0.1.1",
+  "version": "0.1.2-rc4",
   "private": false,
   "description": "React Native transport for the Wavelength self-custodial Lightning wallet SDK.",
   "license": "MIT",
@@ -41,7 +41,7 @@
     }
   },
   "dependencies": {
-    "@lightninglabs/wavelength-core": "0.1.1"
+    "@lightninglabs/wavelength-core": "0.1.2-rc4"
   },
   "peerDependencies": {
     "react": ">=18.0.0",

package/src/client.test.ts

@@ -7,6 +7,8 @@ import {
 } from './client.ts';
 import type { WavelengthEvent } from '@lightninglabs/wavelength-core';
 
+const FINAL_PROFILE_DATA_DIR = '/data/wavelength/wdk/regtest/account-7';
+
 // A scriptable fake of the native module: records calls, replays canned JSON,
 // and hands the test the event listener so it can inject activity events.
 function makeFake() {
@@ -16,6 +18,7 @@ function makeFake() {
   let startActivityCount = 0;
   let stopActivityCount = 0;
   let stopActivityRejects = false;
+  let defaultDataDirCount = 0;
   let deferredStop: { promise: Promise<void>; resolve: () => void } | null = null;
   let listener: ((event: NativeActivityEvent) => void) | null = null;
   let unsubscribed = 0;
@@ -44,6 +47,7 @@ function makeFake() {
         : Promise.resolve();
     },
     getDefaultDataDir() {
+      defaultDataDirCount += 1;
       return Promise.resolve('/data/wavelength');
     },
   };
@@ -74,7 +78,12 @@ function makeFake() {
       return () => deferredStop!.resolve();
     },
     emit: (e: NativeActivityEvent) => listener?.(e),
-    counts: () => ({ startActivityCount, stopActivityCount, unsubscribed }),
+    counts: () => ({
+      startActivityCount,
+      stopActivityCount,
+      defaultDataDirCount,
+      unsubscribed,
+    }),
   };
 }
 
@@ -131,6 +140,63 @@ describe('NativeWavelengthClient', () => {
     assert.equal(cfg.data_dir, '/custom');
   });
 
+  it('startExternalSeedWallet preserves the final profile config', async () => {
+    const fake = makeFake();
+    const client = new NativeWavelengthClient(fake.native, fake.subscribe);
+    fake.responses.set('startExternalSeedWallet', JSON.stringify({
+      Imported: true,
+      IdentityPubKey: 'identity',
+      RecoveryRan: true,
+      RecoveredBoardingAddresses: 1,
+      RecoveredBoardingUTXOs: 2,
+      RecoveredVTXOs: 3,
+      RecoveredOORReceiveScripts: 4,
+      RecoveredOORRecipientEvents: 5,
+    }));
+
+    const result = await client.startExternalSeedWallet(
+      {
+        network: 'regtest',
+        dataDir: FINAL_PROFILE_DATA_DIR,
+        arkServerAddress: 'h:7070',
+      },
+      {
+        seedEntropy: Uint8Array.from({ length: 16 }, (_, index) => index),
+        expectedIdentityPubKey: 'identity',
+        recoverState: true,
+        recoveryWindow: 37,
+      },
+    );
+
+    assert.equal(fake.calls.length, 1);
+    assert.equal(fake.calls[0].method, 'startExternalSeedWallet');
+    assert.deepEqual(JSON.parse(fake.calls[0].paramsJson), {
+      config: {
+        data_dir: FINAL_PROFILE_DATA_DIR,
+        network: 'regtest',
+        server_address: 'h:7070',
+        server_transport: 'grpc',
+        swap_server_transport: 'grpc',
+        wallet_type: 'lwwallet',
+      },
+      seed_entropy: 'AAECAwQFBgcICQoLDA0ODw==',
+      expected_identity_pubkey: 'identity',
+      recover_state: true,
+      recovery_window: 37,
+    });
+    assert.equal(fake.counts().defaultDataDirCount, 0);
+    assert.deepEqual(result, {
+      imported: true,
+      identityPubKey: 'identity',
+      recoveryRan: true,
+      recoveredBoardingAddresses: 1,
+      recoveredBoardingUTXOs: 2,
+      recoveredVTXOs: 3,
+      recoveredOORReceiveScripts: 4,
+      recoveredOORRecipientEvents: 5,
+    });
+  });
+
   it('wraps native rejections in WavelengthError', async () => {
     const fake = makeFake();
     const client = new NativeWavelengthClient(fake.native, fake.subscribe);

package/src/client.ts

@@ -47,11 +47,11 @@ export type SubscribeToNativeEvents = (
   listener: (event: NativeActivityEvent) => void,
 ) => () => void;
 
-  /**
+/**
  * The React Native transport: implements {@link BaseWavelengthClient}'s pipe
  * over the gomobile Turbo Module. JSON strings cross the RN bridge, then the
  * shared base client normalizes responses and streamed entries in TS.
-  */
+ */
 export class NativeWavelengthClient extends BaseWavelengthClient {
   // The embedded daemon runs natively, so it dials the servers over gRPC.
   protected readonly serverTransport = 'grpc' as const;

package/src/index.ts

@@ -1,7 +1,7 @@
 import { NativeEventEmitter, NativeModules } from 'react-native';
 import {
   createWalletEngine,
-  type WavelengthClient,
+  type ExternalSeedWalletClient,
   type PasskeyCeremony,
   type DistributiveOmit,
   type WalletEngine,
@@ -15,11 +15,12 @@ import {
 } from './passkey.ts';
 
 /**
- * Creates a {@link WavelengthClient} backed by the React Native transport: the
- * daemon compiled into the app via the gomobile bindings. Takes no options
- * today; an options parameter can be added later without a breaking change.
+ * Creates an {@link ExternalSeedWalletClient} backed by the React Native
+ * transport: the daemon compiled into the app via the gomobile bindings. Takes
+ * no options today; an options parameter can be added later without a breaking
+ * change.
  */
-export function createNativeClient(): WavelengthClient {
+export function createNativeClient(): ExternalSeedWalletClient {
   // NativeModules.Wavelength is the interop view of the Turbo Module; the
   // emitter needs it (or any module carrying addListener/removeListeners) to
   // route 'wavelengthActivity' device events on both platforms.

package/src/native-dispatch.test.ts

@@ -11,6 +11,10 @@ const ios = new URL('../ios/WavelengthModule.mm', import.meta.url);
 
 const nativeMethods = {
   start: ['Mobile.start', 'MobileStart'],
+  startExternalSeedWallet: [
+    'Mobile.startExternalSeedWallet',
+    'MobileStartExternalSeedWallet',
+  ],
   stop: ['Mobile.stop', 'MobileStop'],
   getInfo: ['Mobile.getInfo', 'MobileGetInfo'],
   status: ['Mobile.status', 'MobileStatus'],
@@ -96,6 +100,19 @@ describe('native facade dispatch', () => {
     assert.deepEqual(iosDispatch(mm), expectedIos);
   });
 
+  it('forwards external-seed starts as byte request and result values', async () => {
+    const { kt, mm } = await readNativeSources();
+
+    assert.match(
+      kt,
+      /"startExternalSeedWallet"\s*->\s*Mobile\.startExternalSeedWallet\(params\)\.toString\(Charsets\.UTF_8\)/,
+    );
+    assert.match(
+      mm,
+      /\[method isEqualToString:@"startExternalSeedWallet"\]\)\s*\{\s*result = MobileStartExternalSeedWallet\(params, &error\);/,
+    );
+  });
+
   for (const [method, kind] of Object.entries(scalarMethods)) {
     it(`serializes the ${method} ${kind} as JSON text`, async () => {
       const { kt, mm } = await readNativeSources();