faucet-terminal 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nethermind
+
+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,115 @@
+<div align="center">
+
+# faucet-terminal
+
+**Get testnet tokens from your terminal**
+
+[![npm](https://img.shields.io/npm/v/faucet-terminal?color=blue)](https://www.npmjs.com/package/faucet-terminal)
+[![Downloads](https://img.shields.io/npm/dm/faucet-terminal)](https://www.npmjs.com/package/faucet-terminal)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+Starknet Sepolia · Ethereum Sepolia
+
+</div>
+
+---
+
+```bash
+npm install -g faucet-terminal
+```
+
+```
+$ faucet-terminal req 0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21 -n eth-sep
+
+  faucet terminal
+
+  network  ethereum
+
+  ✔ Challenge received
+  ✔ Challenge solved in 12.3s
+  ✔ Transaction submitted!
+
+  ────────────────────────────────────────────────────────
+
+    amount  0.01 ETH
+    tx      0x6139cd4b...82e8d55f
+
+    https://sepolia.etherscan.io/tx/0x6139cd4b...
+
+  ────────────────────────────────────────────────────────
+
+  ✔ Tokens will arrive in ~30 seconds
+```
+
+## Quick Start
+
+```bash
+# Ethereum Sepolia
+faucet-terminal req 0xYOUR_ADDRESS -n eth-sep
+
+# Starknet Sepolia (STRK)
+faucet-terminal req 0xYOUR_ADDRESS -n sn-sep
+
+# Starknet Sepolia (ETH)
+faucet-terminal req 0xYOUR_ADDRESS -n sn-sep --token ETH
+
+# Starknet Sepolia (both tokens)
+faucet-terminal req 0xYOUR_ADDRESS -n sn-sep --both
+```
+
+## Networks
+
+| Network | Aliases | Tokens |
+|:--------|:--------|:-------|
+| Starknet Sepolia | `starknet` `sn` `sn-sep` | STRK, ETH |
+| Ethereum Sepolia | `ethereum` `eth` `eth-sep` | ETH |
+
+## Commands
+
+```
+req, r      Request testnet tokens
+status, s   Check cooldown status
+info, i     View faucet info
+quota, q    Check remaining quota
+limits, l   Show rate limits
+```
+
+## Options
+
+```
+-n, --network   Network (required): eth-sep, sn-sep
+--token         Token type: ETH, STRK
+--both          Request both tokens (Starknet only)
+--json          JSON output
+```
+
+## Rate Limits
+
+```
+5 requests/day    per IP address
+1 request/hour    per token type
+24h cooldown      after daily limit
+```
+
+## How It Works
+
+```
+1. Submit address    →  Validate format
+2. Verification      →  Answer simple question
+3. Proof of Work     →  Solve SHA-256 challenge (~30s)
+4. Receive tokens    →  Transaction submitted
+```
+
+## License
+
+MIT
+
+---
+
+<div align="center">
+
+[npm](https://www.npmjs.com/package/faucet-terminal) · [GitHub](https://github.com/Giri-Aayush/faucet-cli) · [Issues](https://github.com/Giri-Aayush/faucet-cli/issues)
+
+Made with ❤️ by a developer, for developers
+
+</div>

package/bin/faucet-terminal.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+
+const binaryName = process.platform === 'win32' ? 'faucet-terminal.exe' : 'faucet-terminal';
+const binaryPath = path.join(__dirname, binaryName);
+
+const child = spawn(binaryPath, process.argv.slice(2), {
+  stdio: 'inherit',
+  env: process.env
+});
+
+child.on('exit', (code) => {
+  process.exit(code || 0);
+});
+
+child.on('error', (err) => {
+  console.error('failed to start:', err.message);
+  process.exit(1);
+});

package/install.js

@@ -0,0 +1,139 @@
+#!/usr/bin/env node
+
+const https = require('https');
+const fs = require('fs');
+const path = require('path');
+const { promisify } = require('util');
+const stream = require('stream');
+
+const pipeline = promisify(stream.pipeline);
+
+const VERSION = 'v2.0.0';
+const GITHUB_REPO = 'Giri-Aayush/faucet-cli';
+
+// Detect platform and architecture
+function getPlatform() {
+  const platform = process.platform;
+  const arch = process.arch;
+
+  let binaryName = 'faucet-terminal';
+
+  if (platform === 'darwin') {
+    if (arch === 'arm64') {
+      binaryName += '-macos-arm64';
+    } else {
+      binaryName += '-macos-amd64';
+    }
+  } else if (platform === 'linux') {
+    if (arch === 'arm64') {
+      binaryName += '-linux-arm64';
+    } else {
+      binaryName += '-linux-amd64';
+    }
+  } else if (platform === 'win32') {
+    binaryName += '-windows-amd64.exe';
+  } else {
+    throw new Error(`Unsupported platform: ${platform} ${arch}`);
+  }
+
+  return binaryName;
+}
+
+async function downloadBinary() {
+  try {
+    const binaryName = getPlatform();
+    const downloadUrl = `https://github.com/${GITHUB_REPO}/releases/download/${VERSION}/${binaryName}`;
+    const binDir = path.join(__dirname, 'bin');
+    const binaryPath = path.join(binDir, process.platform === 'win32' ? 'faucet-terminal.exe' : 'faucet-terminal');
+
+    console.log(`\n  faucet-terminal ${VERSION}\n`);
+    console.log(`  platform  ${process.platform} (${process.arch})`);
+    console.log(`  binary    ${binaryName}\n`);
+
+    // Ensure bin directory exists
+    if (!fs.existsSync(binDir)) {
+      fs.mkdirSync(binDir, { recursive: true });
+    }
+
+    // Download binary with progress indicator
+    await new Promise((resolve, reject) => {
+      https.get(downloadUrl, (response) => {
+        if (response.statusCode === 302 || response.statusCode === 301) {
+          // Follow redirect
+          https.get(response.headers.location, (redirectResponse) => {
+            if (redirectResponse.statusCode !== 200) {
+              reject(new Error(`Download failed with status ${redirectResponse.statusCode}`));
+              return;
+            }
+
+            const totalBytes = parseInt(redirectResponse.headers['content-length'], 10);
+            let downloadedBytes = 0;
+            let lastPercent = 0;
+
+            redirectResponse.on('data', (chunk) => {
+              downloadedBytes += chunk.length;
+              const percent = Math.floor((downloadedBytes / totalBytes) * 100);
+
+              if (percent >= lastPercent + 10 || percent === 100) {
+                const bar = '█'.repeat(Math.floor(percent / 5)) + '░'.repeat(20 - Math.floor(percent / 5));
+                process.stdout.write(`\r  [${bar}] ${percent}%`);
+                lastPercent = percent;
+              }
+            });
+
+            const fileStream = fs.createWriteStream(binaryPath);
+            pipeline(redirectResponse, fileStream)
+              .then(() => {
+                console.log('\n');
+                resolve();
+              })
+              .catch(reject);
+          });
+        } else if (response.statusCode === 200) {
+          const totalBytes = parseInt(response.headers['content-length'], 10);
+          let downloadedBytes = 0;
+          let lastPercent = 0;
+
+          response.on('data', (chunk) => {
+            downloadedBytes += chunk.length;
+            const percent = Math.floor((downloadedBytes / totalBytes) * 100);
+
+            if (percent >= lastPercent + 10 || percent === 100) {
+              const bar = '█'.repeat(Math.floor(percent / 5)) + '░'.repeat(20 - Math.floor(percent / 5));
+              process.stdout.write(`\r  [${bar}] ${percent}%`);
+              lastPercent = percent;
+            }
+          });
+
+          const fileStream = fs.createWriteStream(binaryPath);
+          pipeline(response, fileStream)
+            .then(() => {
+              console.log('\n');
+              resolve();
+            })
+            .catch(reject);
+        } else {
+          reject(new Error(`Download failed with status ${response.statusCode}. Binary may not exist yet for ${binaryName}.`));
+        }
+      }).on('error', reject);
+    });
+
+    // Make binary executable (Unix systems)
+    if (process.platform !== 'win32') {
+      fs.chmodSync(binaryPath, 0o755);
+    }
+
+    console.log('  ✓ installed\n');
+    console.log('  run: faucet-terminal --help\n');
+
+  } catch (error) {
+    console.error('\n  ✗ installation failed:', error.message);
+    console.error('\n  manual install:');
+    console.error(`    1. download from: https://github.com/${GITHUB_REPO}/releases`);
+    console.error(`    2. add to PATH`);
+    console.error(`    3. run: faucet-terminal --help\n`);
+    process.exit(1);
+  }
+}
+
+downloadBinary();

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "faucet-terminal",
+  "version": "2.0.0",
+  "description": "Multi-chain testnet faucet CLI - get tokens on Starknet and Ethereum testnets",
+  "bin": {
+    "faucet-terminal": "./bin/faucet-terminal.js"
+  },
+  "scripts": {
+    "postinstall": "node ./install.js",
+    "test": "node ./bin/faucet-terminal.js --help"
+  },
+  "keywords": [
+    "faucet",
+    "testnet",
+    "starknet",
+    "ethereum",
+    "sepolia",
+    "blockchain",
+    "cli",
+    "multi-chain",
+    "web3",
+    "crypto"
+  ],
+  "author": "Aayush Giri",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Giri-Aayush/faucet-cli.git"
+  },
+  "homepage": "https://github.com/Giri-Aayush/faucet-cli#readme",
+  "bugs": {
+    "url": "https://github.com/Giri-Aayush/faucet-cli/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "bin/",
+    "install.js",
+    "README.md"
+  ]
+}