https://github.com/jabolol/packet
Decentralized mobile data marketplace and hackathon winner submission for Block & Change
https://github.com/jabolol/packet
arthera bos near typescript
Last synced: 2 months ago
JSON representation
Decentralized mobile data marketplace and hackathon winner submission for Block & Change
- Host: GitHub
- URL: https://github.com/jabolol/packet
- Owner: Jabolol
- Created: 2023-10-06T17:33:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-18T12:10:19.000Z (over 1 year ago)
- Last Synced: 2025-01-26T11:15:00.024Z (4 months ago)
- Topics: arthera, bos, near, typescript
- Language: TypeScript
- Homepage: https://packet.vercel.app/
- Size: 43.5 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Packet
> **Note**
>
> **1st place** for the
> [`NEAR's BOS Bounty`](https://x.com/BlockandChange/status/1711175532899897844?s=20)
> and [`Arthera's Best DeFi App`](https://x.com/BlockandChange/status/1711175536079184212?s=20) at **Block & Change** Madrid, sponsored by **Telefónica**
A decentralized Mobile Data Marketplace powered by
[`NEAR's BOS`](https://near.org) and the
[`Arthera Blockchain`](https://arthera.net).
This marketplace enables users to buy and sell mobile data in a decentralized
way. It allows users to **buy** and **swap** mobile data from other users, and
**sell** their own mobile data to other users.
Swapping data is a new concept that allows users to exchange their data with
other users, without worrying about the Carrier. This is possible thanks to the
partnerships between them, allowing for a **small** fee to be charged for the
exchange.
The production build of this project is deployed at
[https://packet.vercel.app/](https://packet.vercel.app/).
# Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Custom BOS components](#custom-bos-components)
- [Interaction with the Arthera Blockchain](#interaction-with-the-arthera-blockchain)
- [Introduction](#introduction)
- [Advantages of Packet 🌟](#advantages-of-packet-)
- [Contract Architecture 🛠](#contract-architecture-)
- [Join the Revolution!](#join-the-revolution)
- [Video Showcase](#showcase)
- [Document](#document)
- [Custom hooks](#custom-hooks)
- [Feedback](#feedback)
- [Extras](#extras)
# Features
- [x] Immutable React components stored on the blockchain
- [x] Custom `BOS` implementation
- [x] Interaction from NEAR's `BOS` components with the Arthera Blockchain
- [x] Production ready smart contracts
# Getting Started
1. Clone the repo
```sh
git clone [email protected]:Jabolol/packet.git .
```
2. Install dependencies
```sh
yarn
```
3. Start the development server
```sh
yarn dev
```
4. Fetch the `BOS` components (you'll need to have `bos-cli` installed)
```sh
ID=c5d50293c3a3ed146051462e6e02e469acda10b517bfffeb3d34652076f0cb7c
cd components
bos components download $ID network-config mainnet
```
# Custom BOS components
This project uses `multiple` custom, reusable `BOS` components, built from the
ground up for this project. All the components are open source and stored on the
blockchain. They can be `forked` from
[here](https://near.org/near/widget/ProfilePage?accountId=c5d50293c3a3ed146051462e6e02e469acda10b517bfffeb3d34652076f0cb7c&tab=apps)
- [`AppHero`](./components/src/AppHero.jsx): The hero section of the app itself,
the main dashboard. Dynamically gets the user address and displays
miscelaneous data. It maps the ethereum address to a `Yaypeg` NFT and displays
it as an avatar dynamically.
- [`DataWidget`](./components/src/DataWidget.jsx): A widget that displays a
numeric value and a label. It's used to display the amount of data the user
has available and the amount of data the user has sold, for instance.
- [`Hero`](./components/src/Hero.jsx): The hero section of the landing page. It
enables users to connect their wallet and displays a brief description of the
app.
- [`ImageWidget`](./components/src/ImageWidget.jsx): A widget that displays an
image and a label. It's used to display an icon instead of a number, to show
an abstract concept.
- [`Yaypeg`](./components/src/Yaypeg.jsx): A component that displays a
[`Yaypeg`](https://yaypeg.com) NFT. It's used to display the user's avatar.
Supports multiple options such as `gif` and `illustration`
# Interaction with the Arthera Blockchain
### Introduction
Welcome to **Arthera**, a dynamic blockchain network that acts as the foundation
for **Packet**, an innovative protocol designed using the **DiamondProxy**
pattern. Packet facilitates a semi-decentralized market for mobile data,
allowing users to seamlessly **buy**, **swap**, and **sell** mobile data with
maximized liquidity and user empowerment.
### Advantages of Packet 🌟
1. **Enhanced Data Liquidity**: Ensures mobile data is easily accessible and
tradable, fostering a liquid market.
2. **P2P Deutch Auctions**: Engage in P2P interactions through Dutch auction
mechanisms, guaranteeing fair pricing and democratized data trading.
3. **Efficient Virtual Accounting**: Minimizes gas fees with a virtual
accounting system, while offering the ability to integrate with traditional
accounting systems.
4. **Decentralized Semi-Open Market**: Empowers users with a decentralized
market to autonomously manage their mobile data transactions.
5. **Immutability and Transparency**: Leverage the power of blockchain for
secure, transparent, and immutable transactions.
### Contract Architecture 🛠
Dive into our network's smart contract architecture:
- **Diamond**:
[0x33568Db9cee48eCe446ff56da507A1dFE37006b3](0x33568Db9cee48eCe446ff56da507A1dFE37006b3)
- **DiamondCutFacet**:
[0x03426abCD59086fF6c6952667983dc7E6D442AC4](0x03426abCD59086fF6c6952667983dc7E6D442AC4)
- **DiamondLoupeFacet**:
[0xAc0a54471ce272B0f8468e1b0f48fA26cD456EF7](0xAc0a54471ce272B0f8468e1b0f48fA26cD456EF7)
- **ExchangeFacet**:
[0xF14F7b69B6830008ED9Ce3134afEB37C6bf61d05](0xF14F7b69B6830008ED9Ce3134afEB37C6bf61d05)
- **OwnerFacet**:
[0xdcc3d56db70CE3E439E0674a6c92484eE3513fCD](0xdcc3d56db70CE3E439E0674a6c92484eE3513fCD)
- **TeleoperatorFacet**:
[0x60437552677E1422E01bA6ac32F244cbAebfa55F](0x60437552677E1422E01bA6ac32F244cbAebfa55F)
- **UserFacet**:
[0xd26bfFaDDabf6aaEf9ca7c75ae02F90Ca3bEF3CB](0xd26bfFaDDabf6aaEf9ca7c75ae02F90Ca3bEF3CB)
#### Join the Revolution!
Get started with Packet, and immerse yourself in a realm where mobile data
becomes a tradable, accessible, and affordable commodity for all.
# Video Showcase
https://github.com/Jabolol/packet/assets/74559859/a0a98f03-cdef-4280-87ea-f5e1a63e7516
# Document
You can find the document [here](./assets/Packet.pdf).
# Custom hooks
The `BOS` components interact with the Arthera Blockchain using custom hooks
created with `wagmi`. The hooks are:
- [`useBuyData`](./src/hooks/useBuyDataTokens.tsx): A hook that enables the user
to buy `DataTokens` from the Arthera Blockchain. It uses the `buyData` method.
- [`useUserBalance`](./src/hooks/useUserBalance.tsx): A hook that enables the
user to get their balance of their account from the Arthera Blockchain. It
uses the `balanceOf` method.
- [`useHistory`](./src/hooks/useRecentPurchases.tsx): A hook that enables the
user to get their history of transactions from the Arthera Blockchain. It
listens for the `tokenPurchased` events.
- [`useTotalUsers`](./src/hooks/useTotalUsers.tsx): A hook that enables the user
to get the all the user IDs registered in the smart contract. It uses the
`totalUsers` method.
# Feedback
NEAR's BlockChain OS is a new technology, and being pioneers in this field is
difficult yet rewarding. Not everything worked at the first try, and we had to
make some changes to the `BOS` components to make them work. Nonetheless, once
we got the hang of it, it was a breeze to work with.
The `BOS` components are a great way to build reusable components that can be
used in multiple projects. They are easy to use and easy to deploy. The
possibilities are endless.
One way to improve the experience would be to have TypeScript support, implement
dark mode in the `sandbox` editor, and have another way to deploy the components
without using the private keys but a expiring token instead.
When it cames to the Arthera Blockchain, we had to make some changes to the
smart contracts to make them work with the `BOS` components. Apart from that,
the integration was seamless. Nothing broke, and everything worked as expected!
# Extras
I encountered a problem when trying to deploy the `BOS` components. `useState`
and `useEffect` weren't working for me! After having a chat on NEARs Discord, I
realized that the `bos-gateway` template was heavily outdated.
In order to spare someone else the trouble of finding out what was wrong, I
created a Pull Request to update the template. You can find it here:
https://github.com/near-examples/bos-gateway/pull/3. No matter how small the
change is, it can make a difference!