solana-meme-kit 0.1.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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +88 -0
  3. package/package.json +51 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Solana Meme Kit
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # solana-meme-kit
2
+
3
+ **The All-in-One SDK for launching Solana Tokens.**
4
+
5
+ [![npm version](https://img.shields.io/npm/v/solana-meme-kit.svg)](https://www.npmjs.com/package/solana-meme-kit)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
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
+
10
+
11
+ ## โœจ Core Features
12
+
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).
21
+ - **Security**: Built-in helpers to revoke Mint and Freeze authorities.
22
+
23
+ ## ๐Ÿ“ฆ Installation
24
+
25
+ ```bash
26
+ bun add solana-meme-kit
27
+ # or
28
+ npm install solana-meme-kit
29
+ ```
30
+
31
+ ## ๐Ÿ’ป Usage
32
+
33
+ ### Basic Launch
34
+
35
+ ```typescript
36
+ import { MemeKit } from 'solana-meme-kit';
37
+
38
+ // 1. Initialize
39
+ const kit = new MemeKit({
40
+ rpcUrl: process.env.RPC_URL!,
41
+ privateKey: process.env.PRIVATE_KEY!,
42
+ cluster: 'mainnet' // 'mainnet' | 'devnet'
43
+ });
44
+
45
+ // 2. Launch
46
+ const result = await kit.launch({
47
+ // Token
48
+ name: 'Cool Token',
49
+ symbol: 'COOL',
50
+ image: 'https://arweave.net/metadata-uri',
51
+ supply: 1_000_000_000,
52
+
53
+ // Liquidity
54
+ solLiquidityAmount: 5,
55
+ tokenLiquidityAmount: 800_000_000,
56
+
57
+ // Advanced Config
58
+ marketMode: 'low-cost', // Optimizes rent costs
59
+ jitoTipAmount: 0.01,
60
+ });
61
+
62
+ console.log('Launch Bundle:', result.bundleId);
63
+ ```
64
+
65
+ ## ๐Ÿ› ๏ธ Architecture
66
+
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.
72
+
73
+ ## ๐Ÿงช Development
74
+
75
+ ```bash
76
+ # Install dependencies
77
+ bun install
78
+
79
+ # Run Tests
80
+ bun test
81
+
82
+ # Build
83
+ bun run build
84
+ ```
85
+
86
+ ## ๐Ÿ“„ License
87
+
88
+ MIT
package/package.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "name": "solana-meme-kit",
3
+ "version": "0.1.0",
4
+ "description": "The abstracted shovel for launching professional Solana tokens. Automated Low-Cost OpenBook Markets and Jito Bundles.",
5
+ "module": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "scripts": {
11
+ "build": "tsc",
12
+ "test": "bun test"
13
+ },
14
+ "license": "MIT",
15
+ "private": false,
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "https://github.com/DarkShark-RAz/solana-meme-kit.git"
19
+ },
20
+ "keywords": [
21
+ "solana",
22
+ "meme",
23
+ "token",
24
+ "launchpad",
25
+ "openbook",
26
+ "raydium",
27
+ "jito"
28
+ ],
29
+ "devDependencies": {
30
+ "@types/bn.js": "^5.2.0",
31
+ "@types/bs58": "^5.0.0",
32
+ "@types/bun": "latest"
33
+ },
34
+ "peerDependencies": {
35
+ "typescript": "^5.9.3"
36
+ },
37
+ "dependencies": {
38
+ "@metaplex-foundation/mpl-token-metadata": "^3.4.0",
39
+ "@metaplex-foundation/umi": "^1.4.1",
40
+ "@metaplex-foundation/umi-bundle-defaults": "^1.4.1",
41
+ "@openbook-dex/openbook": "^0.0.9",
42
+ "@raydium-io/raydium-sdk": "^1.3.1-beta.58",
43
+ "@raydium-io/raydium-sdk-v2": "^0.2.32-alpha",
44
+ "@solana/spl-token": "^0.4.14",
45
+ "@solana/web3.js": "^1.98.4",
46
+ "bn.js": "^5.2.2",
47
+ "bs58": "^6.0.0",
48
+ "dotenv": "^17.2.3",
49
+ "jito-ts": "^4.2.1"
50
+ }
51
+ }