apex/ipfs-api

A minimal implementation of IPFS API

0.1 2022-02-21 07:52 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.18
• php-parallel-lint/php-parallel-lint: ^1.3
• phpmd/phpmd: ^2.9
• phpstan/phpstan: ^0.12.83
• phpunit/phpunit: ^9.5.4
• vlucas/phpdotenv: ^5.3

MIT

• openwse

• api
• decentralized
• ipfs
• ipfs-api

README

Installation

You can install the package via composer:

composer require openwse/ipfs-api

Usage

$client = new Ipfs\Ipfs(
    new Ipfs\Drivers\HttpClient('https://ipfs-host', 5001)
);

// add a single file (and pin it)
$client->add('/path/to/the/file', true);

// add a file from content
$client->add([
    ['/desired-path-on-ipfs/filename.txt', null, 'my text content', 'text/plain']
]);

// add a nested structure
$client->add([
    ['/path/to/local/file', '/path/on/ipfs'],
    'my-custom-dir',
    ['/path/to/local/file', '/my-custom-dir/filename'],
]);

// list all files
$client->files()->ls();

// get the version
$client->version();

// publish
$client->key()->gen('mykeyname');
$client->name()->publish('/path/hash', '48h', 'mykeyname');


// some other examples...
$client->cat('/path/hash');

$client->config()->set('key', 'value');

$client->pin()->add('/path/hash');

$client->pin()->verify();

$client->stats()->bw();

$client->key()->rm('mykeyname');

Lint

Run PHPMD, PHPStan, and PHP-CS-Fixer

composer lint

Testing

composer tests

TODOS:

• Complete async/streams requests
• Implement the following endpoints:
  • P2P
  • Pubsub (with name/pubsub/{cancel,state,subs})
• Missing tests:
  • Block > put
  • Filestore
  • Dht

License

The MIT License (MIT). Please see License File for more information.