https://github.com/barkprotocol/blink-ui
BARK Blink is a feature of the BARK platform that streamlines key interactions on the Solana blockchain.
https://github.com/barkprotocol/blink-ui
Last synced: 7 months ago
JSON representation
BARK Blink is a feature of the BARK platform that streamlines key interactions on the Solana blockchain.
- Host: GitHub
- URL: https://github.com/barkprotocol/blink-ui
- Owner: barkprotocol
- License: mit
- Created: 2024-08-18T09:23:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T08:01:14.000Z (almost 2 years ago)
- Last Synced: 2024-12-29T10:44:15.029Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 2.52 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Solana Actions and Blinks
**BARK (Blockchain Asset and Reward Keeper)** is a platform designed to simplify and enhance interactions with blockchain-based assets, particularly on the Solana network. **BARK Blink** is a core feature of this platform, aimed at making blockchain actions more accessible and user-friendly.
## BARK Blink Description
**BARK Blink** streamlines key interactions on the Solana blockchain with a user-friendly interface. It facilitates various tasks such as sending messages, donate, staking tokens, and transferring assets. The goal of BARK Blink is to enhance the efficiency and accessibility of BARK Protocol´s blockchain operations for users.
## Key Features
1. **On-chain Memo**:
- **Description**: Send simple text messages directly to the Solana blockchain using an SPL Memo. Useful for annotating transactions or recording messages permanently on-chain.
2. **Staking**:
- **Description**: Stake SOL or BARK tokens to a validator to help secure the Solana network and earn rewards.
3. **Transfer SOL**:
- **Description**: Transfer native SOL tokens between Solana wallets. Essential for moving assets within the Solana ecosystem.
4. **Transfer SPL Tokens** (Optional):
- **Description**: Transfer BARK or SPL tokens, which are tokens built on the Solana network. This feature is currently commented out but can be enabled for additional functionality.
5. **Mint an NFT** (Optional):
- **Description**: Mint NFTs (Non-Fungible Tokens) on the Solana blockchain. This feature allows users to create unique digital collectibles. It is currently commented out and can be enabled as needed.
6. **Donate**:
- **Description**: Make donations to support causes or projects.
7. **Payments**:
- **Description**: Manage or make payments for various services.
8. **Vote**:
- **Description**: Participate in community or governance voting.
9. **Manage Wallet**:
- **Description**: View and manage wallet settings and details.
## Logical Flow
1. **Landing Page**:
- **Overview**: Users are welcomed with an introduction to BARK and its features.
- **Call to Action**: Options to explore functionalities like sending memos, staking SOL, or transferring assets.
2. **Application Screenshots**:
2.1. **UI/UX**
2.2. **Features**
2.3. **Action**
3. **Feature Selection**:
- Users select the action they wish to perform from a list of available features.
- Each feature includes a description and an icon for easy identification.
4. **Execution of Actions**:
- **On-chain Memo**: Input and submit a message to be recorded on-chain.
- **Staking SOL**: Choose a validator and specify the amount of SOL to stake. The platform processes the staking transaction.
- **Transfer Native SOL**: Enter the recipient's wallet address and the amount of SOL to transfer.
- **Transfer SPL Tokens**: Similar to native SOL transfers but for SPL tokens (if enabled).
- **Mint an NFT**: Select a collection and mint a new NFT (if enabled).
- **Donate**: Make a donation to a selected cause or project.
- **Payments**: Manage or make payments as needed.
- **Vote**: Participate in governance or community voting.
- **Manage Wallet**: Access and adjust wallet settings and details.
5. **Confirmation and Feedback**:
- Receive confirmation of transaction success or failure.
- View transaction details and updated balances or records.
6. **Integration and User Experience**:
- Designed for intuitive navigation and efficient task completion.
- Provides additional resources or help options for users needing assistance.
## Installation
To get started with BARK Blink, follow these steps:
1. **Clone the Repository**
```bash
git clone https://github.com/barkprotocol/bark-actions-blink.git
```
2. **Navigate to the Project Directory**
```bash
cd bark-actions-blink
```
3. **Install Dependencies**
```bash
npm install
```
or
```bash
yarn install
```
4. **Run the Development Server**
```bash
npm run dev
```
or
```bash
yarn dev
```
The app will be available at `http://localhost:3000`.
## Configuration
### Environment Variables
Ensure you have a `.env.local` file in the root of the project with the necessary configuration. For example:
```env
NEXT_PUBLIC_SOLANA_NETWORK=devnet
NEXT_PUBLIC_SOLANA_RPC_URL=https://api.devnet.solana.com
NEXT_PUBLIC_MINT_API_URL=https://api.actions.barkprotocol.net/mint // Example
```
Replace the values with your actual configuration details.
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature/your-feature`).
5. Create a new Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- **Solana**: [Solana](https://solana.com) for the blockchain infrastructure.
- **Next.js**: [Next.js](https://nextjs.org) for the React framework.
- **Lucide Icons**: [Lucide Icons](https://lucide.dev) for the icon library.