Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
feat: Link stats.repo and stats.bitswap (#210)
Browse files Browse the repository at this point in the history
* Update BITSWAP.md

* Update STATS.md

* Update BITSWAP.md

* Update REPO.md
  • Loading branch information
hacdias authored and daviddias committed Jan 30, 2018
1 parent 02dc5f4 commit 0c40084
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 73 deletions.
51 changes: 49 additions & 2 deletions SPEC/BITSWAP.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,49 @@
bitswap API (not spec'ed yet)
=============================
Bitswap API
=======

#### `wantlist` (not spec'ed yet)

#### `unwant` (not spec'ed yet)

#### `stat`

> Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
##### `Go` **WIP**

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

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

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

- `provideBufLen`
- `wantlist` (array)
- `peers` (array)
- `blocksReceived`
- `dataReceived`
- `blocksSent`
- `dataSent`
- `dupBlksReceived`
- `dupDataReceived`

If no `callback` is passed, a promise is returned.

**Example:**

```JavaScript
ipfs.stats.bitswap((err, stats) => console.log(stats))

// { provideBufLen: 0,
// wantlist: null,
// peers:
// [ 'QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
// 'QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
// 'QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd' ],
// blocksReceived: 0,
// dataReceived: 0,
// blocksSent: 0,
// dataSent: 0,
// dupBlksReceived: 0,
// dupDataReceived: 0 }
```
2 changes: 2 additions & 0 deletions SPEC/REPO.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ ipfs.repo.gc((err, res) => console.log(res))

##### `JavaScript` - ipfs.repo.stat([options, callback])

`stats.repo` and `repo.stat` can be used interchangeably.

Where:

- `options` is an object that contains following properties
Expand Down
74 changes: 3 additions & 71 deletions SPEC/STATS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,11 @@ Stats API

#### `bitswap`

> Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
##### `Go` **WIP**

##### `JavaScript` - ipfs.stats.bitswap([callback])
`stats.bitswap` and `bitswap.stat` can be used interchangeably. See [`bitswap.stat`](./BITSWAP.md#stat) for more details.

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

- `provideBufLen`
- `wantlist` (array)
- `peers` (array)
- `blocksReceived`
- `dataReceived`
- `blocksSent`
- `dataSent`
- `dupBlksReceived`
- `dupDataReceived`
#### `repo`

If no `callback` is passed, a promise is returned.

**Example:**

```JavaScript
ipfs.stats.bitswap((err, stats) => console.log(stats))

// { provideBufLen: 0,
// wantlist: null,
// peers:
// [ 'QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
// 'QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
// 'QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd' ],
// blocksReceived: 0,
// dataReceived: 0,
// blocksSent: 0,
// dataSent: 0,
// dupBlksReceived: 0,
// dupDataReceived: 0 }
```
`stats.repo` and `repo.stat` can be used interchangeably. See [`repo.stat`](./REPO.md#stat) for more details.

#### `bw`

Expand Down Expand Up @@ -77,38 +44,3 @@ ipfs.stats.bw((err, stats) => console.log(stats))
// rateIn: 905.0873512246716,
// rateOut: 893.7400053359125 }
```

#### `stat`

> Get stats for the currently used repo.
##### `Go` **WIP**

##### `JavaScript` - ipfs.repo.stat([options, callback])

Where:

- `options` is an object that contains following properties
- `human` a Boolean value to output `repoSize` in MiB.

`callback` must follow `function (err, stats) {}` signature, where `err` is an Error if the operation was not successful and `stats` is an object containing the following keys:

- `numObjects`
- `repoSize`
- `repoPath`
- `version`
- `storageMax`

If no `callback` is passed, a promise is returned.

**Example:**

```JavaScript
ipfs.repo.stat((err, stats) => console.log(stats))

// { numObjects: 15,
// repoSize: 64190,
// repoPath: 'C:\\Users\\henri\\AppData\\Local\\Temp\\ipfs_687c6eb3da07d3b16fe3c63ce17560e9',
// version: 'fs-repo@6',
// storageMax: 10000000000 }
```

0 comments on commit 0c40084

Please sign in to comment.