Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keep-starknet-strange/joyboy
Decentralized social built with Nostr and powered by Starknet account abstraction.
https://github.com/keep-starknet-strange/joyboy
account-abstraction cairo consumer-app mobile-app nostr nostr-protocol p2p-network react-native social-fi social-network starknet
Last synced: 2 months ago
JSON representation
Decentralized social built with Nostr and powered by Starknet account abstraction.
- Host: GitHub
- URL: https://github.com/keep-starknet-strange/joyboy
- Owner: keep-starknet-strange
- License: mit
- Created: 2024-04-29T07:16:47.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:49:17.000Z (8 months ago)
- Last Synced: 2024-05-22T16:59:36.886Z (8 months ago)
- Topics: account-abstraction, cairo, consumer-app, mobile-app, nostr, nostr-protocol, p2p-network, react-native, social-fi, social-network, starknet
- Language: TypeScript
- Homepage: https://joyboy.community
- Size: 23.3 MB
- Stars: 33
- Watchers: 18
- Forks: 16
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/keep-starknet-strange/joyboy/actions/workflows/starknet-contracts.yml)
[](https://github.com/keep-starknet-strange)
[](https://reactnative.dev/)
[Website](https://www.joyboy.community/) | [Telegram](https://t.me/JoyboyStarknet) | [Twitter](https://x.com/JoyboyStarknet)
## Overview
Decentralized social built with Nostr and powered by Starknet account abstraction.
## Origin story
The name "Joyboy" is inspired by the character from the manga series "One Piece". Joyboy is a mysterious figure from the Void Century who left behind a treasure called the "One Piece". What if the treasure is the friends we made along the way? A decentralized social network should be a treasure trove of memories and connections.
Also, Joyboy refers to a figure in the Caribbean mythology, a dancing god with a constant smile.
> Joyboy is considered as the personification of freedom and joy.
Yes! This is what social networks should be about. A place where you can be yourself, express your thoughts and feelings, and connect with others.
Freedom requires censorship resistance, and Nostr provides exactly that.
## Contribute
Register to [Only Dust](https://onlydust.com/) to get rewarded for your contributions.
Tech stack:
- Starknet smart contracts in Cairo - [Learn Cairo now](https://book.cairo-lang.org/)
- React Native for the mobile app - [Learn React Native now](https://reactnative.dev/docs/tutorial)
- Typescript for the Nostr relayer - [Learn Typescript now](https://www.typescriptlang.org/docs/handbook/2/basic-types.html)
## Roadmap
- [x] Cairo implementation of Nostr signature verification
- [x] Starknet account contract implementation, controlled by Nostr keypair
- [ ] Joyboy landing page
- [x] SocialPay feature to send and receive tips through Nostr signed messages
- [x] Implement a full Nostr client application with Starknet integration
- [x] Run Nostr relay server
- [ ] Crossover with [Vault](https://github.com/keep-starknet-strange/vault) to bring Social features to the Vault application
## Architecture
### Tips
There are two alternatives: WalletConnect, one which expects Nostr users to set up oridinary Starknet wallet like Argent or Braavos, and so called SocialPay which uses custom Account Abstraction contract based on bip340 signature scheme (Nostr native).
#### Wallet Connect
##### Tip to a recipient that never accepted the tip and don't have an account on SN
```mermaid
sequenceDiagram
actor Alice
actor Bob
participant backend as Backend
participant transfer as Deposit Contract
participant erc20 as ERC20
Note over Alice,erc20: Alice tip is escrowed by the Deposit Contract
activate Alice
Alice->>erc20: approve(Deposit Contract, x)
Alice->>transfer: transfer(Bob Nostr Address, x)
transfer->>erc20: transferFrom(Alice, Deposit Contract, x)
transfer->>Alice: deposit_id
deactivate Alice
Note over Alice,erc20: Bob claims the tip with his Nostr identity
activate Bob
Bob->>backend: claim(deposit_id)
Note right of Bob: deposit_id is signed
with Nostr key
backend->>transfer: claim(deposit_id)
transfer->>erc20: transferFrom(Transfer Contract, Bob, x)
deactivate Bob
```
##### Tip to a recipient that earlier accepted the tip
```mermaid
sequenceDiagram
actor Alice
participant transfer as Deposit Contract
participant erc20 as ERC20
activate Alice
Alice->>erc20: approve(Deposit Contract, x)
Alice->>transfer: transfer(Bob Nostr Address, x)
Note left of transfer: Deposit Contract knows
Bob's SN address
transfer->>erc20: transferFrom(Alice, Bob, x)
deactivate Alice
```
#### SocialPay
##### Alice sends tokens to Bob
```mermaid
sequenceDiagram
actor Alice
actor Bob
participant SocialPay gateway
participant Starknet Node
participant Alice Account
participant STRK Token
Alice->>SocialPay gateway: @joyboy send 10 STRK to @bob
activate SocialPay gateway
SocialPay gateway->>Starknet Node: SocialPay transaction
Starknet Node->>Alice Account: SocialPay handler
Alice Account->>STRK Token: transfer
Starknet Node->>SocialPay gateway: SocialPay transaction complete
SocialPay gateway->>Bob: @bob you just received 10 STRK from @alice
SocialPay gateway->>Alice: @alice transfer of 10 STRK to @bob is complete
deactivate SocialPay gateway
```
## Modules
Onchain
The onchain components of the project are implemented as a suite of Starknet smart contracts.
### Build
To build the project, run:
```bash
scarb build
```
### Test
To test the project, run:
```bash
snforge test
```
## Mobile
The Joyboy Mobile app is built with React-native & Expo.
[Current version](https://app.joyboy.community)
[Mobile repo](https://github.com/keep-starknet-strange/joyboy/blob/main/JoyboyCommunity/README.md)
Pick an issue with the labels "mobile" to start work on React-native and contribute!
### Test
To test the mobile app, run:
```bash
cd JoyboyCommunity
yarn install
yarn start
```
Select Expo web, Android or IOS. You can scan it with Expo GO on your phone.
## Resources
- [Starknet](https://starknet.io/)
- [Nostr](https://www.nostr.com/)
- [Nostr Implementation Possibilities](https://github.com/nostr-protocol/nips)
- [JoinStr: Decentralized CoinJoin Implementation Using Nostr](https://www.nobsbitcoin.com/joinstr-decentralized-coinjoin-implementation-using-nostr/)
- [Smart Vaults - Bitcoin multi-custody signature orchestration - website](https://www.smartvaults.io/)
- [Smart Vaults - Bitcoin multi-custody signature orchestration - repo](https://github.com/smartvaults/smartvaults)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Abdel @ StarkWare
💻
Maciej Kamiński @ StarkWare
💻
MSG
💻
Catherine Jonathan
💻
Ayush Tomar
💻
Mubarak Muhammad Aminu
💻
UÄŸur Eren
💻
Oshioke Salaki
💻
Bhavya Gosai
💻
BlackStarkGoku
💻
IsraelRex
🎨
Emmaunuel Ejembi
💻
Abdulhakeem Abdulazeez Ayodeji
💻
Joseph Chimebuka
💻
omahs
💻
Caleb
💻
Ben Ickah
💻
Emmanuel Soetan
💻
princeibs
💻
goofylfg
💻
lfg2
💻
Collins Ikechukwu (devcollins)
💻
petersssong
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!