applesauce-wallet 0.0.0-next-20250313084132 → 0.0.0-next-20250313104750

package/dist/helpers/__tests__/animated-qr.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/__tests__/animated-qr.test.js

@@ -0,0 +1,44 @@
+import { describe, expect, it } from "vitest";
+import { getDecodedToken } from "@cashu/cashu-ts";
+import { lastValueFrom, take, timer } from "rxjs";
+import { subscribeSpyTo } from "@hirez_io/observer-spy";
+import { receiveAnimated, sendAnimated } from "../animated-qr.js";
+const tokenStr = "cashuBo2FteBtodHRwczovL3Rlc3RudXQuY2FzaHUuc3BhY2VhdWNzYXRhdIGiYWlIAJofKTJT5B5hcIOkYWEQYXN4QDA2M2VlYjgwZDZjODM4NWU4NzYwODVhN2E4NzdkOTkyY2U4N2QwNTRmY2RjYzNiODMwMzhjOWY3MmNmMDY1ZGVhY1ghAynsxZ-OuZfZDcqYTLPYfCqHO7jkGjn97aolgtSYhYykYWSjYWVYIGbp_9B9aztSlZxz7g6Tqx5M_1PuFzJCVEMOVd8XAF8wYXNYINTOU77ODcj28v04pq7ektdf6sq2XuxvMjVE0wK6jFolYXJYIM_gZnUGT5jDOyZiQ-2vG9zYnuWaY8vPoWGe_3sXvrvbpGFhBGFzeEA0MWMwZDk1YTU5ZjkxNTdlYTc5NTJlNGFlMzYzYTI3NTMxNTllNmQ1NGJiNzExMTg5ZDk5YjU1MmYzYjIzZTJiYWNYIQM-49gen_1nPchxbaAiKprVr78VmMRVpHH_Tu9P8TO5mGFko2FlWCB9j7rlpdBH_m7tNYnLpzPhn-nGmS1CcbUfnPzjxy6G92FzWCDdsby7fGM5324T5UEoV858YWzZ9MCY59KgKP362fJDfmFyWCDL73v4FRo7iMe83bfMuEy3RJPtC1Vr1jdOpw2-x-7EAaRhYQFhc3hANjRhZDI3NmExOGNmNDhiMDZmYjdiMGYwOWFiMTU4ZTA0ZmM0NmIxYzA4YzMyNjJlODUxNzZkYTMzMTgyYzQ3YWFjWCECMDpCbNbrgA9FcQEIYxobU7ik_pTl8sByPqHDmkY4azxhZKNhZVggqHGaff9M270EU8LGxRpG_G4rn2bMgjyk3hFFg78ZXRVhc1ggP6DsNsWykwKE94yZF23gpCyapcoqh6DDZdVu0lKn2Z5hclggmPKig-lObsuxi_1XCm7_Y_tqaCcqEDz8eCwVhJ8gq9M";
+const token = getDecodedToken(tokenStr);
+describe("sendAnimated", () => {
+    it("should loop", async () => {
+        const qr$ = sendAnimated(token, { interval: 0 });
+        const spy = subscribeSpyTo(qr$);
+        // wait 100ms
+        await lastValueFrom(timer(100));
+        // should not have competed
+        expect(spy.receivedComplete()).toBeFalsy();
+        spy.unsubscribe();
+    });
+    it("should emit parts", async () => {
+        const qr$ = sendAnimated(token, { interval: 0 }).pipe(take(6));
+        const spy = subscribeSpyTo(qr$);
+        // wait 100ms
+        await lastValueFrom(qr$);
+        // should not have competed
+        expect(spy.getValues()).toEqual(Array(6)
+            .fill(0)
+            .map((_, i) => expect.stringContaining(`ur:bytes/${i + 1}-6/`)));
+    });
+});
+describe("receiveAnimated", () => {
+    it("should decode animated qr", async () => {
+        const qr$ = sendAnimated(token, { interval: 0 }).pipe(receiveAnimated);
+        const spy = subscribeSpyTo(qr$);
+        await lastValueFrom(qr$);
+        expect(spy.getValues()).toEqual([
+            expect.any(Number),
+            expect.any(Number),
+            expect.any(Number),
+            expect.any(Number),
+            expect.any(Number),
+            expect.any(Number),
+            token,
+        ]);
+    });
+});

package/dist/helpers/animated-qr.d.ts

@@ -0,0 +1,30 @@
+import { Token } from "@cashu/cashu-ts";
+import { Observable } from "rxjs";
+/** Preset speeds for the animated qr code */
+export declare const ANIMATED_QR_INTERVAL: {
+    SLOW: number;
+    MEDIUM: number;
+    FAST: number;
+};
+/** Presets for fragment length for animated qr code */
+export declare const ANIMATED_QR_FRAGMENTS: {
+    SHORT: number;
+    MEDIUM: number;
+    LONG: number;
+};
+export type SendAnimatedOptions = {
+    /**
+     * The interval between the parts ( 150 - 500 )
+     * @default 150
+     */
+    interval?: number;
+    /**
+     * max fragment length ( 50 - 200 )
+     * @default 100
+     */
+    fragmentLength?: number;
+};
+/** Creates an observable that iterates through a multi-part animated qr code */
+export declare function sendAnimated(token: Token | string, options?: SendAnimatedOptions): Observable<string>;
+/** Creates an observable that completes with decoded token */
+export declare function receiveAnimated(input: Observable<string>): Observable<Token | number>;

package/dist/helpers/animated-qr.js

@@ -0,0 +1,77 @@
+import { getDecodedToken, getEncodedTokenV4 } from "@cashu/cashu-ts";
+import { UR, URDecoder, UREncoder } from "@gandlaf21/bc-ur/dist/lib/es6/index.js";
+import { defer, filter, interval, map, Observable, shareReplay } from "rxjs";
+/** Preset speeds for the animated qr code */
+export const ANIMATED_QR_INTERVAL = {
+    SLOW: 500,
+    MEDIUM: 250,
+    FAST: 150,
+};
+/** Presets for fragment length for animated qr code */
+export const ANIMATED_QR_FRAGMENTS = {
+    SHORT: 50,
+    MEDIUM: 100,
+    LONG: 150,
+};
+/** Creates an observable that iterates through a multi-part animated qr code */
+export function sendAnimated(token, options) {
+    // start the stream as soon as there is subscriber
+    return defer(() => {
+        let encoded = typeof token === "string" ? token : getEncodedTokenV4(token);
+        let buffer = Buffer.from(encoded);
+        let ur = UR.fromBuffer(buffer);
+        let encoder = new UREncoder(ur, options?.fragmentLength ?? 100, 0);
+        return interval(options?.interval ?? ANIMATED_QR_INTERVAL.FAST).pipe(map(() => encoder.nextPart()));
+    });
+}
+/** An operator that decodes UR, emits progress percent and completes with final result or error */
+function urDecoder() {
+    return (source) => new Observable((observer) => {
+        const decoder = new URDecoder();
+        return source.subscribe((part) => {
+            decoder.receivePart(part);
+            if (decoder.isComplete() && decoder.isSuccess()) {
+                // emit progress
+                const progress = decoder.estimatedPercentComplete();
+                observer.next(progress);
+                // emit result
+                const ur = decoder.resultUR();
+                const decoded = ur.decodeCBOR();
+                const utf8 = new TextDecoder();
+                const tokenStr = utf8.decode(decoded);
+                observer.next(tokenStr);
+                // complete
+                observer.complete();
+            }
+            else if (decoder.isError()) {
+                // emit error
+                const reason = decoder.resultError();
+                observer.error(new Error(reason));
+            }
+            else {
+                // emit progress
+                const progress = decoder.estimatedPercentComplete();
+                observer.next(progress);
+            }
+        });
+    });
+}
+/** Creates an observable that completes with decoded token */
+export function receiveAnimated(input) {
+    return input.pipe(
+    // convert to lower case
+    map((str) => str.toLowerCase()), 
+    // filter out non UR parts
+    filter((str) => str.startsWith("ur:")), 
+    // decode UR and complete
+    urDecoder(), 
+    // decode cashu token
+    map((part) => {
+        if (typeof part === "string")
+            return getDecodedToken(part);
+        else
+            return part;
+    }), 
+    // only run one decoder
+    shareReplay(1));
+}

package/dist/helpers/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./wallet.js";
 export * from "./tokens.js";
 export * from "./history.js";
+export * from "./animated-qr.js";

package/dist/helpers/index.js

@@ -1,3 +1,4 @@
 export * from "./wallet.js";
 export * from "./tokens.js";
 export * from "./history.js";
+export * from "./animated-qr.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-wallet",
-  "version": "0.0.0-next-20250313084132",
+  "version": "0.0.0-next-20250313104750",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -78,17 +78,19 @@
   },
   "dependencies": {
     "@cashu/cashu-ts": "2.0.0-rc1",
+    "@gandlaf21/bc-ur": "^1.1.12",
     "@noble/hashes": "^1.7.1",
-    "applesauce-actions": "0.0.0-next-20250313084132",
-    "applesauce-core": "0.0.0-next-20250313084132",
-    "applesauce-factory": "0.0.0-next-20250313084132",
+    "applesauce-actions": "0.0.0-next-20250313104750",
+    "applesauce-core": "0.0.0-next-20250313104750",
+    "applesauce-factory": "0.0.0-next-20250313104750",
+    "buffer": "^6.0.3",
     "nostr-tools": "^2.10.4",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
     "@types/debug": "^4.1.12",
-    "applesauce-signers": "0.0.0-next-20250313084132",
+    "applesauce-signers": "0.0.0-next-20250313104750",
     "typescript": "^5.7.3",
     "vitest": "^3.0.5"
   },