README

A client library for the IPFS API.

As no progress has been made from cloutier in 6 months, I'm forking this to build in my own project.

Usage

Installing

This library requires PHP 7.0 or above:

$ composer require nathansalter/php-ipfs-api
$ composer install

use NathanSalter\PhpIpfsApi\IpfsClient;

// connect to ipfs daemon API server
$ipfs = new IpfsClient("localhost", "8080", "5001"); // leaving out the arguments will default to these values

Please note; the above will soon change to be using GuzzleHttp instead of raw CURL.

API

add

Adds content to IPFS.

Usage

$hash = $ipfs->add('Hello world');

cat

Retrieves the contents of a single hash.

Usage

$ipfs->cat($hash);

ls

Gets the node structure of a hash.

Usage

$hashes = $ipfs->ls($hash);

foreach ($hashes as $e) {
    echo $e['Hash'];
    echo $e['Size'];
    echo $e['Name'];
}

Object size

Returns object size.

Usage

$size = $ipfs->size($hash);

Pin

Pins a hash.

Usage

$ipfs->pinAdd($hash);

License

The MIT License (MIT)

Copyright (c) 2015-2016 Vincent Cloutier
Copyright (c) 2016 S3r3nity Technologies

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.