Add Event resource and update branding

- Add Event resource with get and getAll operations - Implement event tracking for Strike API events - Update node icon from strike.svg to strike.png - Add comprehensive README.md with disclaimer about AI-assisted development - Update CLAUDE.MD documentation with Event resource details - Build dist files with new Event operations Changes include: - New EventDescription.ts with event operations - Updated Strike.node.ts to handle event resource - Icon changed to PNG format for better compatibility - Production-ready README with usage examples and warnings 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-10 11:23:37 +01:00
parent 5605b9b49a
commit 7e99c8fee7
11 changed files with 521 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,209 @@
+# n8n-nodes-strike
+
+![Strike Logo](https://strike.me/assets/images/logo.png)
+
+This is an n8n community node for integrating with the [Strike API](https://strike.me), enabling Bitcoin and Lightning Network payment operations within your n8n workflows.
+
+## ⚠️ Important Disclaimer
+
+**This node has been AI-assisted ("vibe coded") and is not fully tested in production environments. Use at your own risk.**
+
+- This package is provided "as-is" without any warranties or guarantees
+- Not all API endpoints have been thoroughly tested
+- Error handling may not cover all edge cases
+- Always test thoroughly in a sandbox/development environment before using in production
+- The maintainer is not responsible for any financial losses or issues arising from the use of this node
+
+## Installation
+
+### Community Nodes (Recommended)
+
+1. Open n8n
+2. Go to **Settings** → **Community Nodes**
+3. Click **Install a community node**
+4. Enter: `n8n-nodes-strike`
+5. Click **Install**
+
+### Manual Installation
+
+```bash
+npm install n8n-nodes-strike
+```
+
+## Prerequisites
+
+- n8n installed (version 0.200.0 or higher recommended)
+- A Strike account ([sign up here](https://strike.me))
+- Strike API key (obtain from your [Strike Dashboard](https://dashboard.strike.me))
+
+## Configuration
+
+### Strike API Credentials
+
+1. In n8n, create a new **Strike API** credential
+2. Enter your **API Key** from the Strike Dashboard
+3. Select the **Environment**:
+   - **Production**: For live transactions
+   - **Sandbox**: For testing (recommended for initial setup)
+
+## Supported Resources & Operations
+
+### Account
+- **Get Profile**: Retrieve account profile by account ID
+- **Get Profile by Handle**: Retrieve account profile by Strike handle
+- **Get Limits**: Retrieve account limits
+
+### Balance
+- **Get**: Retrieve current account balances
+
+### Currency Exchange
+- **Create Quote**: Create a currency exchange quote
+- **Get Quote**: Retrieve a currency exchange quote
+- **Execute Quote**: Execute a currency exchange quote
+
+### Deposit
+- **Create**: Create a deposit
+- **Get**: Retrieve a deposit by ID
+- **Get Many**: Retrieve multiple deposits with filtering
+- **Estimate Fee**: Estimate deposit fee
+
+### Event
+- **Get**: Retrieve an event by ID
+- **Get Many**: Retrieve multiple events with filtering
+
+### Invoice
+- **Create**: Create a new invoice
+- **Get**: Retrieve an invoice by ID
+- **Get Many**: Retrieve multiple invoices with filtering
+- **Create Quote**: Generate a quote for an invoice
+- **Cancel**: Cancel an unpaid invoice
+
+### Payment
+- **Get**: Retrieve a payment by ID
+- **Create Lightning Quote**: Create a Lightning Network payment quote
+- **Create Onchain Quote**: Create an on-chain Bitcoin payment quote
+- **Create LNURL Quote**: Create a LNURL payment quote
+- **Get LNURL Details**: Retrieve LNURL details
+- **Execute Quote**: Execute a payment quote
+
+### Payment Method
+- **Create Bank**: Add a bank account payment method
+- **Get**: Retrieve a payment method by ID
+- **Get Many**: Retrieve all payment methods
+- **Delete**: Remove a payment method
+
+### Payout
+- **Create**: Create a payout
+- **Get**: Retrieve a payout by ID
+- **Get Many**: Retrieve multiple payouts with filtering
+- **Initiate**: Initiate a payout
+
+### Rates
+- **Get Ticker**: Retrieve exchange rate ticker for a currency pair
+
+## Features
+
+- ⚡ **Lightning Network Support**: Send and receive Lightning Network payments
+- 🪙 **Bitcoin On-chain**: Support for on-chain Bitcoin transactions
+- 💱 **Currency Exchange**: Convert between BTC, USD, EUR, GBP, and more
+- 📊 **Pagination Support**: Handle large datasets with automatic pagination
+- 🔍 **OData Filtering**: Advanced filtering and sorting capabilities
+- 🔐 **Secure Authentication**: Bearer token authentication with environment selection
+
+## Example Workflows
+
+### Create and Monitor an Invoice
+
+1. **Create Invoice Node**
+   - Resource: Invoice
+   - Operation: Create
+   - Amount: 10
+   - Currency: USD
+   - Description: Payment for services
+
+2. **Wait for Payment** (using a webhook or polling)
+
+3. **Get Invoice Status**
+   - Resource: Invoice
+   - Operation: Get
+   - Invoice ID: `{{ $json.invoiceId }}`
+
+### Send Lightning Payment
+
+1. **Create Lightning Quote**
+   - Resource: Payment
+   - Operation: Create Lightning Quote
+   - Lightning Invoice: `lnbc1...`
+   - Source Currency: USD
+
+2. **Execute Quote**
+   - Resource: Payment
+   - Operation: Execute Quote
+   - Payment Quote ID: `{{ $json.paymentQuoteId }}`
+
+### Monitor Account Events
+
+1. **Get Events**
+   - Resource: Event
+   - Operation: Get Many
+   - Return All: true
+   - Filter: `eventType eq 'invoice.created'`
+
+## API Documentation
+
+For detailed API information, refer to the [official Strike API documentation](https://docs.strike.me/api/).
+
+## Known Limitations
+
+- Not all Strike API endpoints are implemented
+- Webhook support is not included (use polling as a workaround)
+- Limited error handling for specific edge cases
+- Test coverage is minimal
+
+## Contributing
+
+Contributions are welcome! If you find bugs or want to add features:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Test thoroughly
+5. Submit a pull request
+
+**Repository**: https://github.com/yourusername/n8n-nodes-strike
+
+## Support
+
+- **Issues**: Report bugs on [GitHub Issues](https://github.com/yourusername/n8n-nodes-strike/issues)
+- **Strike API**: [Strike API Documentation](https://docs.strike.me/api/)
+- **n8n Community**: [n8n Community Forum](https://community.n8n.io/)
+
+## Changelog
+
+### 0.1.0 (Initial Release)
+- Support for 10 Strike API resources
+- 30+ operations across all resources
+- Production and Sandbox environment support
+- Event tracking capabilities
+- OData filtering and pagination
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Disclaimer (Again, for Emphasis)
+
+**USE THIS NODE AT YOUR OWN RISK.** This is experimental software that handles financial transactions. Always:
+
+- Test in sandbox mode first
+- Start with small amounts
+- Monitor transactions closely
+- Keep your API keys secure
+- Review all operations before executing
+- Have a backup plan
+
+The authors and contributors are not liable for any losses, damages, or issues that may arise from using this node.
+
+---
+
+Made with ❤️ and AI assistance | Not officially affiliated with Strike