caver.ipfs

caver.ipfs is a package that provides functionality related to IPFS (InterPlanetary File System).

NOTE caver.ipfs is supported since caver-js v1.5.4.

caver.ipfs.setIPFSNode

caver.ipfs.setIPFSNode(host, port, ssl)

Initializes a connection with an IPFS Node. When an IPFS Node information is set through this function, you can upload files to IPFS or load files from IPFS.

Parameters

Name

Type

Description

host

string

The IPFS Node url to connect with.

port

number

The port number to use.

ssl

boolean

If true, the https protocol is used. Otherwise, the http protocol is used.

Return Value

None

Example

> caver.ipfs.setIPFSNode('localhost', 5001, false)

caver.ipfs.add

caver.ipfs.add(data)

Adds a file to IPFS. The CID(Content Identifier) of the uploaded file is returned.

If the path of a file is passed, the contents of the file are loaded from the path and uploaded to IPFS. If a buffer is passed, it is uploaded to IPFS directly.

Parameters

Name

Type

Description

data

string | Buffer | ArrayBuffer

The path string of a file or a buffer to add to IPFS.

NOTE Buffer is supported since caver-js v1.5.5.

Return Value

Promise returns string

Type

Description

string

The CID(Content Identifier) of the uploaded file.

Example

// Adds a file with path string.
> caver.ipfs.add('./test.txt')
Qmd9thymMS6mejhEDZfwXPowSDunzgma9ex4ezpCSRZGwC
‚Äč
// Adds a file with Buffer containing the contents of the file.
> caver.ipfs.add(Buffer.from('test data'))
QmWmsL95CYvci8JiortAMhezezr8BhAwAVohVUSJBcZcBL

caver.ipfs.get

caver.ipfs.get(hash)

Returns a file addressed by a valid IPFS path.

Parameters

Name

Type

Description

hash

string

An CID(Content Identifier) of the file to download.

Return Value

Promise returns Buffer

Type

Description

Buffer

The content of the file.

Example

> caver.ipfs.get('Qmd9thymMS6mejhEDZfwXPowSDunzgma9ex4ezpCSRZGwC')
<Buffer 74 65 73 74 20 64 61 74 61 20 66 6f 72 20 49 50 46 53>

caver.ipfs.toHex

caver.ipfs.toHex(hash)

Converts a CID(Content Identifier) to a Multihash.

Parameters

Name

Type

Description

hash

string

A CID(Content Identifier) to convert.

Return Value

Type

Description

string

The Multihash string.

Example

> caver.ipfs.toHex('Qmd9thymMS6mejhEDZfwXPowSDunzgma9ex4ezpCSRZGwC')
0x1220dc1dbe0bcf1e5f6cce80bd3d7e7d873801c5a1732add889c0f25391d53470dc3

caver.ipfs.fromHex

caver.ipfs.fromHex(hash)

Converts to CID(Content Identifier) from a Multihash.

Parameters

Name

Type

Description

hash

string

A Multihash to convert.

Return Value

Type

Description

string

The CID(Content Identifier).

Example

> caver.ipfs.fromHex('0x1220dc1dbe0bcf1e5f6cce80bd3d7e7d873801c5a1732add889c0f25391d53470dc3')
Qmd9thymMS6mejhEDZfwXPowSDunzgma9ex4ezpCSRZGwC