1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
|
// Gift wallet primitives — coin reservation, gift creation (incl. the
// split-first flow), the compact gift codec, claiming, and nostr-locked
// gifts. Installed onto the Wallet instance by the gifts feature so a build
// without gifts ships none of this.
import * as btc from '@scure/btc-signer';
import { hex, base64urlnopad, base32nopad } from '@scure/base';
import { encryptGiftPayload } from '../nostr.js';
import { utxoId } from '../wallet.js';
import { p2wpkh } from '@scure/btc-signer/payment';
import { concatBytes, randomBytes } from '@noble/hashes/utils';
import { secp256k1 } from '@noble/curves/secp256k1';
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
export function installGiftWallet(wallet) {
if (wallet.createGift) return; // already installed
Object.assign(wallet, {
// Confirmed coins locked behind unclaimed gift links. The whole source coin is
// committed until the gift is claimed (our change only comes back in the
// claimer's tx), so it's already excluded from spending — and from the
// spendable balance below.
giftLockedValue() {
const res = this.reservedSet();
return this.utxos.reduce((s, u) => s + (res.has(utxoId(u)) ? u.value : 0), 0);
},
// --- gift links (coins backing claimable presigned transactions) ---------
// A gift coin is either RESERVED (set aside, skipped by coin selection) or
// RECLAIMED (freed for spending, but its link stays live until the coin is
// actually spent). Both are "outstanding"; both are persisted per-wallet.
_giftKey() {
return this._cacheKey() + ':gift';
},
_reclaimedKey() {
return this._cacheKey() + ':giftfree';
},
reservedSet() {
if (!this._reserved) this._reserved = this._loadSet(this._giftKey());
return this._reserved;
},
reclaimedSet() {
if (!this._reclaimed) this._reclaimed = this._loadSet(this._reclaimedKey());
return this._reclaimed;
},
_saveReserved() {
try { localStorage.setItem(this._giftKey(), JSON.stringify([...this.reservedSet()])); } catch {}
},
_saveReclaimed() {
try { localStorage.setItem(this._reclaimedKey(), JSON.stringify([...this.reclaimedSet()])); } catch {}
},
isReserved(id) {
return this.reservedSet().has(id);
},
// Passive reclaim: free the coin for spending but keep tracking the live link
// so it can still be revoked later (until the coin is spent).
unreserve(id) {
this.reservedSet().delete(id);
this.reclaimedSet().add(id);
this._saveReserved();
this._saveReclaimed();
try { this.saveCache(); } catch {} // publish the gift-state change to sync
},
// Truly revoke an unclaimed gift: spend its coin back into our own wallet,
// which double-spends the gift's presigned input so the link can't be claimed
// once this confirms. Uses a high fee to win any race with a claimer.
async revokeGift(id, feeRate) {
const draft = this.buildTx({ recipients: [{ address: this.freshChange().address }], feeRate, coinIds: [id], sendMax: true });
const hexTx = this.sign(draft.tx);
const txid = await this.broadcast(hexTx);
this.reservedSet().delete(id);
this.reclaimedSet().delete(id);
this._saveReserved();
this._saveReclaimed();
try { this.saveCache(); } catch {}
return txid;
},
giftLink(id) { return this.giftRecords()[id] || null; },
markGiftRevoked(id) { const r = this.giftRecords()[id]; if (r) { r.revoked = true; this._saveGiftRecords(); try { this.saveCache(); } catch {} } },
giftRecords() {
if (!this._giftRecords) { try { this._giftRecords = JSON.parse(localStorage.getItem(this._giftRecordsKey()) || '{}'); } catch { this._giftRecords = {}; } }
return this._giftRecords;
},
_saveGiftRecords() { try { localStorage.setItem(this._giftRecordsKey(), JSON.stringify(this.giftRecords())); } catch {} },
// We fund a gift from our own coins, so the funding tx is always in our own
// history. A record whose tx isn't means it was never issued here — an
// earlier build let a wallet keep the previous wallet's records in memory
// and then write them back under its own key. Forget those rather than
// show someone another wallet's gifts.
_pruneForeignGifts() {
const recs = this.giftRecords();
const ids = Object.keys(recs);
if (!ids.length) return;
const ours = new Set(this.txs.map((t) => t.txid));
let changed = false;
for (const id of ids) {
const outs = recs[id].outpoints || [];
if (outs.some((o) => ours.has(String(o).split(':')[0]))) continue;
delete recs[id];
changed = true;
}
if (changed) this._saveGiftRecords();
},
// Remember which tx claimed a gift (resolved lazily via outspend) so the
// history can merge the gift row with its claim transaction.
setGiftClaimTx(id, txid) {
const recs = this.giftRecords();
if (recs[id] && recs[id].claimTxid !== txid) {
recs[id].claimTxid = txid;
this._saveGiftRecords();
}
},
// Outstanding gifts (reserved + reclaimed) whose coin is still unspent; prunes
// any whose coin has since been claimed/spent. { id, reserved, value }.
outstandingGifts() {
const live = new Set(this.utxos.map((u) => utxoId(u)));
const res = this.reservedSet();
const rec = this.reclaimedSet();
let changed = false;
for (const id of [...res]) if (!live.has(id)) { res.delete(id); changed = true; }
for (const id of [...rec]) if (!live.has(id)) { rec.delete(id); changed = true; }
if (changed) { this._saveReserved(); this._saveReclaimed(); }
return [...new Set([...res, ...rec])].map((id) => ({
id,
reserved: res.has(id),
value: (this.utxos.find((u) => utxoId(u) === id) || {}).value,
}));
},
// Gifts whose coin has been spent and weren't revoked by us → claimed. (Only
// once scanned, so an un-synced wallet doesn't mislabel everything as claimed.)
claimedGifts() {
if (!this.loaded) return [];
this._pruneForeignGifts();
const live = new Set(this.utxos.map((u) => utxoId(u)));
return Object.values(this.giftRecords())
.filter((r) => !r.revoked && r.outpoints && !r.outpoints.some((o) => live.has(o)))
.map((r) => ({ id: r.id, amount: r.amount, locked: r.locked, created: r.created, claimTxid: r.claimTxid || null, outpoints: r.outpoints }))
.sort((a, b) => (b.created || 0) - (a.created || 0));
},
// Best-fit coin selection for a gift of `gift` sats (needs gift + a dust
// change): the smallest single confirmed coin that covers it — one input and
// the least value locked until claim — else the fewest large coins. Returns
// the selected UTXOs, or null if confirmed funds are insufficient.
_selectGiftCoins(gift, feeRate) {
const DUST = 294n;
const rate = Math.max(1, Math.round(feeRate || (this.feeRates && this.feeRates.halfHourFee) || 5));
// need = gift + a funding fee (up to 2 inputs, E + change) + a dust change
const need = gift + BigInt(_giftFundFee(2, 2, rate)) + DUST;
const avail = this.utxos.filter((u) => !this.isReserved(utxoId(u)) && (u.confirmed || u.chain === 1));
const single = avail.filter((u) => BigInt(u.value) >= need).sort((a, b) => a.value - b.value)[0];
if (single) return [single];
const sel = [];
let sum = 0n;
for (const u of [...avail].sort((a, b) => b.value - a.value)) {
sel.push(u);
sum += BigInt(u.value);
if (sum >= need) return sel;
}
return null; // insufficient confirmed funds
},
// Build a gift link from a best-fit coin, locking the least value. No fee is
// reserved here: the claimer's wallet looks up the fee rate at claim time and
// subtracts it from the amount.
createGift(amountSats, feeRate) {
const gift = BigInt(Math.round(amountSats));
const rate = Math.max(1, Math.round(feeRate));
if (gift < BigInt(giftMinimum(rate))) throw new Error('Gift amount is too small.');
const sel = this._selectGiftCoins(gift, rate);
if (!sel) throw new Error('Not enough confirmed funds for that gift amount.');
return this._buildGiftPsbt(sel, gift, rate);
},
// Gift the entire spendable balance: a no-change sweep of all unreserved
// spendable coins (confirmed, plus our own unconfirmed change). The claimer
// receives the whole amount minus their claim fee.
createGiftAll(feeRate) {
const rate = Math.max(1, Math.round(feeRate));
const sel = this.utxos.filter((u) => !this.isReserved(utxoId(u)) && (u.confirmed || u.chain === 1));
if (!sel.length) throw new Error('No coins available to gift.');
const sum = sel.reduce((s, u) => s + BigInt(u.value), 0n);
if (sum < BigInt(giftMinimum(rate))) throw new Error('Gift amount is too small.');
return this._buildGiftPsbt(sel, sum, rate); // gift >= sum → whole-balance, no change
},
// Split + gift in one shot, with no confirmation wait: broadcast a self-send
// that carves out a gift+dust coin, then build the gift spending that
// still-unconfirmed carve-out. The funding and the claim form a chain that
// confirms together; the recipient just sees a pending balance until the
// split confirms. Lets the sender lock only ~the gift amount (instead of a
// whole large coin) without waiting for the split to confirm first.
async createGiftFromSplit(amountSats, feeRate) {
const gift = Math.round(amountSats);
const rate = Math.max(1, Math.round(feeRate));
if (BigInt(gift) < BigInt(giftMinimum(rate))) throw new Error('Gift amount is too small.');
// Carve out the gift PLUS the funding fee: the gift's presigned funding tx
// spends this one coin (gift → ephemeral key E) and pays its fee from it.
const DUST = _giftFundFee(1, 1, rate);
const recvIndex = this.nextReceiveIndex;
const carveAddr = this.derive(0, recvIndex).address;
const changeIndex = this.nextChangeIndex;
// Carve out exactly gift + dust to one of our own addresses; the rest comes
// back as change. buildTx already spends confirmed coins largest-first.
const draft = this.buildTx({ recipients: [{ address: carveAddr, amount: gift + DUST }], feeRate: rate });
const carveIdx = draft.outputs.findIndex((o) => o.address === carveAddr);
if (carveIdx < 0) throw new Error('Could not size the split output.');
const hexTx = this.sign(draft.tx);
const splitTxid = draft.tx.id;
await this.broadcast(hexTx);
// Wait until the carve-out is actually visible in the mempool before we
// build the gift on top of it and reserve it. Otherwise a background refresh
// could rebuild the address from a not-yet-indexed API response, transiently
// drop the coin, and prune the reservation — risking a double-spend.
let seen = false;
for (let i = 0; i < 8 && !seen; i++) {
await sleep(i === 0 ? 400 : 900);
try {
const us = await this.api.addressUtxos(carveAddr);
seen = us.some((u) => u.txid === splitTxid && u.vout === carveIdx);
} catch {}
}
if (!seen) throw new Error('The split is taking a while to propagate. Once it confirms, create the gift from the new coin.');
// Reflect the split in our coin set — drop the spent inputs, add the
// (now mempool-visible) carve-out and change — so balances and gift tracking
// are correct immediately; a background scan reconciles the rest.
const spent = new Set();
for (let i = 0; i < draft.tx.inputsLength; i++) {
const inp = draft.tx.getInput(i);
spent.add(`${hex.encode(inp.txid)}:${inp.index}`);
}
this.utxos = this.utxos.filter((u) => !spent.has(utxoId(u)));
this.utxos.push({ txid: splitTxid, vout: carveIdx, value: gift + DUST, address: carveAddr, chain: 0, index: recvIndex, confirmed: false });
const changeIdx = draft.outputs.findIndex((o, i) => i !== carveIdx);
if (changeIdx >= 0) {
const co = draft.outputs[changeIdx];
this.utxos.push({ txid: splitTxid, vout: changeIdx, value: co.amount, address: co.address, chain: 1, index: changeIndex, confirmed: false });
}
this._recomputeBalanceFromUtxos();
return this._buildGiftPsbt([{ txid: splitTxid, vout: carveIdx, value: gift + DUST, chain: 0, index: recvIndex }], BigInt(gift), rate);
},
// The coins a gift of this amount would lock: total value + how many inputs.
// A high input count means a costly-to-claim gift (each input adds to the
// claimer's fee) — the UI uses it to recommend splitting/consolidating first.
giftCoinSummary(amountSats) {
const sel = this._selectGiftCoins(BigInt(Math.round(amountSats)));
return sel ? { lock: sel.reduce((s, u) => s + u.value, 0), count: sel.length } : null;
},
// Persistent gift records (per account): the shareable link/code + amount, so a
// gift's link/QR can be re-viewed later and a claimed one identified in history.
_giftRecordsKey() { return this._cacheKey() + ':giftrec'; },
recordGift({ code, locked, amount, claimCode, outpoints }) {
if (!outpoints || !outpoints.length) return;
this.giftRecords()[outpoints[0]] = { id: outpoints[0], code, locked: !!locked, amount, claimCode: claimCode || null, outpoints, created: Date.now(), revoked: false };
this._saveGiftRecords();
try { this.saveCache(); } catch {} // publish the new gift to cross-device sync
},
// Sats that creating this gift right now would lock (the selected coins'
// total), or null if confirmed funds are insufficient. Lets the UI warn when
// the lock would dwarf the gift and offer to split a coin first.
giftLockPreview(amountSats) {
const sel = this._selectGiftCoins(BigInt(Math.round(amountSats)));
return sel ? sel.reduce((s, u) => s + u.value, 0) : null;
},
// Build a presigned ephemeral-key gift from already-chosen coins, returning
// { code, amount, reserved } where amount is what the claimer receives
// before their own sweep fee.
//
// v2 (ephemeral-key) design: instead of presigning a SIGHASH_NONE/SINGLE
// spend of our own coin — a blank cheque a mempool watcher could redirect
// (the front-running theft vector that drained a real gift) — we presign a
// FULLY COMMITTED (SIGHASH_ALL) funding tx that pays the gift to a throwaway
// key E, and put E's private key in the link. The claimer broadcasts the
// funding tx and sweeps E (SIGHASH_ALL) into their own wallet. Neither tx is
// redirectable in the mempool (both commit to every output; redirecting
// needs E's key, which lives only in the link — so holding the link is the
// only way to claim, the intended bearer property). Lazy: the funding tx
// isn't broadcast until claim, so an unclaimed gift moves no coins and is
// revoked for free by spending the still-reserved funding coin.
//
// The sender pays the funding fee (from change / the swept total); the
// claimer pays the sweep fee (from the gift). `gift >= sum` means "gift the
// whole balance": one output, no change.
_buildGiftPsbt(sel, gift, feeRate) {
const DUST = 294n;
const rate = Math.max(1, Math.round(feeRate || (this.feeRates && this.feeRates.halfHourFee) || 5));
const sum = sel.reduce((s, u) => s + BigInt(u.value), 0n);
const whole = gift >= sum; // createGiftAll: gift the entire selection
const fundFee = (nOut) => BigInt(_giftFundFee(sel.length, nOut, rate));
let eAmount, change;
if (whole) {
eAmount = sum - fundFee(1);
change = 0n;
} else {
change = sum - gift - fundFee(2);
if (change >= DUST) { eAmount = gift; }
// change would be dust: drop it into the fee, single output, honour the
// requested amount (fee = sum - gift, which must clear a 1-output fee).
else { eAmount = gift; change = 0n; if (sum - gift < fundFee(1)) throw new Error('Not enough to cover the funding fee. Try a smaller gift.'); }
}
if (eAmount < DUST) throw new Error('Gift amount is too small.');
// the throwaway key that holds the gift until the claimer sweeps it
const epriv = randomBytes(32);
const epub = secp256k1.getPublicKey(epriv, true);
const eaddr = p2wpkh(epub, this.netCfg.net);
const t = new btc.Transaction({ allowUnknownOutputs: true });
sel.forEach((u) => {
const pay = p2wpkh(this.derive(u.chain, u.index).pubkey, this.netCfg.net);
t.addInput({ ...pay, txid: u.txid, index: u.vout, witnessUtxo: { script: pay.script, amount: BigInt(u.value) } });
});
t.addOutput({ script: eaddr.script, amount: eAmount }); // vout 0 = the gift, to E
if (change >= DUST) t.addOutputAddress(this.freshChange().address, change, this.netCfg.net);
sel.forEach((u, i) => t.signIdx(this.node(u.chain, u.index).privateKey, i)); // SIGHASH_ALL (default)
t.finalize();
for (const u of sel) this.reservedSet().add(utxoId(u));
this._saveReserved();
return { code: base32nopad.encode(_encodeLazyGift(epriv, t)), amount: Number(eAmount), reserved: sel.map(utxoId) };
},
});
// reserved gift coins are excluded from spending + the spendable balance
wallet.registerCoinLock(() => wallet.reservedSet());
// Sync gift state across devices (like ark): the records + reserved/reclaimed
// coin sets are per-device localStorage, so a gift made on one device was
// invisible on another. Ride the encrypted snapshot as a merge-safe
// extension: union records (revoked/claimTxid flags sticky), union both coin
// sets. Each device's own scan then reconciles which coins are still live.
wallet.registerCacheExtension({
mergeAlways: true,
save: () => ({
giftState: {
records: wallet.giftRecords(),
reserved: [...wallet.reservedSet()],
reclaimed: [...wallet.reclaimedSet()],
},
}),
load: (d) => {
if (!d.giftState) return;
const recs = wallet.giftRecords();
for (const [id, r] of Object.entries(d.giftState.records || {})) {
const local = recs[id];
if (!local) recs[id] = r;
else { local.revoked = local.revoked || r.revoked; if (!local.claimTxid && r.claimTxid) local.claimTxid = r.claimTxid; }
}
wallet._saveGiftRecords();
const res = wallet.reservedSet(); for (const id of d.giftState.reserved || []) res.add(id);
const rec = wallet.reclaimedSet(); for (const id of d.giftState.reclaimed || []) rec.add(id);
wallet._saveReserved(); wallet._saveReclaimed();
},
});
}
// Gift-link claiming (sender side is Wallet.createGift). A v2 gift code carries
// a throwaway key E plus a fully-signed funding tx paying the gift to E (see
// parseLazyGift / giftClaimTxs). previewGift reports the value on E (before the
// claimer's sweep fee); giftClaimTxs returns the funding + sweep pair to
// broadcast. Retired v1 links (a redirectable presigned spend) are refused.
// Smallest sensible gift at a given fee rate: dust + one sweep fee of headroom
// (floored at 546 sats), so the recipient clears dust even if fees climb.
export function giftMinimum(feeRate) {
const rate = Math.max(1, Math.round(feeRate));
const claimFee = Math.ceil((11 + 68 + 31 * 2) * rate);
return Math.max(546, 294 + claimFee);
}
// Fee (sats) for a p2wpkh tx of nIn inputs and nOut outputs at `rate` sat/vB:
// ~10.5 vB overhead + 68 vB per segwit input + 31 vB per output.
function _giftFundFee(nIn, nOut, rate) {
return Math.max(1, Math.ceil((11 + 68 * nIn + 31 * nOut) * Math.max(1, Math.round(rate))));
}
// ---- compact gift codec ----------------------------------------------------
// A gift link used to carry a full PSBT (verbose). The claimer only needs the
// presigned inputs (outpoint, amount, pubkey, signature) and the sender's
// committed change output, so we serialize just those — ~25% smaller, and (via
// base32 + an uppercase /g/ URL) it scans in the QR's denser alphanumeric mode.
// Legacy base64url-PSBT links still claim; _giftTx auto-detects the format.
const GIFT_MAGIC = 0x01; // legacy blank-cheque on-chain gift — retired (front-runnable)
const GIFT_MAGIC_V2 = 0x02; // ephemeral-key gift: [magic][E privkey:32][le32 rawLen][funding tx]
const _u8 = (n) => Uint8Array.of(n & 0xff);
const _le32 = (n) => { const b = new Uint8Array(4); new DataView(b.buffer).setUint32(0, n >>> 0, true); return b; };
const _le64 = (n) => { const b = new Uint8Array(8); new DataView(b.buffer).setBigUint64(0, BigInt(n), true); return b; };
function _encodeCompactGift(tx) {
const hasChange = tx.outputsLength > 0;
const parts = [_u8(GIFT_MAGIC), _u8(hasChange ? 1 : 0), _u8(tx.inputsLength)];
for (let i = 0; i < tx.inputsLength; i++) {
const inp = tx.getInput(i);
const [pubkey, sig] = inp.partialSig[0]; // pubkey(33), sig = DER + sighash byte
parts.push(inp.txid, _le32(inp.index), _le64(inp.witnessUtxo.amount), pubkey, _u8(sig.length), sig);
}
if (hasChange) {
const o = tx.getOutput(0); // p2wpkh change: script = [00 14 <20-byte hash>]
parts.push(_le64(o.amount), o.script.slice(2));
}
return concatBytes(...parts);
}
function _decodeCompactGift(bytes) {
let p = 0;
const rd = (n) => bytes.slice(p, (p += n));
const r32 = () => { const v = new DataView(bytes.buffer, bytes.byteOffset + p, 4).getUint32(0, true); p += 4; return v; };
const r64 = () => { const v = new DataView(bytes.buffer, bytes.byteOffset + p, 8).getBigUint64(0, true); p += 8; return v; };
p++; // magic
const hasChange = !!(bytes[p++] & 1);
const n = bytes[p++];
const t = new btc.Transaction({ allowUnknownOutputs: true });
for (let i = 0; i < n; i++) {
const txid = rd(32), vout = r32(), amount = r64(), pubkey = rd(33), sigLen = bytes[p++], sig = rd(sigLen);
const pay = p2wpkh(pubkey, btc.NETWORK); // witness-program .script is network-independent
// second arg true: re-add an already-signed input without tripping the sign-status guard
t.addInput({ txid, index: vout, witnessUtxo: { script: pay.script, amount }, sighashType: sig[sig.length - 1], partialSig: [[pubkey, sig]] }, true);
}
if (hasChange) {
const amount = r64();
const hash = rd(20);
t.addOutput({ script: concatBytes(_u8(0x00), _u8(0x14), hash), amount }, true);
}
return t;
}
// Parse a gift code to a Transaction. New format: base32(compact). Legacy:
// base64url(PSBT). Auto-detected via the compact magic byte.
function _giftTx(code) {
try {
const b = base32nopad.decode(code.toUpperCase());
if (b[0] === GIFT_MAGIC) return _decodeCompactGift(b);
} catch {}
return btc.Transaction.fromPSBT(base64urlnopad.decode(code));
}
// ---- ephemeral-key (v2) gift codec -----------------------------------------
// Serialize the throwaway key + the fully-signed funding tx. base32 keeps the
// /g/ URL in the QR's dense uppercase-alphanumeric mode.
function _encodeLazyGift(epriv, tx) {
const raw = hex.decode(tx.hex); // finalized, witness-carrying network tx
return concatBytes(_u8(GIFT_MAGIC_V2), epriv, _le32(raw.length), raw);
}
// Parse a v2 gift code → { epriv, tx } (the funding tx), or null if not v2.
export function parseLazyGift(code) {
try {
const b = base32nopad.decode(code.toUpperCase());
if (b[0] !== GIFT_MAGIC_V2) return null;
let p = 1;
const epriv = b.slice(p, (p += 32));
const len = new DataView(b.buffer, b.byteOffset + p, 4).getUint32(0, true); p += 4;
const raw = b.slice(p, (p += len));
const tx = btc.Transaction.fromRaw(raw, { allowUnknownOutputs: true, allowUnknownInputs: true });
return { epriv, tx };
} catch { return null; }
}
// A gift link whose format can no longer be claimed safely (the retired v1
// blank-cheque on-chain gift). Such links are only claimable by the sweeper
// bot that front-runs them, so we refuse rather than broadcast a doomed claim.
export function isRetiredGift(code) {
if (parseLazyGift(code)) return false; // v2 is fine
try {
const b = base32nopad.decode(code.toUpperCase());
if (b[0] === GIFT_MAGIC) return true; // v1 compact
} catch {}
try { btc.Transaction.fromPSBT(base64urlnopad.decode(code)); return true; } catch {}
return false; // not an on-chain gift at all (e.g. an ark code)
}
function _sumInputs(tx) {
let inAmt = 0n;
for (let i = 0; i < tx.inputsLength; i++) inAmt += tx.getInput(i).witnessUtxo.amount;
return inAmt;
}
// The sender's change committed in a gift PSBT, or 0 for a no-change (whole-
// balance) gift that has no outputs at all.
function _giftChange(tx) {
return tx.outputsLength > 0 ? tx.getOutput(0).amount : 0n;
}
// The gift's funding outpoints (the coins its presigned inputs spend). If any is
// already spent — even by an unconfirmed claim — the gift has been taken and
// re-claiming would be a doomed double-spend. Used to gate the claim screen.
export function giftOutpoints(code) {
// v2: the outpoint whose spend means "already claimed" is E's funding output
// (funding txid : 0). Its txid is deterministic (the funding tx is fully
// signed), so we can name it before the funding tx is ever broadcast — an
// outspend check on it gates the claim screen exactly like v1's input did.
const g = parseLazyGift(code);
if (g) return [{ txid: g.tx.id, vout: 0 }];
try {
const tx = _giftTx(code);
const out = [];
for (let i = 0; i < tx.inputsLength; i++) {
const inp = tx.getInput(i);
out.push({ txid: hex.encode(inp.txid), vout: inp.index });
}
return out;
} catch {
return [];
}
}
export function previewGift(code) {
const g = parseLazyGift(code);
if (g) {
// room = the value sitting on E; the claimer's sweep fee (one input, one
// output) comes out of it at claim time.
return { room: Number(g.tx.getOutput(0).amount), inputs: 1 };
}
try {
const tx = _giftTx(code);
return { room: Number(_sumInputs(tx) - _giftChange(tx)), inputs: tx.inputsLength };
} catch {
return null;
}
}
// Build the transactions that claim a v2 (ephemeral-key) gift into `toAddress`:
// the presigned funding tx (sender coin → E) then a fresh SIGHASH_ALL sweep
// (E → claimer). Broadcast funding first, then sweep. Both fully commit to
// their outputs, so nothing is redirectable in the mempool. Retired v1 links
// throw. Returns { funding, sweep, amount, fee, outpoint }.
export function giftClaimTxs(code, toAddress, feeRate, net) {
const g = parseLazyGift(code);
if (!g) throw new Error('This gift link uses a retired format and can no longer be claimed safely.');
const { epriv, tx: funding } = g;
const fundingTxid = funding.id;
const eAmount = funding.getOutput(0).amount; // E's output, vout 0
const epub = secp256k1.getPublicKey(epriv, true);
const eaddr = p2wpkh(epub, net);
const sweep = new btc.Transaction();
sweep.addInput({ ...eaddr, txid: fundingTxid, index: 0, witnessUtxo: { script: eaddr.script, amount: eAmount } });
const fee = BigInt(_giftFundFee(1, 1, feeRate));
const out = eAmount - fee;
if (out < 294n) throw new Error('Gift is too small to claim at this fee rate.');
sweep.addOutputAddress(toAddress, out, net);
sweep.signIdx(epriv, 0); // SIGHASH_ALL (default)
sweep.finalize();
return {
funding: { hex: funding.hex, txid: fundingTxid },
sweep: { hex: sweep.hex, txid: sweep.id },
amount: Number(out),
fee: Number(fee),
outpoint: { txid: fundingTxid, vout: 0 },
};
}
// A gift locked to a recipient's nostr key. The amount + recipient pubkey are
// public (anyone can see what it is and who it's for), but the claim payload (the
// gift code) is NIP-44-encrypted to the recipient via an ephemeral key — so the
// link can be shared openly yet only the recipient's nostr key can claim it.
// v2 wraps an ARK gift code (v1 wrapped on-chain PSBT gifts and is retired —
// its links no longer exist in the wild). Two ways in, same plaintext: the
// one-time claim code DM'd to the recipient, or a NIP-07 extension holding
// the recipient's key decrypting the ephemeral-key ciphertext in place.
const LOCKED_GIFT_VERSION = 2;
// Encrypt the gift's claim payload under a one-time code. The code is delivered
// to the recipient via a nostr DM; the public link carries only the ciphertext.
// Returns { blob (for the /lg/ link), claimCode (to DM) }.
export function lockGift(code, amount, recipientPkHex) {
const { code: claimCode, ctCode, eph, ctKey } = encryptGiftPayload(code, recipientPkHex);
const blob = base64urlnopad.encode(new TextEncoder().encode(JSON.stringify({ v: LOCKED_GIFT_VERSION, amount, to: recipientPkHex, ct: ctCode, eph, ctKey })));
return { blob, claimCode };
}
// The public fields of a locked-gift blob (or null). Decryption needs the code.
export function previewLockedGift(blob) {
try {
const o = JSON.parse(new TextDecoder().decode(base64urlnopad.decode(blob)));
if (o.v === LOCKED_GIFT_VERSION && typeof o.amount === 'number' && o.to && o.ct) return o;
} catch {}
return null;
}
|