Blockchain Smart Contract & IPFS - Boilerplate

This helpful Boilerplates that allow you to focus on what makes your DApp unique; includes Solidity Smart Contracts & Libraries, Front-end Views and more.

Demo

App	Ganache Port	UI Port
Digital Identity	8545	3333
Flight Delay	8546	3332
Dapp	8547	3331

1. Roadmap

1.1. Truffle Developer

1.2. Lazy Developer

Private Blockchains “Consortium Blockchains” using Geth to setup a “private” or “testnet” Ethereum blockchain. Note: Geth is suitable for building frontends for DApps --> Genesis block, Indentity, DataDir --> Externally Owned Accounts EOA & Contract Accounts TODO
Develop eConomySharing: Listing.sol
Financial atomic processes & standards: payments, assets, data, identity, KYC, governance

1.3. Happy User

2. Directory Structure

  contracts
  ├── contracts                                           <- Solidity contracts 
  ├── migrations                                            <- Deployment Script
  ├── test                                                  <- Test contracts
  ├── truffle-config.js                                     <- Truffle config
  src                                                     <- O2O Service
  ├── ipfs-service                                          <- IPFS service
  ├── contract-service                                      <- Contract service
  ├── test                                                  <- Test services
  README.md

3. Tests

Browser tests are automatically served at http://localhost:8081 when you run npm start.

Tests are automatically rerun when source or test code is changed.

Run a subset of tests using the grep query string parameter, for example: http://localhost:8081/?grep=IpfsService

We also have contract unit tests that are not run in the browser. These can be run with npm run test:contracts (you should not have the server running at this time, as these tests start their own local blockchain instance).

O2OProtocol JS Documentation

Introduction

Welcome to the o2oprotocol.js documentation! o2oprotocol.js is a Javascript library for interacting with the O2O Protocol. Using the library you can create new listings from your applications, purchase them, or update them from your own off-chain applications.

More information can be found at O2OProtocol Platform Readme

Warning

This is still an alpha version which will evolve significantly before the main net release.

Data Sharing

Sellers:

Create Listings
Update Listings
Delete Listings
Validate Listings

Buyers:

Browse Listing
Create Bookings
Update Bookings
Cancel Bookings

Note: to show the gas costs of each transaction during a test, set the enviroment variable GAS_TRACKING before launching truffle develop. For example, using bash: GAS_TRACKING=1 npx truffle develop

Install

NPM

npm install o2oprotocol --save

Yarn

yarn add o2oprotocol

Local

For developing on o2oprotocol.js, it is better to link the package rather than installing it. (Otherwise you would need to run npm build everytime you made a change to the package.)

Install:dev (shortcut for npm install && npm link). Linking makes this available as a local npm package for local dapp development

npm run install:dev

Import

import O2OProtocol from 'o2oprotocol'
const configOptions = {}
const { contractService, ipfsService, o2oService } = new O2OProtocol(configOptions)

Configuration Options

Config options are passed into the O2OProtocol constructor at instantiation

const configOptions = {
  option: 'value'
}
const o2o = new O2OProtocol(configOptions)

Valid options:

ipfsDomain
ipfsApiPort
ipfsGatewayPort
ipfsGatewayProtocol
attestationServerUrl

IPFS

If you are running a local IPFS daemon then set the following config options (see config options):

{
 ipfsDomain: '127.0.0.1',
 ipfsApiPort: '5001',
 ipfsGatewayPort: '8081',
 ipfsGatewayProtocol: 'http'
}

Configure your local IPFS daemon with the following settings to avoid CORS errors:

ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["localhost:*"]'
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["GET", "POST", "PUT"]'
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'

Troubleshooting

Python 3

If you have Python 3 installed, you may see this error when installing dependencies:

gyp ERR! stack Error: Python executable "/Users/aiham/.pyenv/shims/python" is v3.6.4, which is not supported by gyp.

Resolve this by configuring npm to use Python 2 (where python2.7 is a binary accessible from your $PATH):

npm config set python python2.7

Tests

When you begin developing, run npm test and keep it running while you develop.

View test results in your browser (with MetaMask installed and setup) at http://localhost:8081