@bevanamit/n8n-nodes-blockfrost 1.0.0

package/LICENSE

@@ -0,0 +1,160 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+[... rest of the GPL-3.0 license text ...]
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    n8n-nodes-blockfrost - Custom n8n node for interacting with the Cardano blockchain via the Blockfrost API
+    Copyright (C) 2025  Amit Bevinakatti
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.

package/README.md

@@ -0,0 +1,182 @@
+## Screenshots
+
+### Blockfrost Credential Selection
+![Blockfrost Credential Selection](assets/blockfrost-credential-selection.jpg)
+
+### Blockfrost Credential Configuration
+![Blockfrost Credential Configuration](assets/blockfrost-credential-saving.jpg)
+
+### Blockfrost Node Selection in Workflow
+![Blockfrost Node Selection](assets/blockfrost-workflow-node-selection.jpg)
+
+### Blockfrost Node Configuration Details
+![Blockfrost Node Details](assets/blockfrost-node-details.jpg)
+
+## Demo Video
+
+[![Watch the demo on YouTube](https://img.youtube.com/vi/fVEHHZigBes/0.jpg)](https://youtu.be/fVEHHZigBes)
+# n8n-nodes-blockfrost
+
+This is a custom n8n node for interacting with the [Cardano blockchain](https://cardano.org) via the [Blockfrost API](https://blockfrost.io).
+
+## Features
+
+**🎯 Comprehensive Cardano Blockchain Integration**
+- **75+ endpoints** covering all major Cardano operations
+- **Complete API coverage** following Blockfrost OpenAPI v0.1.78
+
+**📊 Available Categories:**
+- **Health & Metrics** - API status and usage monitoring
+- **Accounts** - Stake account information, rewards, history, delegations
+- **Addresses** - Address details, UTXOs, transactions
+- **Assets** - Native tokens, NFTs, asset history and transactions
+- **Blocks** - Block information, transactions, addresses affected
+- **Epochs** - Epoch details, stake distribution, protocol parameters
+- **Governance** - DReps, proposals, votes, governance metadata
+- **Ledger** - Blockchain genesis information
+- **Mempool** - Current pending transactions
+- **Metadata** - Transaction metadata in JSON and CBOR formats
+- **Network** - Network statistics and era information
+- **Pools** - Stake pool data, delegators, performance, votes
+- **Scripts** - Smart contracts, Plutus scripts, redeemers, datums
+- **Transactions** - Full transaction details, UTXOs, certificates, submission
+- **Utilities** - Address derivation, transaction evaluation
+
+**🔧 Advanced Features:**
+- Work with NFTs and native tokens
+- Submit transactions to the blockchain
+- Query smart contract data and redeemers
+- Access governance information (DReps, proposals)
+- Monitor stake pool performance and delegations
+- Evaluate transaction execution costs
+- Support for all Cardano networks (mainnet, preprod, preview)
+
+## Installation
+
+### Option 1: Community Node (via npm)
+
+1. Open your n8n instance
+2. Go to **Settings** > **Community Nodes**
+3. Click **Install**
+4. Enter `n8n-nodes-blockfrost` and click **Install**
+
+### Option 2: Manual Installation
+
+1. Navigate to your n8n custom directory: `~/.n8n/custom/`
+2. Clone this repository: `git clone https://github.com/bevanamit/n8n-nodes-blockfrost.git`
+3. Install dependencies: `cd n8n-nodes-blockfrost && npm install`
+4. Build the project: `npm run build`
+5. Restart n8n
+
+### Option 3: Fail-Safe Installation (if npm install does not work as expected)
+
+If running `npm install n8n-nodes-blockfrost` in your `~/.n8n/custom/` directory does not install the package correctly, try the following steps:
+
+1. Open a terminal and navigate to your n8n custom directory:
+   ```
+   cd ~/.n8n/custom
+   ```
+2. Initialize a package.json if it does not exist:
+   ```
+   npm init -y
+   ```
+3. Install the package:
+   ```
+   npm install n8n-nodes-blockfrost
+   ```
+4. Restart n8n completely (stop and start the process).
+
+This ensures the package and its dependencies are installed correctly and n8n can load the custom node.
+
+## Prerequisites
+
+- [n8n](https://n8n.io/) (version 0.209.0 or newer)
+- A [Blockfrost](https://blockfrost.io) account and project API key
+
+## Credentials
+
+To use this node, you need to set up Blockfrost API credentials:
+
+1. Sign up for a free account on [Blockfrost.io](https://blockfrost.io)
+2. Create a project and get your API key
+3. In n8n, create a new credential of type **Blockfrost API**
+4. Enter your **Project ID** (API key)
+5. Select the appropriate **Network** (mainnet, preprod, preview)
+
+## Usage
+
+1. Add the **Blockfrost** node to your workflow
+2. Select a **Category** (e.g., Accounts, Addresses, Assets, etc.)
+3. Choose an **Operation** specific to that category
+4. Fill in the required parameters
+5. Connect the node to other nodes in your workflow
+
+## Example Workflows
+
+### 1. Monitor Cardano Address Balance
+
+Create a workflow that periodically checks a Cardano address balance and sends notifications when changes occur.
+
+### 2. Track NFT Ownership
+
+Monitor ownership changes of specific NFTs on the Cardano blockchain.
+
+### 3. Analyze Transaction History
+
+Pull transaction data for analysis or reporting purposes.
+
+## Development
+
+If you want to contribute to this node:
+
+1. Clone the repository
+2. Install dependencies: `npm install`
+3. Build the code: `npm run build`
+4. Link to your local n8n: `npm link`
+5. In your n8n installation directory: `npm link n8n-nodes-blockfrost`
+
+## Blockfrost Account Setup
+
+To use this node, you'll need a Blockfrost account and Project ID. Follow these steps to set one up:
+
+1. **Create an Account**:
+   - Visit [blockfrost.io](https://blockfrost.io/)
+   - Click the "Sign Up" button
+   - Complete the registration form
+
+2. **Create a Project**:
+   - After signing in, navigate to the Dashboard
+   - Click "Create Project"
+   - Enter a project name (e.g., "n8n Integration")
+   - Select the network:
+     - **Cardano Mainnet**: For production use
+     - **Cardano Preprod**: For testing on the preprod testnet
+     - **Cardano Preview**: For testing on the preview testnet
+
+3. **Get Your Project ID**:
+   - After creating your project, you'll be shown your Project ID
+   - This ID will look something like `mainnet1a2b3c4d5e6f7g8h9i0j`
+   - Copy this ID to use in your n8n Blockfrost node credentials
+
+4. **Free Tier Information**:
+   - Blockfrost offers a free tier with 50,000 requests per day
+   - This is sufficient for many use cases and development
+   - Paid plans are available if you need higher limits
+
+5. **Security Note**:
+   - Treat your Project ID as a secret key
+   - Don't commit it to public repositories
+   - Consider using n8n's credential encryption feature
+
+## License
+
+This project is licensed under the [GNU General Public License v3.0](LICENSE) - see the [LICENSE](LICENSE) file for details.
+
+This is free software, and you are welcome to redistribute it under certain conditions.
+## Support & Donations
+
+I am not Catalyst funded. Any support you provide is greatly appreciated!
+
+**Cardano (ADA) donation address:**
+
+`addr1qyxypmc96e3pska6ch2ucq4uv5d7uz6nhpgcne4ea4hgmemv40lpm3wmc3wqk5arjpgzrccm0m9k72puaqzwsgrj47asch66sp`

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import BlockfrostNode from './nodes/Blockfrost/Blockfrost.node';
+import BlockfrostCredentials from './nodes/Blockfrost/Blockfrost.credentials';
+export { BlockfrostNode as Blockfrost, BlockfrostCredentials, };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,cAAc,MAAM,oCAAoC,CAAC;AAChE,OAAO,qBAAqB,MAAM,2CAA2C,CAAC;AAE9E,OAAO,EACL,cAAc,IAAI,UAAU,EAC5B,qBAAqB,GACtB,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockfrostCredentials = exports.Blockfrost = void 0;
+const Blockfrost_node_1 = __importDefault(require("./nodes/Blockfrost/Blockfrost.node"));
+exports.Blockfrost = Blockfrost_node_1.default;
+const Blockfrost_credentials_1 = __importDefault(require("./nodes/Blockfrost/Blockfrost.credentials"));
+exports.BlockfrostCredentials = Blockfrost_credentials_1.default;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAIA,yFAAgE;AAI5C,qBAJb,yBAAc,CAIS;AAH9B,uGAA8E;AAI5E,gCAJK,gCAAqB,CAIL"}

package/dist/nodes/Blockfrost/Blockfrost.credentials.d.ts

@@ -0,0 +1,28 @@
+import { ICredentialType } from 'n8n-workflow';
+export declare class Blockfrost implements ICredentialType {
+    name: string;
+    displayName: string;
+    icon: "file:blockfrost-credential.svg";
+    properties: ({
+        displayName: string;
+        name: string;
+        type: "string";
+        required: boolean;
+        default: string;
+        description: string;
+        options?: never;
+    } | {
+        displayName: string;
+        name: string;
+        type: "options";
+        options: {
+            name: string;
+            value: string;
+        }[];
+        default: string;
+        required: boolean;
+        description: string;
+    })[];
+}
+export default Blockfrost;
+//# sourceMappingURL=Blockfrost.credentials.d.ts.map

package/dist/nodes/Blockfrost/Blockfrost.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Blockfrost.credentials.d.ts","sourceRoot":"","sources":["../../../src/nodes/Blockfrost/Blockfrost.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,qBAAa,UAAW,YAAW,eAAe;IAChD,IAAI,SAAmB;IACvB,WAAW,SAAoB;IAC/B,IAAI,EAAG,gCAAgC,CAAU;IACjD,UAAU;;;;;;;;;;;;;;;;;;;SAsBR;CACH;AAED,eAAe,UAAU,CAAC"}

package/dist/nodes/Blockfrost/Blockfrost.credentials.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Blockfrost = void 0;
+class Blockfrost {
+    constructor() {
+        this.name = 'blockfrostApi';
+        this.displayName = 'Blockfrost API';
+        this.icon = 'file:blockfrost-credential.svg';
+        this.properties = [
+            {
+                displayName: 'Project ID',
+                name: 'projectId',
+                type: 'string',
+                required: true,
+                default: '',
+                description: 'Your Blockfrost Project ID from https://blockfrost.io',
+            },
+            {
+                displayName: 'Network',
+                name: 'network',
+                type: 'options',
+                options: [
+                    { name: 'Mainnet', value: 'mainnet' },
+                    { name: 'Preprod', value: 'preprod' },
+                    { name: 'Preview', value: 'preview' },
+                ],
+                default: 'mainnet',
+                required: true,
+                description: 'The Cardano network to connect to',
+            },
+        ];
+    }
+}
+exports.Blockfrost = Blockfrost;
+exports.default = Blockfrost;
+//# sourceMappingURL=Blockfrost.credentials.js.map

package/dist/nodes/Blockfrost/Blockfrost.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Blockfrost.credentials.js","sourceRoot":"","sources":["../../../src/nodes/Blockfrost/Blockfrost.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IAAvB;QACE,SAAI,GAAG,eAAe,CAAC;QACvB,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,SAAI,GAAG,gCAAyC,CAAC;QACjD,eAAU,GAAG;YACX;gBACE,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAiB;gBACvB,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,uDAAuD;aACrE;YACD;gBACE,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAkB;gBACxB,OAAO,EAAE;oBACP,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;oBACrC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;oBACrC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;iBACtC;gBACD,OAAO,EAAE,SAAS;gBAClB,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,mCAAmC;aACjD;SACF,CAAC;IACJ,CAAC;CAAA;AA3BD,gCA2BC;AAED,kBAAe,UAAU,CAAC"}

package/dist/nodes/Blockfrost/Blockfrost.node.d.ts

@@ -0,0 +1,7 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Blockfrost implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+export default Blockfrost;
+//# sourceMappingURL=Blockfrost.node.d.ts.map

package/dist/nodes/Blockfrost/Blockfrost.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Blockfrost.node.d.ts","sourceRoot":"","sources":["../../../src/nodes/Blockfrost/Blockfrost.node.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EAErB,MAAM,cAAc,CAAC;AAItB,qBAAa,UAAW,YAAW,SAAS;IAC1C,WAAW,EAAE,oBAAoB,CAs7B/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAq/BxE;AAED,eAAe,UAAU,CAAC"}