@dropsy/airdrop 0.0.3 → 0.1.1

package/package.json

@@ -1,52 +1,57 @@
-{
-  "name": "@dropsy/airdrop",
-  "version": "0.0.3",
-  "description": "TypeScript SDK for interacting with the Dropsy on-chain Solana airdrop protocol. Easily create, manage, and claim airdrops from any Solana-based dApp.",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "homepage": "https://github.com/scoolmb/dropsy-airdrop",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/scoolmb/dropsy-airdrop"
-  },
-  "scripts": {
-    "build": "tsup",
-    "docs": "typedoc",
-    "deploy:docs": "gh-pages -d docs"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "keywords": [
-    "solana",
-    "airdrop",
-    "web3",
-    "solana-sdk",
-    "solana-airdrop",
-    "dropsy",
-    "typescript",
-    "client-sdk",
-    "anchor",
-    "claim-tokens",
-    "solana-dapp",
-    "claim-solana-dapp",
-    "solana-airdrop-dapp"
-  ],
-  "author": "MBK Official",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/node": "^22.15.29",
-    "gh-pages": "^6.3.0",
-    "tsup": "^8.5.0",
-    "typedoc": "^0.28.5",
-    "typescript": "^5.8.3"
-  },
-  "dependencies": {
-    "@solana/kit": "^2.1.1"
-  }
-}
+{
+  "name": "@dropsy/airdrop",
+  "version": "0.1.1",
+  "description": "Dropsy - The On-Chain Airdrop Protocol for Solana",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://docs.dropsy.xyz/",
+  "repository": {
+    "url": "https://github.com/scoolmb/dropsy-airdrop"
+  },
+  "scripts": {
+    "test": "ts-node index.ts",
+    "build": "tsup"
+  },
+  "keywords": [
+    "solana",
+    "solana airdrop",
+    "web3",
+    "create airdrop",
+    "solana web3",
+    "dropsy",
+    "solana devtools",
+    "token distribution",
+    "airdrop protocol",
+    "solana sdk",
+    "merkle airdrop",
+    "gasless airdrop",
+    "solana token launch",
+    "nft airdrop",
+    "decentralized distribution",
+    "solana-program-library",
+    "anchor program",
+    "spl token",
+    "solana crypto",
+    "airdrop automation",
+    "web3 rewards",
+    "solana developer tools"
+  ],
+  "author": "MBK Official",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^22.15.29",
+    "tsup": "^8.5.0",
+    "typedoc": "^0.28.5",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@solana-program/compute-budget": "^0.8.0",
+    "@solana-program/token": "^0.5.1",
+    "@solana/kit": "^2.1.1",
+    "merkletreejs": "^0.5.2"
+  }
+}

package/readme.md

@@ -0,0 +1,153 @@
+# dropsy-airdrop beta
+
+[![npm version](https://img.shields.io/npm/v/@dropsy/airdrop.svg)](https://www.npmjs.com/package/@dropsy/airdrop)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://scoolmb.github.io/dropsy-airdrop/)
+
+A modern client SDK for interacting with the **Dropsy Airdrop Protocol** on Solana, built with:
+
+- ✅ TypeScript
+- ⚙️ [tsup](https://github.com/egoist/tsup) for fast bundling
+- 🔀 Dual CJS (`require`) and ESM (`import`) support
+- 📦 Auto-generated type declarations
+
+## 🚨 Important Notes
+
+⚠️ This SDK is in active development  
+⚠️ All program addresses are temporary  
+⚠️ Instruction formats may change without warning  
+⚠️ Devnet only - no mainnet support yet
+
+## 🛠 What's New ??
+
+New instructions :
+
+1 - delegate_airdrop
+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.
+
+2 - update_airdrop
+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).
+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.
+
+update on airdrop Account :
+Airdrop = {
+discriminator: ReadonlyUint8Array;
+authority: Address;
+mint: Address;
+controller: Address;
+delegateAuthority: Address; // recently adedd
+merkleRoot: Array<number>;
+supply: bigint;
+startsAt: bigint;
+endsAt: bigint;
+bitmapCount: number;
+delegatePermissions: number; // recently adedd
+version: number;
+bump: number;
+};
+
+**📖 Interactive Documentation**  
+Full API docs with live examples
+
+**🧪 Testnet Sandbox**  
+Try before you integrate
+
+**🎮 CLI Interface**  
+Command-line airdrop management
+
+## 🔭 Current Status (v0.β)
+
+- **Network**: Devnet only
+- **Stability**: Experimental
+- **Program ID**: Subject to change
+- **Roadmap**: Mainnet launch
+
+> Full API documentation: [https://docs.dropsy.xyz/](https://docs.dropsy.xyz/)
+
+## Installation
+
+```bash
+npm install @dropsy/airdrop
+# or
+yarn add @dropsy/airdrop
+# or
+pnpm add @dropsy/airdrop
+```
+
+The @solana/kit is required if not already installed:
+
+# Using npm
+
+npm install @solana/kit
+
+# Using yarn
+
+yarn add @solana/kit
+
+## Examples
+
+Examples are available in the [examples](./examples) folder.  
+Feel free to explore, modify, and use them as a starting point for your own work.
+
+## Features
+
+🚀 Controller – The Heart of Your Airdrop Platform
+One of the most exciting parts of our protocol is the Controller.
+
+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.
+
+What is a Controller?
+A Controller is a special on-chain account that:
+
+Registers ownership over a set of airdrops.
+
+Collects protocol-level fees.
+
+Allows anyone to create token airdrops under your control.
+
+Why Use a Controller?
+
+💸 Monetize: Earn fees from every airdrop created using your controller.
+
+🛠️ Customize: Tailor your airdrop platform around it.
+
+🌐 Permissionless: Anyone can initialize a controller and start building.
+
+How to Initialize a Controller :
+
+```bash
+import * as dropsy from "@dropsy/airdrop";
+
+// Create the instruction to initialize your controller
+const ix = await dropsy.getInitializeControllerInstructionAsync({
+authority: wallet, // the owner of the controller (the signer )
+feeLamports: BigInt(5000), // The fee lamports others will pay when c using your controller
+});
+```
+
+Get initialize airdrop instruction :
+
+```bash
+import * as dropsy from "@dropsy/airdrop";
+
+// Create the instruction to initialize your controller
+const ix = dropsy.getInitializeAirdropInstructionAsync({
+    authority: wallet,   // signer (airdrop creator)
+    mint: mint,       // token mint address
+    controller: controller,     // controller ( fee collector )
+    merkleRoot: merkleRootArray,    // merkle root as an array where all eligible wallets with amount
+    startsTime: null,  // BigInt(.....)   // time when the airdrop will start (default is now )
+    endTime: null,   // BigInt(.....)    // time when the airdrop will end (default is after 60 days  )
+});
+```
+
+checkout the init-airdrop.ts in the examples folder to discover how to create merkleRoot
+
+## 📚 Documentation
+
+Full API documentation is available at
+👉 [https://docs.dropsy.xyz/](https://docs.dropsy.xyz/)
+
+```
+
+```

package/README.md

@@ -1,30 +0,0 @@
-# dropsy-airdrop beta
-
-[![npm version](https://img.shields.io/npm/v/@dropsy/airdrop.svg)](https://www.npmjs.com/package/@dropsy/airdrop)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Docs](https://img.shields.io/badge/docs-online-blue)](https://scoolmb.github.io/dropsy-airdrop/)
-
-A modern client SDK for interacting with the **Dropsy Airdrop Protocol** on Solana, built with:
-
-- ✅ TypeScript
-- ⚙️ [tsup](https://github.com/egoist/tsup) for fast bundling
-- 🔀 Dual CJS (`require`) and ESM (`import`) support
-- 📦 Auto-generated type declarations
-- 🌐 Web3-ready & optimized for dApp integration
-
-> Full API documentation: [https://scoolmb.github.io/dropsy-airdrop](https://scoolmb.github.io/dropsy-airdrop)
-
-## Installation
-
-```bash
-npm install @dropsy/airdrop
-# ora
-yarn add @dropsy/airdrop
-# or
-pnpm add @dropsy/airdrop
-```
-
-## 📚 Documentation
-
-Full API documentation is available at  
-👉 [https://scoolmb.github.io/dropsy-airdrop/](https://scoolmb.github.io/dropsy-airdrop/)