# purescript-ipfs-api

**Repository Path**: yangdao/purescript-ipfs-api

## Basic Information

- **Project Name**: purescript-ipfs-api
- **Description**: No description available
- **Primary Language**: 其他
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-03-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# purescript-ipfs-http-api

### 介绍
purescript版本的ipfs http api实现.

### 进度

#### 文件

##### Regular Files API
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.add</td><td>❌</td></tr>
<tr><td>ipfs.addReadableStream</td><td>❌</td></tr>
<tr><td>ipfs.addFromStream</td><td>❌</td></tr>
<tr><td>ipfs.addFromFs</td><td>❌</td></tr>
<tr><td>ipfs.addFromURL</td><td>❌</td></tr>
<tr><td>ipfs.cat</td><td>✔</td></tr>
<tr><td>ipfs.catReadableStream</td><td>✔</td></tr>
<tr><td>ipfs.get</td><td>✔</td></tr>
<tr><td>ipfs.getReadableStream</td><td>✔</td></tr>
<tr><td>ipfs.ls</td><td>✔</td></tr>
</tbody>
</table>

##### MFS (mutable file system) specific
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.files.cp</td><td>✔</td></tr>
<tr><td>ipfs.files.flush</td><td>✔</td></tr>
<tr><td>ipfs.files.ls</td><td>✔</td></tr>
<tr><td>ipfs.files.mkdir</td><td>✔</td></tr>
<tr><td>ipfs.files.mv</td><td>✔</td></tr>
<tr><td>ipfs.files.read</td><td>✔</td></tr>
<tr><td>ipfs.files.readReadableStream</td><td>✔</td></tr>
<tr><td>ipfs.files.rm</td><td>✔</td></tr>
<tr><td>ipfs.files.stat</td><td>✔</td></tr>
<tr><td>ipfs.files.write</td><td>✔</td></tr>
</tbody>
</table>

##### block
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.block.get</td><td>✔</td></tr>
<tr><td>ipfs.block.put</td><td>❌</td></tr>
<tr><td>ipfs.block.stat</td><td>✔</td></tr>
</tbody>
</table>

#### Graph
##### dag
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.dag.get</td><td><span>❌</span></td></tr>
<tr><td>ipfs.dag.put</td><td>❌</td></tr>
<tr><td>ipfs.dag.tree</td><td>❌</td></tr>
</tbody>
</table>

##### object
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.object.data</td><td><span>❌</span></td></tr>
<tr><td>ipfs.object.get</td><td>❌</td></tr>
<tr><td>ipfs.object.links</td><td>❌</td></tr>
<tr><td>ipfs.object.new</td><td>❌</td></tr>
<tr><td>ipfs.object.patch.addLink</td><td>❌</td></tr>
<tr><td>ipfs.object.patch.appendData</td><td>❌</td></tr>
<tr><td>ipfs.object.patch.rmLink</td><td>❌</td></tr>
<tr><td>ipfs.object.patch.setData</td><td>❌</td></tr>
<tr><td>ipfs.object.put</td><td>❌</td></tr>
<tr><td>ipfs.object.stat</td><td>✔</td></tr>
</tbody>
</table>

##### pin
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.pin.add</td><td><span>✔</span></td></tr>
<tr><td>ipfs.pin.ls</td><td>✔</td></tr>
<tr><td>ipfs.pin.rm</td><td>✔</td></tr>
</tbody>
</table>

##### refs
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.refs.local</td><td><span>❌</span></td></tr>
</tbody>
</table>

##### Network
##### bootstrap
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.bootstrap.add</td><td><span>✔</span></td></tr>
<tr><td>ipfs.bootstrap.ls</td><td><span>✔</span></td></tr>
<tr><td>ipfs.bootstrap.rm</td><td><span>✔</span></td></tr>
<tr><td>ipfs.bootstrap.rmAll</td><td><span>✔</span></td></tr>
<tr><td>ipfs.bootstrap.addDefault</td><td><span>✔</span></td></tr>
</tbody>
</table>
 
##### bitswap
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.bitswap.stat</td><td><span>✔</span></td></tr>
<tr><td>ipfs.bitswap.wantlist</td><td><span>✔</span></td></tr>
<tr><td>ipfs.bitswap.unwant</td><td><span>❌</span></td></tr>
</tbody>
</table>

##### dht
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.dht.findPeer</td><td><span>❌</span></td></tr>
<tr><td>ipfs.dht.findProvs</td><td><span>❌</span></td></tr>
<tr><td>ipfs.dht.get</td><td><span>❌</span></td></tr>
<tr><td>ipfs.dht.provide</td><td><span>❌</span></td></tr>
<tr><td>ipfs.dht.put</td><td><span>❌</span></td></tr>
</tbody>
</table>

##### pubsub
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.pubsub.ls</td><td><span>❌</span></td></tr>
<tr><td>ipfs.pubsub.peers</td><td><span>❌</span></td></tr>
<tr><td>ipfs.pubsub.publish</td><td><span>❌</span></td></tr>
<tr><td>ipfs.pubsub.subscribe</td><td><span>❌</span></td></tr>
<tr><td>ipfs.pubsub.unsubscribe</td><td><span>❌</span></td></tr>
</tbody>
</table>

##### swarm
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.swarm.addrs</td><td><span>✔</span></td></tr>
<tr><td>ipfs.swarm.connect</td><td><span>✔</span></td></tr>
<tr><td>ipfs.swarm.disconnect</td><td><span>✔</span></td></tr>
<tr><td>ipfs.swarm.peers</td><td><span>✔</span></td></tr>
</tbody>
</table>

##### name
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.name.publish</td><td><span>❌</span></td></tr>
<tr><td>ipfs.name.pubsub.cancel</td><td><span>❌</span></td></tr>
<tr><td>ipfs.name.pubsub.state</td><td><span>❌</span></td></tr>
<tr><td>ipfs.name.pubsub.subs</td><td><span>❌</span></td></tr>
<tr><td>ipfs.name.pubsub.resolve</td><td><span>❌</span></td></tr>
</tbody>
</table>

#### Node Management
##### miscellaneous operations
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.dns</td><td><span>✔</span></td></tr>
<tr><td>ipfs.id</td><td><span>✔</span></td></tr>
<tr><td>ipfs.ping</td><td><span>✔</span></td></tr>
<tr><td>ipfs.shutdown</td><td><span>✔</span></td></tr>
<tr><td>ipfs.version</td><td><span>✔</span></td></tr>
</tbody>
</table>

##### config
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.config.get</td><td><span>✔</span></td></tr>
<tr><td>ipfs.config.set</td><td><span>❌</span></td></tr>
<tr><td>ipfs.config.replace</td><td><span>❌</span></td></tr>
<tr><td>ipfs.config.show</td><td><span>✔</span></td></tr>
</tbody>
</table>

##### stats
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.stats.bitswap</td><td><span>✔</span></td></tr>
<tr><td>ipfs.stats.bw</td><td><span>✔</span></td></tr>
<tr><td>ipfs.stats.bwPoll</td><td><span>✔</span></td></tr>
<tr><td>ipfs.stats.repo</td><td><span>✔</span></td></tr>
</tbody>
</table>

##### log
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.log.level</td><td><span>✔</span></td></tr>
<tr><td>ipfs.log.ls</td><td><span>✔</span></td></tr>
<tr><td>ipfs.log.tail</td><td><span>✔</span></td></tr>
</tbody>
</table>

##### repo
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.repo.gc</td><td><span>✔</span></td></tr>
<tr><td>ipfs.repo.stat</td><td><span>✔</span></td></tr>
<tr><td>ipfs.repo.version</td><td><span>✔</span></td></tr>
</tbody>
</table>

##### key
<table>
<thead><tr><th>api</th><th>状态</th></tr></thead>
<tbody>
<tr><td>ipfs.key.gen</td><td><span>✔</span></td></tr>
<tr><td>ipfs.key.list</td><td><span>✔</span></td></tr>
<tr><td>ipfs.key.rename</td><td><span>✔</span></td></tr>
<tr><td>ipfs.key.rm</td><td><span>✔</span></td></tr>
</tbody>
</table>