An alternative full node implementation of LBRY's blockchain written in Go (golang)

Go to file

Dave Collins 41c981348e Use byte literals to make go vet happy. The go vet command complains about untagged struct initializers when defining a ShaHash directly. This seems to be a limitation where go vet does not exclude the warning for types which are a constant size byte array like it does for normal constant size byte array definition. This commit simply modifies the code to use a constant definition cast to a ShaHash to overcome the limitation of go vet.		2014-09-12 14:04:55 -05:00
.travis.yml	Hold off on go vet for now.	2014-09-08 09:16:09 -04:00
doc.go	Fix documentation code examples.	2014-05-27 20:41:30 -05:00
genesis.go	Use byte literals to make go vet happy.	2014-09-12 14:04:55 -05:00
genesis_test.go	goimports -w .	2014-07-02 19:42:29 -05:00
internal_test.go	Test panic for converting invalid sha strings.	2014-06-13 09:49:08 -05:00
LICENSE	Add ISC license.	2014-05-28 00:15:11 -05:00
params.go	WIP coin type	2014-08-12 10:37:58 -05:00
README.md	Update to coveralls.io for test coverage reporting.	2014-06-12 18:44:34 -05:00
register_test.go	Add priv and public key bytes for HD wallet keys.	2014-07-19 03:19:19 -05:00

README.md

btcnet

[] (https://travis-ci.org/conformal/btcnet) [![Coverage Status] (https://coveralls.io/repos/conformal/btcnet/badge.png?branch=master)] (https://coveralls.io/r/conformal/btcnet?branch=master)

Package btcnet defines the network parameters for the three standard Bitcoin networks and provides the ability for callers to define their own custom Bitcoin networks.

This package is one of the core packages from btcd, an alternative full-node implementation of Bitcoin which is under active development by Conformal. Although it was primarily written for btcd, this package has intentionally been designed so it can be used as a standalone package for any projects needing to use parameters for the standard Bitcoin networks or for projects needing to define their own network.

Sample Use

package main

import (
	"flag"
	"fmt"
	"log"

	"github.com/conformal/btcnet"
	"github.com/conformal/btcutil"
)

var testnet = flag.Bool("testnet", false, "operate on the testnet Bitcoin network")

// By default (without -testnet), use mainnet.
var netParams = &btcnet.MainNetParams

func main() {
	flag.Parse()

	// Modify active network parameters if operating on testnet.
	if *testnet {
		netParams = &btcnet.TestNet3Params
	}

	// later...

	// Create and print new payment address, specific to the active network.
	pubKeyHash := make([]byte, 20)
	addr, err := btcutil.NewAddressPubKeyHash(pubKeyHash, netParams)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(addr)
}

Documentation

[] (http://godoc.org/github.com/conformal/btcnet)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here.

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/conformal/btcnet

Installation

$ go get github.com/conformal/btcnet

GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from Conformal. To verify the signature perform the following:

Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
Import the public key into your GPG keyring:
```
gpg --import GIT-GPG-KEY-conformal.txt
```
Verify the release tag with the following command where TAG_NAME is a placeholder for the specific tag:
```
git tag -v TAG_NAME
```

License

Package btcnet is licensed under the liberal ISC License.