Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SocialPay sequence diagram #28

Merged
merged 2 commits into from
May 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,37 @@ Freedom requires censorship resistance, and Nostr provides exactly that.

## Roadmap

- [ ] Cairo implementation of Nostr signature verification
- [x] Cairo implementation of Nostr signature verification
- [ ] Starknet account contract implementation, controlled by Nostr keypair
- [ ] Simple frontend to sign and verify messages (using a browser extension lke [Flamingo](https://www.getflamingo.org/) or any other [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) compatible extension, list can be found [here](https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions))
- [ ] Joyboy landing page
- [ ] SocialPay feature to send and receive tips through Nostr signed messages
- [ ] Implement a full Nostr client application with Starknet integration
- [ ] Run Nostr relay server
- [ ] Crossover with [Vault](https://github.com/keep-starknet-strange/vault) to bring Social features to the Vault application

## Architecture
### SocialPay
#### Alice sends tokens to Bob
```mermaid
sequenceDiagram
actor Alice
actor Bob
participant SocialPay relay
participant Starknet Node
participant Alice Account
participant STRK Token

Alice->>SocialPay relay: @joyboy send 10 STRK to @bob
activate SocialPay relay
SocialPay relay->>Starknet Node: SocialPay transaction
Starknet Node->>Alice Account: SocialPay handler
Alice Account->>STRK Token: transfer
Starknet Node->>SocialPay relay: SocialPay transaction complete
SocialPay relay->>Bob: @bob you just recived 10 STRK from @alice
SocialPay relay->>Alice: @alice transfer of 10 STRK to @bob is complete
deactivate SocialPay relay
```

## Modules

<details>
Expand Down
Loading