solana-meme-kit 0.2.4 โ 0.3.0
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.
- package/README.md +154 -80
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,80 +1,154 @@
|
|
|
1
|
-
# solana-meme-kit
|
|
2
|
-
|
|
3
|
-
**The Universal SDK for launching Solana Tokens.**
|
|
4
|
-
|
|
5
|
-
[](https://www.npmjs.com/package/solana-meme-kit)
|
|
6
|
-
[](https://opensource.org/licenses/MIT)
|
|
7
|
-
|
|
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.
|
|
9
|
-
|
|
10
|
-
## โจ Core Features
|
|
11
|
-
|
|
12
|
-
- **Protocol:Strategy Selection**: Choose your DEX backend using `protocol:strategy` format.
|
|
13
|
-
- **Token Minting**: One-line minting with metadata upload via Metaplex Umi.
|
|
14
|
-
- **OpenBook Markets**: Supports automated low-cost market creation.
|
|
15
|
-
- **Security**: Built-in helpers to revoke Mint and Freeze authorities.
|
|
16
|
-
- **Standardized Interface**: Switch DEXs without changing your business logic.
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
|
22
|
-
|
|
|
23
|
-
| **`
|
|
24
|
-
| **`raydium:
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
dex: "meteora:dlmm", // Choose strategy here
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
console.log(`Token: ${result.mint}, Pool: ${result.poolId}`);
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
1
|
+
# solana-meme-kit
|
|
2
|
+
|
|
3
|
+
**The Universal SDK for launching Solana Tokens.**
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/solana-meme-kit)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
|
|
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.
|
|
9
|
+
|
|
10
|
+
## โจ Core Features
|
|
11
|
+
|
|
12
|
+
- **Protocol:Strategy Selection**: Choose your DEX backend using `protocol:strategy` format.
|
|
13
|
+
- **Token Minting**: One-line minting with metadata upload via Metaplex Umi.
|
|
14
|
+
- **OpenBook Markets**: Supports automated low-cost market creation.
|
|
15
|
+
- **Security**: Built-in helpers to revoke Mint and Freeze authorities.
|
|
16
|
+
- **Standardized Interface**: Switch DEXs without changing your business logic.
|
|
17
|
+
- **Jito Smart Tipping**: Use `jitoTip: "auto"` (or a manual tip) with optional block engine region routing.
|
|
18
|
+
|
|
19
|
+
## ๐ Strategy Comparison
|
|
20
|
+
|
|
21
|
+
| Strategy | Cost (est) | Anti-Snipe | Features |
|
|
22
|
+
| :----------------- | :------------- | :--------- | :----------------------------------- |
|
|
23
|
+
| **`meteora:dlmm`** | ~0.02 SOL | โ
High | Dynamic fees, concentrated liquidity |
|
|
24
|
+
| **`raydium:cpmm`** | ~0.15 SOL | โ ๏ธ Medium | Modern CPMM, no OpenBook needed |
|
|
25
|
+
| **`raydium:amm`** | ~0.2 - 2.8 SOL | โ ๏ธ Low | Legacy AMM, maximum compatibility |
|
|
26
|
+
|
|
27
|
+
## ๐ป Usage
|
|
28
|
+
|
|
29
|
+
### Basic Launch (Meteora DLMM - Default)
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { MemeKit } from "solana-meme-kit";
|
|
33
|
+
|
|
34
|
+
const kit = new MemeKit({
|
|
35
|
+
rpcUrl: "https://api.mainnet-beta.solana.com",
|
|
36
|
+
privateKey: "YOUR_PRIVATE_KEY",
|
|
37
|
+
cluster: "mainnet-beta",
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
const result = await kit.launch({
|
|
41
|
+
name: "Super Gem",
|
|
42
|
+
symbol: "SGEM",
|
|
43
|
+
image: "https://arweave.net/metadata",
|
|
44
|
+
supply: 1_000_000_000,
|
|
45
|
+
liquidity: { solAmount: 5, tokenAmount: 800_000_000 },
|
|
46
|
+
dex: "meteora:dlmm", // Choose strategy here
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
console.log(`Token: ${result.mint}, Pool: ${result.poolId}`);
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Smart Tipping (Jito)
|
|
53
|
+
|
|
54
|
+
`jitoTip` can be a number (SOL) or `"auto"`.
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
import { MemeKit } from "solana-meme-kit";
|
|
58
|
+
|
|
59
|
+
const kit = new MemeKit({
|
|
60
|
+
rpcUrl: "https://api.mainnet-beta.solana.com",
|
|
61
|
+
privateKey: "YOUR_PRIVATE_KEY",
|
|
62
|
+
cluster: "mainnet-beta",
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
const result = await kit.launch({
|
|
66
|
+
name: "Super Gem",
|
|
67
|
+
symbol: "SGEM",
|
|
68
|
+
image: "https://arweave.net/metadata",
|
|
69
|
+
liquidity: { solAmount: 5, tokenAmount: 800_000_000 },
|
|
70
|
+
dex: "meteora:dlmm",
|
|
71
|
+
jitoTip: "auto",
|
|
72
|
+
blockEngine: "ny",
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
console.log(result.signature);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Available `blockEngine` regions:
|
|
79
|
+
|
|
80
|
+
- **default**
|
|
81
|
+
- **ny**
|
|
82
|
+
- **amsterdam**
|
|
83
|
+
- **frankfurt**
|
|
84
|
+
- **tokyo**
|
|
85
|
+
- **slc**
|
|
86
|
+
|
|
87
|
+
### Smart Tip Quote (for UI)
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
import { MemeKit } from "solana-meme-kit";
|
|
91
|
+
|
|
92
|
+
const tipSol = await MemeKit.getSmartTip();
|
|
93
|
+
console.log(tipSol);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Cost Estimation + Fund Recovery
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import { MemeKit } from "solana-meme-kit";
|
|
100
|
+
|
|
101
|
+
const estimatedSol = MemeKit.estimateLaunchCost({
|
|
102
|
+
name: "Super Gem",
|
|
103
|
+
symbol: "SGEM",
|
|
104
|
+
image: "https://arweave.net/metadata",
|
|
105
|
+
liquidity: { solAmount: 5, tokenAmount: 800_000_000 },
|
|
106
|
+
dex: "meteora:dlmm",
|
|
107
|
+
jitoTip: "auto",
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
console.log(estimatedSol);
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
```typescript
|
|
114
|
+
import { MemeKit } from "solana-meme-kit";
|
|
115
|
+
|
|
116
|
+
const kit = new MemeKit({
|
|
117
|
+
rpcUrl: "https://api.mainnet-beta.solana.com",
|
|
118
|
+
privateKey: "YOUR_PRIVATE_KEY",
|
|
119
|
+
cluster: "mainnet-beta",
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
const txid = await kit.recoverFunds("DESTINATION_WALLET_ADDRESS");
|
|
123
|
+
console.log(txid);
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## ๐ ๏ธ Architecture
|
|
127
|
+
|
|
128
|
+
```text
|
|
129
|
+
src/
|
|
130
|
+
โโโ core/ # Main SDK and utilities
|
|
131
|
+
โโโ managers/ # Modular components (Token, Market, etc)
|
|
132
|
+
โโโ strategies/ # DEX-specific implementations
|
|
133
|
+
โโโ meteora/ # Meteora DLMM logic
|
|
134
|
+
โโโ raydium/ # Raydium CPMM & AMM logic
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## ๐งช Development
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
bun install
|
|
141
|
+
bun run build
|
|
142
|
+
bun test
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## ๐ Roadmap
|
|
146
|
+
|
|
147
|
+
- [x] Meteora DLMM Integration
|
|
148
|
+
- [x] Raydium CPMM Integration
|
|
149
|
+
- [x] Raydium AMM (Legacy) Integration
|
|
150
|
+
- [x] Jito Bundle Support (Mainnet)
|
|
151
|
+
|
|
152
|
+
## ๐ License
|
|
153
|
+
|
|
154
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "solana-meme-kit",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
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",
|