consensysmesh / web3studio-sojourn Goto Github PK

View Code? Open in Web Editor NEW

31.0 18.0 5.0 3.8 MB

A React Native DevKit with code for a Web3 Decentralized Data Storage Pattern.

Home Page: https://consensys.github.io/web3studio-sojourn/

License: Apache License 2.0

JavaScript 96.18% Python 0.83% Java 0.88% Objective-C 2.07% Shell 0.04%

web3 dapp react-native react devkit material-ui nextjs blockchain web3studio-sojourn

web3studio-sojourn's Introduction

Sojourn

A React Native DevKit with code for a Web3 Decentralized Data Storage Pattern.

Getting Started ∙ License ∙ DevKit ∙ Description ∙ ConsenSys Web3 Studio - Durham

Sojourn is a really simple example of what you can do with an approach to Web3 storage that our team simplified for a React Native application. It’s a note taking application...or rather, it is a set of UI and back-end components that you can use to construct your own Web3 note taking application.

Getting Started

This DevKit includes a React Native app built with a focus on iOS. To demonstrate the pattern, we're using uPort for authentication and Ethereum interactions. Developers are encouraged to use other providers where it makes sense. To get up and running you need to:

Clone the repo and install dependencies:

$ git clone [email protected]:ConsenSys/imagineering-sojourn.git
$ cd imagineering-sojourn
$ yarn install

# .env.development

UPORT_APP_NAME=Sojourn
UPORT_APP_ADDRESS=<YOUR_APP_ADDRESS>
UPORT_PRIVATE_KEY=<YOUR_PRIVATE_KEY>

Run the development app to a simulator. (Uses ganache-cli for Ethereum interactions.)

# One time per simulator to install
$ yarn ios

# Every time to start the metro bundler and ganache cli
$ yarn start

Run the development app on your device. (Uses uPort and requires an installed uPort app on your phone).

# One time per device to install
$ yarn react-native run-ios --device "<YOUR_DEVICE_NAME>"

# Every time to start the metro bundler
$ yarn start

Deploying your own Smart Contracts

We've provided deployed smart contracts for Rinkeby. If you'd like to deploy your own, or on a different network, create an infura.io api key and setup an HD wallet like metamask and add them to your .env.development file.

# .env.development

# ... Other environment variables

INFURA_KEY=<INFURA_API_KEY>
DEPLOY_WALLET_MNEMONIC=<HD_WALLET_MNEMONIC>

Network definitions are located in truffle.js. You can add your own test-net or use ours. To do a migration, run:

$ yarn truffle migrate --network YOUR_NETWORK_ID

For more details see Truffle's Documentation.

Storage

Sojourn uses IPFS to securely store each document in a way where the user can access it from any device without compromising the security of their data. The way we do this is via Shamir's Secret Sharing Algorithm. Specifically, it encrypts each file with AES, splits it apart with Shamir's Secret Sharing Algorithm, and spreads the shards onto IPFS. Web3Studio created an open source project integrating this pipeline into React-Native, react-native-sssa. Pull request are welcome and encouraged.

DevKit

Go to the Devkit

The ConsenSys Web3 Studio in Durham, NC has a pretty sweet job. Our team of developers, designers and writers spend our days coming up with what we hope are novel, unexpected ways to use blockchain and Web3-related technologies.

We publish stories about these uses in the form of “product reviews from the near future” on Medium. Then we build some of these stories into developer kits like this one. The kits are open source.

Success for us is you taking the kit’s ideas and open source code and building your own web3 applications.

What do we want in return? Two things:

We never say no to tweets and other signs of thanks and comments;
We want to hear about what you are building! Tweet us and let us know.

web3studio-sojourn's People

Contributors

Stargazers

Watchers

Forkers

khoazany joincivil isabella232 b01and

web3studio-sojourn's Issues

Test

Create automatic local storage for notes

As a user, I want to be able to have my notes saved automatically on my phone so that I can easily retrieve and search them. I want to ensure they cannot be read by anybody other than me ( current phones automatically encrypt data at rest ?)

Audit top level readme

Ensure we have good, usable, relevant content in the project README(s).

Version Control

implement git server on iPhone and use it as a backend to store files.
Create a UI that allows users to see all the different versions of their files.

I need a logo image uploaded

Create exportable module for encrypting and storing notes locally

Create Smart Contract that stores hash of associated notes.

As a user, I also want a hash of the notes stored on Ethereum, so I can prove that I wrote them when I did and that nobody has tampered with them since.

Acceptance

There is a smart contract
The smart contract is tested
A new smart contract instance is created at login

devKit>UserFlow

How to Mod the IPFS location Array procedure to make an no-sucky application that elegantly handles what to do with the IPFS location file.

Periodically encrypt most recent notes and submit to IPFS

As a user, I want to know my notes are safe in external storage in case I lose my phone.

Acceptance

Data is chunk'd
Data is on IPFS
Data is encrypted
Reconstruction requires everything, a single piece can't reveil anything new
Reconstruction "instructions" are non-public

Question
How often do we save notes?

Prepare input tuple of smart contract by encrypting each IPFS hash as it returns from IPFS storage, and hashing associated note

As a user, I want to ensure I can retrieve the IPFS location of my notes, in case I lose my phone.

Bip39 Mnemonic generator, storage, and retrieval

As a user I need a bip39 mnemonic generated for me that I can use to access my files.
The requirements are as follows:
-I am only given the 18 word mnemonic once. After that, I cannot retrieve it
-The key associated with the mnemonic is stored securely and locally on my iPhone
-The key associated with the mnemonic can be retrieved by SoJourn for decrypting my files
-The key can only be retrieved by Sojourn after I have authenticated with my fingerprint/passcode

Upload picture test #2

Mobile application v1

As a user, I want a client application that I can take, store, and search notes so that I can interact with the DPV and ensure I have secure, proovable notes.

Acceptance

Users can log in
Users can write notes
Users can search notes
Users can view all notes

Create note listing view

As a user I want to browse all of my past notes so that I can review my notes in the future.

Acceptance

User can see all notes that's been written.

Web3 and Truffle in React Native Proof of Concept

Change uPort sign in paradigm to act like a setup

Replace "sign-in" with "setup"

Something like

Now you're authenticated, set up you're wallet with uPort

devKit>Deliberately Missing "Stuff"

Add Intro and context content from Google Doc to ReadMe

Getting Started and "Developer Kit" sections: https://docs.google.com/document/d/1fac7ep-fyXTKMpXRs9Qz3TfU8wSYcILefQFKrXFiEFA/edit#

List view of application is searchable

As a user I want to search my notes so that I don't have to spend a lot of time finding old notes

Assumptions

Search is done on device

Create note taking UI

As a user I want to be able to write notes with an interface that is both familiar and easy to use.

Should only be one or two screens. Confer with Designers for how note taking UX should be.

Acceptance

Users can write up a note
Note persists to phone local storage
- Persistence is in accordance with the security design #15

Store IPFS array in Azure

Setup CI with Travis

As a developer I want tests and linting to run pre-commit so that reviews are simpler and current master says clean.

Assumptions

Travis CI for infra
Prettier for formatting + single quotes
eslint for linting (js standard + prettier config)
Chai Mocha for for testing

Create robust logging infrastructure

As a developer, I want to see a consolidated report of all outputs and errors

Security design

As a user, I want to know it is extremely hard for someone to get to my stuff.

If file is all in one place, a malicious actor could potentially figure out how to decrypt it.

devKit>Readme

Tasks

Getting Started Text
Install Text
Short Description of project text
Short Description of [Imagineering] text
Call to Action (CTA) to devKit location

Design

Set up Web3.js and Truffle in React-Native environment

As a developer, I can know that I can interact with an already existing smart contract in in react-native so that we know we can use web3.js in react-native.

Acceptance

Dev can create a new contract instance
Dev can call an abi off of a contract and see the result

References
react-native truffle box: https://github.com/truffle-box/react-native-box

set up uPort in React-Native

As a user, I can get an Ethereum public address and private key and know that my private key will be secure. I can use this to login to Sojourn without the risk of someone tracing it back to me.

Questions

Can we use uPort to auth into an Azure bucket?

Test

Another

DevKit Docs

Design Assets

consensysmesh / web3studio-sojourn Goto Github PK

web3studio-sojourn's Introduction

Sojourn

A React Native DevKit with code for a Web3 Decentralized Data Storage Pattern.

Getting Started

Deploying your own Smart Contracts

Storage

DevKit

web3studio-sojourn's People

Contributors

Stargazers

Watchers

Forkers

web3studio-sojourn's Issues

Recommend Projects

Recommend Topics

Recommend Org