Skycoin is a next-generation cryptocurrency.
Skycoin improves on Bitcoin in too many ways to be addressed here.
Skycoin is a small part of OP Redecentralize and OP Darknet Plan.
- Skycoin Blog
- Skycoin Docs
- Skycoin Blockchain Explorer
- Skycoin Development Telegram Channel
Table of Contents
- API Documentation
- Integrating Skycoin with your application
- Contributing a node to the network
- URI Specification
- Client libraries
- Running Tests
- Running Integration Tests
- Code Linting
- Dependency Management
- Wallet GUI Development
Skycoin supports go1.10+.
Go 1.10+ Installation and Setup
Go get skycoin
go get github.com/skycoin/skycoin/...
This will download
You can also clone the repo directly with
git clone https://github.com/skycoin/skycoin,
but it must be cloned to this path:
Run Skycoin from the command line
cd $GOPATH/src/github.com/skycoin/skycoin make run
Show Skycoin node options
cd $GOPATH/src/github.com/skycoin/skycoin make run-help
Run Skycoin with options
cd $GOPATH/src/github.com/skycoin/skycoin make ARGS="--launch-browser=false -data-dir=/custom/path" run
This is the quickest way to start using Skycoin using Docker.
$ docker volume create skycoin-data $ docker volume create skycoin-wallet $ docker run -ti --rm \ -v skycoin-data:/data/.skycoin \ -v skycoin-wallet:/wallet \ -p 6000:6000 \ -p 6420:6420 \ skycoin/skycoin
This image has a
skycoin user for the skycoin daemon to run, with UID and GID 10000.
When you mount the volumes, the container will change their owner, so you
must be aware that if you are mounting an existing host folder any content you
have there will be own by 10000.
The container will run with some default options, but you can change them
by just appending flags at the end of the
docker run command. The following
example will show you the available options.
docker run --rm skycoin/skycoin -help
Access the dashboard: http://localhost:6420.
Access the API: http://localhost:6420/version.
Building your own images
The skycoin/skycoindev-cli docker image is provided in order to make easy to start developing Skycoin. It comes with the compiler, linters, debugger and the vim editor among other tools.
JSON-RPC 2.0 API
Deprecated, avoid using this
Skycoin command line interface
Integrating Skycoin with your application
Contributing a node to the network
Add your node's
ip:port to the peers.txt file.
This file will be periodically uploaded to https://downloads.skycoin.net/blockchain/peers.txt
and used to seed client with peers.
Note: Do not add Skywire nodes to
Only add Skycoin nodes with high uptime and a static IP address (such as a Skycoin node hosted on a VPS).
Skycoin URIs obey the same rules as specified in Bitcoin's BIP21.
They use the same fields, except with the addition of an optional
hours parameter, specifying the coin hours.
Example Skycoin URIs:
We have two branches:
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.
api- REST API interface
api/webrpc- JSON-RPC 2.0 API [deprecated]
cipher- cryptographic library
cli- CLI library
coin- blockchain data structures
daemon- top-level application manager, combining all components (networking, database, wallets)
daemon/gnet- networking library
daemon/pex- peer management
visor- top-level blockchain database layer
visor/blockdb- low-level blockchain database layer
visor/historydb- low-level blockchain database layer for historical blockchain metadata
wallet- wallet file management
Skycoin implements client libraries which export core functionality for usage from other programming languages.
For further details run
make docs to generate documetation and read the corresponding README and API references.
Running Integration Tests
There are integration tests for the CLI and HTTP API interfaces. They have two run modes, "stable" and "live.
The stable integration tests will use a skycoin daemon whose blockchain is synced to a specific point and has networking disabled so that the internal state does not change.
The live integration tests should be run against a synced or syncing node with networking enabled.
Stable Integration Tests
./ci-scripts/integration-test-stable.sh -v -w
-w option, run wallet integrations tests.
-v option, show verbose logs.
Live Integration Tests
The live integration tests run against a live runnning skycoin node, so before running the test, we
need to start a skycoin node. Since the
cli integration test requires the rpc interface enabled,
we should start node with
./run.sh -launch-browser=false -rpc-interface
After the skycoin node is up, run the following command to start the live tests:
The above command will run all tests except the wallet related tests. To run wallet tests, we
need to manually specify a wallet file, and it must have at least
2 coins and
it also must have been loaded by the node.
We can specify the wallet by setting two environment variables:
represents the absolute path of the wallet directory, and
WALLET_NAME represents the wallet file name.
WALLET_DIR is only used by the CLI integration tests. The GUI integration tests use the node's
configured wallet directory, which can be controlled with
-wallet-dir when running the node.
If the wallet is encrypted, also set
export WALLET_DIR="$HOME/.skycoin/wallets" export WALLET_NAME="$valid_wallet_filename" export WALLET_PASSWORD="$wallet_password"
Then run the tests with the following command:
./ci-scripts/integration-test-live.sh -v -w
Debugging Integration Tests
Run specific test case:
It's annoying and a waste of time to run all tests to see if the test we real care
is working correctly. There's an option:
-r, which can be used to run specific test case.
For exampe: if we only want to test
TestStableAddressBalance and see the result, we can run:
./ci-scripts/integration-test-stable.sh -v -r TestStableAddressBalance
Update golden files in integration testdata
Golden files are expected data responses from the CLI or HTTP API saved to disk. When the tests are run, their output is compared to the golden files.
To update golden files, use the
./ci-scripts/integration-test-live.sh -v -u ./ci-scripts/integration-test-stable.sh -v -u
We can also update a specific test case's golden file with the
.go source files should be formatted
goimports. You can do this with:
Dependencies are managed with 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 help for instructions on vendoring a specific version of a dependency, or updating them.
When updating or initializing,
dep will find the latest version of a dependency that will compile.
Initialize all dependencies:
Update all dependencies:
dep ensure -update -v
Add a single dependency (latest version):
dep ensure github.com/foo/bar
Add a single dependency (more specific version), or downgrade an existing dependency:
dep ensure github.com/foo/bar@tag
There are 4 configuration modes in which you can run a skycoin node:
- Development Desktop Daemon
- Server Daemon
- Electron Desktop Client
- Standalone Desktop Client
Development Desktop Daemon Mode
This mode is configured via
Server Daemon Mode
The default settings for a skycoin node are chosen for
Server Daemon, which is typically run from source.
This mode is usually preferred to be run with security options, though
-disable-csrf is normal for server daemon mode, it is left enabled by default.
$ go run cmd/skycoin/skycoin.go
Electron Desktop Client Mode
This mode configures itself via electron-main.js
Standalone Desktop Client Mode
This mode is configured by compiling with
STANDALONE_CLIENT build tag.
The configuration is handled in
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.
Instructions for doing this:
- If the
masterbranch has commits that are not in
develop(e.g. due to a hotfix applied to
- Compile the
src/gui/static/dist/to make sure that it is up to date (see Wallet GUI Development README)
- Update all version strings in the repo (grep for them) to the new version
CHANGELOG.md: move the "unreleased" changes to the version and add the date
- Merge these changes to
- Follow the steps in pre-release testing
- Make a PR merging
- Review the PR and merge it
- Tag the master branch with the version number. Version tags start with
v0.20.0. Sign the tag. If you have your GPG key in github, creating a release on the Github website will automatically tag the release. It can be tagged from the command line with
git tag -as v0.20.0 $COMMIT_ID, but Github will not recognize it as a "release".
- Make sure that the client runs properly from the
- Release builds are created and uploaded by travis. To do it manually, checkout the
masterbranch and follow the create release builds instructions.
If there are problems discovered after merging to master, start over, and increment the 3rd version number.
v0.20.1, for minor fixes.
Performs these actions before releasing:
make integration-test-live(see live integration tests) both with an unencrypted and encrypted wallet.
go run cmd/cli/cli.go checkdbagainst a synced node
- On all OSes, make sure that the client runs properly from the command line (
- Build the releases and make sure that the Electron client runs properly on Windows, Linux and macOS.
- Use a clean data directory with no wallets or database to sync from scratch and verify the wallet setup wizard.
- Load a test wallet with nonzero balance from seed to confirm wallet loading works
- Send coins to another wallet to confirm spending works
- Restart the client, confirm that it reloads properly
Creating release builds
Releases are signed with this PGP key:
The fingerprint for this key is:
pub ed25519 2017-09-01 [SC] [expires: 2023-03-18] 10A7 22B7 6F2F FE7B D238 0222 5801 631B D27C 7874 uid GZ-C SKYCOIN <firstname.lastname@example.org> sub cv25519 2017-09-01 [E] [expires: 2023-03-18]
Keybase.io account: https://keybase.io/gzc
If you can't or don't want to import the keys from a keyserver, the signing key is available in the repo: gz-c.asc.
Releases and their signatures can be found on the releases page.
Instructions for generating a PGP key, publishing it, signing the tags and binaries: https://gist.github.com/gz-c/de3f9c43343b2f1a27c640fe529b067c