@graveyardprotocol/gp-cli 1.0.0

package/LICENSE.md

@@ -0,0 +1,35 @@
+# Proprietary Software License Agreement
+ Version 1.0, March 2026
+ #### *Copyright: © 2026 Graveyard Protocol. All rights reserved.*
+
+---
+
+## Product: Graveyard Protocol CLI 
+
+**1. GRANT OF LICENSE**
+
+Graveyard Protocol ("Owner") grants you a non-exclusive, non-transferable license to download, install, and use the Graveyard Protocol CLI ("Software") solely for your personal or internal business purposes, subject to the terms of this Agreement.
+
+**2. RESTRICTIONS**
+    
+You shall not, and shall not permit any third party to:
+
+- **Reverse Engineer:** Decompile, disassemble, reverse engineer, or otherwise attempt to derive the source code of the Software.
+
+- **Redistribute:** Copy, rent, lease, sub-license, or distribute the Software or any portion thereof to any third party.
+
+- **Modify:** Create derivative works or modifications of the Software.
+
+- **Remove Notices:** Remove or alter any copyright, trademark, or proprietary notices contained in the Software.
+
+**3. OWNERSHIP**
+
+The Software, including its object code and any obfuscated source code published via package managers (e.g., npm), remains the sole and exclusive property of the Owner. This license does not grant you any ownership rights.
+
+**4. THIRD-PARTY LICENSES**
+    
+The Software utilizes third-party open-source libraries (including but not limited to *@solana/web3.js, commander, and inquirer*). These components are used in accordance with their respective MIT or Apache 2.0 licenses. A list of these attributions is included in the THIRD_PARTY_LICENSES file provided with this distribution.
+
+**5. TERMINATION**
+
+This license is effective until terminated. Your rights under this license will terminate automatically without notice if you fail to comply with any term(s) of this Agreement.

package/README.md

@@ -0,0 +1,144 @@
+# GP-CLI — Graveyard Protocol Command Line Interface
+
+Close empty Solana SPL token accounts and reclaim the locked rent (SOL) back to your wallet.
+
+---
+
+## Requirements
+
+- **Node.js 18+**
+- A Solana wallet private key (JSON byte array or Base58 string)
+
+---
+
+## Installation
+
+```bash
+npm install -g @graveyardprotocol/gp-cli
+```
+
+Or run directly from the repo:
+
+```bash
+git clone https://github.com/GraveyardProtocol/gp-cli
+cd gp-cli
+npm install
+npm link          
+```
+
+---
+
+## Quick Start
+
+### 1. Add a wallet
+
+```bash
+gp add-wallet
+```
+
+You will be prompted for your private key. Both formats are accepted:
+
+| Format | Example |
+|---|---|
+| JSON byte array | `[12, 34, 56, ...]` — exported by Phantom / Solflare |
+| Base58 string | `5Jxyz...` — some wallet exporters |
+
+Your private key is **never stored in plaintext**. It is encrypted with AES-256-GCM using a password you choose, and stored in `~/.gp-cli/wallets.json`.
+
+### 2. Close empty token accounts
+
+```bash
+gp close-empty
+```
+
+You will be shown a scan summary and asked to confirm before any transaction is submitted.
+
+---
+
+## All Commands
+
+| Command | Description |
+|---|---|
+| `gp add-wallet` | Add and encrypt a Solana wallet |
+| `gp remove-wallet` | Remove a saved wallet |
+| `gp list-wallets` | Show all saved wallet public keys |
+| `gp close-empty` | Scan and close empty token accounts |
+| `gp close-empty --dry-run` | Preview what would be closed — no transactions sent |
+| `gp close-empty --all` | Process every saved wallet in sequence |
+
+---
+
+## How It Works
+
+```
+CLI                           Backend                      Solana
+ │                               │                            │
+ ├─ gp close-empty               │                            │
+ │                               │                            │
+ ├──── GET /scan/{wallet} ───────►                            │
+ │◄─── { total_accounts, SOL } ──┤  scans on-chain ──────────►
+ │                               │◄─ results ─────────────────┤
+ │                               │                            │
+ ├──── GET /getBatchCount ───────►                            │
+ │◄─── { totalBatches } ─────────┤                            │
+ │                               │                            │
+ ├──── POST /processBatch ───────►                            │
+ │◄─── { intentID,              ─┤  builds instructions       │
+ │       instructionsBatch }     │                            │
+ │                               │                            │
+ ├── build Tx, sign locally ─────►                            │
+ │                               │                            │
+ ├──── POST /executeBatch ───────►                            │
+ │◄─── { txSignature, SOL } ─────┤  simulates + submits ──────►
+ │                               │◄─ confirmed ───────────────┤
+```
+
+**The CLI never broadcasts to Solana directly.** Signing happens locally with your decrypted keypair; the signed transaction is handed to backend API which simulates, sends, and confirms it.
+
+---
+
+## Protocol Economics
+
+| Item | Value |
+|---|---|
+| Protocol fee | 20% of reclaimed rent per batch |
+| You receive | ~80% of total locked SOL |
+| Ghost Points | 100 points per closed account |
+| Average rent per account | ~0.00204 SOL |
+
+---
+
+## Security
+
+- Private keys encrypted with **AES-256-GCM**
+- Key derived via **PBKDF2** (SHA-256, 100,000 iterations)
+- Stored at `~/.gp-cli/wallets.json` — never transmitted
+- GCM authentication tag prevents ciphertext tampering
+
+---
+
+## Local Storage
+
+| Path | Contents |
+|---|---|
+| `~/.gp-cli/wallets.json` | Encrypted wallet entries |
+
+---
+
+**Note:** The source code provided in this repository is for transparency and auditing purposes only. It does not constitute an Open Source grant.
+
+---
+
+## License
+
+**Graveyard Protocol CLI** (gp-cli) is proprietary software. All rights reserved.
+
+The use of this software is governed by the **Proprietary Software License Agreement** found in the LICENSE file included in this repository.
+
+**Commercial Use:** Permitted under the terms of the license.
+
+**Modification/Redistribution:** Strictly prohibited.
+
+**Reverse Engineering:** Strictly prohibited.
+
+For third-party library attributions, please refer to the THIRD_PARTY_LICENSES file generated in the distribution.