solwink-cli 1.0.0 β†’ 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +36 -41
  2. package/package.json +4 -3
package/README.md CHANGED
@@ -1,83 +1,78 @@
1
1
  # 🌊 SolWink: The Ultimate Solana Blink Generator
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/solwink.svg)](https://www.npmjs.com/package/solwink)
3
+ SolWink is a lightning-fast, interactive CLI that scaffolds production-ready Solana Actions & Blinks in seconds.
4
4
 
5
- **SolWink** is a lightning-fast, interactive CLI that scaffolds production-ready **Solana Actions & Blinks** in seconds.
5
+ ## 🌟 The Problem
6
+ Building a Solana Action was a manual, error-prone process that often led to hours of debugging Blank Link unfurls.
7
+ The CORS Trap as Blinks are cross-origin by nature and the Next.js Bloat: Most tutorials force you into a heavy Next.js App Router setup just to serve a simple JSON response. This leads to slow cold starts and unnecessary complexity for a backend-only task.
6
8
 
7
- Stop fighting with CORS headers, Next.js App Router bloat, and `X-Blockchain-Ids` validation. SolWink generates lightweight, pure Express.js backends specifically architected to work perfectly with [Dial.to](https://dial.to), Phantom, and X (Twitter) right out of the box.
8
-
9
- ---
9
+ ## πŸ’‘The Solution
10
+ SolWink automates the boring stuff so you can focus on the blockchain logic. It provides a pre-validated architecture that has passed the Dialect/Solana validator tests, ensuring your Blink "just works" the moment it hits X (Twitter).
11
+ Also it is the most pivotal project for Web2 Devs who want to become Web3 developers without going deep into Solana Action and Blinks.
10
12
 
11
13
  ## ⚑ Quick Start
12
14
 
13
- You don't need to install anything globally. Scaffold your first Blink instantly using `npx`:
15
+ You don't need to install anything globally. Scaffold your first Blink instantly using `npx` or traditional `npm`:
14
16
 
15
17
  ```bash
16
18
  npx create-solwink@latest
17
19
  # or
18
20
  npx solwink@latest
19
- Follow the beautiful interactive prompts to name your project, select your network, and inject your smart contract variables.
20
-
21
- Once generated, simply step into your project and run:
22
-
23
- Bash
24
- cd my-solwink-app
25
- npm install
26
- npm run dev
27
- ✨ Why SolWink?
21
+ #or
22
+ npm i solwink-cli
23
+ ```
24
+ ## ✨ Why SolWink?
28
25
  Building Solana Blinks should be fun, not frustrating. SolWink focuses on Developer Velocity:
29
26
 
30
- Zero-Config Express Backend: We ditched the heavy frontend frameworks. SolWink generates pure, lightweight Node.js/Express servers designed exclusively for API route handling.
27
+ Zero-Config Express Backend: We ditched the heavy frontend frameworks. SolWink generates pure, lightweight Express servers designed exclusively for API route handling.
31
28
 
32
29
  Bulletproof CORS & Headers: Pre-configured with the exact X-Action-Version and Access-Control-Allow-Origin headers required by the Dialect validator.
33
30
 
34
- Dynamic Network Selection: Choose between Mainnet-Beta or Devnet via interactive CLI dropdowns. SolWink automatically maps and injects the correct Genesis Hash / Chain ID into your project.
31
+ Dynamic Network Selection: Choose between Mainnet or Devnet via interactive CLI dropdowns. SolWink automatically maps and injects the correct Chain ID into your project.
35
32
 
36
33
  Smart Variable Injection: The CLI prompts you for your Treasury Wallet or Candy Machine ID and securely injects them directly into the generated codebase.
37
34
 
38
- πŸ› οΈ Phase 1 Templates
39
35
  SolWink currently ships with the two most highly requested use cases in the Solana ecosystem:
36
+ Templates
40
37
 
41
- πŸ’° 1. SOL Donation (Crowdfund)
42
- A dynamic Blink that allows users to send SOL to a specific treasury wallet.
43
-
44
- Features: Customizable donation buttons (e.g., 0.1 SOL, 0.5 SOL, 1 SOL) and a custom amount input field.
38
+ ## πŸ’» Use Cases
39
+ SolWink currently ships with the two most highly requested use cases in the Solana ecosystem:
40
+ Templates
45
41
 
46
- CLI Inputs: Prompts for the destination Treasury Wallet address.
42
+ **1. SOL Donation (Crowdfund)**
47
43
 
48
- πŸ–ΌοΈ 2. NFT Mint (Metaplex Candy Machine)
49
- A fully integrated NFT minting Blink using the modern @metaplex-foundation/umi standard.
44
+ A dynamic Blink that allows users to send SOL to a specific treasury wallet.
50
45
 
51
- Features: Direct integration with Candy Machine v2/v3, pre-configured Umi instance, and optimized image rendering for Twitter unfurls.
46
+ **2. NFT Mint (Metaplex Candy Machine)**
52
47
 
53
- CLI Inputs: Prompts for your specific Metaplex Candy Machine ID.
48
+ A fully integrated NFT minting Blink.
54
49
 
55
- πŸ“ Generated Architecture
56
- SolWink generates a clean, "Headless" backend structure that is easy to deploy to Render, Railway, or Heroku:
50
+ Features: Direct integration with Candy Machine v2/v3, pre-configured Umi instance, and optimized image rendering for Twitter unfurls.
57
51
 
52
+ Templates (under development)
58
53
 
59
- πŸš€ Roadmap (Phase 2 & Beyond)
60
54
  We are actively expanding the SolWink template library to become the standard scaffolding tool for Solana Actions:
61
55
 
62
- [ ] SPL Token Transfer: Support for sending USDC, BONK, and other custom tokens.
56
+ **3. SPL Token Transfer**
57
+
58
+ Support for sending USDC, BONK, and other custom tokens.
63
59
 
64
- [ ] Jupiter Swaps: Direct token-to-token swaps right inside the Blink.
60
+ **4. Jupiter Swaps**
65
61
 
66
- [ ] DAO Governance: On-chain voting for Realms/Snapshot.
62
+ Direct token-to-token swaps right inside the Blink.
67
63
 
68
- [ ] Token Gating: Access control and exclusive claims based on NFT ownership.
64
+ **5. DAO Governance**
69
65
 
70
- 🀝 Contributing
71
- Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
66
+ On-chain voting for Realms/Snapshot.
72
67
 
73
- To develop locally:
68
+ **6. Token Gating**
74
69
 
75
- Clone the repository.
70
+ A Blink that checks if you own a specific NFT. If you do, it reveals a "Claim" button for a discount code or secret link.
76
71
 
77
- Run npm install.
78
72
 
79
- Run npm run build.
73
+ ## πŸ“ Generated Architecture
80
74
 
81
- Run npm link to test the CLI globally on your machine.
75
+ SolWink generates a clean, Headless backend structure that is easy to deploy to Render, Railway, or Heroku:
82
76
 
83
77
 
78
+ Developed by Kartik Angiras with β™₯️ for Solana community.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "solwink-cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "The ultimate interactive CLI to scaffold Solana Blinks and Actions",
5
5
  "type": "module",
6
6
  "bin": {
@@ -29,11 +29,12 @@
29
29
  "dependencies": {
30
30
  "commander": "^12.1.0",
31
31
  "consola": "^3.4.2",
32
- "fs-extra": "^11.2.0"
32
+ "fs-extra": "^11.2.0",
33
+ "solwink-cli": "^1.0.0"
33
34
  },
34
35
  "devDependencies": {
35
36
  "@types/fs-extra": "^11.0.4",
36
37
  "@types/node": "^20.0.0",
37
38
  "typescript": "^5.9.3"
38
39
  }
39
- }
40
+ }