├── .gitignore ├── docs ├── file_list.png ├── record_mm.png ├── change_file.png ├── fileChanged.png ├── onClickFail.png ├── adding_screenshot.png ├── complete_layout.png ├── deployment_image.png ├── read_screenshot.png └── transaction_info.png ├── public ├── favicon.ico ├── manifest.json └── index.html ├── src ├── moibit_logo_transparent.png ├── container │ └── dapp.js ├── App.test.js ├── App.js ├── middleware │ ├── credentials.js │ ├── web3.js │ ├── sampleBetaAppContract.sol │ └── SampleBetaApp.json ├── index.css ├── index.js ├── App.css ├── component │ ├── modal.js │ ├── tableList.js │ └── layout.js └── serviceWorker.js ├── package.json ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | package-lock.json 2 | yarn.lock 3 | 4 | build 5 | node_modules 6 | -------------------------------------------------------------------------------- /docs/file_list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/file_list.png -------------------------------------------------------------------------------- /docs/record_mm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/record_mm.png -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/public/favicon.ico -------------------------------------------------------------------------------- /docs/change_file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/change_file.png -------------------------------------------------------------------------------- /docs/fileChanged.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/fileChanged.png -------------------------------------------------------------------------------- /docs/onClickFail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/onClickFail.png -------------------------------------------------------------------------------- /docs/adding_screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/adding_screenshot.png -------------------------------------------------------------------------------- /docs/complete_layout.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/complete_layout.png -------------------------------------------------------------------------------- /docs/deployment_image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/deployment_image.png -------------------------------------------------------------------------------- /docs/read_screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/read_screenshot.png -------------------------------------------------------------------------------- /docs/transaction_info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/docs/transaction_info.png -------------------------------------------------------------------------------- /src/moibit_logo_transparent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moibit/Moibit-Sample-DApp/HEAD/src/moibit_logo_transparent.png -------------------------------------------------------------------------------- /src/container/dapp.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from 'react'; 2 | import Layout from '../component/layout.js'; 3 | import '../App.css'; 4 | class Dapp extends Component { 5 | render() { 6 | return ( 7 | 8 | ); 9 | } 10 | } 11 | export default Dapp; -------------------------------------------------------------------------------- /src/App.test.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import App from './App'; 4 | 5 | it('renders without crashing', () => { 6 | const div = document.createElement('div'); 7 | ReactDOM.render(, div); 8 | ReactDOM.unmountComponentAtNode(div); 9 | }); 10 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import Container from './container/dapp'; 3 | 4 | class SampleDapp extends React.Component { 5 | render() { 6 | return ( 7 |
8 | 9 |
10 | ); 11 | } 12 | } 13 | 14 | export default SampleDapp; 15 | -------------------------------------------------------------------------------- /src/middleware/credentials.js: -------------------------------------------------------------------------------- 1 | //You need to update each credentials as displayed on your moibit api dashboard. 2 | 3 | export default { 4 | "API_KEY": "", //YOUR API KEY 5 | "API_SECRET": "", //YOUR API SECRET 6 | "ADMIN": "", // ANY ACCOUNT OF YOUR WISH 7 | "CUSTOM_URL" : "" //URL YOU HAVE BEEN ASSIGNED TO 8 | } 9 | -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", 4 | "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", 5 | sans-serif; 6 | -webkit-font-smoothing: antialiased; 7 | -moz-osx-font-smoothing: grayscale; 8 | } 9 | 10 | code { 11 | font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", 12 | monospace; 13 | } 14 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.css'; 4 | import App from './App'; 5 | import * as serviceWorker from './serviceWorker'; 6 | 7 | ReactDOM.render(, document.getElementById('root')); 8 | 9 | // If you want your app to work offline and load faster, you can change 10 | // unregister() to register() below. Note this comes with some pitfalls. 11 | // Learn more about service workers: https://bit.ly/CRA-PWA 12 | serviceWorker.unregister(); 13 | -------------------------------------------------------------------------------- /src/middleware/web3.js: -------------------------------------------------------------------------------- 1 | import BetaAPI from './SampleBetaApp.json'; 2 | import Web3 from 'web3'; 3 | var web3; 4 | 5 | if (window.ethereum) { 6 | web3 = new Web3(window.ethereum); 7 | 8 | try { 9 | // Request account access if needed 10 | window.ethereum.enable() 11 | .then(console.log('Acccounts now exposed')) 12 | .catch(error => console.log(error)); 13 | } catch (error) { 14 | console.log(error.message); 15 | } 16 | 17 | } 18 | 19 | else if(typeof window !== 'undefined' && typeof window.web3 !== 'undefined'){ 20 | web3 = new Web3(window.web3.currentProvider); 21 | } 22 | 23 | const instance = new web3.eth.Contract( 24 | BetaAPI, 25 | '0xdBa8EC446B8fa878EE6d0d0C4A73995Ac7486706' 26 | ); 27 | 28 | export default { 29 | Config : instance, 30 | web3 : web3 31 | } 32 | -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "App", 3 | "icons": [ 4 | { 5 | "src": "\/android-icon-36x36.png", 6 | "sizes": "36x36", 7 | "type": "image\/png", 8 | "density": "0.75" 9 | }, 10 | { 11 | "src": "\/android-icon-48x48.png", 12 | "sizes": "48x48", 13 | "type": "image\/png", 14 | "density": "1.0" 15 | }, 16 | { 17 | "src": "\/android-icon-72x72.png", 18 | "sizes": "72x72", 19 | "type": "image\/png", 20 | "density": "1.5" 21 | }, 22 | { 23 | "src": "\/android-icon-96x96.png", 24 | "sizes": "96x96", 25 | "type": "image\/png", 26 | "density": "2.0" 27 | }, 28 | { 29 | "src": "\/android-icon-144x144.png", 30 | "sizes": "144x144", 31 | "type": "image\/png", 32 | "density": "3.0" 33 | }, 34 | { 35 | "src": "\/android-icon-192x192.png", 36 | "sizes": "192x192", 37 | "type": "image\/png", 38 | "density": "4.0" 39 | } 40 | ] 41 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "dappinit", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "axios": "^0.19.0", 7 | "file-saver": "^2.0.2", 8 | "react": "^16.9.0", 9 | "react-bootstrap": "^1.0.0-beta.12", 10 | "react-dom": "^16.9.0", 11 | "react-scripts": "3.1.1", 12 | "semantic-ui-react": "^0.88.0", 13 | "web3": "^1.2.1" 14 | }, 15 | "scripts": { 16 | "start": "react-scripts start", 17 | "build": "react-scripts build", 18 | "test": "react-scripts test", 19 | "eject": "react-scripts eject" 20 | }, 21 | "eslintConfig": { 22 | "extends": "react-app" 23 | }, 24 | "browserslist": { 25 | "production": [ 26 | ">0.2%", 27 | "not dead", 28 | "not op_mini all" 29 | ], 30 | "development": [ 31 | "last 1 chrome version", 32 | "last 1 firefox version", 33 | "last 1 safari version" 34 | ] 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .layoutBG { 6 | /* background-image: linear-gradient(to bottom, #000000, #241a1f, #3f2d3d, #564462, #655e8b, #6a70a3, #6d83ba, #6c96d1, #72a1d9, #79ade1, #81b8e9, #8ac3f0); */ 7 | height:100vh; 8 | background-image: linear-gradient(to bottom, #112b4e, #183358, #1f3c63, #26446e, #2d4d79, #345684, #3a5e8f, #41679a, #4971a8, #527cb6, #5a87c4, #6392d3); 9 | /* height : -webkit-fill-available; */ 10 | width:100vw; 11 | padding:50px; 12 | } 13 | 14 | .fileLabel { 15 | color:#ffffff; 16 | /* float:left; */ 17 | font-weight: 400; 18 | letter-spacing: 1.5px; 19 | } 20 | .fileInput { 21 | background-color:transparent; 22 | border:1px #fff solid; 23 | color:#fafafa; 24 | border-bottom:1px solid #fbfbfb; 25 | } 26 | .table_body_scrollable { 27 | padding:0px; 28 | margin: 0px; 29 | 30 | } 31 | .content-container { 32 | font-size:14px; 33 | height:50vh; 34 | overflow-y: scroll; 35 | } 36 | .hashHover:hover { 37 | cursor: pointer; 38 | color:rgb(63, 63, 199); 39 | font-weight: 600; 40 | } 41 | -------------------------------------------------------------------------------- /src/middleware/sampleBetaAppContract.sol: -------------------------------------------------------------------------------- 1 | pragma solidity ^0.5.5; 2 | pragma experimental ABIEncoderV2; 3 | 4 | contract SampleBetaAppContract { 5 | 6 | struct File { 7 | string fileName; 8 | string fileHash; 9 | } 10 | 11 | // mapping of user address to their list of files 12 | mapping(address => File[]) public user_files; 13 | mapping (string => string) public file2Hashes; 14 | File[] public allFiles; 15 | 16 | // Appending the new hash to user's list of hashes 17 | function setHash(string memory _fileName, string memory _fileHash) public returns (bool setBool){ 18 | File memory file = File(_fileName, _fileHash); 19 | user_files[msg.sender].push(file); 20 | file2Hashes[_fileName] = _fileHash; 21 | allFiles.push(file); 22 | return true; 23 | } 24 | 25 | // Lists all the hashes of the user's files 26 | function getList() public view returns (File[] memory retFiles) { 27 | return user_files[msg.sender]; 28 | } 29 | 30 | // Lists all the hashes of the files independent of the user 31 | function listAllHashes() public view returns (File[] memory retFiles) { 32 | return allFiles; 33 | } 34 | 35 | // Lists all the hashes of the files independent of the user 36 | function getHashByName(string memory _fileName) public view returns (string memory _fileHash) { 37 | return file2Hashes[_fileName]; 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/component/modal.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { Image,Modal} from 'semantic-ui-react'; 3 | import FileSaver from 'file-saver'; 4 | 5 | 6 | const showModal = (props) => { 7 | return ( 8 | 9 | 10 |
11 |

{props.fileName}

12 |

✕

13 |
14 | 15 | 16 | 17 | {props.fileType === "image/png" || props.fileType === "image/jpeg" || props.fileType === "image/gif" ? 18 | 19 | < Image wrapped size='medium' src={props.responseData} style={{ marginLeft: '25%' }} /> 20 | : props.fileType === "text/plain" || props.fileType === "text/html" || props.fileType === "text/js" || props.fileType === "text/csv"? 21 |

{props.responseData}

22 | : 23 |
24 |

No preview available. 25 | FileSaver.saveAs(props.responseData,props.fileName)}>Download 26 |

27 |
28 | } 29 | 30 | 31 | ); 32 | } 33 | export default showModal; -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 14 | 15 | 19 | 28 | MoiBit Sample App 29 | 30 | 31 | 32 |
33 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /src/middleware/SampleBetaApp.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "constant": false, 4 | "inputs": [ 5 | { 6 | "name": "_fileName", 7 | "type": "string" 8 | }, 9 | { 10 | "name": "_fileHash", 11 | "type": "string" 12 | } 13 | ], 14 | "name": "setHash", 15 | "outputs": [ 16 | { 17 | "name": "setBool", 18 | "type": "bool" 19 | } 20 | ], 21 | "payable": false, 22 | "stateMutability": "nonpayable", 23 | "type": "function" 24 | }, 25 | { 26 | "constant": true, 27 | "inputs": [ 28 | { 29 | "name": "", 30 | "type": "uint256" 31 | } 32 | ], 33 | "name": "allFiles", 34 | "outputs": [ 35 | { 36 | "name": "fileName", 37 | "type": "string" 38 | }, 39 | { 40 | "name": "fileHash", 41 | "type": "string" 42 | } 43 | ], 44 | "payable": false, 45 | "stateMutability": "view", 46 | "type": "function" 47 | }, 48 | { 49 | "constant": true, 50 | "inputs": [ 51 | { 52 | "name": "", 53 | "type": "string" 54 | } 55 | ], 56 | "name": "file2Hashes", 57 | "outputs": [ 58 | { 59 | "name": "", 60 | "type": "string" 61 | } 62 | ], 63 | "payable": false, 64 | "stateMutability": "view", 65 | "type": "function" 66 | }, 67 | { 68 | "constant": true, 69 | "inputs": [ 70 | { 71 | "name": "_fileName", 72 | "type": "string" 73 | } 74 | ], 75 | "name": "getHashByName", 76 | "outputs": [ 77 | { 78 | "name": "_fileHash", 79 | "type": "string" 80 | } 81 | ], 82 | "payable": false, 83 | "stateMutability": "view", 84 | "type": "function" 85 | }, 86 | { 87 | "constant": true, 88 | "inputs": [], 89 | "name": "getList", 90 | "outputs": [ 91 | { 92 | "components": [ 93 | { 94 | "name": "fileName", 95 | "type": "string" 96 | }, 97 | { 98 | "name": "fileHash", 99 | "type": "string" 100 | } 101 | ], 102 | "name": "retFiles", 103 | "type": "tuple[]" 104 | } 105 | ], 106 | "payable": false, 107 | "stateMutability": "view", 108 | "type": "function" 109 | }, 110 | { 111 | "constant": true, 112 | "inputs": [], 113 | "name": "listAllHashes", 114 | "outputs": [ 115 | { 116 | "components": [ 117 | { 118 | "name": "fileName", 119 | "type": "string" 120 | }, 121 | { 122 | "name": "fileHash", 123 | "type": "string" 124 | } 125 | ], 126 | "name": "retFiles", 127 | "type": "tuple[]" 128 | } 129 | ], 130 | "payable": false, 131 | "stateMutability": "view", 132 | "type": "function" 133 | }, 134 | { 135 | "constant": true, 136 | "inputs": [ 137 | { 138 | "name": "", 139 | "type": "address" 140 | }, 141 | { 142 | "name": "", 143 | "type": "uint256" 144 | } 145 | ], 146 | "name": "user_files", 147 | "outputs": [ 148 | { 149 | "name": "fileName", 150 | "type": "string" 151 | }, 152 | { 153 | "name": "fileHash", 154 | "type": "string" 155 | } 156 | ], 157 | "payable": false, 158 | "stateMutability": "view", 159 | "type": "function" 160 | } 161 | ] -------------------------------------------------------------------------------- /src/component/tableList.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { Table,Icon } from 'semantic-ui-react'; 3 | import '../App.css'; 4 | class TableList extends React.Component { 5 | state = { 6 | props1 : this.props 7 | } 8 | componentWillReceiveProps(newProps) { 9 | this.setState({props1 : newProps}); 10 | } 11 | render() { 12 | const custom_primary = { 13 | backgroundColor: '#2185d0', 14 | color: '#fbfbfb', 15 | border: '1px solid #fbfbfb' 16 | } 17 | return ( 18 | 19 | 20 | 21 | 22 | File Name 23 | 24 | 25 | File Hash 26 | 27 | 28 | Verified (Auto verification happens when you view file) 29 | 30 | 31 | 32 | 33 | {this.state.props1.fileList.length == 0 ? 34 | 35 | 36 | 37 | No Data 38 | 39 | 40 | : 41 | this.state.props1.fileList.map(aFile => 42 | 43 | this.state.props1.readFile(aFile.Hash,aFile.Name) } className="hashHover"> 44 | {aFile.Name} 45 | 46 | 47 |

{aFile.Hash}

48 | 49 | 50 | 51 | {aFile.verfiledBoolean == 0 ? 52 |
Unverified
: 53 | aFile.verfiledBoolean == 1 ? 54 |
Passed
: 55 | aFile.verfiledBoolean == -1 ? 56 |
Failed
: 57 | 58 | } 59 | 60 | 61 | 62 | )} 63 | 64 | 65 | 66 |
67 | ); 68 | } 69 | } 70 | export default TableList; 71 | -------------------------------------------------------------------------------- /src/serviceWorker.js: -------------------------------------------------------------------------------- 1 | // This optional code is used to register a service worker. 2 | // register() is not called by default. 3 | 4 | // This lets the app load faster on subsequent visits in production, and gives 5 | // it offline capabilities. However, it also means that developers (and users) 6 | // will only see deployed updates on subsequent visits to a page, after all the 7 | // existing tabs open on the page have been closed, since previously cached 8 | // resources are updated in the background. 9 | 10 | // To learn more about the benefits of this model and instructions on how to 11 | // opt-in, read https://bit.ly/CRA-PWA 12 | 13 | const isLocalhost = Boolean( 14 | window.location.hostname === 'localhost' || 15 | // [::1] is the IPv6 localhost address. 16 | window.location.hostname === '[::1]' || 17 | // 127.0.0.1/8 is considered localhost for IPv4. 18 | window.location.hostname.match( 19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 20 | ) 21 | ); 22 | 23 | export function register(config) { 24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 25 | // The URL constructor is available in all browsers that support SW. 26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); 27 | if (publicUrl.origin !== window.location.origin) { 28 | // Our service worker won't work if PUBLIC_URL is on a different origin 29 | // from what our page is served on. This might happen if a CDN is used to 30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374 31 | return; 32 | } 33 | 34 | window.addEventListener('load', () => { 35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 36 | 37 | if (isLocalhost) { 38 | // This is running on localhost. Let's check if a service worker still exists or not. 39 | checkValidServiceWorker(swUrl, config); 40 | 41 | // Add some additional logging to localhost, pointing developers to the 42 | // service worker/PWA documentation. 43 | navigator.serviceWorker.ready.then(() => { 44 | console.log( 45 | 'This web app is being served cache-first by a service ' + 46 | 'worker. To learn more, visit https://bit.ly/CRA-PWA' 47 | ); 48 | }); 49 | } else { 50 | // Is not localhost. Just register service worker 51 | registerValidSW(swUrl, config); 52 | } 53 | }); 54 | } 55 | } 56 | 57 | function registerValidSW(swUrl, config) { 58 | navigator.serviceWorker 59 | .register(swUrl) 60 | .then(registration => { 61 | registration.onupdatefound = () => { 62 | const installingWorker = registration.installing; 63 | if (installingWorker == null) { 64 | return; 65 | } 66 | installingWorker.onstatechange = () => { 67 | if (installingWorker.state === 'installed') { 68 | if (navigator.serviceWorker.controller) { 69 | // At this point, the updated precached content has been fetched, 70 | // but the previous service worker will still serve the older 71 | // content until all client tabs are closed. 72 | console.log( 73 | 'New content is available and will be used when all ' + 74 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.' 75 | ); 76 | 77 | // Execute callback 78 | if (config && config.onUpdate) { 79 | config.onUpdate(registration); 80 | } 81 | } else { 82 | // At this point, everything has been precached. 83 | // It's the perfect time to display a 84 | // "Content is cached for offline use." message. 85 | console.log('Content is cached for offline use.'); 86 | 87 | // Execute callback 88 | if (config && config.onSuccess) { 89 | config.onSuccess(registration); 90 | } 91 | } 92 | } 93 | }; 94 | }; 95 | }) 96 | .catch(error => { 97 | console.error('Error during service worker registration:', error); 98 | }); 99 | } 100 | 101 | function checkValidServiceWorker(swUrl, config) { 102 | // Check if the service worker can be found. If it can't reload the page. 103 | fetch(swUrl) 104 | .then(response => { 105 | // Ensure service worker exists, and that we really are getting a JS file. 106 | const contentType = response.headers.get('content-type'); 107 | if ( 108 | response.status === 404 || 109 | (contentType != null && contentType.indexOf('javascript') === -1) 110 | ) { 111 | // No service worker found. Probably a different app. Reload the page. 112 | navigator.serviceWorker.ready.then(registration => { 113 | registration.unregister().then(() => { 114 | window.location.reload(); 115 | }); 116 | }); 117 | } else { 118 | // Service worker found. Proceed as normal. 119 | registerValidSW(swUrl, config); 120 | } 121 | }) 122 | .catch(() => { 123 | console.log( 124 | 'No internet connection found. App is running in offline mode.' 125 | ); 126 | }); 127 | } 128 | 129 | export function unregister() { 130 | if ('serviceWorker' in navigator) { 131 | navigator.serviceWorker.ready.then(registration => { 132 | registration.unregister(); 133 | }); 134 | } 135 | } 136 | -------------------------------------------------------------------------------- /src/component/layout.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from 'react'; 2 | import '../App.css'; 3 | import { Image, Table, Button, Input, Form } from 'semantic-ui-react'; 4 | import MoiBit from '../moibit_logo_transparent.png'; 5 | import TableList from './tableList'; 6 | import credentials from '../middleware/credentials'; 7 | import Instance from '../middleware/web3'; 8 | import axios from 'axios'; 9 | import ShowModal from './modal'; 10 | class Layout extends Component { 11 | state = { 12 | fileList: [], 13 | file: '', 14 | accountId: '', 15 | loading: false, 16 | fieldReq: false, 17 | readFileIframe: '', 18 | fileType: '', 19 | modalOpen: false, 20 | fileName: '', 21 | } 22 | async componentDidMount() { 23 | 24 | let acc = await Instance.web3.eth.getAccounts(); 25 | this.setState({ accountId: acc[0] }); 26 | this.observe(); 27 | axios.defaults.headers.common['api_key'] = credentials.API_KEY; 28 | axios.defaults.headers.common['api_secret'] = credentials.API_SECRET; 29 | 30 | if (acc[0] === credentials.ADMIN) { 31 | this.getALLHashes(); 32 | } 33 | else { 34 | this.getFileHash(); 35 | } 36 | } 37 | 38 | getFileHash = async () => { 39 | let data = await Instance.Config.methods.getList().call({ from: this.state.accountId }); 40 | let actual = []; 41 | if(data.length !== 0) { 42 | for (let i = 0; i < data.length; i++) { 43 | actual.push({ 44 | Name : data[i].fileName.split("/")[1], 45 | Hash : data[i].fileHash, 46 | verfiledBoolean : 0 47 | }); 48 | } 49 | } 50 | this.setState({ fileList: actual }); 51 | } 52 | 53 | getALLHashes = async () => { 54 | let response = await axios({ 55 | method: 'post', 56 | url: credentials.CUSTOM_URL+"/moibit/listfiles", 57 | data: { path: "/" } 58 | }); 59 | let data = []; 60 | if(response.data.data.Entries !== null) { 61 | for (let i = 0; i < response.data.data.Entries.length; i++) { 62 | if (response.data.data.Entries[i].Type === 0) { 63 | await data.push({ 64 | Name : response.data.data.Entries[i].Name, 65 | Hash : response.data.data.Entries[i].Hash, 66 | verfiledBoolean : 0 67 | }); 68 | } 69 | } 70 | } 71 | this.setState({ fileList: data }); 72 | } 73 | handleSubmit = async (e) => { 74 | e.preventDefault(); 75 | if (this.state.file !== "") { 76 | let formData = new FormData(); 77 | formData.append('file', this.state.file); 78 | formData.append('fileName', '/' + this.state.file.name); 79 | this.setState({ loading: true }); 80 | 81 | let response = await axios({ 82 | method: 'post', 83 | url: credentials.CUSTOM_URL+"/moibit/writefile", 84 | data: formData 85 | }); 86 | const actualFileName = credentials.API_KEY + "" + response.data.data.Path + "" + response.data.data.Name; 87 | await Instance.Config.methods.setHash(actualFileName, response.data.data.Hash).send({ from: this.state.accountId }); 88 | if (this.state.accountId === credentials.ADMIN) { 89 | this.getALLHashes(); 90 | this.setState({ loading: false }); 91 | } 92 | else { 93 | this.getFileHash(); 94 | this.setState({ loading: false }); 95 | } 96 | this.setState({ loading: false }); 97 | } 98 | else { 99 | this.setState({ fieldReq: true }) 100 | } 101 | } 102 | 103 | observe = async () => { 104 | try { 105 | setTimeout(this.observe, 1000); 106 | const accounts = await Instance.web3.eth.getAccounts(); 107 | if (accounts[0] === this.state.accountId) { 108 | 109 | } 110 | else { 111 | window.location = "/"; 112 | } 113 | return; 114 | } 115 | catch (error) { 116 | console.log(error.message); 117 | } 118 | } 119 | 120 | checkForProvenence = async (name,hash) => { 121 | let response = await axios({ 122 | method: 'post', 123 | url: credentials.CUSTOM_URL+"/moibit/listfiles", 124 | data: { path: "/" } 125 | }); 126 | 127 | let allFiles = response.data.data.Entries; 128 | const index1 = allFiles.map(e => e.Name).indexOf(name); 129 | let checkingHash = ''; 130 | if(index1 != -1) { 131 | checkingHash = allFiles[index1].Hash; 132 | } 133 | 134 | 135 | let successs = true; 136 | let files = this.state.fileList; 137 | const index = files.map(e => e.Name).indexOf(name); 138 | if(files[index].verfiledBoolean === 0) { 139 | files[index] = { 140 | Name : name, 141 | Hash : hash, 142 | verfiledBoolean : 2 143 | } 144 | this.setState({fileList : files}); 145 | 146 | /* we are rendering all the root files so we are adding / in prefix to file name */ 147 | const filename = credentials.API_KEY+'/'+name; 148 | if(checkingHash == await Instance.Config.methods.getHashByName(filename).call()) { 149 | files[index] = { 150 | Name : name, 151 | Hash : hash, 152 | verfiledBoolean : 1 153 | } 154 | this.setState({fileList : files}); 155 | } 156 | else { 157 | files[index] = { 158 | Name : name, 159 | Hash : hash, 160 | verfiledBoolean : -1 161 | } 162 | this.setState({fileList : files}); 163 | successs = false; 164 | } 165 | return successs; 166 | } 167 | else { 168 | return successs; 169 | } 170 | } 171 | 172 | readFile = async (filehash, fileName) => { 173 | if(await this.checkForProvenence(fileName,filehash)) { 174 | var responseType = ''; 175 | if (fileName.substr(-3, 3) === "txt" || fileName.substr(-3, 3) === "csv" || fileName.substr(-3, 3) === "php" || fileName.substr(-3, 3) === "html" || fileName.substr(-2, 2) === "js") { 176 | responseType = ''; 177 | } 178 | else { 179 | responseType = 'blob'; 180 | } 181 | const url = credentials.CUSTOM_URL+'/moibit/readfilebyhash'; 182 | axios({ 183 | method: 'post', 184 | url: url, 185 | responseType: responseType, 186 | data: { 187 | hash: filehash 188 | } 189 | }) 190 | .then(response => { 191 | if (typeof (response.data) == "string") { 192 | this.setState({ readFileIframe: response.data, 193 | fileType: response.headers['content-type'], 194 | fileName: fileName, 195 | modalOpen: true 196 | }); 197 | } 198 | else { 199 | this.setState({ 200 | readFileIframe: window.URL.createObjectURL(new Blob([response.data], {type:response.headers['content-type']})), 201 | fileType: response.headers['content-type'], 202 | fileName: fileName, 203 | modalOpen: true 204 | }) 205 | } 206 | }) 207 | .catch(error => { 208 | console.log(error); 209 | }); 210 | } 211 | else { 212 | this.setState({ readFileIframe: "The file got modified off-chain", 213 | fileType: 'text/plain', 214 | fileName: 'Alert!', 215 | modalOpen: true 216 | }); 217 | } 218 | } 219 | modalClose = () => { 220 | this.setState({ modalOpen: false }); 221 | } 222 | render() { 223 | const custom_header = { 224 | backgroundColor: '#222222', 225 | color: '#fbfbfb', 226 | border: '1px solid #fbfbfb' 227 | } 228 | return ( 229 |
230 | {this.state.fileName !== '' ? : null} 236 |
237 | 238 | {/*

MoiBit

*/} 239 |
240 |
241 |
this.handleSubmit(event)} encType="multipart/form-data"> 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | { 250 | this.setState({ file: e.target.files[0] }); 251 | }} required name="file" style={this.state.fieldReq ? { border: '2px solid red', borderRadius: '5px' } : {}} /> 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | API_KEY : {credentials.API_KEY} 265 | 266 | 267 | 268 | 269 |
270 | API_SECRET : {credentials.API_SECRET} 271 |
272 | 273 | 274 | 275 | 276 | 277 |
278 |
279 |
280 | 282 | 283 |
284 |
285 |
286 | ); 287 | } 288 | } 289 | export default Layout; -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![MoiBit](https://raw.githubusercontent.com/moibit/logo-assets/master/logos/moibit-solo-banner.jpg) 2 | 3 | # MoiBit Sample DApp 4 | 5 | [![Chat on Slack](https://img.shields.io/badge/Slack-MoiBit%20Slack%20community-blue)](https://join.slack.com/t/moibit/signup) 6 | [![Chat on Telegram](https://img.shields.io/badge/Telegram-MoiBit%20Telegram%20community-blue)](https://t.me/moibit) 7 | [![Follow us on Twitter](https://img.shields.io/badge/Twitter-MoiBit%20Twitter-blue?style=social&logo=twitter)](https://twitter.com/moibitio) 8 | 9 | A sample decentralized application that uses **MoiBit API** as a storage platform for off-chain storage. 10 | 11 | ## What does the dApp do? 12 | 13 | It allows the **Authenticated MoiBit** users to upload their files to MoiBit and store the corresponding Multihash of the files on Ethereum for provenance. 14 | It also allows users to view and list their files. All these features are enabled using the MoiBit API platform alongside authentication. 15 | 16 | > Click [here](https://account.moibit.io) to create your Moibit account. 17 | 18 | 19 | > **IMPORTANT NOTE:** Once you create and verify your MoiBit account, be sure to update the /src/middleware/credentials.js file with your proper credentials for the sample DApp to work. 20 | 21 | ## Tech Stack Involved 22 | 23 | - React - Front end library 24 | - Solidity - The language used to build smart contracts that run on Ethereum 25 | - MoiBit - A decentralized storage network with reliable infrastructure and APIs 26 | 27 | ### Let’s Get Started! 28 | 29 | >_Make sure you already have the Metamask downloaded. If not, download it from [here](https://metamask.io/)._ 30 | 31 | #### Install the following dependencies: 32 | [Create React App](https://github.com/facebookincubator/create-react-app) is an intuitive package and is the best way to start building a new [single page](https://reactjs.org/docs/glossary.html#single-page-application) application in React. 33 | 34 | ``` bash 35 | npx create-react-app beta-sample-dapp 36 | cd beta-sample-dapp 37 | npm install web3 --save #middleware to interact with ethereum 38 | npm install semantic-ui-react --save #front-end development framework 39 | npm install axios --save #promise based http client 40 | npm install filesaver --save #enable us to download files 41 | ``` 42 | 43 | #### Deploy the Smart Contract on Kovan Testnet 44 | 45 | >_Make sure you’re on the Kovan testnet on metamask._ 46 | 47 | To deploy the smart contract you need ether(s). To get ethers for the kovan testnet visit [https://faucet.kovan.network](https://faucet.kovan.network) 48 | 49 | To deploy the smart contract go to [https://remix.ethereum.org](https://remix.ethereum.org/). Please add _Deploy & Run Transactions_ and _Solidity Compiler_ plugins if you haven't yet. 50 | 51 | paste the following codes in **_/src/middleware/sampleBetaAppContract.js_** 52 | 53 | ``` js 54 | pragma solidity ^0.5.5; 55 | pragma experimental ABIEncoderV2; 56 | 57 | contract SampleBetaAppContract { 58 | 59 | struct File { 60 | string fileName; 61 | string fileHash; 62 | } 63 | 64 | // mapping of user address to their list of files 65 | mapping(address => File[]) public user_files; 66 | mapping (string => string) public file2Hashes; 67 | File[] public allFiles; 68 | 69 | // Appending the new hash to user's list of hashes 70 | function setHash(string memory _fileName, string memory _fileHash) public returns (bool setBool){ 71 | File memory file = File(_fileName, _fileHash); 72 | user_files[msg.sender].push(file); 73 | file2Hashes[_fileName] = _fileHash; 74 | allFiles.push(file); 75 | return true; 76 | } 77 | 78 | // Lists all the hashes of the user's files 79 | function getList() public view returns (File[] memory retFiles) { 80 | return user_files[msg.sender]; 81 | } 82 | 83 | // Lists all the hashes of the files independent of the user 84 | function listAllHashes() public view returns (File[] memory retFiles) { 85 | return allFiles; 86 | } 87 | 88 | // Lists all the hashes of the files independent of the user 89 | function getHashByName(string memory _fileName) public view returns (string memory _fileHash) { 90 | return file2Hashes[_fileName]; 91 | } 92 | } 93 | ``` 94 | 95 | ![Contract deployment screenshot](https://github.com/KIPFoundation/Beta-Sample-Dapp/blob/master/docs/deployment_image.png) 96 | Save the address of the smart contract. For this dApp it is: ```0xdBa8EC446B8fa878EE6d0d0C4A73995Ac7486706``` 97 | 98 | Also, save the Application Binary Interface (ABI) in JSON. It can be found under solidity complier plugin 99 | For this dApp it is: 100 | 101 | ``` json 102 | [ { "constant": false, "inputs": [ { "name": "_fileName", "type": "string" }, { "name": "_fileHash", "type": "string" } ], "name": "setHash", "outputs": [ { "name": "setBool", "type": "bool" } ], "payable": false, "stateMutability": "nonpayable", "type": "function" }, { "constant": true, "inputs": [ { "name": "", "type": "uint256" } ], "name": "allFiles", "outputs": [ { "name": "fileName", "type": "string" }, { "name": "fileHash", "type": "string" } ], "payable": false, "stateMutability": "view", "type": "function" }, { "constant": true, "inputs": [ { "name": "", "type": "string" } ], "name": "file2Hashes", "outputs": [ { "name": "", "type": "string" } ], "payable": false, "stateMutability": "view", "type": "function" }, { "constant": true, "inputs": [ { "name": "_fileName", "type": "string" } ], "name": "getHashByName", "outputs": [ { "name": "_fileHash", "type": "string" } ], "payable": false, "stateMutability": "view", "type": "function" }, { "constant": true, "inputs": [], "name": "getList", "outputs": [ { "components": [ { "name": "fileName", "type": "string" }, { "name": "fileHash", "type": "string" } ], "name": "retFiles", "type": "tuple[]" } ], "payable": false, "stateMutability": "view", "type": "function" }, { "constant": true, "inputs": [], "name": "listAllHashes", "outputs": [ { "components": [ { "name": "fileName", "type": "string" }, { "name": "fileHash", "type": "string" } ], "name": "retFiles", "type": "tuple[]" } ], "payable": false, "stateMutability": "view", "type": "function" }, { "constant": true, "inputs": [ { "name": "", "type": "address" }, { "name": "", "type": "uint256" } ], "name": "user_files", "outputs": [ { "name": "fileName", "type": "string" }, { "name": "fileHash", "type": "string" } ], "payable": false, "stateMutability": "view", "type": "function" } ] 103 | ``` 104 | 105 | In the **_/src/middleware/web3.js_** 106 | ``` js 107 | import BetaAPI from './SampleBetaApp.json'; 108 | import Web3 from 'web3'; 109 | var web3; 110 | if (window.ethereum) { 111 | web3 = new Web3(window.ethereum); 112 | try { 113 | // Request account access if needed 114 | window.ethereum.enable() 115 | .then(console.log('Acccounts now exposed')) 116 | .catch(error => console.log(error)); 117 | } catch (error) { 118 | console.log(error.message); 119 | } 120 | } 121 | else if(typeof window !== 'undefined' && typeof window.web3 !== 'undefined'){ 122 | web3 = new Web3(window.web3.currentProvider); 123 | } 124 | const instance = new web3.eth.Contract( 125 | BetaAPI, 126 | '0xdBa8EC446B8fa878EE6d0d0C4A73995Ac7486706' 127 | ); 128 | export default {Config : instance,web3 : web3} 129 | ``` 130 | 131 | The above code helps to connect with the contract deployed and make use of the function 132 | >_To make it simple we are going to use first address in metamask as **Admin** and remaining addresses as his/her users._ 133 | 134 | in file **_/src/middleware/credentials.js_** 135 | ``` js 136 | //You need to update each credentials as displayed on your moibit api dashboard. 137 | 138 | export default { 139 | "API_KEY": "", //YOUR API KEY 140 | "API_SECRET": "", //YOUR API SECRET 141 | "ADMIN": "", // ANY ACCOUNT OF YOUR WISH 142 | "CUSTOM_URL" : "" //URL YOU HAVE BEEN ASSIGNED TO 143 | } 144 | ``` 145 | in **_/src/container/dapp.js_** 146 | ``` js 147 | import React, { Component } from 'react'; 148 | import Layout from '../component/layout.js'; 149 | class Dapp extends Component { 150 | render() { 151 | return (); 152 | } 153 | } 154 | export default Dapp; 155 | ``` 156 | The above code will render the layout below which helps to explore all routes of MoiBit. 157 | 158 | ![Sample Dapp Layout](docs/complete_layout.png) 159 | 160 | #### Let's go into the details 161 | in **_src/component/tableList_** 162 | ``` js 163 | import React from 'react'; 164 | import { Table,Icon } from 'semantic-ui-react'; 165 | import '../App.css'; 166 | class TableList extends React.Component { 167 | state = { 168 | props1 : this.props 169 | } 170 | componentWillReceiveProps(newProps) { 171 | this.setState({props1 : newProps}); 172 | } 173 | render() { 174 | const custom_primary = { 175 | backgroundColor: '#2185d0', 176 | color: '#fbfbfb', 177 | border: '1px solid #fbfbfb' 178 | } 179 | return ( 180 | 181 | 182 | 183 | 184 | File Name 185 | 186 | 187 | File Hash 188 | 189 | 190 | Verified (Auto verification happens when you view file) 191 | 192 | 193 | 194 | 195 | {this.state.props1.fileList.length == 0 ? 196 | 197 | 198 | 199 | No Data 200 | 201 | 202 | : 203 | this.state.props1.fileList.map(aFile => 204 | 205 | this.state.props1.readFile(aFile.Hash,aFile.Name) } className="hashHover"> 206 | {aFile.Name} 207 | 208 | 209 |

{aFile.Hash}

210 | 211 | 212 | 213 | {aFile.verfiledBoolean == 0 ? 214 |
Unverified
: 215 | aFile.verfiledBoolean == 1 ? 216 |
Passed
: 217 | aFile.verfiledBoolean == -1 ? 218 |
Failed
: 219 | 220 | } 221 | 222 | 223 | 224 | )} 225 | 226 | 227 | 228 |
229 | ); 230 | } 231 | } 232 | export default TableList; 233 | ``` 234 | this is a re-usable component for rendering the list of files in table format 235 | 236 | in **/src/component/layout.js** 237 | ``` js 238 | import React, { Component } from 'react'; 239 | import '../App.css'; 240 | import { Image, Table, Button, Input, Form } from 'semantic-ui-react'; 241 | import MoiBit from '../moibit_logo_transparent.png'; 242 | import TableList from './tableList'; 243 | import credentials from '../middleware/credentials'; 244 | import Instance from '../middleware/web3'; 245 | import axios from 'axios'; 246 | import ShowModal from './modal'; 247 | class Layout extends Component { 248 | state = { 249 | fileList: [], 250 | file: '', 251 | accountId: '', 252 | loading: false, 253 | fieldReq: false, 254 | readFileIframe: '', 255 | fileType: '', 256 | modalOpen: false, 257 | fileName: '', 258 | } 259 | /* Load loggedIn account and render view respectively */ 260 | async componentDidMount() { 261 | let acc = await Instance.web3.eth.getAccounts(); 262 | this.setState({ accountId: acc[0] }); 263 | this.observe(); 264 | axios.defaults.headers.common['api_key'] = credentials.API_KEY; 265 | axios.defaults.headers.common['api_secret'] = credentials.API_SECRET; 266 | 267 | if (acc[0] === credentials.ADMIN) { 268 | this.getALLHashes(); 269 | } 270 | else { 271 | this.getFileHash(); 272 | } 273 | } 274 | 275 | /* Get all files of users but not customers */ 276 | getFileHash = async () => { 277 | let data = await Instance.Config.methods.getList().call({ from: this.state.accountId }); 278 | let actual = []; 279 | if(data.length !== 0) { 280 | for (let i = 0; i < data.length; i++) { 281 | actual.push({ 282 | Name : data[i].fileName.split("/")[1], 283 | Hash : data[i].fileHash, 284 | verfiledBoolean : 0 285 | }); 286 | } 287 | } 288 | this.setState({ fileList: actual }); 289 | } 290 | 291 | /* Executing list files from MoiBit API */ 292 | getALLHashes = async () => { 293 | let response = await axios({ 294 | method: 'post', 295 | url: credentials.CUSTOM_URL+"/moibit/listfiles", 296 | data: { path: "/" } 297 | }); 298 | let data = []; 299 | if(response.data.data.Entries !== null) { 300 | for (let i = 0; i < response.data.data.Entries.length; i++) { 301 | if (response.data.data.Entries[i].Type === 0) { 302 | await data.push({ 303 | Name : response.data.data.Entries[i].Name, 304 | Hash : response.data.data.Entries[i].Hash, 305 | verfiledBoolean : 0 306 | }); 307 | } 308 | } 309 | } 310 | this.setState({ fileList: data }); 311 | } 312 | handleSubmit = async (e) => { 313 | e.preventDefault(); 314 | if (this.state.file !== "") { 315 | let formData = new FormData(); 316 | formData.append('file', this.state.file); 317 | formData.append('fileName', '/' + this.state.file.name); 318 | this.setState({ loading: true }); 319 | 320 | let response = await axios({ 321 | method: 'post', 322 | url: credentials.CUSTOM_URL+"/moibit/writefile", 323 | data: formData 324 | }); 325 | const actualFileName = credentials.API_KEY + "" + response.data.data.Path + "" + response.data.data.Name; 326 | await Instance.Config.methods.setHash(actualFileName, response.data.data.Hash).send({ from: this.state.accountId }); 327 | if (this.state.accountId === credentials.ADMIN) { 328 | this.getALLHashes(); 329 | this.setState({ loading: false }); 330 | } 331 | else { 332 | this.getFileHash(); 333 | this.setState({ loading: false }); 334 | } 335 | this.setState({ loading: false }); 336 | } 337 | else { 338 | this.setState({ fieldReq: true }) 339 | } 340 | } 341 | 342 | observe = async () => { 343 | try { 344 | setTimeout(this.observe, 1000); 345 | const accounts = await Instance.web3.eth.getAccounts(); 346 | if (accounts[0] === this.state.accountId) { 347 | 348 | } 349 | else { 350 | window.location = "/"; 351 | } 352 | return; 353 | } 354 | catch (error) { 355 | console.log(error.message); 356 | } 357 | } 358 | 359 | /* Comparing hash of off-chain aganist on-chain hash */ 360 | checkForProvenence = async (name,hash) => { 361 | let response = await axios({ 362 | method: 'post', 363 | url: credentials.CUSTOM_URL+"/moibit/listfiles", 364 | data: { path: "/" } 365 | }); 366 | 367 | let allFiles = response.data.data.Entries; 368 | const index1 = allFiles.map(e => e.Name).indexOf(name); 369 | let checkingHash = ''; 370 | if(index1 != -1) { 371 | checkingHash = allFiles[index1].Hash; 372 | } 373 | 374 | 375 | let successs = true; 376 | let files = this.state.fileList; 377 | const index = files.map(e => e.Name).indexOf(name); 378 | if(files[index].verfiledBoolean === 0) { 379 | files[index] = { 380 | Name : name, 381 | Hash : hash, 382 | verfiledBoolean : 2 383 | } 384 | this.setState({fileList : files}); 385 | 386 | /* we are rendering all the root files so we are adding / in prefix to file name */ 387 | const filename = credentials.API_KEY+'/'+name; 388 | if(checkingHash == await Instance.Config.methods.getHashByName(filename).call()) { 389 | files[index] = { 390 | Name : name, 391 | Hash : hash, 392 | verfiledBoolean : 1 393 | } 394 | this.setState({fileList : files}); 395 | } 396 | else { 397 | files[index] = { 398 | Name : name, 399 | Hash : hash, 400 | verfiledBoolean : -1 401 | } 402 | this.setState({fileList : files}); 403 | successs = false; 404 | } 405 | return successs; 406 | } 407 | else { 408 | return successs; 409 | } 410 | } 411 | 412 | readFile = async (filehash, fileName) => { 413 | if(await this.checkForProvenence(fileName,filehash)) { 414 | var responseType = ''; 415 | if (fileName.substr(-3, 3) === "txt" || fileName.substr(-3, 3) === "csv" || fileName.substr(-3, 3) === "php" || fileName.substr(-3, 3) === "html" || fileName.substr(-2, 2) === "js") { 416 | responseType = ''; 417 | } 418 | else { 419 | responseType = 'blob'; 420 | } 421 | const url = credentials.CUSTOM_URL+'/moibit/readfilebyhash'; 422 | axios({ 423 | method: 'post', 424 | url: url, 425 | responseType: responseType, 426 | data: { 427 | hash: filehash 428 | } 429 | }) 430 | .then(response => { 431 | if (typeof (response.data) == "string") { 432 | this.setState({ readFileIframe: response.data, 433 | fileType: response.headers['content-type'], 434 | fileName: fileName, 435 | modalOpen: true 436 | }); 437 | } 438 | else { 439 | this.setState({ 440 | readFileIframe: window.URL.createObjectURL(new Blob([response.data], {type:response.headers['content-type']})), 441 | fileType: response.headers['content-type'], 442 | fileName: fileName, 443 | modalOpen: true 444 | }) 445 | } 446 | }) 447 | .catch(error => { 448 | console.log(error); 449 | }); 450 | } 451 | else { 452 | this.setState({ readFileIframe: "The file got modified off-chain", 453 | fileType: 'text/plain', 454 | fileName: 'Alert!', 455 | modalOpen: true 456 | }); 457 | } 458 | } 459 | modalClose = () => { 460 | this.setState({ modalOpen: false }); 461 | } 462 | render() { 463 | const custom_header = { 464 | backgroundColor: '#222222', 465 | color: '#fbfbfb', 466 | border: '1px solid #fbfbfb' 467 | } 468 | return ( 469 |
470 | {this.state.fileName !== '' ? : null} 476 |
477 | 478 | {/*

MoiBit

*/} 479 |
480 |
481 |
this.handleSubmit(event)} encType="multipart/form-data"> 482 | 483 | 484 | 485 | 486 | 487 | 488 | 489 | { 490 | this.setState({ file: e.target.files[0] }); 491 | }} required name="file" style={this.state.fieldReq ? { border: '2px solid red', borderRadius: '5px' } : {}} /> 492 | 493 | 494 | 495 | 496 | 497 | 498 | 499 | 500 | 501 | 502 | 503 | 504 | API_KEY : {credentials.API_KEY} 505 | 506 | 507 | 508 | 509 |
510 | API_SECRET : {credentials.API_SECRET} 511 |
512 | 513 | 514 | 515 | 516 | 517 |
518 |
519 |
520 | 522 | 523 |
524 |
525 |
526 | ); 527 | } 528 | } 529 | export default Layout; 530 | ``` 531 | >_**You have to send your API_KEY and API_SECRET in the headers with every route**_ 532 | 533 | ![Sample Dapp Upload](docs/adding_screenshot.png) 534 | 535 | on clicking submit the file will be added to MoiBit using the following route: 536 | 537 | >_**YOUR_IP/moibit/writefile"**_ is a post call used to upload/add a file to your directory in MoiBit, which expects a **form data** 538 | ``` json 539 | { 540 | file : , 541 | fileName: // means if you want to add a file to folder called 'X', then fileName : 'X'+ '', 542 | } 543 | ``` 544 | which will return back following response : 545 | ``` json 546 | { 547 | "meta": { 548 | "code": 200, 549 | "msg": "uploaded successfully" 550 | }, 551 | "data": { 552 | "Hash": "bafybeietzxj4i4vtt6k63daqpr7gqhmxt33w3ne6gj45jbkqp4r34hpzye", 553 | "Path": "/12D3KooWRMeX36JkeQegC3cd6dGcAsMffCXUKxaktS278rBcy7dV", 554 | "Name": "1_profile.jpeg", 555 | "Size": 160746, 556 | "CumulativeSize": 160804, 557 | "Blocks": 1, 558 | "Type": "file" 559 | } 560 | } 561 | ``` 562 | for provenance and utility we are storing the file hash into blockchain , where you have to confirm in the metamask popup for which we use the following code: 563 | ``` json 564 | await Instance.Config.methods.setHash(, ).send({ from: }); 565 | ``` 566 | 567 | You can see the transaction in etherscan (as shown below) 568 | > 569 | 570 | | Open Metamask | View Etherscan | 571 | |---------------|----------------| 572 | | ![Screenshot of the opening mm](docs/record_mm.png) | ![Screenshot at etherscan](docs/transaction_info.png) | 573 | 574 | > we are storing the filename as ```/``` since your api key is a root directory itself. 575 | 576 | once the file is uploaded you can see the file listed in the image above. You can list the files using the following route: 577 | 578 | >_**IP/moibit/listFiles**_ is a post call used to get the files from a folder, which expects JSON data with a single attribute ```{ path : }```, if the path is '/' it will return all the files that were uploaded to the root path using your API_KEY and API_SECRET and return the following response: 579 | 580 | ``` json 581 | { 582 | "meta": { 583 | "code": 200, 584 | "msg": "list file successfully" 585 | }, 586 | "data": { 587 | "Entries": [ 588 | { 589 | "Hash": "bafybeietzxj4i4vtt6k63daqpr7gqhmxt33w3ne6gj45jbkqp4r34hpzye", 590 | "Name": "1_profile.jpeg", 591 | "Size": 160746, 592 | "Type": 0 593 | }, 594 | { 595 | "Hash": "bafybeidyzu3ypc55uhev2qxmb4bztplzdxjoc4vevirqb64ab2njxan4rq", 596 | "Name": "404.png", 597 | "Size": 14462, 598 | "Type": 0 599 | }, 600 | ... 601 | ] 602 | } 603 | } 604 | ``` 605 | 606 | A type of 1 is a file and a type of 0 is a folder 607 | 608 | To see the file use the following route : 609 | >_**IP/moibit/readfilebyhash**_ is a post call used to get the file from MoiBit , which expects **JSON data with single attribute** ```{ filename : }``` 610 | 611 | > When viewing the file triggered we are validating the hash stored on-chain against the off-chain hash. If the hashes matches the verified column will be *Passed*. If the hashes do not match the verified column value will be *Failed*. If the file has not been clicked yet it will have a value of *Unverified*. 612 | 613 | After successful verification the file will display if the file type is viewable or it will be downloaded. 614 | ![Sample Dapp File read](docs/read_screenshot.png) 615 | 616 | #### if you change the file off-chain by following the process below 617 | 618 | ![Sample Dapp File change](docs/change_file.png) 619 | 620 | When you click the file the verification will fail because it was changed off-chain and the off-chain hash no longer matches the hash of the file saved on-chain. 621 | 622 | | Verification | On Click | 623 | |---------------|----------------| 624 | | ![Screenshot of the failed case](docs/fileChanged.png) | ![Screenshot of ](docs/onClickFail.png) | 625 | 626 | ## Maintainers 627 | 628 | 1. [Vuppala Sai Prashanth](https://github.com/its-VSP) 629 | 2. [Arunprakash](https://github.com/Arunprakash1414) 630 | 631 | ## Contributors 632 | 633 | 1. Ayush Gupta 634 | 2. Ganesh Prasad Kumble 635 | 636 | ## Support 637 | 638 | If you need more clarifications, feel free to join our Telegram or Slack community channels. You can also write us an email at [hello@moibit.io](mailto:hello@moibit.io) 639 | 640 | ## License 641 | 642 | [GNU General Public License v3.0](https://github.com/moibit/Moibit-Sample-DApp/blob/master/LICENSE) 643 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------