Skip to content

Commit

Permalink
Rebrand comment and doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
laudney committed Nov 26, 2014
1 parent 963b297 commit 014300a
Show file tree
Hide file tree
Showing 23 changed files with 243 additions and 243 deletions.
24 changes: 12 additions & 12 deletions README.md
@@ -1,40 +1,40 @@
btcutil
rddutil
=======

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

Package btcutil provides bitcoin-specific convenience functions and types.
Package rddutil provides Reddcoin-specific convenience functions and types.
A comprehensive suite of tests is provided to ensure proper functionality. See
`test_coverage.txt` for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the `cov_report.sh` script for a real-time
report. Package btcutil is licensed under the liberal ISC license.
report. Package rddutil is licensed under the liberal ISC license.

This package was developed for 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
This package was developed for rddd, an alternative full-node implementation of
Reddcoin which is under active development by Conformal. Although it was
primarily written for rddd, this package has intentionally been designed so it
can be used as a standalone package for any projects needing the functionality
provided.

## Documentation

[![GoDoc](https://godoc.org/github.com/conformal/btcutil?status.png)]
(http://godoc.org/github.com/conformal/btcutil)
[![GoDoc](https://godoc.org/github.com/reddcoin-project/rddutil?status.png)]
(http://godoc.org/github.com/reddcoin-project/rddutil)

Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/conformal/btcutil
http://godoc.org/github.com/reddcoin-project/rddutil

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/btcutil
http://localhost:6060/pkg/github.com/reddcoin-project/rddutil

## Installation

```bash
$ go get github.com/conformal/btcutil
$ go get github.com/reddcoin-project/rddutil
```

## GPG Verification Key
Expand All @@ -59,5 +59,5 @@ signature perform the following:

## License

Package btcutil is licensed under the [copyfree](http://copyfree.org) ISC
Package rddutil is licensed under the [copyfree](http://copyfree.org) ISC
License.
16 changes: 8 additions & 8 deletions address.go
Expand Up @@ -36,7 +36,7 @@ var (
)

// encodeAddress returns a human-readable payment address given a ripemd160 hash
// and netID which encodes the bitcoin network and address type. It is used
// and netID which encodes the Reddcoin network and address type. It is used
// in both pay-to-pubkey-hash (P2PKH) and pay-to-script-hash (P2SH) address
// encoding.
func encodeAddress(hash160 []byte, netID byte) string {
Expand Down Expand Up @@ -76,14 +76,14 @@ type Address interface {
ScriptAddress() []byte

// IsForNet returns whether or not the address is associated with the
// passed bitcoin network.
// passed Reddcoin network.
IsForNet(*rddnet.Params) bool
}

// DecodeAddress decodes the string encoding of an address and returns
// the Address if addr is a valid encoding for a known address type.
//
// The bitcoin network the address is associated with is extracted if possible.
// The Reddcoin network the address is associated with is extracted if possible.
// When the address does not encode the network, such as in the case of a raw
// public key, the address will be associated with the passed defaultNet.
func DecodeAddress(addr string, defaultNet *rddnet.Params) (Address, error) {
Expand Down Expand Up @@ -170,7 +170,7 @@ func (a *AddressPubKeyHash) ScriptAddress() []byte {
}

// IsForNet returns whether or not the pay-to-pubkey-hash address is associated
// with the passed bitcoin network.
// with the passed Reddcoin network.
func (a *AddressPubKeyHash) IsForNet(net *rddnet.Params) bool {
return a.netID == net.PubKeyHashAddrID
}
Expand Down Expand Up @@ -237,7 +237,7 @@ func (a *AddressScriptHash) ScriptAddress() []byte {
}

// IsForNet returns whether or not the pay-to-script-hash address is associated
// with the passed bitcoin network.
// with the passed Reddcoin network.
func (a *AddressScriptHash) IsForNet(net *rddnet.Params) bool {
return a.netID == net.ScriptHashAddrID
}
Expand Down Expand Up @@ -329,7 +329,7 @@ func (a *AddressPubKey) serialize() []byte {
// pay-to-pubkey-hash. Note that the public key format (uncompressed,
// compressed, etc) will change the resulting address. This is expected since
// pay-to-pubkey-hash is a hash of the serialized public key which obviously
// differs with the format. At the time of this writing, most Bitcoin addresses
// differs with the format. At the time of this writing, most Reddcoin addresses
// are pay-to-pubkey-hash constructed from the uncompressed public key.
//
// Part of the Address interface.
Expand All @@ -345,7 +345,7 @@ func (a *AddressPubKey) ScriptAddress() []byte {
}

// IsForNet returns whether or not the pay-to-pubkey address is associated
// with the passed bitcoin network.
// with the passed Reddcoin network.
func (a *AddressPubKey) IsForNet(net *rddnet.Params) bool {
return a.pubKeyHashID == net.PubKeyHashAddrID
}
Expand All @@ -372,7 +372,7 @@ func (a *AddressPubKey) SetFormat(pkFormat PubKeyFormat) {
// pay-to-pubkey-hash address. Note that the public key format (uncompressed,
// compressed, etc) will change the resulting address. This is expected since
// pay-to-pubkey-hash is a hash of the serialized public key which obviously
// differs with the format. At the time of this writing, most Bitcoin addresses
// differs with the format. At the time of this writing, most Reddcoin addresses
// are pay-to-pubkey-hash constructed from the uncompressed public key.
func (a *AddressPubKey) AddressPubKeyHash() *AddressPubKeyHash {
addr := &AddressPubKeyHash{netID: a.pubKeyHashID}
Expand Down
2 changes: 1 addition & 1 deletion address_test.go
Expand Up @@ -19,7 +19,7 @@ import (
)

// invalidNet is an invalid bitcoin network.
const invalidNet = rddwire.BitcoinNet(0xffffffff)
const invalidNet = rddwire.ReddcoinNet(0xffffffff)

func TestAddresses(t *testing.T) {
tests := []struct {
Expand Down
12 changes: 6 additions & 6 deletions bloom/README.md
Expand Up @@ -13,27 +13,27 @@ report. Package coinset is licensed under the liberal ISC license.

## Documentation

[![GoDoc](https://godoc.org/github.com/conformal/btcutil/bloom?status.png)]
(http://godoc.org/github.com/conformal/btcutil/bloom)
[![GoDoc](https://godoc.org/github.com/reddcoin-project/rddutil/bloom?status.png)]
(http://godoc.org/github.com/reddcoin-project/rddutil/bloom)

Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/conformal/btcutil/bloom
http://godoc.org/github.com/reddcoin-project/rddutil/bloom

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/btcutil/bloom
http://localhost:6060/pkg/github.com/reddcoin-project/rddutil/bloom

## Installation

```bash
$ go get github.com/conformal/btcutil/bloom
$ go get github.com/reddcoin-project/rddutil/bloom
```

## Examples

* [NewFilter Example]
(http://godoc.org/github.com/conformal/btcutil/bloom#example-NewFilter)
(http://godoc.org/github.com/reddcoin-project/rddutil/bloom#example-NewFilter)
Demonstrates how to create a new bloom filter, add a transaction hash to it,
and check if the filter matches the transaction.

Expand Down
10 changes: 5 additions & 5 deletions bloom/example_test.go
Expand Up @@ -9,8 +9,8 @@ import (
"math/rand"
"time"

"github.com/conformal/btcutil/bloom"
"github.com/conformal/btcwire"
"github.com/reddcoin-project/rddutil/bloom"
"github.com/reddcoin-project/rddwire"
)

// This example demonstrates how to create a new bloom filter, add a transaction
Expand All @@ -22,13 +22,13 @@ func ExampleNewFilter() {
// Create a new bloom filter intended to hold 10 elements with a 0.01%
// false positive rate and does not include any automatic update
// functionality when transactions are matched.
filter := bloom.NewFilter(10, tweak, 0.0001, btcwire.BloomUpdateNone)
filter := bloom.NewFilter(10, tweak, 0.0001, rddwire.BloomUpdateNone)

// Create a transaction hash and add it to the filter. This particular
// trasaction is the first transaction in block 310,000 of the main
// bitcoin block chain.
// Reddcoin block chain.
txHashStr := "fd611c56ca0d378cdcd16244b45c2ba9588da3adac367c4ef43e808b280b8a45"
txHash, err := btcwire.NewShaHashFromStr(txHashStr)
txHash, err := rddwire.NewShaHashFromStr(txHashStr)
if err != nil {
fmt.Println(err)
return
Expand Down

0 comments on commit 014300a

Please sign in to comment.