Martien/n8n-nodes-strike
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
acf92bd8f9cc529ec7c25aa44f57f4320fa00b7b
n8n-nodes-strike/README.md
Martien 7aa6484486 Bump version to 0.2.1 
- Update version in package.json
- Add changelog entry for v0.2.1

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-10 11:32:14 +01:00

218 lines
6.4 KiB
Markdown
Raw Blame History

# n8n-nodes-strike
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://git.martien.io/Martien/n8n-nodes-strike
## Support
- **Issues**: Report bugs on [Git Repository](https://git.martien.io/Martien/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.2.1
- Fix icon build process to include PNG files
- Fix broken image link in README
### 0.2.0
- Add Event resource with get and getAll operations
- Update node icon from SVG to PNG format
- Add comprehensive README with usage examples
- Update repository URLs to git.martien.io
- Improve documentation
### 0.1.0 (Initial Release)
- Support for 9 Strike API resources
- 30+ operations across all resources
- Production and Sandbox environment support
- 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
Reference in New Issue View Git Blame Copy Permalink