mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2025-02-23 22:47:01 +01:00
Code Issues Projects Releases Wiki Activity
btcd/btcec/README.md

41 lines
1.8 KiB
Markdown
Raw Normal View History

Initial commit.
2013-06-13 12:45:48 -05:00
btcec
=====
docs: update shields
2021-03-04 17:12:45 -05:00
[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files.
2017-05-25 11:29:23 -05:00
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
btcec: convert package into go module, alias to dcrec In this commit, we turn the package into a new Go module (version 2), and then port over the current set of types and functions to mainly alias to the more optimized and maintained dcrec variant. Taking a look at the benchmarks, most operations other than normalization (which IIRC is a bit slower now due to constant time fixes) enjoy some nice speeds up: ``` benchcmp is deprecated in favor of benchstat: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat benchmark old ns/op new ns/op delta BenchmarkAddJacobian-8 464 328 -29.20% BenchmarkAddJacobianNotZOne-8 1138 372 -67.27% BenchmarkScalarBaseMult-8 47336 31531 -33.39% BenchmarkScalarBaseMultLarge-8 42465 32057 -24.51% BenchmarkScalarMult-8 123355 117579 -4.68% BenchmarkNAF-8 582 168 -71.12% BenchmarkSigVerify-8 175414 120794 -31.14% BenchmarkFieldNormalize-8 23.8 24.4 +2.39% BenchmarkParseCompressedPubKey-8 24282 10907 -55.08% ```
2021-11-18 18:25:56 -08:00
[![GoDoc](https://pkg.go.dev/github.com/btcsuite/btcd/btcec/v2?status.png)](https://pkg.go.dev/github.com/btcsuite/btcd/btcec/v2)
Add support for TravisCI. Also add TravisCI build status badge to README.md.
2013-12-23 11:41:02 -06:00
Bring README.md up-to-date with the current status.
2013-12-28 15:04:12 -06:00
Package btcec implements elliptic curve cryptography needed for working with
Bitcoin (secp256k1 only for now). It is designed so that it may be used with the
Remove test coverage report refs from README.md. This is no longer needed since the repository is now configured to work with coveralls.io for test coverage reporting.
2014-08-10 15:10:55 -05:00
standard crypto/ecdsa packages provided with go. A comprehensive suite of test
is provided to ensure proper functionality. Package btcec was originally based
on work from ThePiachu which is licensed under the same terms as Go, but it has
Relicense to the btcsuite developers. This commit relicenses all code in this repository to the btcsuite developers.
2015-05-01 01:28:01 -05:00
signficantly diverged since then. The btcsuite developers original is licensed
under the liberal ISC license.
Initial implementation.
2013-06-13 13:27:23 -05:00
Import btcec repo into btcec directory.
2015-02-06 10:09:24 -06:00
Although this package was primarily written for btcd, it has intentionally been
Initial implementation.
2013-06-13 13:27:23 -05:00
designed so it can be used as a standalone package for any projects needing to
use secp256k1 elliptic curve cryptography.
docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Finally, it's modifies the Installation section to Installation and Updating and adds a '-u' to the 'go get' command since it works for both and thus is simpler.
2015-10-23 11:34:50 -05:00
## Installation and Updating
Initial implementation.
2013-06-13 13:27:23 -05:00
```bash
btcec: convert package into go module, alias to dcrec In this commit, we turn the package into a new Go module (version 2), and then port over the current set of types and functions to mainly alias to the more optimized and maintained dcrec variant. Taking a look at the benchmarks, most operations other than normalization (which IIRC is a bit slower now due to constant time fixes) enjoy some nice speeds up: ``` benchcmp is deprecated in favor of benchstat: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat benchmark old ns/op new ns/op delta BenchmarkAddJacobian-8 464 328 -29.20% BenchmarkAddJacobianNotZOne-8 1138 372 -67.27% BenchmarkScalarBaseMult-8 47336 31531 -33.39% BenchmarkScalarBaseMultLarge-8 42465 32057 -24.51% BenchmarkScalarMult-8 123355 117579 -4.68% BenchmarkNAF-8 582 168 -71.12% BenchmarkSigVerify-8 175414 120794 -31.14% BenchmarkFieldNormalize-8 23.8 24.4 +2.39% BenchmarkParseCompressedPubKey-8 24282 10907 -55.08% ```
2021-11-18 18:25:56 -08:00
$ go install -u -v github.com/btcsuite/btcd/btcec/v2
Initial implementation.
2013-06-13 13:27:23 -05:00
```
Use testable examples and update doc.go README.md. 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.
2014-08-10 15:13:11 -05:00
## Examples
btcec: convert package into go module, alias to dcrec In this commit, we turn the package into a new Go module (version 2), and then port over the current set of types and functions to mainly alias to the more optimized and maintained dcrec variant. Taking a look at the benchmarks, most operations other than normalization (which IIRC is a bit slower now due to constant time fixes) enjoy some nice speeds up: ``` benchcmp is deprecated in favor of benchstat: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat benchmark old ns/op new ns/op delta BenchmarkAddJacobian-8 464 328 -29.20% BenchmarkAddJacobianNotZOne-8 1138 372 -67.27% BenchmarkScalarBaseMult-8 47336 31531 -33.39% BenchmarkScalarBaseMultLarge-8 42465 32057 -24.51% BenchmarkScalarMult-8 123355 117579 -4.68% BenchmarkNAF-8 582 168 -71.12% BenchmarkSigVerify-8 175414 120794 -31.14% BenchmarkFieldNormalize-8 23.8 24.4 +2.39% BenchmarkParseCompressedPubKey-8 24282 10907 -55.08% ```
2021-11-18 18:25:56 -08:00
* [Sign Message](https://pkg.go.dev/github.com/btcsuite/btcd/btcec/v2#example-package--SignMessage)
Use testable examples and update doc.go README.md. 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.
2014-08-10 15:13:11 -05:00
Demonstrates signing a message with a secp256k1 private key that is first
parsed form raw bytes and serializing the generated signature.
btcec: convert package into go module, alias to dcrec In this commit, we turn the package into a new Go module (version 2), and then port over the current set of types and functions to mainly alias to the more optimized and maintained dcrec variant. Taking a look at the benchmarks, most operations other than normalization (which IIRC is a bit slower now due to constant time fixes) enjoy some nice speeds up: ``` benchcmp is deprecated in favor of benchstat: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat benchmark old ns/op new ns/op delta BenchmarkAddJacobian-8 464 328 -29.20% BenchmarkAddJacobianNotZOne-8 1138 372 -67.27% BenchmarkScalarBaseMult-8 47336 31531 -33.39% BenchmarkScalarBaseMultLarge-8 42465 32057 -24.51% BenchmarkScalarMult-8 123355 117579 -4.68% BenchmarkNAF-8 582 168 -71.12% BenchmarkSigVerify-8 175414 120794 -31.14% BenchmarkFieldNormalize-8 23.8 24.4 +2.39% BenchmarkParseCompressedPubKey-8 24282 10907 -55.08% ```
2021-11-18 18:25:56 -08:00
* [Verify Signature](https://pkg.go.dev/github.com/btcsuite/btcd/btcec/v2#example-package--VerifySignature)
Use testable examples and update doc.go README.md. 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.
2014-08-10 15:13:11 -05:00
Demonstrates verifying a secp256k1 signature against a public key that is
first parsed from raw bytes. The signature is also parsed from raw bytes.
Initial implementation.
2013-06-13 13:27:23 -05:00
## License
Use a more specific license adjective.
2014-08-10 15:12:28 -05:00
Package btcec is licensed under the [copyfree](http://copyfree.org) ISC License
except for btcec.go and btcec_test.go which is under the same license as Go.
Initial implementation.
2013-06-13 13:27:23 -05:00
Reference in a new issue Copy permalink