@ar.io/sdk 3.11.0-alpha.7 → 3.11.0-alpha.9

package/lib/cjs/common/wayfinder/wayfinder.test.js

@@ -6,18 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const got_1 = __importDefault(require("got"));
 const node_assert_1 = __importDefault(require("node:assert"));
+const node_events_1 = require("node:events");
+const node_stream_1 = require("node:stream");
 const consumers_1 = require("node:stream/consumers");
 const node_test_1 = require("node:test");
 const logger_js_1 = require("../../common/logger.js");
 const random_js_1 = require("./routers/random.js");
+const static_js_1 = require("./routers/static.js");
 const wayfinder_js_1 = require("./wayfinder.js");
+// TODO: replace with locally running gateway
 const gatewayUrl = 'permagate.io';
 const stubbedGatewaysProvider = {
-    getGateways: async () => [new URL(`https://${gatewayUrl}`)],
+    getGateways: async () => [new URL(`http://${gatewayUrl}`)],
 };
-logger_js_1.Logger.default.setLogLevel('debug');
+logger_js_1.Logger.default.setLogLevel('none');
 (0, node_test_1.describe)('Wayfinder', () => {
-    (0, node_test_1.describe)('http wrapper', () => {
+    node_test_1.describe.skip('http wrapper', () => {
         (0, node_test_1.describe)('fetch', () => {
             let wayfinder;
             (0, node_test_1.before)(() => {
@@ -238,4 +242,259 @@ logger_js_1.Logger.default.setLogLevel('debug');
             });
         });
     });
+    (0, node_test_1.describe)('events', () => {
+        (0, node_test_1.it)('should emit events on the wayfinder event emitter', async () => {
+            const wayfinder = new wayfinder_js_1.Wayfinder({
+                httpClient: fetch,
+                router: new static_js_1.StaticGatewayRouter({
+                    gateway: `http://${gatewayUrl}`,
+                }),
+                verifier: {
+                    // @ts-expect-error
+                    verifyData: async (params) => {
+                        return;
+                    },
+                },
+            });
+            const events = [];
+            wayfinder.emitter.on('verification-failed', (event) => {
+                events.push({ type: 'verification-failed', ...event });
+            });
+            wayfinder.emitter.on('verification-progress', (event) => {
+                events.push({ type: 'verification-progress', ...event });
+            });
+            wayfinder.emitter.on('verification-passed', (event) => {
+                events.push({ type: 'verification-passed', ...event });
+            });
+            // request data and assert the event is emitted
+            const response = await wayfinder.request('ar://c7wkwt6TKgcWJUfgvpJ5q5qi4DIZyJ1_TqhjXgURh0U', {
+                redirect: 'follow',
+            });
+            // read the full response body to ensure the stream is fully consumed
+            await response.text();
+            node_assert_1.default.strictEqual(response.status, 200);
+            node_assert_1.default.ok(events.find((e) => e.type === 'verification-passed'), 'Should emit at least one verification-passed');
+        });
+        (0, node_test_1.it)('should execute callbacks provided to the wayfinder constructor', async () => {
+            let verificationFailed = false;
+            let verificationProgress = false;
+            let verificationPassed = false;
+            const wayfinder = new wayfinder_js_1.Wayfinder({
+                httpClient: fetch,
+                router: new static_js_1.StaticGatewayRouter({
+                    gateway: `http://${gatewayUrl}`,
+                }),
+                events: {
+                    onVerificationFailed: () => {
+                        verificationFailed = true;
+                    },
+                    onVerificationProgress: () => {
+                        verificationProgress = true;
+                    },
+                    onVerificationPassed: () => {
+                        verificationPassed = true;
+                    },
+                },
+            });
+            const response = await wayfinder.request('ar://c7wkwt6TKgcWJUfgvpJ5q5qi4DIZyJ1_TqhjXgURh0U', {
+                redirect: 'follow',
+            });
+            // read the full response body to ensure the stream is fully consumed
+            await response.text();
+            node_assert_1.default.strictEqual(response.status, 200);
+            node_assert_1.default.ok(verificationFailed === false, 'Should not emit verification-failed');
+            node_assert_1.default.ok(verificationProgress, 'Should emit verification-progress');
+            node_assert_1.default.ok(verificationPassed, 'Should emit verification-passed');
+        });
+    });
+    node_test_1.describe.skip('tapAndVerifyRequest', () => {
+        (0, node_test_1.describe)('Readable', () => {
+            (0, node_test_1.it)('should duplicate the stream, verify the first and return the second if verification passes', async () => {
+                // create a simple readable
+                const chunks = [
+                    Buffer.from('foo'),
+                    Buffer.from('bar'),
+                    Buffer.from('baz'),
+                ];
+                const contentLength = chunks.reduce((sum, c) => sum + c.length, 0);
+                // a stream that will emit chunks
+                const originalStream = node_stream_1.Readable.from(chunks);
+                let seen = Buffer.alloc(0);
+                const verifyData = async ({ data, 
+                // @ts-expect-error
+                txId, }) => {
+                    return new Promise((resolve, reject) => {
+                        data.on('data', (chunk) => {
+                            seen = Buffer.concat([seen, chunk]);
+                        });
+                        data.on('end', () => {
+                            // Should have seen exactly the full payload
+                            node_assert_1.default.strictEqual(seen.length, contentLength);
+                            resolve();
+                        });
+                        data.on('error', reject);
+                    });
+                };
+                const txId = 'test-tx-1';
+                const emitter = new node_events_1.EventEmitter();
+                const events = [];
+                emitter.on('verification-progress', (e) => {
+                    console.log('verification-progress', e);
+                    events.push({ type: 'verification-progress', ...e });
+                });
+                emitter.on('verification-passed', (e) => events.push({ type: 'verification-passed', ...e }));
+                // tap with verification
+                const tapped = (0, wayfinder_js_1.tapAndVerifyStream)({
+                    originalStream,
+                    contentLength,
+                    verifyData,
+                    txId,
+                    emitter,
+                });
+                // read the stream
+                const out = [];
+                for await (const chunk of tapped) {
+                    out.push(chunk);
+                }
+                // assert the stream is the same
+                node_assert_1.default.strictEqual(Buffer.concat(out).toString(), Buffer.concat(chunks).toString(), 'The tapped stream should emit exactly the original data');
+                node_assert_1.default.ok(events.find((e) => e.type === 'verification-progress'), 'Should emit at least one verification-progress');
+                node_assert_1.default.ok(events.find((e) => e.type === 'verification-passed' && e.txId === txId), 'Should emit at least one verification-passed');
+            });
+            (0, node_test_1.it)('should throw an error on the client stream if verification fails', async () => {
+                const chunks = [
+                    Buffer.from('foo'),
+                    Buffer.from('bar'),
+                    Buffer.from('baz'),
+                ];
+                const contentLength = chunks.reduce((sum, c) => sum + c.length, 0);
+                // a stream that will emit chunks
+                const originalStream = node_stream_1.Readable.from(chunks);
+                const verifyData = async ({ 
+                // @ts-expect-error
+                data, txId, }) => {
+                    throw new Error('Verification failed for txId: ' + txId);
+                };
+                const txId = 'test-tx-1';
+                const emitter = new node_events_1.EventEmitter();
+                const events = [];
+                emitter.on('verification-progress', (e) => events.push({ type: 'verification-progress', ...e }));
+                emitter.on('verification-failed', (e) => events.push({ type: 'verification-failed', ...e }));
+                // tap with verification
+                const tapped = (0, wayfinder_js_1.tapAndVerifyStream)({
+                    originalStream,
+                    contentLength,
+                    verifyData,
+                    txId,
+                    emitter,
+                });
+                // read the stream
+                try {
+                    const out = [];
+                    for await (const chunk of tapped) {
+                        out.push(chunk);
+                    }
+                }
+                catch (error) {
+                    node_assert_1.default.ok(events.find((e) => e.type === 'verification-failed' && e.txId === txId), 'Should emit at least one verification-failed');
+                    // stream should be closed
+                    node_assert_1.default.ok(tapped.closed);
+                }
+            });
+        });
+        (0, node_test_1.describe)('ReadableStream', () => {
+            (0, node_test_1.it)('should duplicate the ReadableStream, verify the first and return the second if verification passes', async () => {
+                // create a simple readable
+                const chunks = [
+                    Buffer.from('foo'),
+                    Buffer.from('bar'),
+                    Buffer.from('baz'),
+                ];
+                const contentLength = chunks.reduce((sum, c) => sum + c.length, 0);
+                // a stream that will emit chunks
+                const originalStream = ReadableStream.from(chunks);
+                let seen = Buffer.alloc(0);
+                const verifyData = async ({ data, 
+                // @ts-expect-error
+                txId, }) => {
+                    return new Promise(async (resolve, reject) => {
+                        const reader = data.getReader();
+                        while (true) {
+                            try {
+                                const { done, value } = await reader.read();
+                                if (done) {
+                                    resolve();
+                                    break;
+                                }
+                                seen = Buffer.concat([seen, value]);
+                            }
+                            catch (error) {
+                                reject(error);
+                            }
+                        }
+                    });
+                };
+                const txId = 'test-tx-1';
+                const emitter = new node_events_1.EventEmitter();
+                const events = [];
+                emitter.on('verification-progress', (e) => events.push({ type: 'verification-progress', ...e }));
+                emitter.on('verification-passed', (e) => events.push({ type: 'verification-passed', ...e }));
+                // tap with verification
+                const tapped = (0, wayfinder_js_1.tapAndVerifyStream)({
+                    originalStream,
+                    contentLength,
+                    verifyData,
+                    txId,
+                    emitter,
+                });
+                // read the stream
+                const out = [];
+                for await (const chunk of tapped) {
+                    out.push(chunk);
+                }
+                // assert the stream is the same
+                node_assert_1.default.strictEqual(Buffer.concat(out).toString(), Buffer.concat(chunks).toString(), 'The tapped stream should emit exactly the original data');
+                node_assert_1.default.ok(events.find((e) => e.type === 'verification-progress'), 'Should emit at least one verification-progress');
+                node_assert_1.default.ok(events.find((e) => e.type === 'verification-passed' && e.txId === txId), 'Should emit at least one verification-passed');
+            });
+            (0, node_test_1.it)('should throw an error on the client stream if verification fails', async () => {
+                const chunks = [
+                    Buffer.from('foo'),
+                    Buffer.from('bar'),
+                    Buffer.from('baz'),
+                ];
+                const contentLength = chunks.reduce((sum, c) => sum + c.length, 0);
+                // a stream that will emit chunks
+                const originalStream = ReadableStream.from(chunks);
+                const verifyData = async ({ 
+                // @ts-expect-error
+                data, txId, }) => {
+                    throw new Error('Verification failed for txId: ' + txId);
+                };
+                const txId = 'test-tx-1';
+                const emitter = new node_events_1.EventEmitter();
+                const events = [];
+                emitter.on('verification-progress', (e) => events.push({ type: 'verification-progress', ...e }));
+                emitter.on('verification-failed', (e) => events.push({ type: 'verification-failed', ...e }));
+                // tap with verification
+                const tapped = (0, wayfinder_js_1.tapAndVerifyStream)({
+                    originalStream,
+                    contentLength,
+                    verifyData,
+                    txId,
+                    emitter,
+                });
+                // read the stream
+                try {
+                    const out = [];
+                    for await (const chunk of tapped) {
+                        out.push(chunk);
+                    }
+                }
+                catch (error) {
+                    node_assert_1.default.ok(events.find((e) => e.type === 'verification-failed' && e.txId === txId), 'Should emit at least one verification-failed');
+                }
+            });
+        });
+    });
 });

package/lib/cjs/types/wayfinder.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// TODO: add an offset provider that returns offsets for data items so we can use them to verify the signatures of a data item within a bundle

package/lib/cjs/utils/hash.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashBufferToB64Url = exports.hashReadableStreamToB64Url = exports.hashReadableToB64Url = void 0;
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const crypto_1 = require("crypto");
+const base64_js_1 = require("./base64.js");
+const hashReadableToB64Url = (stream, algorithm = 'sha256') => {
+    return new Promise((resolve, reject) => {
+        const hash = (0, crypto_1.createHash)(algorithm);
+        stream.on('data', (chunk) => hash.update(chunk));
+        stream.on('end', () => resolve((0, base64_js_1.toB64Url)(hash.digest())));
+        stream.on('error', (err) => reject(err));
+    });
+};
+exports.hashReadableToB64Url = hashReadableToB64Url;
+const hashReadableStreamToB64Url = (stream, algorithm = 'sha256') => {
+    return new Promise((resolve, reject) => {
+        const hash = (0, crypto_1.createHash)(algorithm);
+        const reader = stream.getReader();
+        const read = async () => {
+            try {
+                const { done, value } = await reader.read();
+                if (done) {
+                    resolve((0, base64_js_1.toB64Url)(hash.digest()));
+                }
+                else {
+                    hash.update(value);
+                    read();
+                }
+            }
+            catch (err) {
+                reject(err);
+            }
+        };
+        read().catch(reject);
+    });
+};
+exports.hashReadableStreamToB64Url = hashReadableStreamToB64Url;
+const hashBufferToB64Url = (buffer, algorithm = 'sha256') => {
+    return (0, base64_js_1.toB64Url)((0, crypto_1.createHash)(algorithm).update(buffer).digest());
+};
+exports.hashBufferToB64Url = hashBufferToB64Url;

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.11.0-alpha.7';
+exports.version = '3.11.0-alpha.9';