Class: CloudflareReadonlyAdapter

CloudflareReadonlyAdapter

A Colony SDK IPFS adapter for Cloudflare IPFS (https://developers.cloudflare.com/web3/ipfs-gateway/). It only supports reading IPFS data from the Cloudflare gateway (not uploading or pinning files).

This is the default IpfsAdapter used in Colony SDK. So in order to use this, you don't have to do anything.

Implements

• IpfsAdapter

Constructors

constructor

• new CloudflareReadonlyAdapter()

Properties

name

• name: string = 'CLOUDFLARE'

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

Name	Type	Description
cid	string	An IPFS hash (CID)

Returns

string

The URL to an ipfs resource

Implementation of

IpfsAdapter.getIpfsUrl

---

uploadJson

▸ uploadJson(): 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.

Returns

Promise<string>

Promise to IPFS hash (CID)

Implementation of

IpfsAdapter.uploadJson