musee/pinata-laravel

The Laravel provider for Pinata API.

v0.1.2 2022-02-08 08:02 UTC

This package is auto-updated.

Last update: 2024-11-06 12:08:27 UTC


README

This is a Laravel/Lumen provider for interacting with Pinata API.

Install

Require this package with composer using the following command:

composer require danielcrt/pinata-laravel

Installation

Add your API credentials to pinata array in the config/services.php config file as follows:

return [

    ...

    'pinata' => [

        'api_key' => env('PINATA_API_KEY'),
        'secret_key' => env('PINATA_API_SECRET')
    ]
]

Laravel

Add the service provider to the providers array in the config/app.php config file as follows:

'providers' => [

    ...

    \Pinata\Providers\PinataServiceProvider::class,
]

Lumen

Add the following snippet to the bootstrap/app.php file under the providers section as follows:

$app->configure('services');
$app->register(Pinata\Providers\PinataServiceProvider::class);

Usage

Pin a File to IPFS

  use Pinata\Facades\Pinata;

  $file_path = '';

  $response = Pinata::pinFileToIPFS($file_path);

Pin a JSON to IPFS

  use Pinata\Facades\Pinata;

  $json = [];

  $response = Pinata::pinJSONToIPFS($json);

Unpin

  use Pinata\Facades\Pinata;

  $ipfs_hash = '';

  $response = Pinata::removePinFromIPFS($ipfs_hash);

For more details about request parameters and responses please visit the official documentation: https://docs.pinata.cloud

Available methods

  • addHashToPinQueue

  • pinFileToIPFS

  • pinHashToIPFS

  • pinJobs

  • pinJSONToIPFS

  • removePinFromIPFS

  • userPinnedDataTotal

  • userPinList