@lightninglabs/wavelength-react-native 0.1.0 → 0.1.1-rc2

package/README.md

@@ -25,14 +25,20 @@ npm install @lightninglabs/wavelength-react-native @lightninglabs/wavelength-rea
 ```
 
 The native wallet runtime binaries (`Wavewalletdk.aar` and
-`Wavewalletdk.xcframework`) are not bundled inside the npm package. Get them one
-of two ways, then stage them into this package before running `pod install` or a
-Gradle build:
-
-- Download them from the paired
-  [wavelength release](https://github.com/lightninglabs/wavelength/releases).
-- Build them from a `wavelength` checkout with `scripts/fetch-bindings.sh`, which
-  compiles them from the daemon source named by `WAVELENGTH_DIR`.
+`Wavewalletdk.xcframework`) are not bundled inside the npm package. Download
+them from the [wavelength release](https://github.com/lightninglabs/wavelength/releases)
+tagged with the `RUNTIME_MANIFEST_VERSION` that
+`@lightninglabs/wavelength-core` exports, and stage them into this package
+before running `pod install` or a Gradle build.
+[Installation](https://wavelength.lightning.engineering/react-native/get-started/installation/)
+in the documentation walks through the exact staging steps, including the
+header rewrite the iOS framework needs.
+
+Working from a checkout of this repository instead, the `bindings:fetch` script
+does all of that for you, and `bindings:local` builds the binaries from the
+daemon source named by `WAVELENGTH_DIR` (for unreleased daemon revisions).
+Neither ships in the published package: both resolve paths relative to the
+repository root, which does not exist in an install.
 
 ## Quick start
 

package/WavelengthReactNative.podspec

@@ -14,7 +14,9 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,mm,swift}"
   s.pod_target_xcconfig = { "DEFINES_MODULE" => "YES" }
 
-  # The gomobile-built daemon; staged by scripts/fetch-bindings.sh (gitignored).
+  # The gomobile-built daemon. Not shipped in the npm package and gitignored
+  # here, so it must be staged before `pod install`; the package README has the
+  # steps, and a wavelength-sdk checkout can run scripts/fetch-bindings.sh.
   s.vendored_frameworks = "ios/Wavewalletdk.xcframework"
 
   # The Go runtime's DNS resolver links against libresolv (res_9_* symbols).

package/android/build.gradle

@@ -30,7 +30,9 @@ android {
 
 dependencies {
   implementation "com.facebook.react:react-android"
-  // The gomobile-generated bindings, staged by scripts/fetch-bindings.sh.
+  // The gomobile-generated bindings. Not shipped in the npm package, so they
+  // must be staged before a Gradle build; the package README has the steps, and
+  // a wavelength-sdk checkout can run scripts/fetch-bindings.sh.
   api files("libs/Wavewalletdk.aar")
   // Passkeys: Credential Manager plus its Play services provider binding.
   implementation "androidx.credentials:credentials:1.6.0"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightninglabs/wavelength-react-native",
-  "version": "0.1.0",
+  "version": "0.1.1-rc2",
   "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.0"
+    "@lightninglabs/wavelength-core": "0.1.1-rc2"
   },
   "peerDependencies": {
     "react": ">=18.0.0",
@@ -65,6 +65,7 @@
     "build": "tsc -p tsconfig.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "node --test",
-    "fetch-bindings": "bash scripts/fetch-bindings.sh"
+    "bindings:fetch": "bash scripts/fetch-bindings.sh",
+    "bindings:local": "bash scripts/bindings-local.sh"
   }
 }

package/dist/NativeWalletdk.d.ts

@@ -1,31 +0,0 @@
-import type { TurboModule } from 'react-native';
-/**
- * The Turbo Module contract for the walletdk native bridge. The surface is a
- * deliberately thin JSON pipe: `call` dispatches every facade verb by name
- * with a JSON string in and a JSON string out, and the activity stream
- * arrives as 'walletdkActivity' device events carrying
- * `{ kind: 'entry' | 'end' | 'error', payload: string }`.
- */
-export interface Spec extends TurboModule {
-    /** Invokes a facade verb by name with a JSON payload, returning JSON. */
-    call(method: string, paramsJson: string): Promise<string>;
-    /** Opens the activity subscription; entries arrive as device events. */
-    startActivity(reqJson: string): Promise<void>;
-    /** Closes the activity subscription; a no-op when none is open. */
-    stopActivity(): Promise<void>;
-    /** Resolves the platform default wallet data directory. */
-    getDefaultDataDir(): Promise<string>;
-    /** Reports whether the platform can run a passkey PRF ceremony. */
-    passkeySupported(): Promise<boolean>;
-    /** Runs a passkey registration ceremony; WebAuthn JSON in and out. */
-    passkeyCreate(requestJson: string): Promise<string>;
-    /** Runs a passkey assertion ceremony; WebAuthn JSON in and out. */
-    passkeyGet(requestJson: string): Promise<string>;
-    /** Required by NativeEventEmitter. */
-    addListener(eventName: string): void;
-    /** Required by NativeEventEmitter. */
-    removeListeners(count: number): void;
-}
-declare const _default: Spec;
-export default _default;
-//# sourceMappingURL=NativeWalletdk.d.ts.map

package/dist/NativeWalletdk.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativeWalletdk.d.ts","sourceRoot":"","sources":["../src/NativeWalletdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD;;;;;;GAMG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,yEAAyE;IACzE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,wEAAwE;IACxE,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,mEAAmE;IACnE,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,2DAA2D;IAC3D,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,mEAAmE;IACnE,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC,sEAAsE;IACtE,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD,mEAAmE;IACnE,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,sCAAsC;IACtC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,sCAAsC;IACtC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;;AAED,wBAAkE"}

package/dist/NativeWalletdk.js

@@ -1,2 +0,0 @@
-import { TurboModuleRegistry } from 'react-native';
-export default TurboModuleRegistry.getEnforcing('Walletdk');