Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

docs: remove references to Go #442

Merged
merged 1 commit into from
Feb 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The API is presented with both Node.js and Go primitives. However, there are no

- [JavaScript IPFS implementation](https://github.com/ipfs/js-ipfs)
- [JavaScript IPFS HTTP Client Library](https://github.com/ipfs/js-ipfs-api)
- Soon™, go-ipfs, go-ipfs-api, java-ipfs-api, python-ipfs-api and others will implement it as well.
- [JavaScript IPFS postMessage proxy](https://github.com/ipfs-shipyard/ipfs-postmsg-proxy)

Send in a PR if you find or write one!

Expand All @@ -57,8 +57,6 @@ In JavaScript land:
npm install interface-ipfs-core
```

In Go land:

If you want to run these tests against a go-ipfs daemon, checkout [ipfs-http-client](https://github.com/ipfs/js-ipfs-http-client) and run test tests:

```
Expand All @@ -69,8 +67,6 @@ npm test

## Usage

### JavaScript

Install `interface-ipfs-core` as one of the dependencies of your project and as a test file. Then, using `mocha` (for Node.js) or a test runner with compatible API, do:

```js
Expand Down Expand Up @@ -156,7 +152,7 @@ tests.repo(createCommon, { only: ['should do a thing'] })

## API

In order to be considered "valid", an IPFS core implementation must expose the API described in [/SPEC](/SPEC). You can also use this loose spec as documentation for consuming the core APIs. Here is an outline of the contents of that directory:
In order to be considered "valid", an IPFS core implementation must expose the API described in [/SPEC](/SPEC). You can also use this loose spec as documentation for consuming the core APIs. Here is an outline of the contents of that directory:

- **Files**
- [files](/SPEC/FILES.md)
Expand All @@ -166,15 +162,17 @@ In order to be considered "valid", an IPFS core implementation must expose the
- [dag](/SPEC/DAG.md)
- [object](/SPEC/OBJECT.md)
- [pin](/SPEC/PIN.md)
- [**Name**](/SPEC/NAME.md)
- **Network**
- [bootstrap](/SPEC/BOOSTRAP.md)
- [bitswap (not spec'ed yet)](/SPEC/BITSWAP.md)
- [dht (not spec'ed yet)](/SPEC/DHT.md)
- [bitswap](/SPEC/BITSWAP.md)
- [dht](/SPEC/DHT.md)
- [pubsub](/SPEC/PUBSUB.md)
- [swarm](/SPEC/SWARM.md)
- **Node Management**
- [Miscellaneous](/SPEC/MISCELLANEOUS.md)
- [config](/SPEC/CONFIG.md)
- [key](/SPEC/KEY.md)
- [stats](/SPEC/STATS.md)
- [repo](/SPEC/REPO.md)
- [**Types**](/SPEC/TYPES.md)
Expand Down
8 changes: 2 additions & 6 deletions SPEC/BITSWAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@

> Returns the wantlist, optionally filtered by peer ID

#### Go **WIP**

#### JavaScript - `ipfs.bitswap.wantlist([peerId], [callback])`
#### `ipfs.bitswap.wantlist([peerId], [callback])`

`callback` must follow `function (err, list) {}` signature, where `err` is an error if the operation was not successful. `list` is an Object containing the following keys:

Expand All @@ -34,9 +32,7 @@ ipfs.bitswap.wantlist(peerId, (err, list) => console.log(list))

> Show diagnostic information on the bitswap agent.

##### Go **WIP**

##### JavaScript - `ipfs.bitswap.stat([callback])`
##### `ipfs.bitswap.stat([callback])`

Note: `bitswap.stat` and `stats.bitswap` can be used interchangeably.

Expand Down
12 changes: 3 additions & 9 deletions SPEC/BLOCK.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@

> Get a raw IPFS block.

##### Go **WIP**

##### JavaScript - `ipfs.block.get(cid, [options], [callback])`
##### `ipfs.block.get(cid, [options], [callback])`

`cid` is a [cid][cid] which can be passed as:

Expand Down Expand Up @@ -44,9 +42,7 @@ A great source of [examples][] can be found in the tests for this API.

> Stores input as an IPFS block.

##### Go **WIP**

##### JavaScript - `ipfs.block.put(block, [options], [callback])`
##### `ipfs.block.put(block, [options], [callback])`

Where `block` can be:

Expand Down Expand Up @@ -114,9 +110,7 @@ A great source of [examples][] can be found in the tests for this API.

> Print information of a raw IPFS block.

##### Go **WIP**

##### JavaScript - `ipfs.block.stat(cid, [callback])`
##### `ipfs.block.stat(cid, [callback])`

`cid` is a [cid][cid] which can be passed as:

Expand Down
12 changes: 3 additions & 9 deletions SPEC/BOOTSTRAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@

> Add a peer address to the bootstrap list

##### Go **WIP**

##### JavaScript - `ipfs.bootstrap.add(addr, [options], [callback])`
##### `ipfs.bootstrap.add(addr, [options], [callback])`

- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
- `options.default` if true, add the default peers to the list
Expand All @@ -26,9 +24,7 @@

> List all peer addresses in the bootstrap list

##### Go **WIP**

##### JavaScript - `ipfs.bootstrap.list([callback])``
##### `ipfs.bootstrap.list([callback])``

- `callback` must follow `function (err, res) {}` signature, where `err` is an error if the operation was not successful. `res.Peers` is an array of addresses.

Expand All @@ -37,9 +33,7 @@

> Remove a peer address from the bootstrap list

##### Go **WIP**

##### JavaScript - `ipfs.bootstrap.rm(peer, [options], [callback])`
##### `ipfs.bootstrap.rm(peer, [options], [callback])`

- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
- `options.all` if true, remove all peers from the list
Expand Down
12 changes: 3 additions & 9 deletions SPEC/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@

> Returns the currently being used config. If the daemon is off, it returns the stored config.

##### Go **WIP**

##### JavaScript - `ipfs.config.get([key], [callback])`
##### `ipfs.config.get([key], [callback])`

`key` is the key of the value that should be fetched from the config file. If no key is passed, then the whole config should be returned. `key` should be of type String.

Expand All @@ -35,9 +33,7 @@ A great source of [examples][] can be found in the tests for this API.

> Adds or replaces a config value.

##### Go **WIP**

##### JavaScript - `ipfs.config.set(key, value, [callback])`
##### `ipfs.config.set(key, value, [callback])`

`key` is the key value that will be added or replaced (in case of the value already). `key` should be of type String.

Expand Down Expand Up @@ -66,9 +62,7 @@ A great source of [examples][] can be found in the tests for this API.

> Adds or replaces a config file.

##### Go **WIP**

##### JavaScript - `ipfs.config.replace(config, [callback])`
##### `ipfs.config.replace(config, [callback])`

`config` is a JSON object that contains the new config.

Expand Down
12 changes: 3 additions & 9 deletions SPEC/DAG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@

> Store an IPLD format node

##### Go **WIP**

##### JavaScript - `ipfs.dag.put(dagNode, [options], [callback])`
##### `ipfs.dag.put(dagNode, [options], [callback])`

- `dagNode` - a DAG node that follows one of the supported IPLD formats.
- `options` - a object that might contain the following values:
Expand Down Expand Up @@ -46,9 +44,7 @@ A great source of [examples][] can be found in the tests for this API.

> Retrieve an IPLD format node

##### Go **WIP**

##### JavaScript - `ipfs.dag.get(cid, [path], [options], [callback])`
##### `ipfs.dag.get(cid, [path], [options], [callback])`

- `cid` - can be one of the following:
- a [CID](https://github.com/ipfs/js-cid) instance.
Expand Down Expand Up @@ -117,9 +113,7 @@ A great source of [examples][] can be found in the tests for this API.

> Enumerate all the entries in a graph

##### Go **WIP**

##### JavaScript - `ipfs.dag.tree(cid, [path], [options], [callback])`
##### `ipfs.dag.tree(cid, [path], [options], [callback])`

- `cid` - can be one of the following:
- a [CID](https://github.com/ipfs/js-cid) instance.
Expand Down
24 changes: 6 additions & 18 deletions SPEC/DHT.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

> Retrieve the Peer Info of a reachable node in the network.

##### Go **WIP**

##### JavaScript - `ipfs.dht.findPeer(peerId, [callback])`
##### `ipfs.dht.findPeer(peerId, [callback])`

Where `peerId` is a IPFS/libp2p Id from [PeerId](https://github.com/libp2p/js-peer-id) type.

Expand All @@ -39,9 +37,7 @@ A great source of [examples][] can be found in the tests for this API.

> Retrieve the providers for content that is addressed by an hash.

##### Go **WIP**

##### JavaScript - `ipfs.dht.findProvs(hash, [options], [callback])`
##### `ipfs.dht.findProvs(hash, [options], [callback])`

Where `hash` is a multihash.

Expand All @@ -67,9 +63,7 @@ A great source of [examples][] can be found in the tests for this API.

> Retrieve a value from DHT

##### Go **WIP**

##### JavaScript - `ipfs.dht.get(key, [callback])`
##### `ipfs.dht.get(key, [callback])`

Where `key` is a Buffer.

Expand All @@ -89,9 +83,7 @@ A great source of [examples][] can be found in the tests for this API.

> Announce to the network that you are providing given values.

##### Go **WIP**

##### JavaScript - `ipfs.dht.provide(cid, [callback])`
##### `ipfs.dht.provide(cid, [callback])`

Where `cid` is a CID or array of CIDs.

Expand All @@ -111,9 +103,7 @@ A great source of [examples][] can be found in the tests for this API.

> Store a value on the DHT

##### Go **WIP**

##### JavaScript - `ipfs.dht.put(key, value, [callback])`
##### `ipfs.dht.put(key, value, [callback])`

Where `key` is a Buffer and `value` is a Buffer.

Expand All @@ -133,9 +123,7 @@ A great source of [examples][] can be found in the tests for this API.

> Queries the network for the 'closest peers' to a given key. 'closest' is defined by the rules of the underlying Peer Routing mechanism.

##### Go **WIP**

##### JavaScript - `ipfs.dht.query(peerId, [callback])`
##### `ipfs.dht.query(peerId, [callback])`

Where `peerId` is a IPFS/libp2p Id of type [PeerId](https://github.com/libp2p/js-peer-id).

Expand Down
Loading