caver.ipfs
caver.ipfs
는 IPFS (InterPlanetary File System)와 관련된 기능을 제공하는 패키지입니다.
참고 caver.ipfs
는 caver-js v1.5.4부터 지원됩니다.
caver.ipfs.setIPFSNode
IPFS 노드와의 연결을 초기화합니다. 이 함수를 통해 IPFS 노드 정보가 설정되면, IPFS에 대해 파일을 업로드, 다운로드 할 수 있습니다.
Parameters
Name | Type | Description |
---|---|---|
host | string | 연결할 IPFS 노드 URL입니다. |
port | number | 사용할 포트 번호입니다. |
ssl | boolean | 참이라면 |
Return Value
None
Example
caver.ipfs.add
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
caver.ipfs.get
유효한 IPFS 경로로 주소가 설정된 파일을 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
hash | string | 다운로드할 파일의 CID(Content Identifier)입니다. |
Return Value
Promise
는 Buffer
를 반환합니다.
Type | Description |
---|---|
Buffer | 파일의 내용입니다. |
Example
caver.ipfs.toHex
CID(Content Identifier)를 Multihash로 변환합니다.
Parameters
Name | Type | Description |
---|---|---|
hash | string | 변환할 CID(Content Identifier)입니다. |
Return Value
Type | Description |
---|---|
string | Multihash 문자열입니다. |
Example
caver.ipfs.fromHex
CID(Content Identifier)를 Multihash로 변환합니다.
Parameters
Name | Type | Description |
---|---|---|
hash | string | 변환할 Multihash 문자열입니다. |
Return Value
Type | Description |
---|---|
string |
Example
Last updated