@attocash/n8n-nodes-atto 0.3.2 → 0.4.0

package/README.md

@@ -83,6 +83,8 @@ Trigger events:
 - **Transaction**: watches by hash, address stream, or all supported transactions.
 - **Account Entry**: watches by hash, address stream, or all supported account entries.
 
+Triggers stay connected to the selected Atto NDJSON endpoint. If a stream closes, the node reconnects with exponential backoff from 1 to 30 seconds; a received event resets the delay.
+
 ## Example Workflows
 
 Importable examples live in [`examples`](./examples):

package/THIRD_PARTY_NOTICES.md

@@ -31,6 +31,38 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+## js-joda
+
+`@js-joda/core` is licensed under the BSD 3-Clause License.
+
+Copyright (c) 2016, Philipp Thürwächter & Pattrick Hüper
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of js-joda nor the names of its contributors may be used
+   to endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
 ## Noble Hashes
 
 `@noble/hashes` is licensed under the MIT License.

package/dist/nodes/Atto/Atto.node.js

@@ -7,12 +7,12 @@ const SECRET_PARAMETER_NAMES = ['secretSource', 'walletSecretType', 'walletSecre
 const OPERATION_PARAMETER_NAMES = {
     deriveAddress: SECRET_PARAMETER_NAMES,
     deriveAccount: SECRET_PARAMETER_NAMES,
-    getAccount: ['address', 'simplify'],
-    getReceivables: ['addressSource', 'addresses', 'minAmount', 'minAmountUnit', 'maxItems', 'timeoutMs', 'simplify'],
-    getTransactions: ['queryMode', 'addresses', 'hash', 'fromHeight', 'toHeight', 'maxItems', 'timeoutMs', 'simplify'],
+    getAccount: ['address'],
+    getReceivables: ['addressSource', 'addresses', 'minAmount', 'minAmountUnit', 'maxItems', 'timeoutMs'],
+    getTransactions: ['queryMode', 'addresses', 'hash', 'fromHeight', 'toHeight', 'maxItems', 'timeoutMs'],
     sendTransaction: [...SECRET_PARAMETER_NAMES, 'destinationAddress', 'amount', 'amountUnit', 'timeoutMs'],
     receivePending: [...SECRET_PARAMETER_NAMES, 'representativeAddress', 'timeoutMs'],
-    getAccountEntries: ['queryMode', 'addresses', 'hash', 'fromHeight', 'toHeight', 'maxItems', 'timeoutMs', 'simplify'],
+    getAccountEntries: ['queryMode', 'addresses', 'hash', 'fromHeight', 'toHeight', 'maxItems', 'timeoutMs'],
     changeRepresentative: [...SECRET_PARAMETER_NAMES, 'representativeAddress'],
 };
 const DEFAULT_OPERATION_BY_RESOURCE = {
@@ -51,7 +51,6 @@ const DEFAULT_PARAMETER_VALUES = {
     representativeAddress: '',
     timeoutMs: 5000,
     maxItems: 25,
-    simplify: true,
 };
 const AMOUNT_UNITS = [
     {
@@ -553,18 +552,6 @@ class Atto {
                 },
                 description: 'New representative address',
             },
-            {
-                displayName: 'Simplify',
-                name: 'simplify',
-                type: 'boolean',
-                default: true,
-                displayOptions: {
-                    show: {
-                        operation: ['getAccount', 'getReceivables', 'getTransactions', 'getAccountEntries'],
-                    },
-                },
-                description: 'Whether to return a compact set of commonly used fields instead of the complete Atto API response',
-            },
             {
                 displayName: 'Max Items',
                 name: 'maxItems',

package/dist/nodes/Atto/operations.js

@@ -1,14 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeAttoOperation = executeAttoOperation;
-exports.pollAttoEvent = pollAttoEvent;
+exports.attoStreamRequest = attoStreamRequest;
+exports.attoHttpStreamRequest = attoHttpStreamRequest;
+exports.startAttoEventStream = startAttoEventStream;
 const n8n_workflow_1 = require("n8n-workflow");
 const protocol_1 = require("./protocol");
 const DEFAULT_STREAM_TIMEOUT_MS = 5000;
 const DEFAULT_PUBLISH_TIMEOUT_MS = 60000;
-const POLL_MAX_ITEMS = 100;
-const POLL_TIMEOUT_MS = 2000;
-const MAX_SEEN_POLL_ITEMS = 500;
+const INITIAL_RECONNECT_DELAY_MS = 1000;
+const MAX_RECONNECT_DELAY_MS = 30000;
+function scheduleTimeout(callback, delayMs) {
+    const controller = new AbortController();
+    const timeout = AbortSignal.timeout(delayMs);
+    const onTimeout = () => {
+        if (!controller.signal.aborted)
+            callback();
+    };
+    timeout.addEventListener('abort', onTimeout, { once: true });
+    controller.signal.addEventListener('abort', () => timeout.removeEventListener('abort', onTimeout), { once: true });
+    return controller;
+}
+const DEFAULT_STREAM_RUNTIME = {
+    open: openAttoEventStream,
+    setTimeout: scheduleTimeout,
+    clearTimeout: (timer) => timer.abort(),
+};
 function credentials(value) {
     return (value ?? {});
 }
@@ -39,13 +56,14 @@ function positiveHeight(value, fieldName) {
         throw new Error(`${fieldName} must be a positive integer`);
     return valueText;
 }
-function simplifyOutput(parameters) {
-    return parameters.simplify !== false;
-}
 function requireNodeUrl(value) {
     const url = text(value.nodeUrl);
     if (!url)
         throw new Error('Atto credentials must include a Node Base URL');
+    const parsed = URL.canParse(url) ? new URL(url) : undefined;
+    if (!parsed || (parsed.protocol !== 'http:' && parsed.protocol !== 'https:')) {
+        throw new Error('Atto credentials must include a valid HTTP Node Base URL');
+    }
     return url.replace(/\/+$/, '');
 }
 function requireWorkerUrl(value) {
@@ -189,6 +207,24 @@ async function requestStream(context, value, request) {
         throw apiError(context, error, `Atto API stream failed: ${request.method} /${request.path}`);
     }
 }
+async function openAttoEventStream(context, value, request, signal) {
+    const response = await context.helpers.httpRequest({
+        url: `${requireNodeUrl(value)}/${request.path}`,
+        method: request.method,
+        headers: {
+            ...requestHeaders(value, 'application/x-ndjson'),
+            ...(request.body ? { 'Content-Type': 'application/json' } : {}),
+        },
+        encoding: 'stream',
+        json: false,
+        abortSignal: signal,
+        ...(request.body ? { body: (0, protocol_1.stringifyAttoJson)(request.body) } : {}),
+    });
+    if (!response || typeof response !== 'object' || !(Symbol.asyncIterator in response)) {
+        throw new Error('Atto stream response is not readable');
+    }
+    return response;
+}
 function contextRequired(context) {
     if (!context)
         throw new Error('This Atto operation requires an n8n execution context');
@@ -410,7 +446,6 @@ async function receivableFromInput(context, value, parameters) {
 }
 async function executeAttoOperation(context, operation, parameters, credentialData) {
     const value = credentials(credentialData);
-    const simplify = simplifyOutput(parameters);
     if (operation === 'deriveAddress' || operation === 'deriveAccount') {
         const derived = await (0, protocol_1.deriveAddressFromSecret)(parameters, value);
         return { address: derived.value, publicKey: derived.publicKey, keyIndex: derived.keyIndex, secretType: derived.secretType };
@@ -419,21 +454,21 @@ async function executeAttoOperation(context, operation, parameters, credentialDa
     if (operation === 'getAccount') {
         const address = (0, protocol_1.parseAddress)(parameters.address ?? parameters.lookupAddress);
         const account = await accountByAddress(execution, value, address);
-        return account ? (0, protocol_1.accountOutput)(account, simplify) : { found: false, address: address.value };
+        return account ? (0, protocol_1.accountOutput)(account) : { found: false, address: address.value };
     }
     if (operation === 'getReceivables') {
-        return (await requestStream(execution, value, await receivableStreamRequest(parameters, value))).map((item) => (0, protocol_1.receivableOutput)(item, simplify));
+        return (await requestStream(execution, value, await receivableStreamRequest(parameters, value))).map((item) => (0, protocol_1.receivableOutput)(item));
     }
     if (operation === 'getTransactions') {
         if (queryMode(parameters.queryMode) === 'hash') {
             const hash = (0, protocol_1.parseHash)(parameters.hash);
             const transaction = (await requestJson(execution, value, requireNodeUrl(value), 'GET', `transactions/${hash}`));
-            return [(0, protocol_1.transactionOutput)(transaction, simplify)];
+            return [(0, protocol_1.transactionOutput)(transaction)];
         }
-        return (await requestStream(execution, value, await transactionStreamRequest(parameters, value))).map((item) => (0, protocol_1.transactionOutput)(item, simplify));
+        return (await requestStream(execution, value, await transactionStreamRequest(parameters, value))).map((item) => (0, protocol_1.transactionOutput)(item));
     }
     if (operation === 'getAccountEntries') {
-        return (await requestStream(execution, value, await accountEntryStreamRequest(parameters, value))).map((item) => (0, protocol_1.accountEntryOutput)(item, simplify));
+        return (await requestStream(execution, value, await accountEntryStreamRequest(parameters, value))).map((item) => (0, protocol_1.accountEntryOutput)(item));
     }
     const derived = await (0, protocol_1.deriveAddressFromSecret)(parameters, value);
     const account = await accountByAddress(execution, value, derived);
@@ -447,7 +482,7 @@ async function executeAttoOperation(context, operation, parameters, credentialDa
         const block = (0, protocol_1.createSendBlock)(account, destination, amount, timestamp);
         const transaction = await publishBlock(execution, value, block, derived.signer, timeoutMs);
         return {
-            ...(0, protocol_1.transactionOutput)(transaction, true, 'published'),
+            ...(0, protocol_1.transactionOutput)(transaction, 'published'),
             fromAddress: derived.value,
             destinationAddress: destination.value,
             amount: (0, protocol_1.amountOutput)(amount),
@@ -464,7 +499,7 @@ async function executeAttoOperation(context, operation, parameters, credentialDa
         const block = (0, protocol_1.createReceiveBlock)(account, receivable, representative, timestamp);
         const transaction = await publishBlock(execution, value, block, derived.signer, timeoutMs);
         return {
-            ...(0, protocol_1.transactionOutput)(transaction, true, 'received'),
+            ...(0, protocol_1.transactionOutput)(transaction, 'received'),
             address: derived.value,
             representativeAddress: representative.value,
             amount: (0, protocol_1.amountOutput)(receivable.amount),
@@ -477,66 +512,234 @@ async function executeAttoOperation(context, operation, parameters, credentialDa
         const block = (0, protocol_1.createChangeBlock)(account, representative, timestamp);
         const transaction = await publishBlock(execution, value, block, derived.signer, timeoutMs);
         return {
-            ...(0, protocol_1.transactionOutput)(transaction, true, 'representative_changed'),
+            ...(0, protocol_1.transactionOutput)(transaction, 'representative_changed'),
             address: derived.value,
             representativeAddress: representative.value,
         };
     }
     throw new Error(`Unsupported Atto operation: ${operation}`);
 }
-async function pollAccounts(context, parameters, value) {
-    const addresses = await addressesForSource(parameters, value, true);
-    if (addresses?.length === 1) {
-        const account = await accountByAddress(context, value, addresses[0]);
-        return account ? [(0, protocol_1.accountOutput)(account, true)] : [];
-    }
-    return (await requestStream(context, value, {
-        method: addresses ? 'POST' : 'GET',
-        path: 'accounts/stream',
-        ...(addresses ? { body: { addresses: addresses.map((address) => address.value) } } : {}),
-        maxItems: POLL_MAX_ITEMS,
-        timeoutMs: POLL_TIMEOUT_MS,
-    })).map((item) => (0, protocol_1.accountOutput)(item, true));
-}
-function pollItemKey(event, item) {
-    if (event === 'account')
-        return `${String(item.address)}:${String(item.frontier)}:${String(item.balance?.raw ?? '')}`;
-    return String(item.hash ?? JSON.stringify(item));
-}
-function newPollItems(context, event, items) {
-    const staticData = context.getWorkflowStaticData('node');
-    const stateKey = `seen_${event}`;
-    const existing = Array.isArray(staticData[stateKey]) ? staticData[stateKey].map(String) : [];
-    const seen = new Set(existing);
-    const fresh = items.filter((item) => !seen.has(pollItemKey(event, item)));
-    const updated = [...existing, ...items.map((item) => pollItemKey(event, item))].slice(-MAX_SEEN_POLL_ITEMS);
-    staticData[stateKey] = updated;
-    if (existing.length === 0 && context.getMode() !== 'manual')
-        return [];
-    return fresh;
-}
-async function pollAttoEvent(context, event, parameters, credentialData) {
+function addressStreamRoute(event, addresses) {
+    if (!addresses)
+        return { event, route: 'all' };
+    return {
+        event,
+        route: addresses.length === 1 ? 'publicKey' : 'addresses',
+        addresses,
+    };
+}
+async function attoStreamRequest(event, parameters, credentialData) {
     const value = credentials(credentialData);
-    let items;
     if (event === 'receivable') {
-        items = (await requestStream(context, value, await receivableStreamRequest(parameters, value, POLL_MAX_ITEMS, POLL_TIMEOUT_MS))).map((item) => (0, protocol_1.receivableOutput)(item, true));
+        const request = addressStreamRoute(event, await addressesForSource(parameters, value));
+        return {
+            ...request,
+            minAmount: optionalText(parameters.minAmount)
+                ? (0, protocol_1.parseAmount)(parameters.minAmount, parameters.minAmountUnit ?? 'RAW', 'Minimum Amount').toString()
+                : '0',
+        };
     }
-    else if (event === 'account') {
-        items = await pollAccounts(context, parameters, value);
+    if (event === 'account') {
+        return addressStreamRoute(event, await addressesForSource(parameters, value, true));
     }
-    else if (event === 'transaction') {
-        const mode = queryMode(parameters.queryMode);
-        if (mode === 'hash') {
-            const transaction = (await requestJson(context, value, requireNodeUrl(value), 'GET', `transactions/${(0, protocol_1.parseHash)(parameters.hash)}`));
-            items = [(0, protocol_1.transactionOutput)(transaction, true)];
+    const mode = queryMode(parameters.queryMode);
+    if (mode === 'hash') {
+        return {
+            event,
+            route: 'hash',
+            hash: (0, protocol_1.parseHash)(parameters.hash),
+        };
+    }
+    const request = addressStreamRoute(event, await addressesForQuery(parameters, value));
+    if (request.route === 'all')
+        return request;
+    return {
+        ...request,
+        fromHeight: positiveHeight(parameters.fromHeight, 'From Height') ?? '1',
+        toHeight: positiveHeight(parameters.toHeight, 'To Height'),
+    };
+}
+function requiredStreamAddresses(request) {
+    const addresses = request.addresses ?? [];
+    if (addresses.length === 0)
+        throw new Error('Atto stream route requires at least one address');
+    return addresses;
+}
+function streamHeightQuery(request) {
+    const fromHeight = request.fromHeight ?? '1';
+    return `fromHeight=${encodeURIComponent(fromHeight)}${request.toHeight ? `&toHeight=${encodeURIComponent(request.toHeight)}` : ''}`;
+}
+function streamHeightSearch(request) {
+    return {
+        search: requiredStreamAddresses(request).map((address) => ({
+            address: address.value,
+            fromHeight: request.fromHeight ?? '1',
+            ...(request.toHeight ? { toHeight: request.toHeight } : {}),
+        })),
+    };
+}
+function attoHttpStreamRequest(request) {
+    if (request.event === 'account') {
+        if (request.route === 'all')
+            return { method: 'GET', path: 'accounts/stream' };
+        const addresses = requiredStreamAddresses(request);
+        if (request.route === 'publicKey') {
+            return { method: 'GET', path: `accounts/${addresses[0].publicKey}/stream` };
         }
-        else {
-            items = (await requestStream(context, value, await transactionStreamRequest(parameters, value, POLL_MAX_ITEMS, POLL_TIMEOUT_MS))).map((item) => (0, protocol_1.transactionOutput)(item, true));
+        if (request.route === 'addresses') {
+            return {
+                method: 'POST',
+                path: 'accounts/stream',
+                body: { addresses: addresses.map((address) => address.value) },
+            };
         }
     }
-    else {
-        items = (await requestStream(context, value, await accountEntryStreamRequest(parameters, value, POLL_MAX_ITEMS, POLL_TIMEOUT_MS))).map((item) => (0, protocol_1.accountEntryOutput)(item, true));
+    if (request.event === 'receivable') {
+        const addresses = requiredStreamAddresses(request);
+        const path = `accounts/receivables/stream?minAmount=${encodeURIComponent(request.minAmount ?? '0')}`;
+        if (request.route === 'publicKey') {
+            return {
+                method: 'GET',
+                path: `accounts/${addresses[0].publicKey}/receivables/stream?minAmount=${encodeURIComponent(request.minAmount ?? '0')}`,
+            };
+        }
+        if (request.route === 'addresses') {
+            return {
+                method: 'POST',
+                path,
+                body: { addresses: addresses.map((address) => address.value) },
+            };
+        }
+    }
+    if (request.event === 'transaction') {
+        if (request.route === 'all')
+            return { method: 'GET', path: 'transactions/stream' };
+        if (request.route === 'hash' && request.hash) {
+            return { method: 'GET', path: `transactions/${request.hash}/stream` };
+        }
+        const addresses = requiredStreamAddresses(request);
+        if (request.route === 'publicKey') {
+            return {
+                method: 'GET',
+                path: `accounts/${addresses[0].publicKey}/transactions/stream?${streamHeightQuery(request)}`,
+            };
+        }
+        if (request.route === 'addresses') {
+            return {
+                method: 'POST',
+                path: 'accounts/transactions/stream',
+                body: streamHeightSearch(request),
+            };
+        }
+    }
+    if (request.event === 'accountEntry') {
+        if (request.route === 'all')
+            return { method: 'GET', path: 'accounts/entries/stream' };
+        if (request.route === 'hash' && request.hash) {
+            return { method: 'GET', path: `accounts/entries/${request.hash}/stream` };
+        }
+        const addresses = requiredStreamAddresses(request);
+        if (request.route === 'publicKey') {
+            return {
+                method: 'GET',
+                path: `accounts/${addresses[0].publicKey}/entries/stream?${streamHeightQuery(request)}`,
+            };
+        }
+        if (request.route === 'addresses') {
+            return {
+                method: 'POST',
+                path: 'accounts/entries/stream',
+                body: streamHeightSearch(request),
+            };
+        }
     }
-    return newPollItems(context, event, items);
+    throw new Error(`Unsupported Atto ${request.event} stream route: ${request.route}`);
+}
+async function startAttoEventStream(context, event, parameters, credentialData, onEvent, runtime = DEFAULT_STREAM_RUNTIME) {
+    const value = credentials(credentialData);
+    requireNodeUrl(value);
+    requestHeaders(value, 'application/x-ndjson');
+    const request = attoHttpStreamRequest(await attoStreamRequest(event, parameters, credentialData));
+    let activeController;
+    let activeConnection;
+    let reconnectTimer;
+    let reconnectDelayMs = INITIAL_RECONNECT_DELAY_MS;
+    let generation = 0;
+    let closed = false;
+    const scheduleReconnect = () => {
+        if (closed || activeController || reconnectTimer !== undefined)
+            return;
+        const delayMs = reconnectDelayMs;
+        reconnectDelayMs = Math.min(reconnectDelayMs * 2, MAX_RECONNECT_DELAY_MS);
+        reconnectTimer = runtime.setTimeout(() => {
+            reconnectTimer = undefined;
+            connect();
+        }, delayMs);
+    };
+    const connect = () => {
+        if (closed || activeController)
+            return;
+        const streamGeneration = ++generation;
+        const controller = new AbortController();
+        activeController = controller;
+        activeConnection = (async () => {
+            try {
+                const response = await runtime.open(context, value, request, controller.signal);
+                let pending = '';
+                for await (const chunk of response) {
+                    if (closed || streamGeneration !== generation)
+                        return;
+                    pending += streamChunk(chunk);
+                    const lines = pending.split('\n');
+                    pending = lines.pop() ?? '';
+                    for (const line of lines) {
+                        if (!line.trim())
+                            continue;
+                        const parsed = (0, protocol_1.parseAttoJson)(line);
+                        if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
+                            throw new Error(`Atto ${event} stream item must contain a JSON object`);
+                        }
+                        onEvent((0, protocol_1.streamEventOutput)(event, parsed));
+                        reconnectDelayMs = INITIAL_RECONNECT_DELAY_MS;
+                    }
+                }
+                if (pending.trim() && !closed && streamGeneration === generation) {
+                    const parsed = (0, protocol_1.parseAttoJson)(pending);
+                    if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
+                        throw new Error(`Atto ${event} stream item must contain a JSON object`);
+                    }
+                    onEvent((0, protocol_1.streamEventOutput)(event, parsed));
+                    reconnectDelayMs = INITIAL_RECONNECT_DELAY_MS;
+                }
+            }
+            catch {
+            }
+            finally {
+                if (streamGeneration === generation) {
+                    activeController = undefined;
+                    activeConnection = undefined;
+                    scheduleReconnect();
+                }
+            }
+        })();
+    };
+    connect();
+    return {
+        async close() {
+            if (closed)
+                return;
+            closed = true;
+            generation++;
+            if (reconnectTimer !== undefined) {
+                runtime.clearTimeout(reconnectTimer);
+                reconnectTimer = undefined;
+            }
+            const connection = activeConnection;
+            activeController?.abort();
+            activeController = undefined;
+            activeConnection = undefined;
+            await connection;
+        },
+    };
 }
 //# sourceMappingURL=operations.js.map