Skip to main content

Class: PinataAdapter

PinataAdapter

A Colony SDK IPFS adapter for Pinata (https://pinata.cloud). In order to use this, sign up for Pinata (if you haven't already) and generate a token. Then either supply this token when instantiating the class (example below) or provide it via the environment variable COLONY_IPFS_PINATA_TOKEN (when using NodeJS). Then provide an instance of this class to the ColonyNetwork or ColonyEventManager classes (depending on your needs).

Remarks

DO NOT CHECK IN YOUR PINATA TOKEN INTO VERSION CONTROL AND DO NOT EMBED IT INTO YOUR FRONTEND BUNDLE.

Example

import { ColonyNetwork, PinataAdapter } from '@colony/sdk';
const pinataAdapter = new PinataAdapter('YOUR_PINANTA_JWT_TOKEN');
const colonyNetwork = new ColonyNetwork({ ipfsAdapter: pinataAdapter });

Implements

Constructors

constructor

new PinataAdapter(pinataToken?)

Parameters

NameType
pinataToken?string

Properties

name

name: string = 'PINATA'

Name for the IpfsAdapter. All uppercase please

Implementation of

IpfsAdapter.name

Methods

getIpfsUrl

getIpfsUrl(cid): string

Should return the whole URL to an IPFS resource on the corresponding gateway (e.g. https://my-ipfs-gateway/ipfs/QmXxxxXXxxXxXxXxxxXXxxxXxXXx).

Parameters

NameTypeDescription
cidstringAn IPFS hash (CID)

Returns

string

The URL to an ipfs resource

Implementation of

IpfsAdapter.getIpfsUrl


uploadJson

uploadJson(jsonString): Promise<string>

Function to upload a JSON string to IPFS. Takes the string as an argument (use JSON.stringify() if needbe). Returns a promise that resolves to the IPFS hash (CID)

Remarks

This function should ideally pin your data on the relevant service.

Parameters

NameTypeDescription
jsonStringstringJSON string to upload (and pin) to IPFS

Returns

Promise<string>

Promise to IPFS hash (CID)

Implementation of

IpfsAdapter.uploadJson