Skycoin

Skycoin is a next-generation cryptocurrency.

Skycoin improves on Bitcoin in too many ways to be addressed here.

Skycoin is small part of OP Redecentralize and OP Darknet Plan.

Installation

Installing golang

Fetch the skycoin source

go get https://github.com/skycoin/skycoin/...

This will download github.com/skycoin/skycoin to $GOPATH/src/github.com/skycoin/skycoin.

If you clone the repo with git clone, make sure to place it at $GOPATH/src/github.com/skycoin/skycoin.

Run

cd $GOPATH/src/github.com/skycoin/skycoin
./run.sh

Options

cd $GOPATH/src/github.com/skycoin/skycoin
./run.sh --help

API Documentation

Development

We have two branches: master and develop.

develop is the default branch and will have the latest code.

master will always be equal to the current stable release on the website, and should correspond with the latest release tag.

Modules

/src/cipher - cryptography library
/src/coin - the blockchain
/src/daemon - networking and wire protocol
/src/visor - the top level, client
/src/gui - the web wallet and json client interface
/src/wallet - the private key storage library
/src/api/webrpc - JSON-RPC 2.0 API
/src/api/cli - CLI library

Formatting

All .go source files should be formatted with gofmt or goimports.

Updating Vendored Dependencies

Dependencies are managed with dep.

To install dep:

go get -u github.com/golang/dep

dep vendors all dependencies into the repo.

If you change the dependencies, you should update them as needed with dep ensure.

Use dep help for instructions on vendoring a specific version of a dependency, or updating them.

After adding a new dependency (with dep ensure), run dep prune to remove any unnecessary subpackages from the dependency.

When updating or initializing, dep will find the latest version of a dependency that will compile.

Examples:

Initialize all dependencies:

dep init
dep prune

Update all dependencies:

dep ensure -update -v
dep prune

Add a single dependency (latest version):

dep ensure github.com/foo/bar
dep prune

Add a single dependency (more specific version), or downgrade an existing dependency:

dep ensure github.com/foo/bar@tag
dep prune

Wallet GUI Development

The compiled wallet source should be checked in to the repo, so that others do not need to install node to run the software.

Compile and add the wallet source to git:

cd src/gui/static
npm install
npm run build
git add .

Releases

TODO: Full instructions on doing a release. Need instructions on updating version number in source code, and running scripts to build releases

When ready to do a release, a pull request merging develop into master must be made.

After merging to master, tag the branch with the version number.

Once master branch is updated, git checkout master and create the release builds.

Creating release builds

Create Release builds.

Enrique8191/skycoin