Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sleepdefic1t/BIP66
A simple Bitcoin BIP66 Implementation in C++ for the ARK Blockchain.
https://github.com/sleepdefic1t/BIP66
Last synced: 3 months ago
JSON representation
A simple Bitcoin BIP66 Implementation in C++ for the ARK Blockchain.
- Host: GitHub
- URL: https://github.com/sleepdefic1t/BIP66
- Owner: sleepdefic1t
- License: mit
- Created: 2019-02-09T12:51:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-14T23:11:32.000Z (over 3 years ago)
- Last Synced: 2024-02-14T21:31:53.318Z (9 months ago)
- Language: C++
- Homepage:
- Size: 228 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# BIP66
> A simple Bitcoin BIP66 Implementation in C++ for the ARK Ecosystem.
ANS.1 DER Encoder/Decoder based on [Bitcoin BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki).
[](https://github.com/sleepdefic1t/BIP66)
[](https://www.codefactor.io/repository/github/sleepdefic1t/bip66)
[](https://www.codacy.com/manual/sleepdefic1t/BIP66)
[](https://github.com/sleepdefic1t/BIP66/releases)
[](https://opensource.org/licenses/MIT)
- [Supported Platforms](#supported-platforms)
- [Installation](#installation)
- [Arduino IDE](#arduino-ide)
- [PlatformIO](#platformio)
- [CMake](#cmake)
- [Usage](#usage)
- [Encoding a Signature](#encoding-a-signature)
- [Decoding a Signature](#decoding-a-signature)
- [Checking an Encoded Signature](#checking-an-encoded-signature)
- [License](#license)
## Supported Platforms
| OS: | Supported: |
| :-- | :--------: |
| Linux | ✅ |
| macOS | ✅ |
| Windows | ✅ |
| Environment: | Supported: |
| :------- | :--------: |
| Arduino IDE | ✅ |
| PlatformIO | ✅ |
| Board: | Supported: |
| :------ | :--------: |
| ESP8266 | ✅ |
| ESP32 | ✅ |
| ESP32-S2 | ✅ |
## Installation
### Arduino IDE
Download BIP66 from the Arduino IDE Library manager.
You can also copy this repo to the Arduino Libraries directory.
(e.g. `~/Documents/Arduino/libraries`)
1) Open the `BIP66.ino` sketch in the `examples/BIP66` folder.
2) Select your board from the Arduino IDE
3) Upload the sketch.
---
### PlatformIO
#### Building BIP66 with PIO
`pio run`
#### Building BIP66 and Tests with PIO
`pio run -t test/`
#### Flashing and Running Tests with PIO
`pio run -t test/ -e esp32 -t upload`
---
### CMake
Operating System builds like Linux, macOS, and Windows use CMake.
This build should be done out of source.
#### Building BIP66 with CMake
1) `mkdir build && cd build`
2) `cmake ..`
3) `cmake --build .`
#### Building BIP66 and Tests with CMake
1) `mkdir build && cd build`
2) `cmake -DUNIT_TEST=ON ..`
3) `cmake --build .`
#### Running BIP66 Tests with CMake
`./test/bip66_tests`
---
## Usage
### Encoding a Signature
From the raw R & S elements:
```cpp
uint8_t r[32] = {
33, 112, 79, 42, 219, 46, 74, 16, 163, 221, 193, 215, 214, 69, 82, 184, 6, 28, 5, 246, 209, 42, 22, 140, 105, 9, 28, 117, 88, 29, 97, 20
};
uint8_t s[32] = {
14, 223, 55, 104, 157, 39, 134, 252, 105, 10, 249, 240, 246, 250, 31, 98, 156, 149, 105, 80, 57, 246, 72, 166, 212, 85, 72, 67, 2, 64, 46, 147
};
uint8_t signature[72];
const bool success = bip66::encode(r, 32, s, 32, signature);
```
---
### Decoding a Signature
From a DER-encoded signature to raw R & S elements:
```cpp
uint8_t derEncodedSignature[70] = {
48, 68, 2, 32, 33, 112, 79, 42, 219, 46, 74, 16, 163, 221, 193, 215, 214, 69, 82, 184, 6, 28, 5, 246, 209, 42, 22, 140, 105, 9, 28, 117, 88, 29, 97, 20, 2, 32, 14, 223, 55, 104, 157, 39, 134, 252, 105, 10, 249, 240, 246, 250, 31, 98, 156, 149, 105, 80, 57, 246, 72, 166, 212, 85, 72, 67, 2, 64, 46, 147
};
uint8_t r[32];
uint8_t s[32];
const bool success = bip66::decode(derEncodedSignature, 70, r, s);
```
---
### Checking an Encoded Signature
From a DER-encoded signature:
```cpp
const uint8_t derEncodedSignature[70] = {
48, 68, 2, 32, 33, 112, 79, 42, 219, 46, 74, 16, 163, 221, 193, 215, 214, 69, 82, 184, 6, 28, 5, 246, 209, 42, 22, 140, 105, 9, 28, 117, 88, 29, 97, 20, 2, 32, 14, 223, 55, 104, 157, 39, 134, 252, 105, 10, 249, 240, 246, 250, 31, 98, 156, 149, 105, 80, 57, 246, 72, 166, 212, 85, 72, 67, 2, 64, 46, 147
};
const bool success = bip66::check(derEncodedSignature, 70);
```
---
## License
[MIT](LICENSE) © [Simon Downey](https://github.com/sleepdefic1t)