nim-eth-keys/README.md

# Nim ETH-keys

[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
[![Build Status](https://travis-ci.org/status-im/nim-eth-keys.svg?branch=master)](https://travis-ci.org/status-im/nim-eth-keys)

This library is a Nim re-implementation of [eth-keys](https://github.com/ethereum/eth-keys): the common API for working with Ethereum's public and private keys, signatures, and addresses.

By default, Nim eth-keys uses Bitcoin's [libsecp256k1](https://github.com/bitcoin-core/secp256k1) as a backend. Make sure libsecp256k1 is available on your system.

An experimental pure Nim backend (Warning ⚠: do not use in production) is available with the compilation switch `-d:backend_native`

## Installation
nimble install https://github.com/status-im/nim-eth-keys/blob/master/eth_keys.nimble


## License

Distributed under one of the following:

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
initial commit 2018-02-08 10:51:13 +01:00			`# Nim ETH-keys`

Relicense under dual Apachev2/MIT 2018-03-02 11:57:43 +01:00			`[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
initial commit 2018-02-08 10:51:13 +01:00			`[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)`
gitignore and readme update 2018-02-08 11:26:57 +01:00			`![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)`
Travis config 2018-03-01 13:05:02 +02:00			`[![Build Status](https://travis-ci.org/status-im/nim-eth-keys.svg?branch=master)](https://travis-ci.org/status-im/nim-eth-keys)`
initial commit 2018-02-08 10:51:13 +01:00
Update README.md 2018-05-23 17:44:50 -07:00			`This library is a Nim re-implementation of [eth-keys](https://github.com/ethereum/eth-keys): the common API for working with Ethereum's public and private keys, signatures, and addresses.`
initial commit 2018-02-08 10:51:13 +01:00
Update README.md 2018-05-23 17:44:50 -07:00			`By default, Nim eth-keys uses Bitcoin's [libsecp256k1](https://github.com/bitcoin-core/secp256k1) as a backend. Make sure libsecp256k1 is available on your system.`
[WIP] add native ECDSA backend implementation (⚠ to be debugged) * Add jacobian primitives * Add ECDSA algos * Implement ECDSA, HMAC crypto (to be cleaned up) * [WIP] test suite * Fix arrayOfBytes <-> UInt256 casting issue * ecdsa_raw_sign: Fix shadowing result which lead to implicit object field construction requires a .partial object * Fix casting + remove tests covered by ranged type * Fix toHex conversion and add first test (failing) * Fix modular inversion for unsigned ints * Add modulo template * Public key generation bug still to hunt. 2018-02-13 19:20:27 +01:00
Update README: Implementation with libsecp256k1 backend finished 2018-02-14 20:49:26 +01:00			An experimental pure Nim backend (Warning ⚠: do not use in production) is available with the compilation switch `-d:backend_native`
Relicense under dual Apachev2/MIT 2018-03-02 11:57:43 +01:00
Update README.md 2018-05-27 14:10:03 -07:00			`## Installation`
			`nimble install https://github.com/status-im/nim-eth-keys/blob/master/eth_keys.nimble`

Relicense under dual Apachev2/MIT 2018-03-02 11:57:43 +01:00
Update README.md 2018-05-27 14:10:03 -07:00			`## License`
Relicense under dual Apachev2/MIT 2018-03-02 11:57:43 +01:00
Update README.md 2018-05-27 14:10:03 -07:00			`Distributed under one of the following:`
Relicense under dual Apachev2/MIT 2018-03-02 11:57:43 +01:00
Update README.md 2018-05-27 14:10:03 -07:00			`* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)`
			`* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)`