caver.ipfs

caver.ipfs는 IPFS (InterPlanetary File System)와 관련된 기능을 제공하는 패키지입니다.

참고 caver.ipfs는 caver-js v1.5.4부터 지원됩니다.

caver.ipfs.setIPFSNode

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

IPFS 노드와의 연결을 초기화합니다. 이 함수를 통해 IPFS 노드 정보가 설정되면, IPFS에 대해 파일을 업로드, 다운로드 할 수 있습니다.

Parameters

Name	Type	Description
host	string	연결할 IPFS 노드 URL입니다.
port	number	사용할 포트 번호입니다.
ssl	boolean	참이라면 https 프로토콜이 사용됩니다. 그 외의 경우 http 프로토콜이 사용됩니다.

Return Value

None

Example

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

caver.ipfs.add

caver.ipfs.add(data)

IPFS에 파일을 추가합니다. 업로드된 파일의 CID(Content Identifier)가 반환됩니다.

파일의 경로(path)가 전달되면, 경로로부터 파일의 내용을 받아서 IPFS에 업로드합니다. 버퍼가 전달되면, IPFS에 직접적으로 업로드됩니다.

Parameters

Name	Type	Description
data	string | Buffer | ArrayBuffer	IPFS에 추가될 파일 또는 버퍼의 경로 문자열입니다.

참고 Buffer는 caver-js v1.5.5부터 지원됩니다.

Return Value

Promise는 string을 반환합니다.

Type	Description
string	업로드된 파일의 CID(Content Identifier)입니다.

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)

유효한 IPFS 경로로 주소가 설정된 파일을 반환합니다.

Parameters

Name	Type	Description
hash	string	다운로드할 파일의 CID(Content Identifier)입니다.

Return Value

Promise는 Buffer를 반환합니다.

Type	Description
Buffer	파일의 내용입니다.

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)

CID(Content Identifier)를 Multihash로 변환합니다.

Parameters

Name	Type	Description
hash	string	변환할 CID(Content Identifier)입니다.

Return Value

Type	Description
string	Multihash 문자열입니다.

Example

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

caver.ipfs.fromHex

caver.ipfs.fromHex(hash)

CID(Content Identifier)를 Multihash로 변환합니다.

Parameters

Name	Type	Description
hash	string	변환할 Multihash 문자열입니다.

Return Value

Type	Description
string	CID(Content Identifier)입니다.

Example

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