Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serknight/face-block
A truffle dApp that creates ETH user profiles & stores profile data on IPFS
https://github.com/serknight/face-block
ethereum ipfs ipfs-api javascript solidity web3js
Last synced: 4 days ago
JSON representation
A truffle dApp that creates ETH user profiles & stores profile data on IPFS
- Host: GitHub
- URL: https://github.com/serknight/face-block
- Owner: SerKnight
- Created: 2018-07-31T17:56:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T11:57:17.000Z (about 2 years ago)
- Last Synced: 2024-12-17T11:44:13.690Z (8 days ago)
- Topics: ethereum, ipfs, ipfs-api, javascript, solidity, web3js
- Language: JavaScript
- Homepage:
- Size: 28 MB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Faceblock
> A decentralized application that creates profiles stored on the Ethereum blockchain using IPFS to house a user's data.
### Dependencies
* Metamask
* Ganache
* IPFS
### Metamask
Download: (MetaMask)[https://chrome.google.com/webstore/detail/metamask/nkbihfbeogaeaoehlefnkodbefgpgknn?hl=en]
### Ganache
Ganache is used to local blockchain to interface with our smart contracts
Download: (Ganache)[https://truffleframework.com/ganache]
### IPFS
*Inter Planetary File Storage* IPFS works similarly to the bittorent client in that it uses a content based lookup system instead of an address based on like HTTP. This enables users to request files stored on the network that are the closest to the client, vs at a predefined address. Theoretically if someone from Mars downloaded a movie from IPFS, the first load would take a day or so, but other Mars network users would then get the file from that local source, rather than having to re-download it from Earth!
## Running the Application
```
npm install -g truffle
git clone https://github.com/SerKnight/face-block.git
cd face-block
npm install
```
This app will save a Faceblock entries data on IPFS and the user's ethereum address will store the address to fetch the correct data for the profiles.
In a new tab
```
brew install ipfs
ipfs init
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin "[\"*\"]"
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials "[\"true\"]"
ipfs daemon
```
----------------------
1. `npm run dev`
2. Boot Ganache desktop app, in the settings *top right* make sure the port is set to `8545`
4. Open up `http://localhost:8081` -> ipfs will default to 8080, so webpack should increment this by 1 port
5. Connect `Metamask` to `Ganache`
* Open `Metamask` chrome plugin from browser
* Click settings dropdown, then `Custom RPC`
* Enter `http://localhost:8545` under Custom RPC & Save
Last things, then we can do stuff!
`truffle compile`
`truffle migrate`
# Creating a Faceblock profile
> 1. Open up the *Transactions* tab in the `Ganache` GUI, you should see some transactions from the Apps initialization.
> 2. Under `Ganache's` Accounts tab, show one of the pre-seeded account keys on the right, and copy it in clipboard.
> 3. Head over to `http://localhost:8081` and in the `MetaMask` plugin, click the users icon, and at the bottom, *Import Account*
> 4. Reload the page, and your imported account address should be loaded in the Signup *Eth Address* input
> 5. Paste into *private key*
> 6. Enter all details to create a profile & hit **Sign Up**
> Though the app does reload after success.. I didn't perfect the timing for when IPFS data is accessible and you may need to wait a few and reload manually for your user records to be loaded back in.
You now have a running application & the first FaceBlock profile! There is only ** one user ** allowed per private key so to add more profiles, swap your ETH account by repeating steps *2..6*
If you run into any issues getting it running -> [email protected]
# TODO & Notes
* You may have to wait a bit & reload after profiles are added to Ganache + IPFS to fully reflect all the profiles..
* You will need to reload if you change your metamask account for the app to pickup the new address.
* I need to work on the UI/UX logging to utilize the contract events with Web3
* reference common errors for troubleshooting
* I ended up storing images as DataURI's as it seemed the most effective way, but i'd like to learn the golden way for IPFS content sharing!
# Testing
Test can be run using:
`truffle test --development`
* Test suite is primarily focused around UserProfile creation being limited to one per address
* Also important to test that certain validations and events are emitted during contract usage
* unique address
* unique username
-------------------------------------------
# Common Errors
> If you start/stop ganache occasionally gets our of sync, and you may have to run `truffle migrate --reset`
> If you get failed transactions ex *after importing lots of accounts / restarting Ganache*, the console errors might say Nonce is off. (Documentation of issue)[https://github.com/MetaMask/metamask-extension/issues/1999] To fix You can do the following:
* Change network id in ganache ui (settings) and restart
* `truffle migrate --reset`
* go to browser and change to another network (ex. Ropsten) and afterwards back to the private network, `http://localhost:8545`