status-go/README.md

# Status bindings for go-ethereum
[![TravisCI Builds](https://img.shields.io/badge/TravisCI-URL-yellowgreen.svg?link=https://travis-ci.org/status-im/status-go)](https://travis-ci.org/status-im/status-go)
[![GoDoc](https://godoc.org/github.com/status-im/status-go?status.svg)](https://godoc.org/github.com/status-im/status-go) [![Master Build Status](https://img.shields.io/travis/status-im/status-go/master.svg?label=build/master)](https://github.com/status-im/status-go/tree/master) [![Develop Build Status](https://img.shields.io/travis/status-im/status-go/develop.svg?label=build/develop)](https://github.com/status-im/status-go/tree/develop)

# Docs
- [How To Build](https://www.notion.so/status/Building-status-go-f6b827dd1302436ba0575f4c543a352e)
- [Notes on Bindings](https://www.notion.so/status/Binding-notes-344f30ce0f2845a2b43e2de70931284a)
- [Status-go docs](https://www.notion.so/status/status-go-4fbe361e8e75484abeadadc80dd4dcdc)

# Intro
status-go is an underlying part of [Status](status.im) - a browser, messenger, and gateway to a decentralized world.

It's written in Go and requires Go 1.8 or above.

It uses Makefile to do most common actions. See `make help` output for available commands.

status-go uses [forked ethereum-go](https://github.com/status-im/go-ethereum) with [some changes](https://github.com/status-im/go-ethereum/wiki/Rebase-Geth-1.7.0) in it, located under [`vendor/` dir](https://github.com/status-im/status-go/tree/develop/vendor/github.com/ethereum/go-ethereum).

# Build
There are two main modes status-go can be built:

 - standalone server
 - library to link for Android or iOS

Use following Makefile commands:

- `make statusgo` (builds binary into `build/bin/statusd`)
- `make statusgo-android`) (builds .aar file `build/android-16/aar`)
- `make statusgo-ios` and `make statusgo-ios-simulator` (builds iOS related artifacts in `build/os-9.3/framework`)

# Testing
To setup accounts passphrase you need to setup an environment variable: `export ACCOUNT_PASSWORD="secret_pass_phrase"`.

To test statusgo, use: `make ci`. Make sure the `gometalinter` package is installed first by running `make lint-install`
To test statusgo using a giving network by name, use: `make ci networkid=rinkeby`.
To test statusgo using a giving network by id number, use: `make ci networkid=3`.

If you want to launch specific test, for instance `RPCSendTransactions`, use the following command:
```
go test -v ./geth/api/ -testify.m ^RPCSendTransaction$
```

Note `-testify.m` as [testify/suite](https://godoc.org/github.com/stretchr/testify/suite) is used to group individual tests.

# Licence
[Mozilla Public License 2.0](https://github.com/status-im/status-go/blob/develop/LICENSE.md)
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			`# Status bindings for go-ethereum`
			`[![TravisCI Builds](https://img.shields.io/badge/TravisCI-URL-yellowgreen.svg?link=https://travis-ci.org/status-im/status-go)](https://travis-ci.org/status-im/status-go)`
			`[![GoDoc](https://godoc.org/github.com/status-im/status-go?status.svg)](https://godoc.org/github.com/status-im/status-go) [![Master Build Status](https://img.shields.io/travis/status-im/status-go/master.svg?label=build/master)](https://github.com/status-im/status-go/tree/master) [![Develop Build Status](https://img.shields.io/travis/status-im/status-go/develop.svg?label=build/develop)](https://github.com/status-im/status-go/tree/develop)`
Adds build status 2016-09-28 14:35:39 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			`# Docs`
			`- [How To Build](https://www.notion.so/status/Building-status-go-f6b827dd1302436ba0575f4c543a352e)`
			`- [Notes on Bindings](https://www.notion.so/status/Binding-notes-344f30ce0f2845a2b43e2de70931284a)`
			`- [Status-go docs](https://www.notion.so/status/status-go-4fbe361e8e75484abeadadc80dd4dcdc)`
Update README.md 2016-12-19 20:51:08 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			`# Intro`
			`status-go is an underlying part of [Status](status.im) - a browser, messenger, and gateway to a decentralized world.`
Adds build status 2016-09-28 14:35:39 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			`It's written in Go and requires Go 1.8 or above.`
Adds build status 2016-09-28 14:35:39 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			It uses Makefile to do most common actions. See `make help` output for available commands.
Update README.md 2016-09-01 13:39:04 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			status-go uses [forked ethereum-go](https://github.com/status-im/go-ethereum) with [some changes](https://github.com/status-im/go-ethereum/wiki/Rebase-Geth-1.7.0) in it, located under [`vendor/` dir](https://github.com/status-im/status-go/tree/develop/vendor/github.com/ethereum/go-ethereum).
Note on reference LES server 2016-09-28 12:31:09 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			`# Build`
			`There are two main modes status-go can be built:`

			`- standalone server`
			`- library to link for Android or iOS`

			`Use following Makefile commands:`

			- `make statusgo` (builds binary into `build/bin/statusd`)
			- `make statusgo-android`) (builds .aar file `build/android-16/aar`)
			- `make statusgo-ios` and `make statusgo-ios-simulator` (builds iOS related artifacts in `build/os-9.3/framework`)

			`# Testing`
Issue/fix public testnet tests #424 (#438) * Accounts are now encrypted with a strong passphrase. * The encrypted passphrase is stored in .travis.yml * Public testnet tests are now run after tests on a private net 2017-11-07 17:46:11 +00:00			To setup accounts passphrase you need to setup an environment variable: `export ACCOUNT_PASSWORD="secret_pass_phrase"`.

Add instructions to install gometalinter in Readme (#506) 2017-12-08 11:54:07 +00:00			To test statusgo, use: `make ci`. Make sure the `gometalinter` package is installed first by running `make lint-install`
Update readme 2017-10-26 19:05:12 +00:00			To test statusgo using a giving network by name, use: `make ci networkid=rinkeby`.
			To test statusgo using a giving network by id number, use: `make ci networkid=3`.
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00
			If you want to launch specific test, for instance `RPCSendTransactions`, use the following command:
			```
Get rid of build/env.sh Fixes #418 (#446) Removing build/env.sh and relying on callers of Makefile to have their Go environment properly set up. 2017-11-04 04:20:17 +00:00			`go test -v ./geth/api/ -testify.m ^RPCSendTransaction$`
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			```

			Note `-testify.m` as [testify/suite](https://godoc.org/github.com/stretchr/testify/suite) is used to group individual tests.
Note on reference LES server 2016-09-28 12:31:09 +00:00
Update README (#380) Added basic info on build and testing to README 2017-10-09 14:11:12 +00:00			`# Licence`
			`[Mozilla Public License 2.0](https://github.com/status-im/status-go/blob/develop/LICENSE.md)`