ケイバー
caver.ipfs は IPFS (InterPlanetary File System) に関連する機能を提供するパッケージである。
NOTE caver.ipfsはcaver-js v1.5.4からサポートされています。
caver.ipfs.setIPFSNode
caver.ipfs.setIPFSNode(host, port, ssl)
IPFS ノードとの接続を初期化します。 この機能でIPFSノード情報を設定すると、IPFSにファイルをアップロードしたり、IPFSからファイルをロードしたりすることができます。
パラメーター
| 名称 | タイプ | 説明 |
|---|---|---|
| ホスト | ストリング | 接続するIPFSノードのURL。 |
| ポート | 番号 | 使用するポート番号。 |
| エスエスエル | ブーリアン | trueの場合、httpsプロトコルが使用される。 そうでない場合は http プロトコルが使用される。 |
リターン・バリュー
なし
例
> caver.ipfs.setIPFSNode('localhost',5001,false)。
caver.ipfs.add
caver.ipfs.add(データ)
IPFSにファイルを追加する。 アップロードされたファイルのCID(Content Identifier)が返される。
ファイルのパスが渡された場合、ファイルの内容がパスからロードされ、IPFSにアップロードされる。 バッファが渡された場合、IPFSに直接アップロードされる。
パラメーター
| 名称 | タイプ | 説明 |
|---|---|---|
| データ | string \ | Buffer \ |
NOTE Bufferはcaver-js v1.5.5からサポートされています。
リターン・バリュー
Promise は string を返す。
| タイプ | 説明 |
|---|---|
| ストリング | アップロードされたファイルのCID(Content Identifier)。 |
例
// パス文字列でファイルを追加する。> caver.ipfs.add('./test.txt')Qmd9thymMS6mejhEDZfwXPowSDunzma9ex4ezpCSRZGwC// ファイルの内容を含む Buffer でファイルを追加します。// Bufferでファイルを追加する。QmWmsL95CYvci8JiortAMhezezr8BhAwAVohVUSJBcZcBL
caver.ipfs.get
caver.ipfs.get(ハッシュ)
有効な IPFS パスで指定されたファイルを返します。
パラメーター
| 名称 | タイプ | 説明 |
|---|---|---|
| ハッシュ | ストリング | ダウンロードするファイルのCID(Content Identifier)。 |
リターン・バリュー
Promise は Buffer を返す。
| タイプ | 説明 |
|---|---|
| バッファ | ファイルの内容。 |
例
> 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(ハッシュ)
CID(コンテンツ識別子)](https://docs.ipfs.io/concepts/content-addressing/#content-addressing-and-cids)を[マルチハッシュ](https://multiformats.io/multihash)に変換する。
パラメーター
| 名称 | タイプ | 説明 |
|---|---|---|
| ハッシュ | ストリング | 変換するCID(Content Identifier)。 |
リターン・バリュー
| タイプ | 説明 |
|---|---|
| ストリング | マルチハッシュ](https://multiformats.io/multihash) 文字列。 |
例
> caver.ipfs.toHex('Qmd9thymMS6mejhEDZfwXPowSDunzgma9ex4ezpCSRZGwC')0x1220dc1dbe0bcf1e5f6cce80bd3d7e7d873801c5a1732add889c0f25391d53470dc3
caver.ipfs.fromHex
caver.ipfs.fromHex(ハッシュ)
Multihash](https://multiformats.io/multihash) から CID(Content Identifier) に変換します。
パラメーター
| 名称 | タイプ | 説明 |
|---|---|---|
| ハッシュ | ストリング | 変換するマルチハッシュ。 |
リターン・バリュー
| タイプ | 説明 |
|---|---|
| ストリング | CID(コンテンツ識別子)](https://docs.ipfs.io/concepts/content-addressing/#content-addressing-and-cids)。 |
例
> caver.ipfs.fromHex('0x1220dc1dbe0bcf1e5f6cce80bd3d7e7d873801c5a1732add889c0f25391d53470dc3')Qmd9thymMS6mejhEDZfwXPowSDunzgma9ex4ezpCSRZGwC