@runflame/wallet-wasm 0.0.1-rc.0 → 0.0.1-rc.1

package/flamewallet_wasm.d.ts

@@ -50,10 +50,13 @@ export interface TransferInput {
 }
 
 export interface TransferOutput {
-    predicate: Uint8Array;
+    /** The recipient's bech32f address, for the wallet's network. */
+    address: string;
     qty: bigint;
     /** Absent for flames. */
     flavor?: Uint8Array;
+    /** Sealed into the note for the recipient alone; at most 8102 bytes. */
+    memo?: Uint8Array;
 }
 
 export interface TransferRequest {
@@ -70,8 +73,8 @@ export interface CreatedOutput {
     contractId: Uint8Array;
     /** Its published bytes, as an indexer serves them once confirmed. */
     contract: Uint8Array;
-    /** The only record the output can be spent from. */
-    opening: Opening;
+    /** The encrypted note that follows it on chain; `Wallet.openNote` reads it. */
+    note: Uint8Array;
 }
 
 export interface Transfer {
@@ -79,9 +82,25 @@ export interface Transfer {
     txid: Uint8Array;
     /** `BlockTx::to_bytes`: what a node's `submit_tx` takes. */
     blockTx: Uint8Array;
+    /** In published order, not request order: match each by its predicate. */
     outputs: CreatedOutput[];
 }
 
+/** What `Wallet.openNote` gives: the opening to spend with, and the memo. */
+export interface ReceivedNote {
+    opening: Opening;
+    memo: Uint8Array;
+}
+
+/** Why a note did not open; `docs/payments.md` "Receiving" says what to do. */
+export type NoteFailure =
+| "missing"
+| "malformed"
+| "unknownVersion"
+| "undecryptable"
+| "openingMismatch"
+| "notConfidential";
+
 /** What every call throws. Fields beyond `kind` depend on it. */
 export interface FlameError extends Error {
     name: "FlameError";
@@ -92,12 +111,15 @@ export interface FlameError extends Error {
     | "invalidKeyPath"
     | "invalidBytes"
     | "keyMismatch"
+    | "note"
     | "transfer";
     reason?: string;
     /** For `invalidBytes`: contract, proof, predicate, flavor or blinding. */
     what?: string;
     /** For `keyMismatch`: the input's position. */
     input?: number;
+    /** For `note`: how it failed. */
+    failure?: NoteFailure;
 }
 
 
@@ -138,6 +160,11 @@ export class Wallet {
      * The next receiving index not yet issued: what an app stores.
      */
     nextIndex(): number;
+    /**
+     * Opens the note a scan served with `contract` (`undefined` if none),
+     * with the key at `path`, as `owns` found it.
+     */
+    openNote(contract: Uint8Array, note: Uint8Array | null | undefined, path: KeyPath): ReceivedNote;
     /**
      * Which path below `nextIndex + gap` owns `predicate`, if any.
      */
@@ -196,6 +223,7 @@ export interface InitOutput {
     readonly wallet_network: (a: number, b: number) => void;
     readonly wallet_nextAddress: (a: number, b: number) => void;
     readonly wallet_nextIndex: (a: number) => number;
+    readonly wallet_openNote: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
     readonly wallet_owns: (a: number, b: number, c: number, d: number, e: number) => void;
     readonly wallet_receivingKey: (a: number, b: number) => void;
     readonly ffi_flamewallet_ffi_uniffi_contract_version: () => number;
@@ -257,32 +285,34 @@ export interface InitOutput {
     readonly uniffi_flamewallet_ffi_checksum_method_wallet_owns: () => number;
     readonly uniffi_flamewallet_ffi_fn_method_wallet_receiving_key: (a: number, b: bigint, c: number) => void;
     readonly uniffi_flamewallet_ffi_checksum_method_wallet_receiving_key: () => number;
+    readonly uniffi_flamewallet_ffi_fn_method_wallet_open_note: (a: number, b: bigint, c: number, d: number, e: number, f: number) => void;
+    readonly uniffi_flamewallet_ffi_checksum_method_wallet_open_note: () => number;
     readonly uniffi_flamewallet_ffi_fn_method_wallet_build_transfer: (a: number, b: bigint, c: number, d: number) => void;
     readonly uniffi_flamewallet_ffi_checksum_method_wallet_build_transfer: () => number;
-    readonly ffi_flamewallet_ffi_rust_future_free_u16: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_cancel_u16: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_free_u32: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_complete_u32: (a: bigint, b: number) => number;
-    readonly ffi_flamewallet_ffi_rust_future_cancel_u32: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_free_i64: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_cancel_i64: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_free_rust_buffer: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_cancel_rust_buffer: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_free_i32: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_cancel_i32: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_free_i64: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_cancel_i64: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_free_u64: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_complete_u64: (a: bigint, b: number) => bigint;
     readonly ffi_flamewallet_ffi_rust_future_cancel_u64: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_free_u8: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_cancel_u8: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_free_void: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_cancel_void: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_free_i16: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_cancel_i16: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_free_u32: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_cancel_u32: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_free_f64: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_cancel_f64: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_free_i8: (a: bigint) => void;
     readonly ffi_flamewallet_ffi_rust_future_cancel_i8: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_free_i16: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_cancel_i16: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_free_u8: (a: bigint) => void;
-    readonly ffi_flamewallet_ffi_rust_future_cancel_u8: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_free_i32: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_complete_u32: (a: bigint, b: number) => number;
+    readonly ffi_flamewallet_ffi_rust_future_cancel_i32: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_free_u16: (a: bigint) => void;
+    readonly ffi_flamewallet_ffi_rust_future_cancel_u16: (a: bigint) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;

package/flamewallet_wasm.js

@@ -160,6 +160,33 @@ export class Wallet {
         const ret = wasm.wallet_nextIndex(this.__wbg_ptr);
         return ret >>> 0;
     }
+    /**
+     * Opens the note a scan served with `contract` (`undefined` if none),
+     * with the key at `path`, as `owns` found it.
+     * @param {Uint8Array} contract
+     * @param {Uint8Array | null | undefined} note
+     * @param {KeyPath} path
+     * @returns {ReceivedNote}
+     */
+    openNote(contract, note, path) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passArray8ToWasm0(contract, wasm.__wbindgen_export);
+            const len0 = WASM_VECTOR_LEN;
+            var ptr1 = isLikeNone(note) ? 0 : passArray8ToWasm0(note, wasm.__wbindgen_export);
+            var len1 = WASM_VECTOR_LEN;
+            wasm.wallet_openNote(retptr, this.__wbg_ptr, ptr0, len0, ptr1, len1, addHeapObject(path));
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * Which path below `nextIndex + gap` owns `predicate`, if any.
      * @param {Uint8Array} predicate

package/flamewallet_wasm_bg.wasm.d.ts

@@ -15,6 +15,7 @@ export const wallet_fromSeed: (a: number, b: number, c: number, d: number, e: nu
 export const wallet_network: (a: number, b: number) => void;
 export const wallet_nextAddress: (a: number, b: number) => void;
 export const wallet_nextIndex: (a: number) => number;
+export const wallet_openNote: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
 export const wallet_owns: (a: number, b: number, c: number, d: number, e: number) => void;
 export const wallet_receivingKey: (a: number, b: number) => void;
 export const ffi_flamewallet_ffi_uniffi_contract_version: () => number;
@@ -76,32 +77,34 @@ export const uniffi_flamewallet_ffi_fn_method_wallet_owns: (a: number, b: bigint
 export const uniffi_flamewallet_ffi_checksum_method_wallet_owns: () => number;
 export const uniffi_flamewallet_ffi_fn_method_wallet_receiving_key: (a: number, b: bigint, c: number) => void;
 export const uniffi_flamewallet_ffi_checksum_method_wallet_receiving_key: () => number;
+export const uniffi_flamewallet_ffi_fn_method_wallet_open_note: (a: number, b: bigint, c: number, d: number, e: number, f: number) => void;
+export const uniffi_flamewallet_ffi_checksum_method_wallet_open_note: () => number;
 export const uniffi_flamewallet_ffi_fn_method_wallet_build_transfer: (a: number, b: bigint, c: number, d: number) => void;
 export const uniffi_flamewallet_ffi_checksum_method_wallet_build_transfer: () => number;
-export const ffi_flamewallet_ffi_rust_future_free_u16: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_cancel_u16: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_free_u32: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_complete_u32: (a: bigint, b: number) => number;
-export const ffi_flamewallet_ffi_rust_future_cancel_u32: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_free_i64: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_cancel_i64: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_free_rust_buffer: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_cancel_rust_buffer: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_free_i32: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_cancel_i32: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_free_i64: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_cancel_i64: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_free_u64: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_complete_u64: (a: bigint, b: number) => bigint;
 export const ffi_flamewallet_ffi_rust_future_cancel_u64: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_free_u8: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_cancel_u8: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_free_void: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_cancel_void: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_free_i16: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_cancel_i16: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_free_u32: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_cancel_u32: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_free_f64: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_cancel_f64: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_free_i8: (a: bigint) => void;
 export const ffi_flamewallet_ffi_rust_future_cancel_i8: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_free_i16: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_cancel_i16: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_free_u8: (a: bigint) => void;
-export const ffi_flamewallet_ffi_rust_future_cancel_u8: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_free_i32: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_complete_u32: (a: bigint, b: number) => number;
+export const ffi_flamewallet_ffi_rust_future_cancel_i32: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_free_u16: (a: bigint) => void;
+export const ffi_flamewallet_ffi_rust_future_cancel_u16: (a: bigint) => void;
 export const __wbindgen_export: (a: number, b: number) => number;
 export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_export3: (a: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runflame/wallet-wasm",
-  "version": "0.0.1-rc.0",
+  "version": "0.0.1-rc.1",
   "description": "Flame wallet keys and confidential transfers, compiled to WebAssembly",
   "license": "Apache-2.0",
   "repository": {