This repository was archived by the owner on Feb 12, 2024. It is now read-only.
chore: make IPFS API static (remove api-manager) #3365
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| 'use strict' | ||
|
|
||
| const createWantlist = require('./wantlist') | ||
| const createWantlistForPeer = require('./wantlist-for-peer') | ||
| const createUnwant = require('./unwant') | ||
| const createStat = require('./stat') | ||
|
|
||
| class BitswapAPI { | ||
| /** | ||
| * @param {Object} config | ||
Gozala marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * @param {NetworkService} config.network | ||
| */ | ||
| constructor ({ network }) { | ||
| this.wantlist = createWantlist({ network }) | ||
| this.wantlistForPeer = createWantlistForPeer({ network }) | ||
| this.unwant = createUnwant({ network }) | ||
| this.stat = createStat({ network }) | ||
| } | ||
| } | ||
| module.exports = BitswapAPI | ||
|
|
||
| /** | ||
| * @typedef {import('..').NetworkService} NetworkService | ||
Gozala marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * @typedef {import('..').PeerId} PeerId | ||
| * @typedef {import('..').CID} CID | ||
| * @typedef {import('..').AbortOptions} AbortOptions | ||
| */ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,16 +6,13 @@ const withTimeoutOption = require('ipfs-core-utils/src/with-timeout-option') | |
|
|
||
| /** | ||
| * @param {Object} config | ||
| * @param {import('.').NetworkService} config.network | ||
| */ | ||
| module.exports = ({ network }) => { | ||
| /** | ||
| * Show diagnostic information on the bitswap agent. | ||
| * Note: `bitswap.stat` and `stats.bitswap` can be used interchangeably. | ||
| * | ||
| * @example | ||
| * ```js | ||
| * const stats = await ipfs.bitswap.stat() | ||
|
|
@@ -35,8 +32,11 @@ module.exports = ({ bitswap }) => { | |
| * // dupDataReceived: 0 | ||
| * // } | ||
| * ``` | ||
| * @param {import('.').AbortOptions} [options] | ||
| * @returns {Promise<BitswapStats>} | ||
| */ | ||
| async function stat (options) { | ||
| const { bitswap } = await network.use(options) | ||
| const snapshot = bitswap.stat().snapshot | ||
|
|
||
| return { | ||
|
|
@@ -59,13 +59,11 @@ module.exports = ({ bitswap }) => { | |
| * @typedef {object} BitswapStats - An object that contains information about the bitswap agent | ||
| * @property {number} provideBufLen - an integer | ||
| * @property {CID[]} wantlist | ||
| * @property {CID[]} peers - array of peer IDs | ||
|
There was a problem hiding this comment. See docs comment, peer IDs should be strings consistent with There was a problem hiding this comment. Current implementation is not and docs / types were incorrect. And I have submitted #3389 to address that separately. |
||
| * @property {Big} blocksReceived | ||
| * @property {Big} dataReceived | ||
| * @property {Big} blocksSent | ||
| * @property {Big} dataSent | ||
| * @property {Big} dupBlksReceived | ||
| * @property {Big} dupDataReceived | ||
| */ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,24 +5,26 @@ const withTimeoutOption = require('ipfs-core-utils/src/with-timeout-option') | |
|
|
||
| /** | ||
| * @param {Object} config | ||
| * @param {import('.').NetworkService} config.network | ||
| */ | ||
| module.exports = ({ network }) => { | ||
| /** | ||
| * Returns the wantlist for a connected peer | ||
| * | ||
| * @example | ||
| * ```js | ||
| * const list = await ipfs.bitswap.wantlistForPeer(peerId) | ||
| * console.log(list) | ||
| * // [ CID('QmHash') ] | ||
| * ``` | ||
| * | ||
| * @param {PeerId | CID | string | Uint8Array} peerId - A peer ID to return the wantlist for\ | ||
|
There was a problem hiding this comment. can we have a There was a problem hiding this comment. I think better alternative would be accept I think we already have couple of places with Either way can we deal with trickling types into separate packages as a followup work ? There was a problem hiding this comment. Created a followup here libp2p/js-peer-id#133 There was a problem hiding this comment. We already have several I think this would be nice to have, I would just go with |
||
| * @param {AbortOptions} [options] | ||
| * @returns {Promise<CID[]>} - An array of CIDs currently in the wantlist | ||
| * | ||
| */ | ||
| async function wantlistForPeer (peerId, options = {}) { | ||
| const { bitswap } = await network.use(options) | ||
| const list = bitswap.wantlistForPeer(PeerId.createFromCID(peerId), options) | ||
|
|
||
| return Array.from(list).map(e => e[1].cid) | ||
|
|
@@ -32,9 +34,9 @@ module.exports = ({ bitswap }) => { | |
| } | ||
|
|
||
| /** | ||
| * @typedef {import('.').AbortOptions} AbortOptions | ||
| * @typedef {import('.').CID} CID | ||
| * @typedef {import('.').PeerId} PeerId | ||
| */ | ||
|
|
||
| /** | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.