Skip to main content

@taqueria/plugin-ipfs-pinata

This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM

The IPFS Pinata plugin provides a publish task to upload metadata, media, or other files to IPFS via Pinata

Requirements

  • Node.js v16.3 or later
  • Docker v0.8.6 or later
  • A Pinata account
  • A Pinata JWT Token added to the project

Installation

To install the IPFS Pinata plugin on a Taqueria project, navigate to the project folder and run:

taq install @taqueria/plugin-ipfs-pinata

Configuration

In order for Taqueria to connect to Pinata, you must first add your Pinata JWT token to the project. To do this, follow the steps below:

  1. Sign into your Pinata account here
  2. Find your JWT token and copy it
  3. Create the file .env in your Taqueria project
  4. Add the JWT token to a property called pinataJwtToken as shown below:
pinataJwtToken=eyJhbGc...

Usage

The IPFS Pinata plugin exposes a publish task which uploads one or more files to IPFS via Pinata, and stores the results in Taqueria State

You will first need to create a new directory in your project and add any metadata or media files you would like to upload to it. Once you have a directory in your project with one or more files to upload, you can run:

taq publish < path >

Tasks

The taq publish Task

The publish task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:

taq publish < sourceDirectory >

Task Properties

attributevalue
task'publish'
command'publish < path >
aliasesN/A

Plugin Architecture

This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK