Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helius-labs/airship
Helius AirShip is an open-source tool that simplifies and reduces the cost of Solana token airdrops, offering both web and CLI versions.
https://github.com/helius-labs/airship
airdrop helius solana zk zk-compression
Last synced: 4 days ago
JSON representation
Helius AirShip is an open-source tool that simplifies and reduces the cost of Solana token airdrops, offering both web and CLI versions.
- Host: GitHub
- URL: https://github.com/helius-labs/airship
- Owner: helius-labs
- License: apache-2.0
- Created: 2024-08-08T12:12:37.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T20:30:09.000Z (30 days ago)
- Last Synced: 2024-12-10T01:32:28.352Z (13 days ago)
- Topics: airdrop, helius, solana, zk, zk-compression
- Language: TypeScript
- Homepage: https://airship.helius.dev
- Size: 9.25 MB
- Stars: 41
- Watchers: 2
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Helius AirShip
Helius AirShip is an open-source tool that makes token airdrops simple, affordable, and accessible. Whether you're distributing to Saga Chapter 2 holders, NFT/cNFT holders, SPL token holders, or using a CSV file, Helius AirShip streamlines the process and cuts costs.
## Features
- 🚀 **Simplified Airdrops**: Easy token airdrops for all, no technical skills needed.
- 💸 **ZK Compression**: Cut costs on large airdrops by reducing account usage. [More info](https://www.zkcompression.com/).
- 🖥️ **Web Version**: Perfect for small airdrops, up to 200,000 recipients.
- **CLI Version**: For advanced users needing larger-scale distribution.
## Web Version
### Requirements
- RPC that supports both ZK Compression and the DAS API. If you don't have one, you can get one for free at https://www.helius.dev
### Public Web Version
You can find public web version of Helius AirShip [here](https://airship.helius.dev).
### Run locally from source
```bash
git clone https://github.com/helius-labs/airship.git
cd airship
pnpm install
cd apps/web
pnpm preview
```
Open http://localhost:4173/
## CLI Version
### Requirements
- Ensure you have Node >= v20.9.0 installed on your machine.
- You will need an RPC that supports both ZK Compression and the DAS API. If you don't have one, you can get one for free at https://www.helius.dev
- You will need a valid Solana filesystem wallet. If you don't have one yet, visit the [Solana documentation](https://docs.solanalabs.com/cli/wallets/file-system) for details. The CLI will use this wallet for signing transactions, covering transaction fees, and as the owner of the token you wish to distribute.
### Installation
#### Using npm
```bash
npm install -g helius-airship
```
#### Build from source using pnpm
```bash
git clone https://github.com/helius-labs/airship.git
cd airship
pnpm install && pnpm build
cd packages/cli
pnpm link --global
helius-airship --help
```
### Example
To perform an airdrop, use the following command and follow the steps:
```bash
helius-airship --keypair /path/to/your/airdrop_wallet.json --url https://mainnet.helius-rpc.com/?api-key=
```
Replace `/path/to/your/airdrop_wallet.json` with the path to your Solana filesystem wallet that holds the token you wish to distribute and some SOL to pay for the transaction fees. Replace `https://mainnet.helius-rpc.com/?api-key=` with your RPC URL and API key.