c949e04246
This commit adds an example test file so it integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code. It is also nice to have the examples in one place rather than repeating it in doc.go and README.md. Links and information about the examples have been included in README.md in place of the examples and doc.go has been updated accordingly.
21 lines
946 B
Go
21 lines
946 B
Go
// Copyright (c) 2013-2014 Conformal Systems LLC.
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
/*
|
|
Package btcec implements support for the elliptic curves needed for bitcoin.
|
|
|
|
Bitcoin uses elliptic curve cryptography using koblitz curves
|
|
(specifically secp256k1) for cryptographic functions. See
|
|
http://www.secg.org/collateral/sec2_final.pdf for details on the
|
|
standard.
|
|
|
|
This package provides the data structures and functions implementing the
|
|
crypto/elliptic Curve interface in order to permit using these curves
|
|
with the standard crypto/ecdsa package provided with go. Helper
|
|
functionality is provided to parse signatures and public keys from
|
|
standard formats. It was designed for use with btcd, but should be
|
|
general enough for other uses of elliptic curve crypto. It was originally based
|
|
on some initial work by ThePiachu, but has significantly diverged since then.
|
|
*/
|
|
package btcec
|