solana-meme-kit 0.1.0 โ†’ 0.2.4

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 +37 -45
  2. package/package.json +3 -1
package/README.md CHANGED
@@ -1,88 +1,80 @@
1
1
  # solana-meme-kit
2
2
 
3
- **The All-in-One SDK for launching Solana Tokens.**
3
+ **The Universal SDK for launching Solana Tokens.**
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/solana-meme-kit.svg)](https://www.npmjs.com/package/solana-meme-kit)
6
6
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
7
 
8
- A unified, open-source TypeScript SDK that abstracts the complexity of Solana token launches. It provides a single interface to handle Token Minting, "Low-Cost" OpenBook Market creation, and Raydium Liquidity provisioning with Jito Bundles (Anti-Snipe).
9
-
8
+ A unified, open-source TypeScript SDK that abstracts the complexity of Solana token launches. It provides a **Strategy Pattern** allowing you to choose different DEX backends for liquidity provision with a single code path.
10
9
 
11
10
  ## โœจ Core Features
12
11
 
12
+ - **Protocol:Strategy Selection**: Choose your DEX backend using `protocol:strategy` format.
13
13
  - **Token Minting**: One-line minting with metadata upload via Metaplex Umi.
14
- - **OpenBook Markets**:
15
- - Automatically calculates rent-exempt minimums.
16
- - Supports **"Low-Cost"** configuration (Event Queue: 128, Request Queue: 63, Orderbook: 201) to save ~2.6 SOL per launch.
17
- - Uses the official OpenBook V1 Program ID.
18
- - **Liquidity Management**:
19
- - Integrated with **Raydium SDK V2**.
20
- - **Jito Bundle Support**: Atomically executes `InitPool` + `AddLiquidity` + `Swap` + `Tip` to prevent sniping (Mainnet only).
14
+ - **OpenBook Markets**: Supports automated low-cost market creation.
21
15
  - **Security**: Built-in helpers to revoke Mint and Freeze authorities.
16
+ - **Standardized Interface**: Switch DEXs without changing your business logic.
22
17
 
23
- ## ๐Ÿ“ฆ Installation
18
+ ## ๐Ÿ“Š Strategy Comparison
24
19
 
25
- ```bash
26
- bun add solana-meme-kit
27
- # or
28
- npm install solana-meme-kit
29
- ```
20
+ | Strategy | Cost (est) | Anti-Snipe | Features |
21
+ | :----------------- | :------------- | :--------- | :----------------------------------- |
22
+ | **`meteora:dlmm`** | ~0.02 SOL | โœ… High | Dynamic fees, concentrated liquidity |
23
+ | **`raydium:cpmm`** | ~0.15 SOL | โš ๏ธ Medium | Modern CPMM, no OpenBook needed |
24
+ | **`raydium:amm`** | ~0.2 - 2.8 SOL | โš ๏ธ Low | Legacy AMM, maximum compatibility |
30
25
 
31
26
  ## ๐Ÿ’ป Usage
32
27
 
33
- ### Basic Launch
28
+ ### Basic Launch (Meteora DLMM - Default)
34
29
 
35
30
  ```typescript
36
- import { MemeKit } from 'solana-meme-kit';
31
+ import { MemeKit } from "solana-meme-kit";
37
32
 
38
- // 1. Initialize
39
33
  const kit = new MemeKit({
40
- rpcUrl: process.env.RPC_URL!,
41
- privateKey: process.env.PRIVATE_KEY!,
42
- cluster: 'mainnet' // 'mainnet' | 'devnet'
34
+ rpcUrl: "https://api.mainnet-beta.solana.com",
35
+ privateKey: "YOUR_PRIVATE_KEY",
36
+ cluster: "mainnet",
43
37
  });
44
38
 
45
- // 2. Launch
46
39
  const result = await kit.launch({
47
- // Token
48
- name: 'Cool Token',
49
- symbol: 'COOL',
50
- image: 'https://arweave.net/metadata-uri',
40
+ name: "Super Gem",
41
+ symbol: "SGEM",
42
+ image: "https://arweave.net/metadata",
51
43
  supply: 1_000_000_000,
52
-
53
- // Liquidity
54
44
  solLiquidityAmount: 5,
55
45
  tokenLiquidityAmount: 800_000_000,
56
-
57
- // Advanced Config
58
- marketMode: 'low-cost', // Optimizes rent costs
59
- jitoTipAmount: 0.01,
46
+ dex: "meteora:dlmm", // Choose strategy here
60
47
  });
61
48
 
62
- console.log('Launch Bundle:', result.bundleId);
49
+ console.log(`Token: ${result.mint}, Pool: ${result.poolId}`);
63
50
  ```
64
51
 
65
52
  ## ๐Ÿ› ๏ธ Architecture
66
53
 
67
- The SDK is composed of three main managers which can also be used independently:
68
-
69
- - **`TokenManager`**: Wraps `@metaplex-foundation/umi` for minting and authority management.
70
- - **`MarketManager`**: Wraps `@openbook-dex/openbook` for market ID generation.
71
- - **`LiquidityManager`**: Wraps `@raydium-io/raydium-sdk-v2` and `jito-ts` for pool actions.
54
+ ```
55
+ src/
56
+ โ”œโ”€โ”€ core/ # Main SDK and utilities
57
+ โ”œโ”€โ”€ managers/ # Modular components (Token, Market, etc)
58
+ โ””โ”€โ”€ strategies/ # DEX-specific implementations
59
+ โ”œโ”€โ”€ meteora/ # Meteora DLMM logic
60
+ โ””โ”€โ”€ raydium/ # Raydium CPMM & AMM logic
61
+ ```
72
62
 
73
63
  ## ๐Ÿงช Development
74
64
 
75
65
  ```bash
76
- # Install dependencies
77
66
  bun install
78
-
79
- # Run Tests
80
- bun test
81
-
82
- # Build
83
67
  bun run build
68
+ bun test
84
69
  ```
85
70
 
71
+ ## ๐Ÿš€ Roadmap
72
+
73
+ - [x] Meteora DLMM Integration
74
+ - [x] Raydium CPMM Integration
75
+ - [x] Raydium AMM (Legacy) Integration
76
+ - [x] Jito Bundle Support (Mainnet)
77
+
86
78
  ## ๐Ÿ“„ License
87
79
 
88
80
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "solana-meme-kit",
3
- "version": "0.1.0",
3
+ "version": "0.2.4",
4
4
  "description": "The abstracted shovel for launching professional Solana tokens. Automated Low-Cost OpenBook Markets and Jito Bundles.",
5
5
  "module": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -35,9 +35,11 @@
35
35
  "typescript": "^5.9.3"
36
36
  },
37
37
  "dependencies": {
38
+ "@coral-xyz/anchor": "^0.32.1",
38
39
  "@metaplex-foundation/mpl-token-metadata": "^3.4.0",
39
40
  "@metaplex-foundation/umi": "^1.4.1",
40
41
  "@metaplex-foundation/umi-bundle-defaults": "^1.4.1",
42
+ "@meteora-ag/dlmm": "^1.9.2",
41
43
  "@openbook-dex/openbook": "^0.0.9",
42
44
  "@raydium-io/raydium-sdk": "^1.3.1-beta.58",
43
45
  "@raydium-io/raydium-sdk-v2": "^0.2.32-alpha",