README

Interact with IPFS using the RPC api.

Take a look at contributing.md to see a to do list.

Installation

Via Composer

composer require fliq/ipfs

Usage

To get started with IPFS visit the IPFS documentation

This package uses Guzzle every request is made using the requestAsync method, and every method on the Ipfs class returns a guzzles PromiseInterface.

There are two modes for the ipfs client 'api' and 'gateway'. Gateway is accessible publicly for read only operations and api can write.

use Fliq\Ipfs\Ipfs;

$ipfs = new Ipfs('localhost', '8080', 'http', 'gateway');

$data = $ipfs->cat('QmSgvgwxZGaBLqkGyWemEDqikCqU52XxsYLKtdy3vGZ8uq')->wait(); // spaceship-launch.jpg

To write files you must be in 'api' mode.

use Fliq\Ipfs\Ipfs;

$ipfs = new Ipfs('localhost', '5001', 'http', 'api');

$result = $ipfs->add('Hello, IPFS')->wait();

$cid = $result[0]['Hash']; // content identifier

You can add files flexibly to IPFS with support for strings, php resources and encode arrays into json, and multiple files at once all wrapped into a directory.

use GuzzleHttp\Psr7\Utils;

$ipfs = new Ipfs('localhost', '5001', 'http', 'api');

$file = Utils::tryFopen('path/to/file.jpeg')

$results = $ipfs->add([
    'file.jpeg' => $file,
    'meta.json' => [
        'name' => 'My file',
        'description' => 'file description',
        'properties' => [...],
    ],
], ['wrap-with-directory' => true])->wait();

$directoryCid = $results[2]['Hash'];

Retrieving data from IPFS. With the cat method you can get a Psr7 stream as a result, but for convenience you can use the get() and json() methods to read files also.

$data = $ipfs->cat('Qm...')
               ->then(fn($stream) => $stream->getContents())
               ->then(fn($str) => json_decode($str, 1))
               ->wait();

// is the same as.

$data = $ipfs->get('Qm...')
             ->then(fn($str) => json_decode($str, 1))
             ->wait();

// is the same as

$data = $ipfs->json('Qm...')->wait();

Because every request is async you can make multiple requests at the same time.

use GuzzleHttp\Promise;

$promises = [];

$promises[] = $ipfs->add('Hello, IPFS');
$promises[] = $ipfs->cat('QmSgvgwxZGaBLqkGyWemEDqikCqU52XxsYLKtdy3vGZ8uq');

$responses = Promise\Utils::unwrap($promises);

Lastly you can call any endpoint using the call() method.

$ipfs->call('name/resolve', ['query' => $args])->then(function(Response $response) {
    // handle response.
});

Methods:

version()

Gets Kubo node information.

add()

Adds files to IPFS

cat()

Reads files returns a Stream

get()

Reads files returns a string

json()

Reads files returns an array

ls()

Reads content from CID

call()

Will call

Change log

Please see the changelog for more information on what has changed recently.

Testing

You'll need a local IPFS node running to test using localhost.

./vendor/bin/pest

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author@email.com instead of using the issue tracker.

Credits

License

MIT. Please see the license file for more information.

fliq / ipfs

Maintainers

Details