blossom-client-sdk 5.0.0-2 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/actions/delete.d.ts +3 -0
- package/lib/actions/delete.js +11 -7
- package/lib/actions/download.d.ts +3 -0
- package/lib/actions/download.js +11 -7
- package/lib/actions/list.d.ts +3 -0
- package/lib/actions/list.js +11 -7
- package/lib/actions/media.js +11 -7
- package/lib/actions/mirror.d.ts +3 -0
- package/lib/actions/mirror.js +11 -7
- package/lib/actions/multi-server.js +14 -0
- package/lib/actions/upload.d.ts +3 -0
- package/lib/actions/upload.js +11 -7
- package/lib/helpers/cashu.d.ts +3 -1
- package/lib/helpers/cashu.js +185 -4
- package/lib/helpers/headers.d.ts +1 -0
- package/lib/helpers/headers.js +5 -0
- package/lib/helpers/index.d.ts +1 -1
- package/lib/helpers/index.js +1 -1
- package/package.json +1 -5
- package/src/actions/delete.ts +12 -8
- package/src/actions/download.ts +12 -8
- package/src/actions/list.ts +12 -8
- package/src/actions/media.ts +10 -8
- package/src/actions/mirror.ts +13 -8
- package/src/actions/multi-server.ts +12 -0
- package/src/actions/upload.ts +13 -8
- package/src/helpers/cashu.ts +184 -7
- package/src/helpers/headers.ts +5 -0
- package/src/helpers/index.ts +1 -1
- package/src/types.ts +1 -2
- package/lib/helpers/cachu.d.ts +0 -5
- package/lib/helpers/cachu.js +0 -14
- package/lib/helpers.d.ts +0 -20
- package/lib/helpers.js +0 -73
- package/lib/upload.d.ts +0 -13
- package/lib/upload.js +0 -37
package/src/actions/delete.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { encodeAuthorizationHeader, getReusableAuthEvent, storeAuthEvent } from
|
|
|
2
2
|
import { ServerType } from "../types.js";
|
|
3
3
|
import HTTPError from "../error.js";
|
|
4
4
|
import { fetchWithTimeout } from "../helpers/fetch.js";
|
|
5
|
+
import { mergeHeaders } from "../helpers/headers.js";
|
|
5
6
|
import { PaymentRequest, PaymentToken, SignedEvent } from "../types.js";
|
|
6
7
|
|
|
7
8
|
export type DeleteOptions<S extends ServerType> = {
|
|
@@ -13,12 +14,15 @@ export type DeleteOptions<S extends ServerType> = {
|
|
|
13
14
|
authEvents?: Set<SignedEvent>;
|
|
14
15
|
/** Request timeout */
|
|
15
16
|
timeout?: number;
|
|
17
|
+
/** Return headers to retry a request rejected with HTTP 402. */
|
|
18
|
+
onPaymentRequired?: (server: S, sha256: string, headers: Headers) => Promise<HeadersInit>;
|
|
16
19
|
/**
|
|
17
20
|
* A method used to request payment when deleting
|
|
18
21
|
* @param server the server requiring payment
|
|
19
22
|
* @param sha256 the sha256 of the blob being uploaded or mirrored
|
|
20
23
|
* @param request the payment request
|
|
21
24
|
*/
|
|
25
|
+
/** @deprecated Use onPaymentRequired to handle payment schemes generically. */
|
|
22
26
|
onPayment?: (server: S, sha256: string, request: PaymentRequest) => Promise<PaymentToken>;
|
|
23
27
|
/**
|
|
24
28
|
* A method used to request a signed auth event for a server and sha256
|
|
@@ -81,19 +85,19 @@ export async function deleteBlob<S extends ServerType>(server: S, hash: string,
|
|
|
81
85
|
break;
|
|
82
86
|
}
|
|
83
87
|
case 402: {
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
88
|
+
let paymentHeaders: HeadersInit;
|
|
89
|
+
if (opts?.onPaymentRequired) paymentHeaders = await opts.onPaymentRequired(server, hash, res.headers);
|
|
90
|
+
else if (opts?.onPayment) {
|
|
91
|
+
const { encodePaymentToken, getPaymentRequestFromHeaders } = await import("../helpers/cashu.js");
|
|
92
|
+
const request = await getPaymentRequestFromHeaders(res.headers);
|
|
93
|
+
paymentHeaders = { "X-Cashu": encodePaymentToken(await opts.onPayment(server, hash, request)) };
|
|
94
|
+
} else throw new Error("Missing payment handler");
|
|
91
95
|
|
|
92
96
|
// Try delete with payment
|
|
93
97
|
res = await fetchWithTimeout(url, {
|
|
94
98
|
signal: opts?.signal,
|
|
95
99
|
method: "DELETE",
|
|
96
|
-
headers:
|
|
100
|
+
headers: mergeHeaders(headers, paymentHeaders),
|
|
97
101
|
timeout: opts?.timeout,
|
|
98
102
|
});
|
|
99
103
|
break;
|
package/src/actions/download.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { PaymentRequest, PaymentToken, SignedEvent } from "../types.js";
|
|
|
3
3
|
import HTTPError from "../error.js";
|
|
4
4
|
import { encodeAuthorizationHeader, getReusableAuthEvent, storeAuthEvent } from "../auth.js";
|
|
5
5
|
import { fetchWithTimeout } from "../helpers/index.js";
|
|
6
|
+
import { mergeHeaders } from "../helpers/headers.js";
|
|
6
7
|
|
|
7
8
|
export type DownloadOptions<S extends ServerType> = {
|
|
8
9
|
/** AbortSignal to cancel the action */
|
|
@@ -13,12 +14,15 @@ export type DownloadOptions<S extends ServerType> = {
|
|
|
13
14
|
authEvents?: Set<SignedEvent>;
|
|
14
15
|
/** Request timeout */
|
|
15
16
|
timeout?: number;
|
|
17
|
+
/** Return headers to retry a request rejected with HTTP 402. */
|
|
18
|
+
onPaymentRequired?: (server: S, sha256: string, headers: Headers) => Promise<HeadersInit>;
|
|
16
19
|
/**
|
|
17
20
|
* A method used to request payment when downloading
|
|
18
21
|
* @param server the server requiring payment
|
|
19
22
|
* @param sha256 the sha256 of the blob being uploaded or mirrored
|
|
20
23
|
* @param request the payment request
|
|
21
24
|
*/
|
|
25
|
+
/** @deprecated Use onPaymentRequired to handle payment schemes generically. */
|
|
22
26
|
onPayment?: (server: S, sha256: string, request: PaymentRequest) => Promise<PaymentToken>;
|
|
23
27
|
/**
|
|
24
28
|
* A method used to request a signed auth event for a server and sha256
|
|
@@ -80,17 +84,17 @@ export async function downloadBlob<S extends ServerType>(server: S, hash: string
|
|
|
80
84
|
break;
|
|
81
85
|
}
|
|
82
86
|
case 402: {
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
87
|
+
let paymentHeaders: HeadersInit;
|
|
88
|
+
if (opts?.onPaymentRequired) paymentHeaders = await opts.onPaymentRequired(server, hash, download.headers);
|
|
89
|
+
else if (opts?.onPayment) {
|
|
90
|
+
const { encodePaymentToken, getPaymentRequestFromHeaders } = await import("../helpers/cashu.js");
|
|
91
|
+
const request = await getPaymentRequestFromHeaders(download.headers);
|
|
92
|
+
paymentHeaders = { "X-Cashu": encodePaymentToken(await opts.onPayment(server, hash, request)) };
|
|
93
|
+
} else throw new Error("Missing payment handler");
|
|
90
94
|
|
|
91
95
|
// Try download with payment
|
|
92
96
|
download = await fetchWithTimeout(url, {
|
|
93
|
-
headers:
|
|
97
|
+
headers: mergeHeaders(headers, paymentHeaders),
|
|
94
98
|
signal: opts?.signal,
|
|
95
99
|
timeout: opts?.timeout,
|
|
96
100
|
});
|
package/src/actions/list.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { ServerType } from "../types.js";
|
|
|
3
3
|
import { BlobDescriptor, PaymentRequest, PaymentToken, SignedEvent } from "../types.js";
|
|
4
4
|
import { encodeAuthorizationHeader, getReusableAuthEvent, storeAuthEvent } from "../auth.js";
|
|
5
5
|
import { fetchWithTimeout } from "../helpers/index.js";
|
|
6
|
+
import { mergeHeaders } from "../helpers/headers.js";
|
|
6
7
|
|
|
7
8
|
export type ListOptions<S extends ServerType> = {
|
|
8
9
|
/** AbortSignal to cancel the action */
|
|
@@ -17,11 +18,14 @@ export type ListOptions<S extends ServerType> = {
|
|
|
17
18
|
limit?: number;
|
|
18
19
|
since?: number;
|
|
19
20
|
until?: number;
|
|
21
|
+
/** Return headers to retry a request rejected with HTTP 402. */
|
|
22
|
+
onPaymentRequired?: (server: S, headers: Headers) => Promise<HeadersInit>;
|
|
20
23
|
/**
|
|
21
24
|
* A method used to request payment
|
|
22
25
|
* @param server the server requiring payment
|
|
23
26
|
* @param request the payment request
|
|
24
27
|
*/
|
|
28
|
+
/** @deprecated Use onPaymentRequired to handle payment schemes generically. */
|
|
25
29
|
onPayment?: (server: S, request: PaymentRequest) => Promise<PaymentToken>;
|
|
26
30
|
/**
|
|
27
31
|
* A method used to request a signed auth event for a server
|
|
@@ -83,17 +87,17 @@ export async function listBlobs<S extends ServerType>(
|
|
|
83
87
|
break;
|
|
84
88
|
}
|
|
85
89
|
case 402: {
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
90
|
+
let paymentHeaders: HeadersInit;
|
|
91
|
+
if (opts?.onPaymentRequired) paymentHeaders = await opts.onPaymentRequired(server, list.headers);
|
|
92
|
+
else if (opts?.onPayment) {
|
|
93
|
+
const { encodePaymentToken, getPaymentRequestFromHeaders } = await import("../helpers/cashu.js");
|
|
94
|
+
const request = await getPaymentRequestFromHeaders(list.headers);
|
|
95
|
+
paymentHeaders = { "X-Cashu": encodePaymentToken(await opts.onPayment(server, request)) };
|
|
96
|
+
} else throw new Error("Missing payment handler");
|
|
93
97
|
|
|
94
98
|
// Try list with payment
|
|
95
99
|
list = await fetchWithTimeout(url, {
|
|
96
|
-
headers:
|
|
100
|
+
headers: mergeHeaders(headers, paymentHeaders),
|
|
97
101
|
signal: opts?.signal,
|
|
98
102
|
timeout: opts?.timeout,
|
|
99
103
|
});
|
package/src/actions/media.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ServerType, UploadType } from "../types.js";
|
|
2
2
|
import { BlobDescriptor } from "../types.js";
|
|
3
3
|
import { getBlobSha256, getBlobSize, getBlobType } from "../helpers/index.js";
|
|
4
|
+
import { mergeHeaders } from "../helpers/headers.js";
|
|
4
5
|
import HTTPError from "../error.js";
|
|
5
6
|
import { encodeAuthorizationHeader, getReusableAuthEvent, storeAuthEvent } from "../auth.js";
|
|
6
7
|
import { SignedEvent } from "../types.js";
|
|
@@ -87,20 +88,21 @@ export async function uploadMedia<S extends ServerType, B extends UploadType>(
|
|
|
87
88
|
break;
|
|
88
89
|
}
|
|
89
90
|
case 402: {
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
91
|
+
let paymentHeaders: HeadersInit;
|
|
92
|
+
if (opts?.onPaymentRequired)
|
|
93
|
+
paymentHeaders = await opts.onPaymentRequired(server, sha256, blob, firstTry.headers);
|
|
94
|
+
else if (opts?.onPayment) {
|
|
95
|
+
const { encodePaymentToken, getPaymentRequestFromHeaders } = await import("../helpers/cashu.js");
|
|
96
|
+
const request = await getPaymentRequestFromHeaders(firstTry.headers);
|
|
97
|
+
paymentHeaders = { "X-Cashu": encodePaymentToken(await opts.onPayment(server, sha256, blob, request)) };
|
|
98
|
+
} else throw new Error("Missing payment handler");
|
|
97
99
|
|
|
98
100
|
// Try upload with payment
|
|
99
101
|
upload = await fetch(url, {
|
|
100
102
|
signal: opts?.signal,
|
|
101
103
|
method: "PUT",
|
|
102
104
|
body: blob,
|
|
103
|
-
headers:
|
|
105
|
+
headers: mergeHeaders(headers, paymentHeaders),
|
|
104
106
|
});
|
|
105
107
|
break;
|
|
106
108
|
}
|
package/src/actions/mirror.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { encodeAuthorizationHeader, getReusableAuthEvent, storeAuthEvent } from
|
|
|
2
2
|
import { ServerType } from "../types.js";
|
|
3
3
|
import HTTPError from "../error.js";
|
|
4
4
|
import { fetchWithTimeout } from "../helpers/index.js";
|
|
5
|
+
import { mergeHeaders } from "../helpers/headers.js";
|
|
5
6
|
import { BlobDescriptor, PaymentRequest, PaymentToken, SignedEvent } from "../types.js";
|
|
6
7
|
|
|
7
8
|
export type MirrorOptions<S extends ServerType> = {
|
|
@@ -13,6 +14,8 @@ export type MirrorOptions<S extends ServerType> = {
|
|
|
13
14
|
authEvents?: Set<SignedEvent>;
|
|
14
15
|
/** Request timeout */
|
|
15
16
|
timeout?: number;
|
|
17
|
+
/** Return headers to retry a request rejected with HTTP 402. */
|
|
18
|
+
onPaymentRequired?: (server: S, sha256: string, blob: BlobDescriptor, headers: Headers) => Promise<HeadersInit>;
|
|
16
19
|
/**
|
|
17
20
|
* A method used to request payment when uploading or mirroring a blob
|
|
18
21
|
* @param server the server requiring payment
|
|
@@ -20,6 +23,7 @@ export type MirrorOptions<S extends ServerType> = {
|
|
|
20
23
|
* @param blob the original blob
|
|
21
24
|
* @param request the payment request
|
|
22
25
|
*/
|
|
26
|
+
/** @deprecated Use onPaymentRequired to handle payment schemes generically. */
|
|
23
27
|
onPayment?: (server: S, sha256: string, blob: BlobDescriptor, request: PaymentRequest) => Promise<PaymentToken>;
|
|
24
28
|
/**
|
|
25
29
|
* A method used to request a signed auth event for a server and sha256
|
|
@@ -94,20 +98,21 @@ export async function mirrorBlob<S extends ServerType>(
|
|
|
94
98
|
break;
|
|
95
99
|
}
|
|
96
100
|
case 402: {
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
101
|
+
let paymentHeaders: HeadersInit;
|
|
102
|
+
if (opts?.onPaymentRequired)
|
|
103
|
+
paymentHeaders = await opts.onPaymentRequired(server, blob.sha256, blob, mirror.headers);
|
|
104
|
+
else if (opts?.onPayment) {
|
|
105
|
+
const { encodePaymentToken, getPaymentRequestFromHeaders } = await import("../helpers/cashu.js");
|
|
106
|
+
const request = await getPaymentRequestFromHeaders(mirror.headers);
|
|
107
|
+
paymentHeaders = { "X-Cashu": encodePaymentToken(await opts.onPayment(server, blob.sha256, blob, request)) };
|
|
108
|
+
} else throw new Error("Missing payment handler");
|
|
104
109
|
|
|
105
110
|
// Try mirror with payment
|
|
106
111
|
mirror = await fetchWithTimeout(url, {
|
|
107
112
|
signal: opts?.signal,
|
|
108
113
|
method: "PUT",
|
|
109
114
|
body,
|
|
110
|
-
headers:
|
|
115
|
+
headers: mergeHeaders(headers, paymentHeaders),
|
|
111
116
|
timeout: opts?.timeout,
|
|
112
117
|
});
|
|
113
118
|
break;
|
|
@@ -121,6 +121,10 @@ export async function multiServerUpload<S extends ServerType, B extends UploadTy
|
|
|
121
121
|
if (!options.onPayment) throw new Error("Missing payment handler");
|
|
122
122
|
return options.onPayment(server, sha256, blob, request);
|
|
123
123
|
};
|
|
124
|
+
const handlePaymentRequired = (server: S, sha256: string, _blob: any, headers: Headers) => {
|
|
125
|
+
if (!options.onPaymentRequired) throw new Error("Missing payment handler");
|
|
126
|
+
return options.onPaymentRequired(server, sha256, blob, headers);
|
|
127
|
+
};
|
|
124
128
|
|
|
125
129
|
const handleRejection = async (server: S, sha256: string, error: unknown): Promise<RejectionAction | false> => {
|
|
126
130
|
if (!HTTPError.isRejection(error)) return false;
|
|
@@ -179,6 +183,7 @@ export async function multiServerUpload<S extends ServerType, B extends UploadTy
|
|
|
179
183
|
auth: typeof options.auth === "boolean" ? options.auth : undefined,
|
|
180
184
|
onAuth: (server, sha256) => handleAuthRequest(server, sha256, "upload"),
|
|
181
185
|
onPayment: handlePaymentRequest,
|
|
186
|
+
onPaymentRequired: options.onPaymentRequired ? handlePaymentRequired : undefined,
|
|
182
187
|
timeout: options.mirrorTimeout,
|
|
183
188
|
});
|
|
184
189
|
} catch (error) {
|
|
@@ -196,6 +201,7 @@ export async function multiServerUpload<S extends ServerType, B extends UploadTy
|
|
|
196
201
|
auth: typeof options.auth === "boolean" ? options.auth : undefined,
|
|
197
202
|
onAuth: handleAuthRequest,
|
|
198
203
|
onPayment: handlePaymentRequest,
|
|
204
|
+
onPaymentRequired: options.onPaymentRequired ? handlePaymentRequired : undefined,
|
|
199
205
|
timeout: options.mirrorTimeout,
|
|
200
206
|
});
|
|
201
207
|
|
|
@@ -259,6 +265,10 @@ export async function multiServerMediaUpload<S extends ServerType, B extends Upl
|
|
|
259
265
|
if (!options.onPayment) throw new Error("Missing payment handler");
|
|
260
266
|
return options.onPayment(server, sha256, blob, request);
|
|
261
267
|
};
|
|
268
|
+
const handlePaymentRequired = (server: S, sha256: string, _blob: any, headers: Headers) => {
|
|
269
|
+
if (!options.onPaymentRequired) throw new Error("Missing payment handler");
|
|
270
|
+
return options.onPaymentRequired(server, sha256, blob, headers);
|
|
271
|
+
};
|
|
262
272
|
|
|
263
273
|
const handleRejection = async (server: S, sha256: string, error: unknown): Promise<RejectionAction | false> => {
|
|
264
274
|
if (!HTTPError.isRejection(error)) return false;
|
|
@@ -285,6 +295,7 @@ export async function multiServerMediaUpload<S extends ServerType, B extends Upl
|
|
|
285
295
|
auth: typeof options.auth === "boolean" ? options.auth : undefined,
|
|
286
296
|
onAuth: handleAuthRequest,
|
|
287
297
|
onPayment: handlePaymentRequest,
|
|
298
|
+
onPaymentRequired: options.onPaymentRequired ? handlePaymentRequired : undefined,
|
|
288
299
|
});
|
|
289
300
|
|
|
290
301
|
results.set(server, initialUpload);
|
|
@@ -348,6 +359,7 @@ export async function multiServerMediaUpload<S extends ServerType, B extends Upl
|
|
|
348
359
|
auth: typeof options.auth === "boolean" ? options.auth : undefined,
|
|
349
360
|
onAuth: (server, sha256) => handleAuthRequest(server, sha256, "upload"),
|
|
350
361
|
onPayment: handlePaymentRequest,
|
|
362
|
+
onPaymentRequired: options.onPaymentRequired ? handlePaymentRequired : undefined,
|
|
351
363
|
timeout: options.mirrorTimeout,
|
|
352
364
|
});
|
|
353
365
|
|
package/src/actions/upload.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { encodeAuthorizationHeader, getReusableAuthEvent, storeAuthEvent } from
|
|
|
2
2
|
import { ServerType, UploadType } from "../types.js";
|
|
3
3
|
import HTTPError from "../error.js";
|
|
4
4
|
import { fetchWithTimeout, getBlobSha256, getBlobSize, getBlobType } from "../helpers/index.js";
|
|
5
|
+
import { mergeHeaders } from "../helpers/headers.js";
|
|
5
6
|
import { BlobDescriptor, PaymentRequest, PaymentToken, SignedEvent } from "../types.js";
|
|
6
7
|
|
|
7
8
|
export type UploadOptions<S extends ServerType, B extends UploadType> = {
|
|
@@ -13,6 +14,8 @@ export type UploadOptions<S extends ServerType, B extends UploadType> = {
|
|
|
13
14
|
authEvents?: Set<SignedEvent>;
|
|
14
15
|
/** Request timeout */
|
|
15
16
|
timeout?: number;
|
|
17
|
+
/** Return headers to retry a request rejected with HTTP 402. */
|
|
18
|
+
onPaymentRequired?: (server: S, sha256: string, blob: B, headers: Headers) => Promise<HeadersInit>;
|
|
16
19
|
/**
|
|
17
20
|
* A method used to request payment when uploading or mirroring a blob
|
|
18
21
|
* @param server the server requiring payment
|
|
@@ -20,6 +23,7 @@ export type UploadOptions<S extends ServerType, B extends UploadType> = {
|
|
|
20
23
|
* @param blob the original blob
|
|
21
24
|
* @param request the payment request
|
|
22
25
|
*/
|
|
26
|
+
/** @deprecated Use onPaymentRequired to handle payment schemes generically. */
|
|
23
27
|
onPayment?: (server: S, sha256: string, blob: B, request: PaymentRequest) => Promise<PaymentToken>;
|
|
24
28
|
/**
|
|
25
29
|
* A method used to request a signed auth event for a server and sha256
|
|
@@ -112,19 +116,20 @@ export async function uploadBlob<S extends ServerType, B extends UploadType>(
|
|
|
112
116
|
break;
|
|
113
117
|
}
|
|
114
118
|
case 402: {
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
119
|
+
let paymentHeaders: HeadersInit;
|
|
120
|
+
if (opts?.onPaymentRequired)
|
|
121
|
+
paymentHeaders = await opts.onPaymentRequired(server, sha256, blob, firstTry.headers);
|
|
122
|
+
else if (opts?.onPayment) {
|
|
123
|
+
const { encodePaymentToken, getPaymentRequestFromHeaders } = await import("../helpers/cashu.js");
|
|
124
|
+
const request = await getPaymentRequestFromHeaders(firstTry.headers);
|
|
125
|
+
paymentHeaders = { "X-Cashu": encodePaymentToken(await opts.onPayment(server, sha256, blob, request)) };
|
|
126
|
+
} else throw new Error("Missing payment handler");
|
|
122
127
|
|
|
123
128
|
// Try upload with payment
|
|
124
129
|
upload = await fetchWithTimeout(url, {
|
|
125
130
|
method: "PUT",
|
|
126
131
|
body: blob,
|
|
127
|
-
headers:
|
|
132
|
+
headers: mergeHeaders(headers, paymentHeaders),
|
|
128
133
|
signal: opts?.signal,
|
|
129
134
|
timeout: opts?.timeout,
|
|
130
135
|
});
|
package/src/helpers/cashu.ts
CHANGED
|
@@ -1,21 +1,198 @@
|
|
|
1
1
|
import { PaymentRequest } from "../types.js";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
const decodeBase64 = (value: string) => {
|
|
4
|
+
const base64 = value
|
|
5
|
+
.replace(/-/g, "+")
|
|
6
|
+
.replace(/_/g, "/")
|
|
7
|
+
.padEnd(Math.ceil(value.length / 4) * 4, "=");
|
|
8
|
+
return Uint8Array.from(atob(base64), (character) => character.charCodeAt(0));
|
|
9
|
+
};
|
|
10
|
+
const encodedRequests = new WeakMap<object, string>();
|
|
11
|
+
|
|
12
|
+
class PaymentRequestCompatibility implements PaymentRequest {
|
|
13
|
+
constructor(
|
|
14
|
+
public transport: PaymentRequest["transport"],
|
|
15
|
+
public id?: string,
|
|
16
|
+
public amount?: number,
|
|
17
|
+
public unit?: string,
|
|
18
|
+
public mints?: string[],
|
|
19
|
+
public description?: string,
|
|
20
|
+
public singleUse = false,
|
|
21
|
+
) {}
|
|
22
|
+
|
|
23
|
+
toRawRequest(): ReturnType<PaymentRequest["toRawRequest"]> {
|
|
24
|
+
return {
|
|
25
|
+
t: this.transport.map((item) => ({ t: item.type, a: item.target, g: item.tags })),
|
|
26
|
+
...(this.id ? { i: this.id } : {}),
|
|
27
|
+
...(this.amount ? { a: this.amount } : {}),
|
|
28
|
+
...(this.unit ? { u: this.unit } : {}),
|
|
29
|
+
...(this.mints ? { m: this.mints } : {}),
|
|
30
|
+
...(this.description ? { d: this.description } : {}),
|
|
31
|
+
...(this.singleUse ? { s: true } : {}),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
toEncodedRequest() {
|
|
36
|
+
return encodedRequests.get(this)!;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
getTransport(type: string) {
|
|
40
|
+
return this.transport.find((item) => item.type === type);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function decodeCbor(data: Uint8Array): unknown {
|
|
45
|
+
const view = new DataView(data.buffer, data.byteOffset, data.byteLength);
|
|
46
|
+
|
|
47
|
+
const decodeLength = (offset: number, info: number): [number, number] => {
|
|
48
|
+
if (info < 24) return [info, offset];
|
|
49
|
+
if (info === 24) return [view.getUint8(offset), offset + 1];
|
|
50
|
+
if (info === 25) return [view.getUint16(offset), offset + 2];
|
|
51
|
+
if (info === 26) return [view.getUint32(offset), offset + 4];
|
|
52
|
+
throw new Error("Unsupported CBOR length");
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
const decode = (offset: number): [unknown, number] => {
|
|
56
|
+
const byte = view.getUint8(offset++);
|
|
57
|
+
const type = byte >> 5;
|
|
58
|
+
const info = byte & 0x1f;
|
|
59
|
+
const [length, next] = decodeLength(offset, info);
|
|
60
|
+
|
|
61
|
+
if (type === 0) return [length, next];
|
|
62
|
+
if (type === 2) return [data.slice(next, next + length), next + length];
|
|
63
|
+
if (type === 3) return [new TextDecoder().decode(data.slice(next, next + length)), next + length];
|
|
64
|
+
if (type === 4) {
|
|
65
|
+
const values: unknown[] = [];
|
|
66
|
+
let cursor = next;
|
|
67
|
+
for (let index = 0; index < length; index++) {
|
|
68
|
+
const [value, end] = decode(cursor);
|
|
69
|
+
values.push(value);
|
|
70
|
+
cursor = end;
|
|
71
|
+
}
|
|
72
|
+
return [values, cursor];
|
|
73
|
+
}
|
|
74
|
+
if (type === 5) {
|
|
75
|
+
const value: Record<string, unknown> = {};
|
|
76
|
+
let cursor = next;
|
|
77
|
+
for (let index = 0; index < length; index++) {
|
|
78
|
+
const [key, keyEnd] = decode(cursor);
|
|
79
|
+
const [item, itemEnd] = decode(keyEnd);
|
|
80
|
+
value[String(key)] = item;
|
|
81
|
+
cursor = itemEnd;
|
|
82
|
+
}
|
|
83
|
+
return [value, cursor];
|
|
84
|
+
}
|
|
85
|
+
if (type === 7 && info >= 20 && info <= 23) return [[false, true, null, undefined][info - 20], offset];
|
|
86
|
+
throw new Error("Unsupported CBOR value");
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
return decode(0)[0];
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
function encodeCbor(value: unknown): Uint8Array {
|
|
93
|
+
const output: number[] = [];
|
|
94
|
+
const length = (major: number, value: number) => {
|
|
95
|
+
if (value < 24) output.push((major << 5) | value);
|
|
96
|
+
else if (value < 256) output.push((major << 5) | 24, value);
|
|
97
|
+
else if (value < 65536) output.push((major << 5) | 25, value >> 8, value & 0xff);
|
|
98
|
+
else output.push((major << 5) | 26, value >> 24, (value >> 16) & 0xff, (value >> 8) & 0xff, value & 0xff);
|
|
99
|
+
};
|
|
100
|
+
const encode = (item: unknown) => {
|
|
101
|
+
if (typeof item === "number") length(0, item);
|
|
102
|
+
else if (typeof item === "string") {
|
|
103
|
+
const bytes = new TextEncoder().encode(item);
|
|
104
|
+
length(3, bytes.length);
|
|
105
|
+
output.push(...bytes);
|
|
106
|
+
} else if (item instanceof Uint8Array) {
|
|
107
|
+
length(2, item.length);
|
|
108
|
+
output.push(...item);
|
|
109
|
+
} else if (Array.isArray(item)) {
|
|
110
|
+
length(4, item.length);
|
|
111
|
+
item.forEach(encode);
|
|
112
|
+
} else if (item && typeof item === "object") {
|
|
113
|
+
const entries = Object.entries(item);
|
|
114
|
+
length(5, entries.length);
|
|
115
|
+
entries.forEach(([key, entry]) => {
|
|
116
|
+
encode(key);
|
|
117
|
+
encode(entry);
|
|
118
|
+
});
|
|
119
|
+
} else if (typeof item === "boolean") output.push(item ? 0xf5 : 0xf4);
|
|
120
|
+
else throw new Error("Unsupported CBOR value");
|
|
121
|
+
};
|
|
122
|
+
encode(value);
|
|
123
|
+
return Uint8Array.from(output);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
const hexToBytes = (hex: string) => Uint8Array.from(hex.match(/.{1,2}/g) ?? [], (value) => Number.parseInt(value, 16));
|
|
127
|
+
|
|
128
|
+
/** Extracts a Cashu PaymentRequest-compatible object from Headers. */
|
|
4
129
|
export async function getPaymentRequestFromHeaders(headers: Headers): Promise<PaymentRequest>;
|
|
5
130
|
export async function getPaymentRequestFromHeaders(headers: Headers, quite: false): Promise<PaymentRequest>;
|
|
6
131
|
export async function getPaymentRequestFromHeaders(headers: Headers, quite: true): Promise<PaymentRequest | undefined>;
|
|
7
|
-
export async function getPaymentRequestFromHeaders(
|
|
132
|
+
export async function getPaymentRequestFromHeaders(
|
|
133
|
+
headers: Headers,
|
|
134
|
+
quite = false,
|
|
135
|
+
): Promise<PaymentRequest | undefined> {
|
|
8
136
|
const header = headers.get("X-Cashu");
|
|
9
137
|
if (!header) {
|
|
10
138
|
if (!quite) throw new Error("Missing cashu header");
|
|
11
139
|
else return undefined;
|
|
12
140
|
}
|
|
13
141
|
|
|
14
|
-
|
|
15
|
-
const
|
|
142
|
+
if (!header.startsWith("creqA")) throw new Error("Unsupported cashu payment request");
|
|
143
|
+
const raw = decodeCbor(decodeBase64(header.slice(5))) as ReturnType<PaymentRequest["toRawRequest"]>;
|
|
144
|
+
const request = new PaymentRequestCompatibility([], raw.i, raw.a, raw.u, raw.m, raw.d, raw.s);
|
|
145
|
+
encodedRequests.set(request, header);
|
|
146
|
+
return request;
|
|
147
|
+
}
|
|
16
148
|
|
|
17
|
-
|
|
18
|
-
|
|
149
|
+
/** Encodes the legacy Cashu token shape used by the deprecated onPayment callback. */
|
|
150
|
+
export function encodePaymentToken(token: unknown): string {
|
|
151
|
+
const value = token as {
|
|
152
|
+
mint: string;
|
|
153
|
+
unit?: string;
|
|
154
|
+
memo?: string;
|
|
155
|
+
proofs: Array<{
|
|
156
|
+
id: string;
|
|
157
|
+
amount: number;
|
|
158
|
+
secret: string;
|
|
159
|
+
C: string;
|
|
160
|
+
dleq?: { e: string; s: string; r?: string };
|
|
161
|
+
}>;
|
|
162
|
+
};
|
|
163
|
+
const nonHex = value.proofs.some((proof) => !/^[0-9a-fA-F]+$/.test(proof.id));
|
|
164
|
+
if (nonHex) {
|
|
165
|
+
const json = JSON.stringify({
|
|
166
|
+
token: [{ mint: value.mint, proofs: value.proofs }],
|
|
167
|
+
unit: value.unit,
|
|
168
|
+
memo: value.memo,
|
|
169
|
+
});
|
|
170
|
+
const bytes = new TextEncoder().encode(json);
|
|
171
|
+
let binary = "";
|
|
172
|
+
for (const byte of bytes) binary += String.fromCharCode(byte);
|
|
173
|
+
return "cashuA" + btoa(binary).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
|
|
174
|
+
}
|
|
19
175
|
|
|
20
|
-
|
|
176
|
+
const groups = new Map<string, typeof value.proofs>();
|
|
177
|
+
for (const proof of value.proofs) groups.set(proof.id, [...(groups.get(proof.id) ?? []), proof]);
|
|
178
|
+
const template = {
|
|
179
|
+
m: value.mint,
|
|
180
|
+
u: value.unit || "sat",
|
|
181
|
+
t: [...groups].map(([id, proofs]) => ({
|
|
182
|
+
i: hexToBytes(id),
|
|
183
|
+
p: proofs.map((proof) => ({
|
|
184
|
+
a: proof.amount,
|
|
185
|
+
s: proof.secret,
|
|
186
|
+
c: hexToBytes(proof.C),
|
|
187
|
+
...(proof.dleq
|
|
188
|
+
? { d: { e: hexToBytes(proof.dleq.e), s: hexToBytes(proof.dleq.s), r: hexToBytes(proof.dleq.r ?? "00") } }
|
|
189
|
+
: {}),
|
|
190
|
+
})),
|
|
191
|
+
})),
|
|
192
|
+
...(value.memo ? { d: value.memo } : {}),
|
|
193
|
+
};
|
|
194
|
+
const bytes = encodeCbor(template);
|
|
195
|
+
let binary = "";
|
|
196
|
+
for (const byte of bytes) binary += String.fromCharCode(byte);
|
|
197
|
+
return "cashuB" + btoa(binary).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
|
|
21
198
|
}
|
package/src/helpers/index.ts
CHANGED
package/src/types.ts
CHANGED
|
@@ -40,8 +40,7 @@ export type BlobDescriptor = {
|
|
|
40
40
|
|
|
41
41
|
export type RejectionAction = "skip" | "cancel";
|
|
42
42
|
|
|
43
|
-
// NOTE: structural copies
|
|
44
|
-
// optional peer dependency. Keep field shapes in sync with cashu-ts upstream.
|
|
43
|
+
// NOTE: structural copies retained for compatibility with the deprecated Cashu payment handlers.
|
|
45
44
|
|
|
46
45
|
export type PaymentRequestTransport = {
|
|
47
46
|
type: string;
|
package/lib/helpers/cachu.d.ts
DELETED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { PaymentRequest } from "../types.js";
|
|
2
|
-
/** Extracts a cashu-ts PaymentRequest from Headers */
|
|
3
|
-
export declare function getPaymentRequestFromHeaders(headers: Headers): PaymentRequest;
|
|
4
|
-
export declare function getPaymentRequestFromHeaders(headers: Headers, quite: false): PaymentRequest;
|
|
5
|
-
export declare function getPaymentRequestFromHeaders(headers: Headers, quite: true): PaymentRequest | undefined;
|
package/lib/helpers/cachu.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { decodePaymentRequest } from "@cashu/cashu-ts";
|
|
2
|
-
export function getPaymentRequestFromHeaders(headers, quite = false) {
|
|
3
|
-
const header = headers.get("X-Cashu");
|
|
4
|
-
if (!header) {
|
|
5
|
-
if (!quite)
|
|
6
|
-
throw new Error("Missing cashu header");
|
|
7
|
-
else
|
|
8
|
-
return undefined;
|
|
9
|
-
}
|
|
10
|
-
const request = decodePaymentRequest(header);
|
|
11
|
-
// Clear the transport, since NUT-23 is only in-band payments
|
|
12
|
-
request.transport = [];
|
|
13
|
-
return request;
|
|
14
|
-
}
|
package/lib/helpers.d.ts
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { type UploadType } from "./client.js";
|
|
2
|
-
import { PaymentRequest } from "./types.js";
|
|
3
|
-
export declare function isSha256(str: string): RegExpMatchArray | null;
|
|
4
|
-
/** returns the last sha256 in a URL */
|
|
5
|
-
export declare function getHashFromURL(url: string | URL): string | null;
|
|
6
|
-
export declare const BlobHashSymbol: unique symbol;
|
|
7
|
-
/** gets or calculates the sha2456 of a Blob */
|
|
8
|
-
export declare function getBlobSha256(blob: UploadType): string | Promise<string>;
|
|
9
|
-
/** Calculates the sha2456 of a Blob */
|
|
10
|
-
export declare function computeBlobSha256(blob: UploadType): Promise<string>;
|
|
11
|
-
/** Returns the size of the blob in bytes */
|
|
12
|
-
export declare function getBlobSize(blob: UploadType): number;
|
|
13
|
-
/** Returns the mime type of the blob */
|
|
14
|
-
export declare function getBlobType(blob: UploadType): string | undefined;
|
|
15
|
-
/** Check if two servers are the same */
|
|
16
|
-
export declare function areServersEqual(a: string | URL, b: string | URL): boolean;
|
|
17
|
-
/** Extracts a cashu-ts PaymentRequest from Headers */
|
|
18
|
-
export declare function getPaymentRequestFromHeaders(headers: Headers): PaymentRequest;
|
|
19
|
-
export declare function getPaymentRequestFromHeaders(headers: Headers, quite: false): PaymentRequest;
|
|
20
|
-
export declare function getPaymentRequestFromHeaders(headers: Headers, quite: true): PaymentRequest | undefined;
|