@dropsy/airdrop 0.2.7 → 0.4.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/package.json CHANGED
@@ -1,59 +1,69 @@
1
- {
2
- "name": "@dropsy/airdrop",
3
- "version": "0.2.7",
4
- "description": "Dropsy - The Token Districution Layer on SOLANA",
5
- "main": "./dist/index.js",
6
- "module": "./dist/index.mjs",
7
- "types": "./dist/index.d.ts",
8
- "publishConfig": {
9
- "access": "public"
10
- },
11
- "homepage": "https://docs.dropsy.xyz/",
12
- "repository": {
13
- "url": "https://github.com/scoolmb/dropsy-airdrop"
14
- },
15
- "scripts": {
16
- "test": "ts-node index.ts",
17
- "build": "tsup"
18
- },
19
- "keywords": [
20
- "solana",
21
- "solana airdrop",
22
- "web3",
23
- "create airdrop",
24
- "solana web3",
25
- "dropsy",
26
- "solana devtools",
27
- "token distribution",
28
- "airdrop protocol",
29
- "solana sdk",
30
- "merkle airdrop",
31
- "gasless airdrop",
32
- "solana token launch",
33
- "nft airdrop",
34
- "decentralized distribution",
35
- "solana-program-library",
36
- "anchor program",
37
- "spl token",
38
- "solana crypto",
39
- "airdrop automation",
40
- "web3 rewards",
41
- "solana developer tools"
42
- ],
43
- "author": "MBK Official",
44
- "license": "MIT",
45
- "devDependencies": {
46
- "@solana-program/token": "^0.9.0",
47
- "@solana/kit": "^5.0.0",
48
- "@types/node": "^22.15.29",
49
- "merkletreejs": "^0.6.0",
50
- "tsup": "^8.5.0",
51
- "typedoc": "^0.28.5",
52
- "typescript": "^5.8.3"
53
- },
54
- "peerDependencies": {
55
- "@solana-program/token": "^0.9.0",
56
- "@solana/kit": "^5.0.0",
57
- "merkletreejs": "^0.6.0"
58
- }
59
- }
1
+ {
2
+ "name": "@dropsy/airdrop",
3
+ "version": "0.4.0",
4
+ "description": "Dropsy - The Token Distribution Layer on SOLANA - A powerful and flexible airdrop protocol for seamless token distribution on the Solana blockchain.",
5
+ "main": "./dist/index.js",
6
+
7
+ "module": "./dist/index.mjs",
8
+ "types": "./dist/index.d.ts",
9
+ "publishConfig": {
10
+ "access": "public"
11
+ },
12
+ "homepage": "https://docs.dropsy.org/",
13
+ "repository": {
14
+ "url": "https://github.com/scoolmb/dropsy-airdrop"
15
+ },
16
+ "scripts": {
17
+ "test": "ts-node index.ts",
18
+ "build": "tsup"
19
+ },
20
+ "keywords": [
21
+ "solana",
22
+ "solana airdrop",
23
+ "web3",
24
+ "create airdrop",
25
+ "solana web3",
26
+ "dropsy",
27
+ "solana devtools",
28
+ "token distribution",
29
+ "airdrop protocol",
30
+ "solana sdk",
31
+ "merkle airdrop",
32
+ "gasless airdrop",
33
+ "solana token launch",
34
+ "nft airdrop",
35
+ "decentralized distribution",
36
+ "solana-program-library",
37
+ "anchor program",
38
+ "spl token",
39
+ "solana crypto",
40
+ "airdrop automation",
41
+ "web3 rewards",
42
+ "solana developer tools",
43
+ "solana token distribution",
44
+ "solana airdrop protocol",
45
+ "solana token airdrop",
46
+ "solana token distribution protocol",
47
+ "solana token launchpad",
48
+ "solana token marketing",
49
+ "solana token rewards",
50
+ "solana token giveaway",
51
+ "solana token raffles"
52
+ ],
53
+ "author": "MBK Official",
54
+ "license": "MIT",
55
+ "peerDependencies": {
56
+ "@solana-program/token": "^0.13.0",
57
+ "@solana/kit": "^6.8.0",
58
+ "merkletreejs": "^0.6.0"
59
+ },
60
+ "devDependencies": {
61
+ "@types/node": "^25.6.0",
62
+ "tsup": "^8.5.1",
63
+ "tsx": "^4.21.0",
64
+ "typescript": "^5.9.3"
65
+ },
66
+ "dependencies": {
67
+ "@dropsy/airdrop": "file:dropsy-airdrop-0.4.0.tgz"
68
+ }
69
+ }
package/readme.md CHANGED
@@ -1,153 +1,60 @@
1
- # dropsy-airdrop beta
2
-
3
- [![npm version](https://img.shields.io/npm/v/@dropsy/airdrop.svg)](https://www.npmjs.com/package/@dropsy/airdrop)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
- [![Docs](https://img.shields.io/badge/docs-online-blue)](https://scoolmb.github.io/dropsy-airdrop/)
6
-
7
- A modern client SDK for interacting with the **Dropsy Airdrop Protocol** on Solana, built with:
8
-
9
- - TypeScript
10
- - ⚙️ [tsup](https://github.com/egoist/tsup) for fast bundling
11
- - 🔀 Dual CJS (`require`) and ESM (`import`) support
12
- - 📦 Auto-generated type declarations
13
-
14
- ## 🚨 Important Notes
15
-
16
- ⚠️ This SDK is in active development
17
- ⚠️ All program addresses are temporary
18
- ⚠️ Instruction formats may change without warning
19
- ⚠️ Devnet only - no mainnet support yet
20
-
21
- ## 🛠 What's New ??
22
-
23
- New instructions :
24
-
25
- 1 - delegate_airdrop
26
- This instruction allows a designated authority to manage airdrop allocations on behalf of the original distributor. It is particularly useful for delegating airdrop responsibilities to trusted parties or third-party services, enabling decentralized management of token distributions.
27
-
28
- 2 - update_airdrop
29
- The update_airdrop instruction enables the modification of existing airdrop configurations. This includes updating the list of eligible recipients (via the Merkle root) and adjusting the timing (start/end dates).
30
- This provides flexibility for creating Quest-based airdrops on top of Snapshot-based airdrops, delegated by third parties such as Quest platforms or NFT platforms.
31
-
32
- update on airdrop Account :
33
- Airdrop = {
34
- discriminator: ReadonlyUint8Array;
35
- authority: Address;
36
- mint: Address;
37
- controller: Address;
38
- delegateAuthority: Address; // recently adedd
39
- merkleRoot: Array<number>;
40
- supply: bigint;
41
- startsAt: bigint;
42
- endsAt: bigint;
43
- bitmapCount: number;
44
- delegatePermissions: number; // recently adedd
45
- version: number;
46
- bump: number;
47
- };
48
-
49
- **📖 Interactive Documentation**
50
- Full API docs with live examples
51
-
52
- **🧪 Testnet Sandbox**
53
- Try before you integrate
54
-
55
- **🎮 CLI Interface**
56
- Command-line airdrop management
57
-
58
- ## 🔭 Current Status (v0.β)
59
-
60
- - **Network**: Devnet only
61
- - **Stability**: Experimental
62
- - **Program ID**: Subject to change
63
- - **Roadmap**: Mainnet launch
64
-
65
- > Full API documentation: [https://docs.dropsy.xyz/](https://docs.dropsy.xyz/)
66
-
67
- ## Installation
68
-
69
- ```bash
70
- npm install @dropsy/airdrop
71
- # or
72
- yarn add @dropsy/airdrop
73
- # or
74
- pnpm add @dropsy/airdrop
75
- ```
76
-
77
- The @solana/kit is required if not already installed:
78
-
79
- # Using npm
80
-
81
- npm install @solana/kit
82
-
83
- # Using yarn
84
-
85
- yarn add @solana/kit
86
-
87
- ## Examples
88
-
89
- Examples are available in the [examples](./examples) folder.
90
- Feel free to explore, modify, and use them as a starting point for your own work.
91
-
92
- ## Features
93
-
94
- 🚀 Controller – The Heart of Your Airdrop Platform
95
- One of the most exciting parts of our protocol is the Controller.
96
-
97
- A Controller acts as the foundation for creating and managing airdrops. By initializing your own controller, you can build a fully self-managed airdrop platform — and alse earn protocol fees from all the airdrops created using it.
98
-
99
- What is a Controller?
100
- A Controller is a special on-chain account that:
101
-
102
- Registers ownership over a set of airdrops.
103
-
104
- Collects protocol-level fees.
105
-
106
- Allows anyone to create token airdrops under your control.
107
-
108
- Why Use a Controller?
109
-
110
- 💸 Monetize: Earn fees from every airdrop created using your controller.
111
-
112
- 🛠️ Customize: Tailor your airdrop platform around it.
113
-
114
- 🌐 Permissionless: Anyone can initialize a controller and start building.
115
-
116
- How to Initialize a Controller :
117
-
118
- ```bash
119
- import * as dropsy from "@dropsy/airdrop";
120
-
121
- // Create the instruction to initialize your controller
122
- const ix = await dropsy.getInitializeControllerInstructionAsync({
123
- authority: wallet, // the owner of the controller (the signer )
124
- feeLamports: BigInt(5000), // The fee lamports others will pay when c using your controller
125
- });
126
- ```
127
-
128
- Get initialize airdrop instruction :
129
-
130
- ```bash
131
- import * as dropsy from "@dropsy/airdrop";
132
-
133
- // Create the instruction to initialize your controller
134
- const ix = dropsy.getInitializeAirdropInstructionAsync({
135
- authority: wallet, // signer (airdrop creator)
136
- mint: mint, // token mint address
137
- controller: controller, // controller ( fee collector )
138
- merkleRoot: merkleRootArray, // merkle root as an array where all eligible wallets with amount
139
- startsTime: null, // BigInt(.....) // time when the airdrop will start (default is now )
140
- endTime: null, // BigInt(.....) // time when the airdrop will end (default is after 60 days )
141
- });
142
- ```
143
-
144
- checkout the init-airdrop.ts in the examples folder to discover how to create merkleRoot
145
-
146
- ## 📚 Documentation
147
-
148
- Full API documentation is available at
149
- 👉 [https://docs.dropsy.xyz/](https://docs.dropsy.xyz/)
150
-
151
- ```
152
-
153
- ```
1
+ # dropsy-airdrop
2
+
3
+ ## What is Dropsy ?
4
+
5
+ Dropsy Protocol is the token distribution layer for Solana, enabling creators, protocols, and teams to distribute tokens with zero friction.
6
+
7
+ With Airdrop Master, teams can create their own airdrop systems, customize fee models, and even build entire token-distribution products on top of Dropsy.
8
+
9
+ ## What You Can Build ?
10
+
11
+ - Airdrop launchpads
12
+ - Claim portals
13
+ - Community reward apps
14
+ - Platform-level distribution tools (with your own fee model)
15
+ - Growth, referral, or engagement incentive systems
16
+ **Dropsy** is built to unlock a wild range of Web3 opportunities, empowering teams to launch incentives, boost growth, and create meaningful reward experiences with ease.
17
+
18
+ ## 🚨 Important Notes
19
+
20
+ ⚠️ This SDK is in active development
21
+ ⚠️ All program addresses are temporary
22
+ ⚠️ Instruction formats may change without warning
23
+ ⚠️ Devnet only - no mainnet support yet
24
+
25
+ ## 🔭 Current Status (v0.β)
26
+
27
+ - **Network**: Devnet only
28
+ - **Stability**: Experimental
29
+ - **Program ID**: Subject to change
30
+
31
+ > Full API documentation: [https://docs.dropsy.org/](https://docs.dropsy.org/)
32
+
33
+ ## Installation
34
+
35
+ ```bash
36
+ npm install @dropsy/airdrop
37
+ # or
38
+ yarn add @dropsy/airdrop
39
+ # or
40
+ pnpm add @dropsy/airdrop
41
+ ```
42
+
43
+ The @solana/kit and @solana-program/token are required if not already installed:
44
+
45
+ # Using npm
46
+
47
+ npm install @solana/kit @solana-program/token
48
+
49
+ # Using yarn
50
+
51
+ yarn add @solana/kit @solana-program/token
52
+
53
+ ## Examples
54
+
55
+ **Examples** under update (coming soon)
56
+
57
+ ## 📚 Documentation
58
+
59
+ Full documentation is available at
60
+ 👉 [https://docs.dropsy.org/](https://docs.dropsy.org/)