n8n-nodes-lighter 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# n8n-nodes-lighter
+
+This is an n8n community node for **Lighter (zkLighter)** - a high-performance perpetuals DEX built on a zero-knowledge rollup on Ethereum.
+
+[Lighter](https://lighter.xyz) | [API Documentation](https://apidocs.lighter.xyz) | [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
+
+## Features
+
+### Lighter Node (REST API)
+- **Account Operations**: Get account info, positions, PnL, liquidations, funding data
+- **Market Operations**: Order books, exchange stats, funding rates
+- **Order Operations**: Active/inactive orders, order history export
+- **Trade Operations**: Recent trades, trade history
+- **Transaction Operations**: Transaction details, deposit/withdraw/transfer history
+- **System Operations**: Status, info, announcements
+
+### Lighter Trigger (WebSocket)
+Real-time data streaming via WebSocket:
+- Order book updates (50ms intervals)
+- Market statistics
+- Trade feed
+- Account positions, orders, trades
+- Notifications (liquidations, deleveraging)
+- Blockchain height updates
+
+## Installation
+
+### Community Nodes (Recommended)
+1. Go to **Settings > Community Nodes** in n8n
+2. Select **Install**
+3. Enter `n8n-nodes-lighter`
+4. Click **Install**
+
+### Manual Installation
+```bash
+cd ~/.n8n/nodes
+npm install n8n-nodes-lighter
+```
+
+## Credentials
+
+To use this node, you need to set up Lighter API credentials:
+
+1. **Environment**: Choose between Mainnet or Testnet
+2. **Account Index**: Your Lighter account index (find it using `accountsByL1Address` endpoint)
+3. **API Key Index**: Your API key index (3-254, indices 0-2 are reserved)
+4. **API Private Key**: Your API private key for signing transactions
+5. **Auth Token** (Optional): Pre-generated auth token for authenticated endpoints
+
+### Getting Your Credentials
+
+1. Visit [Lighter](https://app.lighter.xyz) and connect your wallet
+2. Create an API key using the Python or Go SDK
+3. Find your account index using the `accountsByL1Address` endpoint
+
+Example using Python SDK:
+```python
+import lighter
+
+client = lighter.SignerClient(
+    url="https://mainnet.zklighter.elliot.ai",
+    api_private_keys={3: "your_private_key"},
+    account_index=YOUR_ACCOUNT_INDEX
+)
+
+# Generate auth token (max 8 hours)
+auth, err = client.create_auth_token_with_expiry(3600)
+```
+
+## Usage Examples
+
+### Get Account Information
+1. Add the **Lighter** node to your workflow
+2. Select **Resource**: Account
+3. Select **Operation**: Get Account
+4. Choose **Query By**: Account Index or L1 Address
+5. Enter the account index or address
+
+### Subscribe to Order Book Updates
+1. Add the **Lighter Trigger** node
+2. Select **Channel**: Order Book
+3. Enter the **Market Index** (0 = ETH-USD)
+4. The trigger will emit events on every orderbook update
+
+### Get Recent Trades
+1. Add the **Lighter** node
+2. Select **Resource**: Trade
+3. Select **Operation**: Get Recent Trades
+4. Enter **Market Index** and **Limit**
+
+## API Reference
+
+### Markets
+| Index | Symbol |
+|-------|--------|
+| 0 | ETH-USD |
+| 1 | BTC-USD |
+| 2 | SOL-USD |
+| ... | ... |
+
+Use the `Get Order Books` operation to retrieve all available markets.
+
+### Rate Limits
+- **Standard Account**: 60 weighted requests/minute
+- **Premium Account**: 24,000 weighted requests/minute
+- **WebSocket**: 100 connections, 1000 subscriptions total
+
+## Resources
+
+- [Lighter Documentation](https://docs.lighter.xyz)
+- [API Documentation](https://apidocs.lighter.xyz)
+- [Python SDK](https://github.com/elliottech/lighter-python)
+- [Go SDK](https://github.com/elliottech/lighter-go)
+
+## License
+
+[MIT](LICENSE.md)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/credentials/LighterApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class LighterApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/LighterApi.credentials.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LighterApi = void 0;
+class LighterApi {
+    constructor() {
+        this.name = 'lighterApi';
+        this.displayName = 'Lighter API';
+        this.documentationUrl = 'https://apidocs.lighter.xyz/docs/get-started-for-programmers-1';
+        this.properties = [
+            {
+                displayName: 'Environment',
+                name: 'environment',
+                type: 'options',
+                default: 'mainnet',
+                options: [
+                    {
+                        name: 'Mainnet',
+                        value: 'mainnet',
+                    },
+                    {
+                        name: 'Testnet',
+                        value: 'testnet',
+                    },
+                ],
+                description: 'Select the Lighter network environment',
+            },
+            {
+                displayName: 'Account Index',
+                name: 'accountIndex',
+                type: 'number',
+                default: 0,
+                required: true,
+                description: 'Your Lighter account index. Find it using the accountsByL1Address endpoint.',
+            },
+            {
+                displayName: 'API Key Index',
+                name: 'apiKeyIndex',
+                type: 'number',
+                default: 3,
+                required: true,
+                description: 'The API key index (3-254). Indices 0-2 are reserved for desktop/mobile apps.',
+            },
+            {
+                displayName: 'API Private Key',
+                name: 'apiPrivateKey',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'Your Lighter API private key for signing transactions',
+            },
+            {
+                displayName: 'Auth Token',
+                name: 'authToken',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                description: 'Pre-generated auth token for API requests. If empty, public endpoints will be used.',
+                hint: 'Generate using the SDK: client.create_auth_token_with_expiry()',
+            },
+            {
+                displayName: 'L1 Address (Optional)',
+                name: 'l1Address',
+                type: 'string',
+                default: '',
+                description: 'Your Ethereum L1 address (optional, for convenience)',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '={{$credentials.authToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.environment === "mainnet" ? "https://mainnet.zklighter.elliot.ai" : "https://testnet.zklighter.elliot.ai"}}',
+                url: '/api/v1/status',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.LighterApi = LighterApi;
+//# sourceMappingURL=LighterApi.credentials.js.map

package/dist/credentials/LighterApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LighterApi.credentials.js","sourceRoot":"","sources":["../../credentials/LighterApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,UAAU;IAAvB;QACC,SAAI,GAAG,YAAY,CAAC;QACpB,gBAAW,GAAG,aAAa,CAAC;QAC5B,qBAAgB,GAAG,gEAAgE,CAAC;QACpF,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,aAAa;gBAC1B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,SAAS;gBAClB,OAAO,EAAE;oBACR;wBACC,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,SAAS;qBAChB;oBACD;wBACC,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,SAAS;qBAChB;iBACD;gBACD,WAAW,EAAE,wCAAwC;aACrD;YACD;gBACC,WAAW,EAAE,eAAe;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6EAA6E;aAC1F;YACD;gBACC,WAAW,EAAE,eAAe;gBAC5B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,8EAA8E;aAC3F;YACD;gBACC,WAAW,EAAE,iBAAiB;gBAC9B,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,uDAAuD;aACpE;YACD;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,qFAAqF;gBAClG,IAAI,EAAE,gEAAgE;aACtE;YACD;gBACC,WAAW,EAAE,uBAAuB;gBACpC,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,sDAAsD;aACnE;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,6BAA6B;iBAC5C;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,6HAA6H;gBACtI,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AArFD,gCAqFC"}

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

@@ -0,0 +1,5 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Lighter implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}