bitpay / key-utils
BitPay Utils pack for cryptography
Installs: 303 838
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 5
Forks: 14
Open Issues: 0
Requires
- php: ^8.1 || ^8.2 || ^8.3
- ext-bcmath: *
- ext-curl: *
- ext-iconv: *
- ext-json: *
- ext-openssl: *
Requires (Dev)
- phpunit/phpunit: 10.5.36
Suggests
- ext-gmp: Required to use this package with GMP instead of BCMath
README
This dependency file provides utilities for use with the BitPay API. It enables creating keys, retrieving public keys, retrieving private keys, creating the SIN that is used in retrieving tokens from BitPay, and signing payloads for the X-Signature
header in a BitPay API request.
Installation
Composer
Install Composer
curl -sS https://getcomposer.org/installer | php
Install via composer by hand
Add to your composer.json file by hand.
{ ... "require": { ... "bitpay/key-utils": "~2.0" } ... }
Once you have added this, just run:
php composer.phar update bitpay/key-utils
Install using composer
php composer.phar require bitpay/key-utils:~2.0
Usage
Autoloader
To use the library's autoloader (which doesn't include composer dependencies) instead of composer's autoloader, use the following code:
<?php $autoloader = __DIR__ . '/relative/path/to/Bitpay/Autoloader.php'; if (true === file_exists($autoloader) && true === is_readable($autoloader)) { require_once $autoloader; \Bitpay\Autoloader::register(); } else { throw new Exception('BitPay Library could not be loaded'); }
Documentation
Please see the examples.php script for examples on using this library.
Support
License
MIT License
Copyright (c) 2019 BitPay
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.