-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
42 changed files
with
4,919 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,9 @@ | ||
composer.phar | ||
/vendor/ | ||
.idea/ | ||
|
||
# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file | ||
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file | ||
# composer.lock | ||
composer.lock | ||
|
||
build-docs/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# cardano-php-api | ||
A open-source project to allow users to connect to the Cardano API using PHP. | ||
An open-source project to allow users to connect to the Cardano API using PHP. There will be two APIs included in this Wrapper: | ||
- Explorer Wrapper - Wrapper for the [Cardano Explorer API](https://cardanodocs.com/technical/explorer/api/). | ||
- (Upcoming) Cardano-SL Wallet API Wrapper - Wrapper for the [Cardano SL Wallet Backend](https://cardanodocs.com/technical/wallet-backend/). | ||
|
||
## Installation | ||
|
||
Install with composer: | ||
|
||
```bash | ||
composer require codybutz/cardano-php-api | ||
``` | ||
|
||
## Usage | ||
|
||
This package contains two components: Explorer Wrapper and Cardano-SL Wallet API Wrapper. | ||
|
||
### Using the Explorer API | ||
|
||
```php | ||
<?php | ||
$explorer = new \Butz\Cardano\Explorer\ExplorerAPI(); | ||
|
||
$address = $explorer->getAddressSummary('DdzFF...'); // Returns an AddressSummary object. | ||
``` | ||
|
||
### Using the Wrapper API | ||
|
||
TODO | ||
|
||
## Run tests | ||
|
||
Invoke the test runner as follows: | ||
|
||
phpunit | ||
|
||
## License | ||
|
||
This code is licensed under the MIT License | ||
|
||
## Submitting bugs and feature requests | ||
|
||
If any problems are found please email me at [email protected] or submit an issue to this repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"name": "codybutz/cardano-php-api", | ||
"version": "0.0.1", | ||
"description": "An open-source project to allow users to connect to the Cardano API using PHP.", | ||
"authors": [ | ||
{ | ||
"name": "Cody Butz", | ||
"email": "[email protected]" | ||
} | ||
], | ||
"require": { | ||
"php": "^5.6|^7.0", | ||
"stephenhill/base58": "^1.1", | ||
"guzzlehttp/guzzle": "^6.3", | ||
"cvuorinen/phpdoc-markdown-public": "^0.2.0" | ||
}, | ||
|
||
"require-dev": { | ||
"phpunit/phpunit": "^7.0", | ||
"evert/phpdoc-md": "^0.2.0" | ||
}, | ||
"autoload": { | ||
"psr-4": { | ||
"Butz\\Cardano\\": "src/", | ||
"Butz\\Tests\\": "test/" | ||
} | ||
}, | ||
"scripts": { | ||
"test": "./vendor/bin/phpunit" | ||
} | ||
} |
Oops, something went wrong.