Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kompendium-ano/factom-php-client
PHP JSON-RPC client for the Factom protocol
https://github.com/kompendium-ano/factom-php-client
factom factom-blockchain factom-protocol json-rpc-client php
Last synced: about 1 month ago
JSON representation
PHP JSON-RPC client for the Factom protocol
- Host: GitHub
- URL: https://github.com/kompendium-ano/factom-php-client
- Owner: kompendium-ano
- License: mit
- Created: 2019-11-03T19:14:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-17T06:15:30.000Z (over 4 years ago)
- Last Synced: 2024-04-19T11:45:49.404Z (9 months ago)
- Topics: factom, factom-blockchain, factom-protocol, json-rpc-client, php
- Language: PHP
- Homepage:
- Size: 329 KB
- Stars: 9
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP JSON-RPC client for Factom API
[](https://travis-ci.com/kompendium-llc/factom-php-client)
[](https://coveralls.io/github/kompendium-llc/factom-ruby-client?branch=master)
[](https://github.com/kompendium-llc/factom-php/blob/master/LICENSE)
A JSON-RPC Php client for the Factom protocol. Each response has unique type that automatically converted from JSON response and suitable for further usage in business logic. All responses are available in [Response](https://github.com/kompendium-llc/factom-php-client/tree/master/src/Factom/Api/Responses) directory along with convinient converters.
## Installation
**Composer**:
```bash
composer require kompendium-llc/factom-php-client
```
**Git**:
```bash
git clone https://github.com/kompendium-llc/factom-php-client.git
```
## Config
You can change default node url or ports
Add this lines after this -
require_once __DIR__ . '/../vendor/autoload.php';
// Set Custom host of node
define('walletHost', 'https://dev.factomd.net/v2');
define('host', 'https://dev.factomd.net/v2');
define('debugHost', 'http://localhost:8088/debug');
## Usage
```php
require_once __DIR__ . '/../vendor/autoload.php';;
require_once __DIR__.'/../vendor/kompendium/factom-api-php/config.php';
use Factom\Api\Blocks;
```
### Retreiving a balance
```php
use Factom\Api\Factoid;
result = Factoid::factoidBalance("EC2dTBH2Nc9t9Y7RFD3FYMN5ottoPeHdk6xqUWEc6eHVoBPj6CmH");
print_r(result);
```
### Reading Entry Data
```php
# factomd -> entry api
use Factom\Api\Entry;
result = Entry::entry("61b3d3175f211f3b23b455bb8710fdbcf545cb40da397d9e20b26eca31c389a6");
print_r(result);
```
### Writing an Entry
*Note: Ensure data in the entry fields is hex-encoded. This includes the content section.*
```php
use Factom\Api\Entry;
$composeEntry = Entry::composeEntry("48e0c94d00bf14d89ab10044075a370e1f55bcb28b2ff16206d865e192827645","EC2DKSYyRcNWf7RS963VFYgMExo1824HVeCfQ9PGPmNzwrcmgm2r");
print_r($composeEntry);
use Factom\Api\Commits;
$commitEntry = Commits::commitEntry("00015507C1024BF5C956749FC3EBA4ACC60FD485FB100E601070A44FCCE54FF358D60669854734013B6A27BCCEB6A42D62A3A8D02A6F0D73653215771DE243A63AC048A18B59DA29F4CBD953E6EBE684D693FDCA270CE231783E8ECC62D630F983CD59E559C6253F84D1F54C8E8D8665D493F7B4A4C1864751E3CDEC885A64C2144E0938BF648A00");
print_r($commitEntry);
use Factom\Api\Entry;
$revealEntry = Entry::revealEntry("007E18CCC911F057FB111C7570778F6FDC51E189F35A6E6DA683EC2A264443531F000E0005746573745A0005746573745A48656C6C6F20466163746F6D21");
print_r($revealEntry);
```
### Block Height and Current Minute
```php
# factomd -> Get Height
use Factom\Api\FactomWalletd;
$getheight = FactomWalletd::getHeight();
print_r($getheight);
# factomd -> current minute
use Factom\Api\Minute;
$currentMinute = Minute::currentMinute();
print_r($currentMinute);
```
### Sending A Transaction
```php
# send transaction
use Factom\Api\Transaction;
$data = [
"txname" => "test1234",
"inputAddress" => "FA2jK2HcLnRdS94dEcU27rF3meoJfpUcZPSinpb7AwQvPRY6RL1Q",
"inputAmount" => 1000012000,
"outputAddress" => "FA2yeHMMJR6rpjRYGe3Q4ogThHUmByk3WLhTjQDvPrxDoTYF8BbC",
"outputAmount" => 1000000000
];
$transaction = Transaction::sendTransaction($data);
print_r($transaction);
```
## Testing
```bash
$ php tests/blocks.php
$ php tests/chains.php
$ php tests/commits.php
$ php tests/debug.php
$ php tests/entry.php
$ php tests/factoid.php
$ php tests/factomaddress.php
$ php tests/factomd.php
$ php tests/factomwalletd.php
$ php tests/minute.php
$ php tests/pending.php
$ php tests/security.php
$ php tests/transaction.php
```
Additionally, tests are executed by Travis CI with config pointing at Factom's Open Node (https://factomd.net).
### Examples
Found in the [examples]("examples/Readme.md") folder
## Support
Additional support for the Factom Protocol or library usage can be found on [discord](https://discord.gg/mYmcQM2)
## Development
To contribute to the `factom-php-client` library, clone the repository, create a feature branch and submit a PRfor review.
## Learn
- [Accessing the Factom blockchain from different programming languages](https://medium.com/kompendium-developments/accessing-factom-blockchain-from-different-programming-languages-7f09030efe16)
- [Building simple blockchain game with Factom](https://medium.com/kompendium-developments/accessing-factom-blockchain-from-different-programming-languages-7f09030efe16)
## Contributions
The Library developed by Kompendium, LLC in partnership with Kelecorix, Inc and Sergey Bushnyak for the good of the Factom community. While we see the usage of the libraries over the months, the Factom community decided not to support this work in the form of a grant either upfront or as backpay on multiple occasions ([1](https://factomize.com/forums/threads/kompendium-12-back-pay-two-factom-community-sdks-client-libraries-php-ruby.4802/), [2](https://factomize.com/forums/threads/kompendium-12-back-pay-ruby-haskell-client-libraries-for-the-factom-blockchain.2740/), [3](https://factomize.com/forums/threads/back-pay-development-of-4-json-rpc-client-libraries-to-the-factom-community.2513/))
If you're an active user or find it useful we strongly encourage you to support our efforts and ensure long maintenance by contributing a small donation to one of the following cryptocurrency addresses:
BTC: 39oVXpsgsyW8ZgzsnX3sV7HLdtXWfT96qN
ETH: 0x9cDBA6bb44772259B3A3fb89cf233A147a720f34
FCT: FA38cwer93mmPw1HxjScLmK1yF9iJTu5P87T2vdkbuLovm2YXyss