Skip to content

Commit

Permalink
Update readme.md to include new architecture design and markoff compl…
Browse files Browse the repository at this point in the history
…eted tasks
  • Loading branch information
eliashezron authored May 23, 2024
1 parent 78a8e60 commit e10fc1d
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Karst is a web3 social graph on Starknet. it aims to build a social infrastructu

## TODOS

- [ ] Implement `create profiles contract` functionality using `erc6551`
- [x] Implement `create profiles contract` functionality using `erc6551`
- [x] Implement `create profile` functionality
- [x] Implement `setProfileMetadataURI` functionality
- [x] Write test for `createProfile` and related `profile` functions
Expand All @@ -17,19 +17,19 @@ Karst is a web3 social graph on Starknet. it aims to build a social infrastructu
- [ ] Implement `quote` functionality
- [ ] implement `tipPost` functionality
- [ ] implement `follow` functionality from followNFT
- [ ] Implement `FollowNFT` contract
- [ ] implement `unwrap` functionality
- [ ] Implement `approveFollow` functionality
- [ ] Implement `removeFollower` functionality
- [ ] Implement `wrap` functionality
- [ ] Implement `follow` functionality
- [ ] Implement `unfollow` functionality
- [ ] Implement `getOriginalFollowTimestamp` functionality
- [ ] Implement `getFollowTimestamp` functionality
- [ ] Implement `getProfileIdAllowedToRecover` functionality
- [ ] Implement `getFollowData` functionality
- [ ] Implement `getFollowApproved` functionality
- [ ] Implement `getFollowerCount` functionality
- [x] Implement `FollowNFT` contract
- [x] implement `unwrap` functionality
- [x] Implement `approveFollow` functionality
- [x] Implement `removeFollower` functionality
- [x] Implement `wrap` functionality
- [x] Implement `follow` functionality
- [x] Implement `unfollow` functionality
- [x] Implement `getOriginalFollowTimestamp` functionality
- [x] Implement `getFollowTimestamp` functionality
- [x] Implement `getProfileIdAllowedToRecover` functionality
- [x] Implement `getFollowData` functionality
- [x] Implement `getFollowApproved` functionality
- [x] Implement `getFollowerCount` functionality
- Implement `addDelegate` functionality
- [ ] Implement indexing of publish contract
- [ ] indexing shall be done with [arweave](https://www.arweave.org/)
Expand All @@ -48,4 +48,6 @@ link to [Lens protocol](https://polygonscan.com/address/0x176c2a1c54e8b028eeec14
Check out the architecture below, and also reference [lens protocol](https://github.com/lens-protocol/core/tree/master) to understand more.

*Architecture Preview.*
![Local Image](./img/karst%20archieture.png)
<img width="614" alt="Screenshot 2024-05-24 at 00 11 16" src="https://github.com/horuslabsio/karst-core/assets/60871378/25f001ff-b198-4cd1-aaff-866b1d0bd4f8">


0 comments on commit e10fc1d

Please sign in to comment.