openx

README

OpenX

This repo contains a WIP implementation of the openx idea. Broadly, the openx model seeks to implement the paradigm of investing and developing projects without hassles and enabling smart ownership with the help of semi trust-less entities on the blockchain. The openx model can be thought more generally as a platform of platforms and houses multiple platforms within it (in platforms/). The goal is to have a common interface between all parties that relate to a project: investors, investees (i.e. beneficiaries or receivers of the investment) and the family of developers (that include all service providers). Depending upon the country of project origin, investors may be required to complete KYC to be able to invest in assets. The openx model can be adapted to any blockchain model and we're currently piloting the opensolar idea in Stellar.

Related Repositories

Like Go, openx is built on the idea of modularity and reusability of packages.

This repo contains the architecture handlers necessary for building you own platform :

• essentials contains the code necessary for commonly used packages, crypto and database handlers
• openx-cli contains CLI clients that can interface with openx
• opensolar contains an implementation of the openx idea targeted at solar infrastructure

Getting Started

Installing from PPA

Openx is available on PPA here

Building from source

In order to be able to run this, you need to have the latest version of go installed. Here is a quick tutorial on how to get go installed on a Linux / macOS machine. Older versions of go (more than two versions old according to the golang wiki) may have unpatched vulnerabilities and as a result, we will not be backporting openx to older versions of go.

Once you have go installed, you need to go get the packages in this repo. Before that, you might need to install the stellar/go package separately since it uses a separate dependency manager (dep). If this is the case, get the stellar/go package and then run dep ensure -v inside $HOME/stellar/go.

Once you're done with stellar/go, clone the repo using git clone https://github.com/YaleOpenLab/openx.git and install dependencies using go get -v ./...

Now you should be ready to compile openx using go build. Create a config file similar to dummyconfig.yaml and ensure you have necessary permissions to write to $HOME. Then you should be able to start openx using ./openx

Installing IPFS

ipfs is used by some parts of the program to store data that needs to be publicly verified. Download a release from https://github.com/ipfs/go-ipfs/releases and run install.sh. If you face conflicts between multiple ipfs versions, you might need to run fs-repo-migrations to migrate to the newer version. If you don't have anything worth storing, you can delete the ipfs home directory and run ipfs init again (this will delete the data stored in ipfs prior to deletion)

You need to keep your peer key (ipfs.key usually) in a safe place for future reference. Start ipfs using ipfs daemon and you can test it by creating a file test.txt and run ipfs add test.txt. The resultant hash can be decrypted using curl "http://127.0.0.1:8080/ipfs/hash" where 127:0.0.1:8080 is the endpoint of the ipfs server. If you need more help on setting up ipfs, you can also refer to this helpful tutorial.

Running tests

Running tests is simple with go test but the tests have flags since some require running other daemons in the background (ipfs). There are two kinds of flags right now - travis and all. If you need the coverage stats as well, you need to install cover as well. go get golang.org/x/tools/cmd/cover if you don't have the package. Running go test --tags="travis" -coverprofile=test.txt ./... should run all the tests and provide coverage data on each specific package.

Contributing

Please feel free to open Pull Requests and Issues with your changes and suggestions. Before working on a major feature, please describe the same in an issue so everyone can understand what you're building.

Security

For security related issues, DO NOT OPEN A GITHUB ISSUE!. Please disclose the information responsibly by sending a (preferably PGP Encrypted) email to the lead developer Varunram Ganesh (contact@varunram.com). His PGP Key fingerprint is C98F 0014 9A99 36E4 E56D 2471 708C 6065 04A4 9970

In addition to this, openx is fully fully compliant with the disclose.io core terms followed by bugcrowd. For more info, please checkout SECURITY.md

License

GPL3