Boralabs - TBA Project

Introduction

BORAlabs - TBA Project is an Token Bound Account Standard project. We present a groundbreaking NFT market that transcends traditional NFT trading by incorporating the ERC-1155 Multi Token Standard. This project introduces a transformative feature, enabling the transfer of entire wallet (account) ownership through NFT trades. At its core, this project introduces ERC-6551, Token Bound Accounts (TBA) Standard that are tightly connected to NFTs, allowing the seamless transfer of all assets within an account during TBA trades. Join us as we explore these concepts, their real-world applications, and reshape the landscape of blockchain asset ownership and management.

Table of Contents

0. Prerequisite

1. Quick Start

2. Features

3. Examples

4. Licenses

5. References & Docs

---

Prerequisite

System Requirement

• 🐳 Docker Desktop (latest with docker-compose)
• 🥮 Ganache GUI download
• 🟩 Node v18.17 (latest)
• 🐱 Yarn v1.22.19
• 🌐 Chrome Web Browser / with Metamask Extension 🦊
• 📝 Visual Studio Code (Or any text editors of your choice ❤️)
• git (latest)
• WSL 2 (for windows only)

---

Quick Start

Visit our 👉 live demo

Local Environment Setup

Step 1. Install required packages via Yarn

git clone https://github.com/boraecosystem/boralabs-tba
cd ./boralabs-tba
yarn
code . // open your text editor (optional)

NOTE: current directory is your <project_root_dir>

Step 2. Open Ganache GUI

• Refer to 👉 Ganache Quick Start
• Open Ganache > Click Quick start
• Get the Private Key for the first account (Use it for Step 3 and import it to your Metamask)
• Import your private key to your Metamask (Latest version of Chrome Recommended)

How to import a private key to Metamask

Step 3. Deploy Contracts

cd <project_root_dir>
git clone https://github.com/boraecosystem/boralabs-tba-contract ./chain && cd ./chain
yarn
echo DEPLOYER_KEY=<your_private_key> > .env
yarn hardhat compile
yarn hardhat deploy --network ganache_network --tags TBA // press 'Y' to each deployment prompt
cp .env.export ../.env

NOTE: <your_private_key> is the private key you got from Ganache GUI (see step 2)

Also NOTE: By the end of step 3, you will have a .env file contains chain information and contract addresses in your <project_root_dir> directory. Check the result with your text editor.

step 4. Build & Run Application

cd <project_root_dir>
docker-compose up -d

• open http://localhost:8080 on Chrome
• Login with Metamask

---

Features

1. Mint Various Assets:
   • Mint NFT(ERC-721), TBA(ERC-6551), MTS(Multi Token Standard, ERC-1155), and regular FT(ERC-20) for testing purpose.
   • Each token type follows the standard specified with it.
2. Token Conversion:
   • Convert NFT to TBA seamlessly.
3. Asset Transfers:
   • Transfer assets, including NFTs, MTS tokens, and FTs to different addresses both EOA and SCA.
4. View Assets within TBAs:
   • Easily view and manage assets within TBAs, enhancing UX and accessibility.
5. TBA Ownership Transfer:
   • Facilitate the transfer of TBA ownership, enabling seamless mass transaction of assets with just one transaction.
6. Bulk Transfer of MTS:
   • Perform bulk transfers of MTS tokens based on ERC-1155 specifications.

Examples

• Project main page after creating all assets.

• list all existing assets, and send them to other addresses.

• View all assets in TBA token.

• Transfer assets in TBA token to other addresses.

---

Licenses

MIT License, see LICENSE.

---

References & Docs

• ERC-6551 Protocols: https://eips.ethereum.org/EIPS/eip-6551
• ERC-1155 Protocols: https://eips.ethereum.org/EIPS/eip-1155