https://github.com/milojebtc/btc-brc20-5bytes-public
This repository provides a streamlined implementation of the Bitcoin BRC-20 protocol, specifically designed for handling 5-byte operations. The project focuses on simplicity, scalability, and compatibility with the broader Bitcoin ecosystem while maintaining the core principles of decentralization and security.
https://github.com/milojebtc/btc-brc20-5bytes-public
5bytes bitcoin blockchain brc20 btc deploy mint transfer
Last synced: about 2 months ago
JSON representation
This repository provides a streamlined implementation of the Bitcoin BRC-20 protocol, specifically designed for handling 5-byte operations. The project focuses on simplicity, scalability, and compatibility with the broader Bitcoin ecosystem while maintaining the core principles of decentralization and security.
- Host: GitHub
- URL: https://github.com/milojebtc/btc-brc20-5bytes-public
- Owner: milojeBtc
- Created: 2024-12-30T17:29:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-16T20:16:28.000Z (3 months ago)
- Last Synced: 2025-08-16T22:10:40.855Z (3 months ago)
- Topics: 5bytes, bitcoin, blockchain, brc20, btc, deploy, mint, transfer
- Homepage:
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# Bitcoin BRC-20 5Bytes
## Overview
This repository provides a streamlined implementation of the Bitcoin BRC-20 protocol, specifically designed for handling 5-byte operations. The project focuses on simplicity, scalability, and compatibility with the broader Bitcoin ecosystem while maintaining the core principles of decentralization and security.
## Features
- **Advantages of 5-Byte Standard**: The 5-byte BRC-20 standard offers improved efficiency and scalability compared to previous versions by reducing data overhead. This enables faster transaction processing, lower storage requirements, and better compatibility with lightweight applications.
- **5-Byte Compatibility**: Optimized for operations using the 5-byte standard, enabling efficient and lightweight token transfers.
- **Express Framework**: Built using the Express.js framework for rapid API development and robust backend functionality.
- **TypeScript Support**: Fully typed for enhanced developer productivity, maintainability, and reduced runtime errors.
- **MongoDB Integration**: A reliable and scalable database for storing and managing transaction data.
- **Unisat API Integration**: Utilizes the Unisat API for seamless interaction with the Bitcoin network, eliminating the need for a local Bitcoin Core instance.
## Getting Started
### Prerequisites
Ensure you have the following installed:
- Node.js (>= 16.0.0)
- MongoDB (>= 4.4)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/milojeBtc/btc-brc20-5bytes-private.git
cd bitcoin-brc20-5bytes
```
2. Install dependencies:
```bash
npm install
```
3. Configure the environment variables:
Create a `.env` file in the root directory and populate it with the required variables. See `.env.example` for reference.
4. Start the development server:
```bash
npm run dev
```
5. Access the application at `http://localhost:3000`.
## Usage
- **API Endpoints**: A comprehensive set of API endpoints is provided for creating, managing, and transferring BRC-20 tokens. Refer to the [API Documentation](https://open-api-testnet.unisat.io/swagger.html) for details.
- **CLI Tool**: A command-line interface is available for performing common operations. Run `npm run cli --help` for usage instructions.
## Contributing
We welcome contributions from the community! To contribute:
1. Fork the repository.
2. Create a feature branch: `git checkout -b feature-name`
3. Commit your changes: `git commit -m 'Add feature-name'`
4. Push to the branch: `git push origin feature-name`
5. Open a pull request.
### Connect With Me:
[](mailto:nikolic.miloje0507@gmail.com)
[](https://t.me/mylord1_1)
[](https://join.skype.com/ubWuVGchDEnU)
[](https://discord.com/users/509337382810550280)