An open API service indexing awesome lists of open source software.

https://github.com/aarjn/solanaswift

A quick and efficient Solana wallet CLI
https://github.com/aarjn/solanaswift

cli sol solana ssf-2024 typescript wallet web3

Last synced: 2 months ago
JSON representation

A quick and efficient Solana wallet CLI

Awesome Lists containing this project

README

          

# SolanaSwift 🚀

SolanaSwift is a quick and efficient Solana wallet CLI tool for managing Solana transactions on the devnet.

## Install tool from NPM 👀:

- Install cli tool using:
```
npx i solanawallet
```

## Features 🌟

- Create new wallets
- Check wallet balance
- Transfer SOL between wallets
- Request airdrops (on devnet)
- Get wallet address for receiving SOL
- Recover wallet using mnemonic phrase
- Get transactions history

## Installation 🛠️

1. Clone the repository:

```
git clone https://github.com/yourusername/SolanaSwift.git
cd SolanaSwift
```

2. Install dependencies:
```
bun install
```

## Usage 📘

### Create a New Wallet 🆕

Create a new wallet and save the secret key to a file:

```
bun index.ts create-wallet [output-path]
```

- `[output-path]`: Optional. Path to save the wallet secret key (default: `wallet-secret.json`)
- **MAKE SURE YOU SAVE YOU MNEMONIC PHRASE**

### Recover Wallet 🏥

You can recover the wallet using:

```
bun index.ts recover-wallet "your mnemonic phrase here" [output-path]
```

- `[output-path]`: Optional. Path to save the recovered wallet secret key (default: `recovered-wallet-secret.json`)

### Wallet Operations 💼

All wallet operations require the `-k` option to specify the path to your wallet's secret key file.

#### Check Balance 💰

Get the balance of your wallet:

```
bun index.ts wallet -k balance
```

#### Transfer SOL 💸

Transfer SOL to another address:

```
bun index.ts wallet -k transfer
```

- ``: The public key of the recipient's wallet
- ``: The amount of SOL to transfer

#### Get Wallet Address 📫

Display the public address of your wallet:

```
bun index.ts wallet -k address
```

#### Request Airdrop 🪂

Request an airdrop of SOL tokens from the devnet faucet:

```
bun index.ts wallet -k airdrop
```

- ``: The amount of SOL to request (subject to devnet limitations)

#### Transaction History 📝

Get your transactions history :

```
bun index.ts walletk -k history
```

- ``: The amount of SOL to request (subject to devnet limitations)

## To Build

```
bun run build index.ts
```

## Important Notes ⚠️

- This tool connects to the Solana devnet by default.
- Devnet SOL tokens have no real-world value and are for testing purposes only.
- Airdrop functionality is limited by devnet restrictions on amount and frequency.

## Contributing 🤝

Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/4rjun/SolanaSwift/issues).

## License 📄

[MIT](https://choosealicense.com/licenses/mit/)

## Show your support ⭐

Give a ⭐️ if this project helped you!

This project was created using `bun init` in bun v1.1.20. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.