diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000000..0bc3b42de8 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +version: 2 +updates: +- package-ecosystem: npm + directory: "/" + schedule: + interval: daily + time: "10:00" + open-pull-requests-limit: 10 + commit-message: + prefix: "deps" + prefix-development: "deps(dev)" diff --git a/.github/workflows/bundlesize.yml b/.github/workflows/bundlesize.yml deleted file mode 100644 index dad3e1ab7d..0000000000 --- a/.github/workflows/bundlesize.yml +++ /dev/null @@ -1,34 +0,0 @@ -# Checks bundlesize, does not run on master -on: - pull_request: - branches: - - '*' - -name: Bundlesize -jobs: - check: - runs-on: ubuntu-latest # https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-README.md - strategy: - matrix: - node-version: [14.x] - project: - - packages/ipfs - - packages/ipfs-core - - packages/ipfs-client - - packages/ipfs-grpc-client - - packages/ipfs-http-client - - packages/ipfs-message-port-client - steps: - - uses: actions/checkout@v2 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node-version }} - - uses: actions/checkout@v2 - - run: npm install - - name: Bundlesize ${{ matrix.project }} - uses: ipfs/aegir/actions/bundle-size@v32.1.0 - continue-on-error: true - with: - project: ${{ matrix.project }} - github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 0000000000..fe461b4243 --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,20 @@ +# Dependency Review Action +# +# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging. +# +# Source repository: https://github.com/actions/dependency-review-action +# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v3 + - name: 'Dependency Review' + uses: actions/dependency-review-action@v2 diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml new file mode 100644 index 0000000000..d876b0a7c7 --- /dev/null +++ b/.github/workflows/examples.yml @@ -0,0 +1,130 @@ +name: Examples +on: + push: + branches: + - master + pull_request: + branches: + - '**' + +jobs: + + build: + name: Build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + + # test-examples: + # name: Test example ${{ matrix.example.name }} + # needs: build + # runs-on: ubuntu-latest + # continue-on-error: true + # strategy: + # matrix: + # example: + # - name: ipfs browser add readable stream + # repo: https://github.com/ipfs-examples/js-ipfs-browser-add-readable-stream.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser angular + # repo: https://github.com/ipfs-examples/js-ipfs-browser-angular.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs-core-types@$PWD/packages/ipfs-core-types + # - name: ipfs browser browserify + # repo: https://github.com/ipfs-examples/js-ipfs-browser-browserify.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser react + # repo: https://github.com/ipfs-examples/js-ipfs-browser-create-react-app.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser exchange files + # repo: https://github.com/ipfs-examples/js-ipfs-browser-exchange-files.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs@$PWD/packages/ipfs,ipfs-core-types@$PWD/packages/ipfs-core-types,ipfs-http-client@$PWD/packages/ipfs-http-client + # - name: ipfs browser ipns publish + # repo: https://github.com/ipfs-examples/js-ipfs-browser-ipns-publish.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs-http-client@$PWD/packages/ipfs-http-client + # - name: ipfs browser mfs + # repo: https://github.com/ipfs-examples/js-ipfs-browser-mfs.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # # fails with No native build was found for platform=darwin arch=x64 runtime=node abi=93 uv=1 libc=glibc node=16.13.0 webpack=true + # #- name: ipfs browser nextjs + # # repo: https://github.com/ipfs-examples/js-ipfs-browser-nextjs.git + # # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser parceljs + # repo: https://github.com/ipfs-examples/js-ipfs-browser-parceljs.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser readable stream + # repo: https://github.com/ipfs-examples/js-ipfs-browser-readablestream.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser service worker + # repo: https://github.com/ipfs-examples/js-ipfs-browser-service-worker.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs-message-port-client@$PWD/packages/ipfs-message-port-client,ipfs-message-port-protocol@$PWD/packages/ipfs-message-port-protocol,ipfs-message-port-server@$PWD/packages/ipfs-message-port-server + # - name: ipfs browser sharing across tabs + # repo: https://github.com/ipfs-examples/js-ipfs-browser-sharing-node-across-tabs.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs-message-port-client@$PWD/packages/ipfs-message-port-client,ipfs-message-port-server@$PWD/packages/ipfs-message-port-server + # - name: ipfs browser video streaming + # repo: https://github.com/ipfs-examples/js-ipfs-browser-video-streaming.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser vue + # repo: https://github.com/ipfs-examples/js-ipfs-browser-vue.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs browser webpack + # repo: https://github.com/ipfs-examples/js-ipfs-browser-webpack.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs circuit relaying + # repo: https://github.com/ipfs-examples/js-ipfs-circuit-relaying.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs-http-client@$PWD/packages/ipfs-http-client + # - name: ipfs custom ipfs repo + # repo: https://github.com/ipfs-examples/js-ipfs-custom-ipfs-repo.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs custom ipld formats + # repo: https://github.com/ipfs-examples/js-ipfs-custom-ipld-formats.git + # deps: ipfs-core@$PWD/packages/ipfs-core,ipfs-daemon@$PWD/packages/ipfs-daemon,ipfs-http-client@$PWD/packages/ipfs-http-client + # - name: ipfs custom libp2p + # repo: https://github.com/ipfs-examples/js-ipfs-custom-libp2p.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs-http-client browser pubsub + # repo: https://github.com/ipfs-examples/js-ipfs-http-client-browser-pubsub.git + # deps: ipfs-http-client@$PWD/packages/ipfs-http-client,ipfs@$PWD/packages/ipfs + # - name: ipfs-http-client bundle webpack + # repo: https://github.com/ipfs-examples/js-ipfs-http-client-bundle-webpack.git + # deps: ipfs-http-client@$PWD/packages/ipfs-http-client,ipfs@$PWD/packages/ipfs + # - name: ipfs-http-client name api + # repo: https://github.com/ipfs-examples/js-ipfs-http-client-name-api.git + # deps: ipfs-http-client@$PWD/packages/ipfs-http-client + # - name: ipfs-http-client upload file + # repo: https://github.com/ipfs-examples/js-ipfs-http-client-upload-file.git + # deps: ipfs@$PWD/packages/ipfs,ipfs-http-client@$PWD/packages/ipfs-http-client + # - name: ipfs 101 + # repo: https://github.com/ipfs-examples/js-ipfs-101.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs-client add files + # repo: https://github.com/ipfs-examples/js-ipfs-ipfs-client-add-files.git + # deps: ipfs@$PWD/packages/ipfs,ipfs-client@$PWD/packages/ipfs-client + # - name: ipfs electron js + # repo: https://github.com/ipfs-examples/js-ipfs-run-in-electron.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: ipfs running multiple nodes + # repo: https://github.com/ipfs-examples/js-ipfs-running-multiple-nodes.git + # deps: ipfs@$PWD/packages/ipfs + # - name: ipfs traverse ipld graphs + # repo: https://github.com/ipfs-examples/js-ipfs-traverse-ipld-graphs.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: types with typescript + # repo: https://github.com/ipfs-examples/js-ipfs-types-use-ipfs-from-ts.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # - name: types with typed js + # repo: https://github.com/ipfs-examples/js-ipfs-types-use-ipfs-from-typed-js.git + # deps: ipfs-core@$PWD/packages/ipfs-core + # steps: + # - uses: actions/checkout@v2 + # - uses: actions/setup-node@v2 + # with: + # node-version: lts/* + # - uses: ipfs/aegir/actions/cache-node-modules@master + # - uses: GabrielBB/xvfb-action@v1 + # name: Run npm run test:external -- -- -- ${{ matrix.example.repo }} --deps ${{ matrix.example.deps }} + # with: + # run: npm run test:external -- -- -- ${{ matrix.example.repo }} --deps ${{ matrix.example.deps }} diff --git a/.github/workflows/externals.yml b/.github/workflows/externals.yml new file mode 100644 index 0000000000..5ba3536c01 --- /dev/null +++ b/.github/workflows/externals.yml @@ -0,0 +1,51 @@ +name: Externals +on: + push: + branches: + - master + pull_request: + branches: + - '**' + +jobs: + + build: + name: Build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + + test-externals: + name: Test external ${{ matrix.external.name }} + needs: build + runs-on: ubuntu-latest + strategy: + matrix: + external: + - name: ipfs webui + repo: https://github.com/ipfs-shipyard/ipfs-webui.git + deps: ipfs@$PWD/packages/ipfs + - name: ipfs companion + repo: https://github.com/ipfs-shipyard/ipfs-companion.git + deps: ipfs@$PWD/packages/ipfs + - name: orbit-db-io + repo: https://github.com/orbitdb/orbit-db-io.git + deps: ipfs@$PWD/packages/ipfs + - name: ipfs-log + repo: https://github.com/orbitdb/ipfs-log.git + deps: ipfs@$PWD/packages/ipfs,orbit-db-io@next + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - uses: GabrielBB/xvfb-action@v1 + name: Run npm run test:external -- -- -- ${{ matrix.external.repo }} --deps ${{ matrix.external.deps }} --branch ${{ matrix.external.branch }} + continue-on-error: true + with: + run: npm run test:external -- -- -- ${{ matrix.external.repo }} --deps ${{ matrix.external.deps }} --branch ${{ matrix.external.branch }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 0000000000..6f6d895d19 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,26 @@ +name: Close and mark stale issue + +on: + schedule: + - cron: '0 0 * * *' + +jobs: + stale: + + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + + steps: + - uses: actions/stale@v3 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-issue-message: 'Oops, seems like we needed more information for this issue, please comment with more details or this issue will be closed in 7 days.' + close-issue-message: 'This issue was closed because it is missing author input.' + stale-issue-label: 'kind/stale' + any-of-labels: 'need/author-input' + exempt-issue-labels: 'need/triage,need/community-input,need/maintainer-input,need/maintainers-input,need/analysis,status/blocked,status/in-progress,status/ready,status/deferred,status/inactive' + days-before-issue-stale: 6 + days-before-issue-close: 7 + enable-statistics: true diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000000..b16ab31931 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,271 @@ +name: Test +on: + push: + branches: + - master + pull_request: + branches: + - '**' + +jobs: + + build: + name: Build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + + check: + name: Check + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: | + npm run lint + npm run dep-check -- -- -- -p + npm run dep-check -- -- -- -- --unused + + test-node: + name: Unit tests node ${{ matrix.node }} ${{ matrix.os }} + needs: build + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, macos-latest] + node: [16] + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node }} + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npx lerna run test:node --since ${{ github.event.pull_request.base.sha }} --concurrency 1 + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: node + + test-chrome: + name: Unit tests chrome + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npx lerna run test:chrome --since ${{ github.event.pull_request.base.sha }} --concurrency 1 + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: chrome + + test-chrome-webworker: + name: Unit tests chrome-webworker + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npx lerna run test:chrome-webworker --since ${{ github.event.pull_request.base.sha }} --concurrency 1 + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: chrome-webworker + + test-firefox: + name: Unit tests firefox + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npx lerna run test:firefox --since ${{ github.event.pull_request.base.sha }} --concurrency 1 + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: firefox + + test-firefox-webworker: + name: Unit tests firefox-webworker + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npx playwright install --with-deps + - run: npx lerna run test:firefox-webworker --since ${{ github.event.pull_request.base.sha }} --concurrency 1 + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: firefox-webworker + + test-electron-main: + name: Unit tests electron-main + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - uses: GabrielBB/xvfb-action@v1 + with: + run: npx lerna run test:electron-main --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- --bail + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: electron-main + + test-interop: + name: Interop tests ${{ matrix.project }} ${{ matrix.type }} + runs-on: ubuntu-latest + strategy: + matrix: + type: + - node + - browser + #- electron-main + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npm install + - run: npm run build + - run: npx lerna run test:interop --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- -t ${{ matrix.type }} --bail + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: interop-${{ matrix.type }} + + test-interface: + name: Interface tests ${{ matrix.suite }} ${{ matrix.type }} + runs-on: ubuntu-latest + strategy: + matrix: + type: + - node + - browser + #- electron-main + suite: + - test:interface:core + - test:interface:client + - test:interface:http-go + - test:interface:http-js + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - run: npm install + - run: npm run build + - run: npx lerna run ${{ matrix.suite }} --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -t ${{ matrix.type }} --bail + - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 + with: + flags: interface-${{ matrix.type }} + + test-interface-message-port-client: + name: Interface tests test:interface:message-port-client browser + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: ipfs/aegir/actions/cache-node-modules@master + - run: npx playwright install --with-deps + - run: npx lerna run test:interface:message-port-client --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- --bail + + release: + runs-on: ubuntu-latest + needs: [ + test-node, + test-chrome, + test-chrome-webworker, + test-firefox, + test-firefox-webworker, + test-electron-main, + test-interop, + test-interface, + test-interface-message-port-client + ] + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + steps: + - uses: GoogleCloudPlatform/release-please-action@v2 + id: release + with: + token: ${{ secrets.GITHUB_TOKEN }} + command: manifest + release-type: node + manifest-file: .release-please-manifest.json + config-file: .release-please.json + changelog-types: | + [ + { "type": "feat", "section": "Features", "hidden": false }, + { "type": "fix", "section": "Bug Fixes", "hidden": false }, + { "type": "chore", "section": "Trivial Changes", "hidden": false }, + { "type": "docs", "section": "Documentation", "hidden": false }, + { "type": "deps", "section": "Dependencies", "hidden": false } + ] + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v2 + with: + node-version: lts/* + registry-url: 'https://registry.npmjs.org' + - uses: ipfs/aegir/actions/cache-node-modules@master + - uses: ipfs/aegir/actions/docker-login@master + with: + docker-token: ${{ secrets.DOCKER_TOKEN }} + docker-username: ${{ secrets.DOCKER_USERNAME }} + - if: ${{ steps.release.outputs.releases_created }} + name: Run release version + run: | + git update-index --assume-unchanged packages/ipfs-core/src/version.js packages/ipfs-http-server/src/version.js packages/ipfs/src/package.js + npm run --if-present release + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + - if: ${{ !steps.release.outputs.releases_created }} + name: Run release rc + run: | + git config --global user.email "github-actions[bot]@users.noreply.github.com" + git config --global user.name "github-actions[bot]" + git update-index --assume-unchanged packages/ipfs-core/src/version.js packages/ipfs-http-server/src/version.js packages/ipfs/src/package.js + npm run --if-present release:rc + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml deleted file mode 100644 index b64158cba4..0000000000 --- a/.github/workflows/typecheck.yml +++ /dev/null @@ -1,43 +0,0 @@ -on: - pull_request: - branches: - - '*' - -name: Typecheck -jobs: - check: - runs-on: ubuntu-latest - strategy: - matrix: - node-version: [14.x] - project: - - packages/ipfs - - packages/ipfs-cli - - packages/ipfs-client - - packages/ipfs-core - - packages/ipfs-core-types - - packages/ipfs-core-utils - - packages/ipfs-daemon - - packages/ipfs-grpc-client - - packages/ipfs-grpc-server - - packages/ipfs-http-client - - packages/ipfs-http-gateway - - packages/ipfs-http-server - - packages/ipfs-message-port-client - - packages/ipfs-message-port-protocol - - packages/ipfs-message-port-server - steps: - - uses: actions/checkout@v2 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node-version }} - - name: Install dependencies - run: npm install - - name: Build types - run: npm run build - - name: Typecheck ${{ matrix.project }} - uses: gozala/typescript-error-reporter-action@v1.0.8 - with: - project: ${{ matrix.project }} - diff --git a/.gitignore b/.gitignore index 4da7986f91..7ebda0ab08 100644 --- a/.gitignore +++ b/.gitignore @@ -4,9 +4,11 @@ logs npm-debug.log* package-lock.json yarn.lock +tsconfig-types.aegir.json # Coverage directory used by tools like istanbul coverage +.coverage .nyc_output tests_output cache @@ -21,6 +23,7 @@ dist build bundle.js tsconfig-types.aegir.json +tsconfig-check.aegir.json .tsbuildinfo # Deployment files @@ -31,3 +34,4 @@ tsconfig-types.aegir.json # Operating system files .DS_Store +types \ No newline at end of file diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000000..6f9bc03873 --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1 @@ +{"packages/interface-ipfs-core":"0.157.0","packages/ipfs":"0.65.0","packages/ipfs-cli":"0.15.0","packages/ipfs-client":"0.9.2","packages/ipfs-core":"0.17.0","packages/ipfs-core-config":"0.6.0","packages/ipfs-core-types":"0.13.0","packages/ipfs-core-utils":"0.17.0","packages/ipfs-daemon":"0.15.0","packages/ipfs-grpc-client":"0.12.0","packages/ipfs-grpc-protocol":"0.7.0","packages/ipfs-grpc-server":"0.11.0","packages/ipfs-http-client":"59.0.0","packages/ipfs-http-gateway":"0.12.0","packages/ipfs-http-response":"5.0.0","packages/ipfs-http-server":"0.14.0","packages/ipfs-message-port-client":"0.14.0","packages/ipfs-message-port-protocol":"0.14.0","packages/ipfs-message-port-server":"0.14.0"} \ No newline at end of file diff --git a/.release-please.json b/.release-please.json new file mode 100644 index 0000000000..ef11a9e9bb --- /dev/null +++ b/.release-please.json @@ -0,0 +1,26 @@ +{ + "plugins": ["node-workspace"], + "bump-minor-pre-major": true, + "group-pull-request-title-pattern": "chore: release ${component}", + "packages": { + "packages/interface-ipfs-core": {}, + "packages/ipfs": {}, + "packages/ipfs-cli": {}, + "packages/ipfs-client": {}, + "packages/ipfs-core": {}, + "packages/ipfs-core-config": {}, + "packages/ipfs-core-types": {}, + "packages/ipfs-core-utils": {}, + "packages/ipfs-daemon": {}, + "packages/ipfs-grpc-client": {}, + "packages/ipfs-grpc-protocol": {}, + "packages/ipfs-grpc-server": {}, + "packages/ipfs-http-client": {}, + "packages/ipfs-http-gateway": {}, + "packages/ipfs-http-response": {}, + "packages/ipfs-http-server": {}, + "packages/ipfs-message-port-client": {}, + "packages/ipfs-message-port-protocol": {}, + "packages/ipfs-message-port-server": {} + } +} diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b3320469b2..0000000000 --- a/.travis.yml +++ /dev/null @@ -1,372 +0,0 @@ -language: node_js -dist: bionic - -cache: - # https://travis-ci.community/t/npm-cache-on-windows-supplies-incorrect-dependency-versions/11335 - npm: false - -services: - - xvfb - -branches: - only: - - master - - /^release\/.*$/ - -stages: - - test - - release-rc - - release-docker - - test-external - -node_js: - - 'lts/*' - - 'node' - -os: - - linux - - osx - - windows - -env: - # This stops Windows builds from hanging - # https://travis-ci.community/t/timeout-after-build-finished-and-succeeded/1336 - - YARN_GPG=no - -addons: - apt: - packages: - # # These are required to run webkit - # - libwoff1 - # - libopus0 - # - libwebp6 - # - libwebpdemux2 - # - libenchant1c2a - # - libgudev-1.0-0 - # - libsecret-1-0 - # - libhyphen0 - # - libgdk-pixbuf2.0-0 - # - libegl1 - # - libgles2 - # - libevent-2.1-6 - # - libnotify4 - # - libxslt1.1 - # - libvpx5 - # # gstreamer and plugins to support video playback in WebKit. - # - gstreamer1.0-gl - # - gstreamer1.0-plugins-base - # - gstreamer1.0-plugins-good - # - gstreamer1.0-plugins-bad - # This is required to run chromium - - libgbm1 - chrome: stable - -before_install: - # prevents windows error: npm ERR! ... git-sh-setup: file not found - - if [ "$TRAVIS_OS_NAME" = "windows" ]; then export PATH=/c/PROGRA~1/Git/usr/bin:/c/PROGRA~1/Git/mingw64/libexec/git-core:$PATH ; fi - # only run jobs in packages that have changed since master in PR builds - - if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then export RUN_SINCE='--since master' ; fi - -script: - - npm run test:node -- $RUN_SINCE -- -- --timeout 10000 --bail -- --exit # TODO remove --exit https://mochajs.org/#-exit - -jobs: - allow_failures: - - name: external - ipfs-webui - - name: external - ipfs-companion - - name: external - npm-on-ipfs - - name: external - peer-base - - name: external - service-worker-gateway - - name: external - orbit-db - - name: external - ipfs-log - - include: - - stage: test - name: lint - script: - - npm run lint -- $RUN_SINCE --concurrency 1 - - - stage: test - name: dep-check (production deps) - script: - - npm run dep-check -- $RUN_SINCE -- -- -p - - - stage: test - name: dep-check (unused deps) - script: - - npm run dep-check -- $RUN_SINCE -- -- -- --unused - - - stage: test - name: chrome - script: - - npm run test:browser -- $RUN_SINCE -- -- --bail - - - stage: test - name: chrome webworker - script: - - npm run test:webworker -- $RUN_SINCE -- -- --bail --timeout 60000 - - - stage: test - name: firefox - script: - - npm run test:browser -- $RUN_SINCE -- -- --bail -- --browser firefox - - - stage: test - name: firefox webworker - script: - - npm run test:webworker -- $RUN_SINCE -- -- --bail --timeout 60000 -- --browser firefox - - - stage: test - name: electron-main - script: - - npm run test:electron-main -- $RUN_SINCE -- -- --bail --timeout 60000 - - - stage: test - name: electron-renderer - script: - - npm run test:electron-renderer -- $RUN_SINCE -- -- --bail --timeout 60000 - - - stage: test - name: interop - node - script: - - npm run test:interop -- $RUN_SINCE -- -- -- -t node --bail - - - stage: test - name: interop - browser - script: - - npm run test:interop -- $RUN_SINCE -- -- -- -t browser --bail - - - stage: test - name: interop - electron-main - script: - - npm run test:interop -- $RUN_SINCE -- -- -- -t electron-main -f ./test/node.js --bail --timeout 60000 - - - stage: test - name: interop - electron-renderer - script: - - npm run test:interop -- $RUN_SINCE -- -- -- -t electron-renderer -f ./test/browser.js -bail --timeout 60000 - - - stage: test - name: js-ipfs interface tests - node - script: - - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t node -- --exit # TODO remove --exit https://mochajs.org/#-exit - - - stage: test - name: js-ipfs interface tests - chrome - script: - - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t browser - - - stage: test - name: js-ipfs interface tests - chrome webworker - script: - - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 - - - stage: test - name: js-ipfs interface tests - firefox - script: - - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t browser -- --browser firefox - - #- stage: test - # name: js-ipfs interface tests - firefox webworker - # script: - # - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 -- --browser firefox - - - stage: test - name: js-ipfs interface tests - electron main - script: - - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t electron-main --timeout 60000 - - - stage: test - name: js-ipfs interface tests - electron renderer - script: - - npm run test:interface:core -- $RUN_SINCE -- -- --bail -t electron-renderer --timeout 60000 - - - stage: test - name: js-ipfs interface tests - ipfs-client - node - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t node -- --exit # TODO remove --exit https://mochajs.org/#-exit - - - stage: test - name: js-ipfs interface tests - ipfs-client - chrome - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t browser - - - stage: test - name: js-ipfs interface tests - ipfs-client - chrome webworker - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 - - - stage: test - name: js-ipfs interface tests - ipfs-client - firefox - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t browser -- --browser firefox - - - stage: test - name: js-ipfs interface tests - ipfs-client - firefox webworker - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 -- --browser firefox - - - stage: test - name: js-ipfs interface tests - ipfs-client - electron main - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t electron-main --timeout 60000 - - - stage: test - name: js-ipfs interface tests - ipfs-client - electron renderer - script: - - npm run test:interface:client -- $RUN_SINCE -- -- --bail -t electron-renderer --timeout 60000 - - - stage: test - name: http-api-client interface tests vs go-ipfs - node - script: - - npm run test:interface:http-go -- $RUN_SINCE -- -- --bail -t node -- --exit # TODO remove --exit https://mochajs.org/#-exit - - - stage: test - name: http-api-client interface tests vs go-ipfs - chrome - script: - - npm run test:interface:http-go -- $RUN_SINCE -- -- --bail -t browser - - - stage: test - name: http-api-client interface tests vs go-ipfs - chrome webworker - script: - - npm run test:interface:http-go -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 - - - stage: test - name: http-api-client interface tests vs go-ipfs - firefox - script: - - npm run test:interface:http-go -- $RUN_SINCE -- -- --bail -t browser -- --browser firefox - - - stage: test - name: http-api-client interface tests vs go-ipfs - firefox webworker - script: - - npm run test:interface:http-go -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 -- --browser firefox - - - stage: test - name: http-api-client interface tests vs js-ipfs - node - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t node -- --exit # TODO remove --exit https://mochajs.org/#-exit - - - stage: test - name: http-api-client interface tests vs js-ipfs - chrome - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t browser - - - stage: test - name: http-api-client interface tests vs js-ipfs - chrome webworker - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 - - - stage: test - name: http-api-client interface tests vs js-ipfs - firefox - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t browser --browser firefox - - - stage: test - name: http-api-client interface tests vs js-ipfs - firefox webworker - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t webworker --timeout 60000 -- --browser firefox - - - stage: test - name: http-api-client interface tests vs js-ipfs - electron main - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t electron-main --timeout 60000 - - - stage: test - name: http-api-client interface tests vs js-ipfs - electron renderer - script: - - npm run test:interface:http-js -- $RUN_SINCE -- -- --bail -t electron-renderer --timeout 60000 - - - stage: test - name: ipfs-message-port-client interface tests - chrome - script: - - npm run test:interface:message-port-client -- $RUN_SINCE -- -- --bail -t browser - - - stage: test - name: ipfs-message-port-client interface tests - firefox - script: - - npm run test:interface:message-port-client -- $RUN_SINCE -- -- --bail -t browser -- --browser firefox - - - stage: test - name: examples - script: - # Travis lets scripts continue even if previous steps fail so need to use &&: https://github.com/travis-ci/travis-ci/issues/1066 - - npm run configure-examples && - npm run test -- --scope=example* --concurrency=1 - - - stage: release-rc - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: release rc - script: - # travis does not fetch the whole repo history, but we need that to work out the - # ref count to publish canary releases properly - - git fetch --unshallow - - echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc - - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin - # only run if the last commit was not part of a release - - if [[ ! `git log -n 1 -q` =~ publish ]]; then npm run release:rc ; fi - - - stage: release-docker - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: release docker - script: - # travis does not fetch the whole repo history, but we need that to work out the - # ref count to publish canary releases properly - - git fetch --unshallow - - echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc - - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin - # only run if the last commit was not part of a release - - if [[ ! `git log -n 1 -q` =~ publish ]]; then npm run docker:rc ; fi - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - ipfs-webui - script: - - E2E_IPFSD_TYPE=js npm run test:external -- -- -- https://github.com/ipfs-shipyard/ipfs-webui.git --deps=ipfs@next - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - ipfs-companion - script: - - npm run test:external -- -- -- https://github.com/ipfs-shipyard/ipfs-companion.git --deps=ipfs@next - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - npm-on-ipfs - script: - - npm run test:external -- -- -- https://github.com/ipfs-shipyard/npm-on-ipfs.git --deps=ipfs@next - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - peer-base - script: - - npm run test:external -- -- -- https://github.com/achingbrain/peer-base.git --branch upgrade-to-latest-ipfs-rc --deps=ipfs@next - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - service-worker-gateway - script: - - npm run test:external -- -- -- https://github.com/ipfs-shipyard/service-worker-gateway.git --deps=ipfs@next - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - orbit-db - script: - - npm run test:external -- -- -- https://github.com/orbitdb/orbit-db.git --deps=ipfs@next - - - stage: test-external - # only run on changes to master - if: branch = master AND type = push AND fork = false - name: external - ipfs-log - script: - - npm run test:external -- -- -- https://github.com/orbitdb/ipfs-log.git --deps=ipfs@next - -notifications: - email: false diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..20ce483c86 --- /dev/null +++ b/LICENSE @@ -0,0 +1,4 @@ +This project is dual licensed under MIT and Apache-2.0. + +MIT: https://www.opensource.org/licenses/mit +Apache-2.0: https://www.apache.org/licenses/license-2.0 diff --git a/LICENSE-MIT b/LICENSE-MIT index 749aa1ecd9..72dc60d84b 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file +THE SOFTWARE. diff --git a/README.md b/README.md index 019fb749c6..49da0064e0 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,6 @@

The JavaScript implementation of the IPFS protocol

-

- - - - -

-

@@ -20,34 +13,29 @@

-> **Upgrading from <=0.40 to 0.48?** See the [release notes](https://github.com/ipfs/js-ipfs/issues/2656) for the list of API changes and the [migration guide](https://github.com/ipfs/js-ipfs/tree/master/docs/MIGRATION-TO-ASYNC-AWAIT.md). - -We've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of 🐉.. - ## Getting started * Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -* Look into the [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +* Ensure CORS is [correctly configured](https://github.com/ipfs/js-ipfs/blob/master/docs/CORS.md) for use with the HTTP client +* Look into the [examples](https://github.com/ipfs-examples/js-ipfs-examples/tree/master) to learn how to spawn an IPFS node in Node.js and in the Browser * Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node -* Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it -* Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs -* Check out https://docs.ipfs.io for tips, how-tos and more -* See https://blog.ipfs.io for news and more +* Head over to https://proto.school to take the [IPFS course](https://proto.school/course/ipfs) that covers core IPFS concepts and JS APIs +* Check out https://docs.ipfs.io for [glossary](https://docs.ipfs.io/concepts/glossary), tips, how-tos and more * Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io - -## Lead Maintainer - -[Alex Potsides](http://github.com/achingbrain) +* Find out about chat channels, the IPFS newsletter, the IPFS blog, and more in the [IPFS community space](https://docs.ipfs.io/community/). ## Table of Contents - [Getting started](#getting-started) + - [Install as a CLI user](#install-as-a-cli-user) + - [Install as an application developer](#install-as-an-application-developer) - [Documentation](#documentation) - [Structure](#structure) +- [Packages](#packages) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) - [License](#license) -## Getting Started +## Getting Started ### Install as a CLI user @@ -82,7 +70,7 @@ $ npm install ipfs-core Then start a node in your app: ```javascript -const IPFS = require('ipfs-core') +import * as IPFS from 'ipfs-core' const ipfs = await IPFS.create() const { cid } = await ipfs.add('Hello world') @@ -92,9 +80,10 @@ console.info(cid) ## Documentation +* [Concepts](https://docs.ipfs.io/concepts/) * [Config](./docs/CONFIG.md) * [Core API](./docs/core-api) -* [Examples](./examples) +* [Examples](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples) * [Development](./docs/DEVELOPMENT.md) ## Structure @@ -102,10 +91,19 @@ console.info(cid) This project is broken into several modules, their purposes are: * [`/packages/interface-ipfs-core`](./packages/interface-ipfs-core) Tests to ensure adherence of an implementation to the spec -* [`/packages/ipfs`](./packages/ipfs) The core implementation +* [`/packages/ipfs`](./packages/ipfs) An aggregator module that bundles the core implementation, the CLI, HTTP API server and daemon +* [`/packages/ipfs-cli`](./packages/ipfs-cli) A CLI to the core implementation +* [`/packages/ipfs-core`](./packages/ipfs-core) The core implementation +* [`/packages/ipfs-core-types`](./packages/ipfs-core-types) Typescript definitions for the core API * [`/packages/ipfs-core-utils`](./packages/ipfs-core-utils) Helpers and utilities common to core and the HTTP RPC API client +* [`/packages/ipfs-daemon`](./packages/ipfs-daemon) Run js-IPFS as a background daemon +* [`/packages/ipfs-grpc-client`](./packages/ipfs-grpc-client) A gRPC client for js-IPFS +* [`/packages/ipfs-grpc-protocol`](./packages/ipfs-grpc-protocol) Shared module between the gRPC client and server +* [`/packages/ipfs-grpc-server`](./packages/ipfs-grpc-server) A gRPC-over-websockets server for js-IPFS * [`/packages/ipfs-http-client`](./packages/ipfs-http-client) A client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs -* [`/packages/ipfs-message-port-client`](./packages/ipfs-http-client) A client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs +* [`/packages/ipfs-http-server`](./packages/ipfs-http-server) JS implementation of the [Kubo RPC HTTP API](https://docs.ipfs.io/reference/kubo/rpc/) +* [`/packages/ipfs-http-gateway`](./packages/ipfs-http-gateway) JS implementation of the [IPFS HTTP Gateway](https://docs.ipfs.io/concepts/ipfs-gateway/) +* [`/packages/ipfs-http-response`](./packages/ipfs-http-response) Creates a HTTP response for a given IPFS Path * [`/packages/ipfs-message-port-client`](./packages/ipfs-message-port-client) A client for the RPC-over-message-port API presented by js-ipfs running in a shared worker * [`/packages/ipfs-message-port-protocol`](./packages/ipfs-message-port-protocol) Code shared by the message port client & server * [`/packages/ipfs-message-port-server`](./packages/ipfs-message-port-server) The server that receives requests from ipfs-message-port-client @@ -117,14 +115,11 @@ List of the main packages that make up the IPFS ecosystem. | Package | Version | Deps | CI/Travis | Coverage | Lead Maintainer | | ---------|---------|---------|---------|---------|--------- | | **Files** | -| [`ipfs-unixfs-exporter`](//github.com/ipfs/js-ipfs-unixfs) | [![npm](https://img.shields.io/npm/v/ipfs-unixfs-exporter.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-unixfs/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs/master)](https://travis-ci.com/ipfs/js-ipfs-unixfs) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs) | [Alex Potsides](mailto:alex.potsides@protocol.ai) | -| [`ipfs-unixfs-importer`](//github.com/ipfs/js-ipfs-unixfs) | [![npm](https://img.shields.io/npm/v/ipfs-unixfs-importer.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-unixfs/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs/master)](https://travis-ci.com/ipfs/js-ipfs-unixfs) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs) | [Alex Potsides](mailto:alex.potsides@protocol.ai) | | [`ipfs-unixfs`](//github.com/ipfs/js-ipfs-unixfs) | [![npm](https://img.shields.io/npm/v/ipfs-unixfs.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-unixfs/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs/master)](https://travis-ci.com/ipfs/js-ipfs-unixfs) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs) | [Alex Potsides](mailto:alex.potsides@protocol.ai) | | **Repo** | | [`ipfs-repo`](//github.com/ipfs/js-ipfs-repo) | [![npm](https://img.shields.io/npm/v/ipfs-repo.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-repo/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-repo.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-repo) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-repo/master)](https://travis-ci.com/ipfs/js-ipfs-repo) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-repo/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-repo) | [Alex Potsides](mailto:alex@achingbrain.net) | +| [`ipfs-repo-migrations`](//github.com/ipfs/js-ipfs-repo-migrations) | [![npm](https://img.shields.io/npm/v/ipfs-repo-migrations.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-repo-migrations/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-repo-migrations.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-repo-migrations) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-repo-migrations/master)](https://travis-ci.com/ipfs/js-ipfs-repo-migrations) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations) | N/A | | **Exchange** | -| [`ipfs-block-service`](//github.com/ipfs/js-ipfs-block-service) | [![npm](https://img.shields.io/npm/v/ipfs-block-service.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-block-service/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-block-service.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-block-service) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-block-service/master)](https://travis-ci.com/ipfs/js-ipfs-block-service) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-block-service/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-block-service) | [Volker Mische](mailto:volker.mische@gmail.com) | -| [`ipfs-block`](//github.com/ipfs/js-ipfs-block) | [![npm](https://img.shields.io/npm/v/ipfs-block.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-block/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-block.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-block) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-block/master)](https://travis-ci.com/ipfs/js-ipfs-block) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-block/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-block) | [Volker Mische](mailto:volker.mische@gmail.com) | | [`ipfs-bitswap`](//github.com/ipfs/js-ipfs-bitswap) | [![npm](https://img.shields.io/npm/v/ipfs-bitswap.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-bitswap/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-bitswap.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-bitswap) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-bitswap/master)](https://travis-ci.com/ipfs/js-ipfs-bitswap) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-bitswap/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-bitswap) | [Dirk McCormick](mailto:dirk@protocol.ai) | | **IPNS** | | [`ipns`](//github.com/ipfs/js-ipns) | [![npm](https://img.shields.io/npm/v/ipns.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipns/releases) | [![Deps](https://david-dm.org/ipfs/js-ipns.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipns) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipns/master)](https://travis-ci.com/ipfs/js-ipns) | [![codecov](https://codecov.io/gh/ipfs/js-ipns/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipns) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | @@ -135,7 +130,6 @@ List of the main packages that make up the IPFS ecosystem. | [`ipfsd-ctl`](//github.com/ipfs/js-ipfsd-ctl) | [![npm](https://img.shields.io/npm/v/ipfsd-ctl.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfsd-ctl/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfsd-ctl.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfsd-ctl) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfsd-ctl/master)](https://travis-ci.com/ipfs/js-ipfsd-ctl) | [![codecov](https://codecov.io/gh/ipfs/js-ipfsd-ctl/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfsd-ctl) | [Hugo Dias](mailto:mail@hugodias.me) | | [`is-ipfs`](//github.com/ipfs/is-ipfs) | [![npm](https://img.shields.io/npm/v/is-ipfs.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/is-ipfs/releases) | [![Deps](https://david-dm.org/ipfs/is-ipfs.svg?style=flat-square)](https://david-dm.org/ipfs/is-ipfs) | [![Travis CI](https://flat.badgen.net/travis/ipfs/is-ipfs/master)](https://travis-ci.com/ipfs/is-ipfs) | [![codecov](https://codecov.io/gh/ipfs/is-ipfs/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/is-ipfs) | [Marcin Rataj](mailto:lidel@lidel.org) | | [`aegir`](//github.com/ipfs/aegir) | [![npm](https://img.shields.io/npm/v/aegir.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/aegir/releases) | [![Deps](https://david-dm.org/ipfs/aegir.svg?style=flat-square)](https://david-dm.org/ipfs/aegir) | [![Travis CI](https://flat.badgen.net/travis/ipfs/aegir/master)](https://travis-ci.com/ipfs/aegir) | [![codecov](https://codecov.io/gh/ipfs/aegir/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/aegir) | [Hugo Dias](mailto:hugomrdias@gmail.com) | -| [`ipfs-repo-migrations`](//github.com/ipfs/js-ipfs-repo-migrations) | [![npm](https://img.shields.io/npm/v/ipfs-repo-migrations.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-repo-migrations/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-repo-migrations.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-repo-migrations) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-repo-migrations/master)](https://travis-ci.com/ipfs/js-ipfs-repo-migrations) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations) | N/A | | **libp2p** | | [`libp2p`](//github.com/libp2p/js-libp2p) | [![npm](https://img.shields.io/npm/v/libp2p.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p/master)](https://travis-ci.com/libp2p/js-libp2p) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p) | [Jacob Heun](mailto:jacobheun@gmail.com) | | [`peer-id`](//github.com/libp2p/js-peer-id) | [![npm](https://img.shields.io/npm/v/peer-id.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-id/releases) | [![Deps](https://david-dm.org/libp2p/js-peer-id.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-id) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-peer-id/master)](https://travis-ci.com/libp2p/js-peer-id) | [![codecov](https://codecov.io/gh/libp2p/js-peer-id/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-peer-id) | [Vasco Santos](mailto:santos.vasco10@gmail.com) | @@ -145,7 +139,7 @@ List of the main packages that make up the IPFS ecosystem. | [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [![npm](https://img.shields.io/npm/v/libp2p-kad-dht.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-dht/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-kad-dht/master)](https://travis-ci.com/libp2p/js-libp2p-kad-dht) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-kad-dht/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | | [`libp2p-mdns`](//github.com/libp2p/js-libp2p-mdns) | [![npm](https://img.shields.io/npm/v/libp2p-mdns.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-mdns/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-mdns.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-mdns) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-mdns/master)](https://travis-ci.com/libp2p/js-libp2p-mdns) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-mdns/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-mdns) | [Jacob Heun](mailto:jacobheun@gmail.com) | | [`libp2p-bootstrap`](//github.com/libp2p/js-libp2p-bootstrap) | [![npm](https://img.shields.io/npm/v/libp2p-bootstrap.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-bootstrap/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-bootstrap.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-bootstrap) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-bootstrap/master)](https://travis-ci.com/libp2p/js-libp2p-bootstrap) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-bootstrap/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | -| [`libp2p-noise`](//github.com/NodeFactoryIo/js-libp2p-noise) | [![npm](https://img.shields.io/npm/v/libp2p-noise.svg?maxAge=86400&style=flat-square)](//github.com/NodeFactoryIo/js-libp2p-noise/releases) | [![Deps](https://david-dm.org/NodeFactoryIo/js-libp2p-noise.svg?style=flat-square)](https://david-dm.org/NodeFactoryIo/js-libp2p-noise) | [![Travis CI](https://flat.badgen.net/travis/NodeFactoryIo/js-libp2p-noise/master)](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise) | [![codecov](https://codecov.io/gh/NodeFactoryIo/js-libp2p-noise/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/NodeFactoryIo/js-libp2p-noise) | N/A | +| [`@chainsafe/libp2p-noise`](//github.com/ChainSafe/js-libp2p-noise) | [![npm](https://img.shields.io/npm/v/libp2p-noise.svg?maxAge=86400&style=flat-square)](//github.com/ChainSafe/js-libp2p-noise/releases) | [![Deps](https://david-dm.org/ChainSafe/js-libp2p-noise.svg?style=flat-square)](https://david-dm.org/ChainSafe/js-libp2p-noise) | [![Travis CI](https://flat.badgen.net/travis/ChainSafe/js-libp2p-noise/master)](https://travis-ci.com/ChainSafe/js-libp2p-noise) | [![codecov](https://codecov.io/gh/ChainSafe/js-libp2p-noise/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ChainSafe/js-libp2p-noise) | N/A | | [`libp2p-tcp`](//github.com/libp2p/js-libp2p-tcp) | [![npm](https://img.shields.io/npm/v/libp2p-tcp.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-tcp/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-tcp/master)](https://travis-ci.com/libp2p/js-libp2p-tcp) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-tcp/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tcp) | [Jacob Heun](mailto:jacobheun@gmail.com) | | [`libp2p-webrtc-star`](//github.com/libp2p/js-libp2p-webrtc-star) | [![npm](https://img.shields.io/npm/v/libp2p-webrtc-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-webrtc-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-webrtc-star/master)](https://travis-ci.com/libp2p/js-libp2p-webrtc-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | | [`libp2p-websockets`](//github.com/libp2p/js-libp2p-websockets) | [![npm](https://img.shields.io/npm/v/libp2p-websockets.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websockets/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-websockets.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-websockets/master)](https://travis-ci.com/libp2p/js-libp2p-websockets) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-websockets/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-websockets) | [Jacob Heun](mailto:jacobheun@gmail.com) | @@ -153,14 +147,12 @@ List of the main packages that make up the IPFS ecosystem. | [`libp2p-delegated-content-routing`](//github.com/libp2p/js-libp2p-delegated-content-routing) | [![npm](https://img.shields.io/npm/v/libp2p-delegated-content-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-delegated-content-routing/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-delegated-content-routing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-delegated-content-routing) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-delegated-content-routing/master)](https://travis-ci.com/libp2p/js-libp2p-delegated-content-routing) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-delegated-content-routing/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-delegated-content-routing) | [Jacob Heun](mailto:jacobheun@gmail.com) | | [`libp2p-delegated-peer-routing`](//github.com/libp2p/js-libp2p-delegated-peer-routing) | [![npm](https://img.shields.io/npm/v/libp2p-delegated-peer-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-delegated-peer-routing/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-delegated-peer-routing/master)](https://travis-ci.com/libp2p/js-libp2p-delegated-peer-routing) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing) | [Jacob Heun](mailto:jacobheun@gmail.com) | | **IPLD** | -| [`ipld`](//github.com/ipld/js-ipld) | [![npm](https://img.shields.io/npm/v/ipld.svg?maxAge=86400&style=flat-square)](//github.com/ipld/js-ipld/releases) | [![Deps](https://david-dm.org/ipld/js-ipld.svg?style=flat-square)](https://david-dm.org/ipld/js-ipld) | [![Travis CI](https://flat.badgen.net/travis/ipld/js-ipld/master)](https://travis-ci.com/ipld/js-ipld) | [![codecov](https://codecov.io/gh/ipld/js-ipld/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipld/js-ipld) | [Volker Mische](mailto:volker.mische@gmail.com) | -| [`ipld-dag-pb`](//github.com/ipld/js-ipld-dag-pb) | [![npm](https://img.shields.io/npm/v/ipld-dag-pb.svg?maxAge=86400&style=flat-square)](//github.com/ipld/js-ipld-dag-pb/releases) | [![Deps](https://david-dm.org/ipld/js-ipld-dag-pb.svg?style=flat-square)](https://david-dm.org/ipld/js-ipld-dag-pb) | [![Travis CI](https://flat.badgen.net/travis/ipld/js-ipld-dag-pb/master)](https://travis-ci.com/ipld/js-ipld-dag-pb) | [![codecov](https://codecov.io/gh/ipld/js-ipld-dag-pb/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipld/js-ipld-dag-pb) | [Volker Mische](mailto:volker.mische@gmail.com) | -| [`ipld-dag-cbor`](//github.com/ipld/js-ipld-dag-cbor) | [![npm](https://img.shields.io/npm/v/ipld-dag-cbor.svg?maxAge=86400&style=flat-square)](//github.com/ipld/js-ipld-dag-cbor/releases) | [![Deps](https://david-dm.org/ipld/js-ipld-dag-cbor.svg?style=flat-square)](https://david-dm.org/ipld/js-ipld-dag-cbor) | [![Travis CI](https://flat.badgen.net/travis/ipld/js-ipld-dag-cbor/master)](https://travis-ci.com/ipld/js-ipld-dag-cbor) | [![codecov](https://codecov.io/gh/ipld/js-ipld-dag-cbor/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipld/js-ipld-dag-cbor) | [Volker Mische](mailto:volker.mische@gmail.com) | +| [`@ipld/dag-pb`](//github.com/ipld/js-dag-pb) | [![npm](https://img.shields.io/npm/v/@ipld/dag-pb.svg?maxAge=86400&style=flat-square)](//github.com/ipld/js-dag-pb/releases) | [![Deps](https://david-dm.org/ipld/js-dag-pb.svg?style=flat-square)](https://david-dm.org/ipld/js-dag-pb) | [![Travis CI](https://flat.badgen.net/travis/ipld/js-dag-pb/master)](https://travis-ci.com/ipld/js-dag-pb) | [![codecov](https://codecov.io/gh/ipld/js-dag-pb/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipld/js-dag-pb) | N/A | +| [`@ipld/dag-cbor`](//github.com/ipld/js-dag-cbor) | [![npm](https://img.shields.io/npm/v/@ipld/dag-cbor.svg?maxAge=86400&style=flat-square)](//github.com/ipld/js-dag-cbor/releases) | [![Deps](https://david-dm.org/ipld/js-dag-cbor.svg?style=flat-square)](https://david-dm.org/ipld/js-dag-cbor) | [![Travis CI](https://flat.badgen.net/travis/ipld/js-dag-cbor/master)](https://travis-ci.com/ipld/js-dag-cbor) | [![codecov](https://codecov.io/gh/ipld/js-dag-cbor/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipld/js-dag-cbor) | N/A | | **Multiformats** | -| [`multihashing`](//github.com/multiformats/js-multihashing) | [![npm](https://img.shields.io/npm/v/multihashing.svg?maxAge=86400&style=flat-square)](//github.com/multiformats/js-multihashing/releases) | [![Deps](https://david-dm.org/multiformats/js-multihashing.svg?style=flat-square)](https://david-dm.org/multiformats/js-multihashing) | [![Travis CI](https://flat.badgen.net/travis/multiformats/js-multihashing/master)](https://travis-ci.com/multiformats/js-multihashing) | [![codecov](https://codecov.io/gh/multiformats/js-multihashing/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multihashing) | [Hugo Dias](mailto:mail@hugodias.me) | +| [`multiformats`](//github.com/multiformats/js-multiformats) | [![npm](https://img.shields.io/npm/v/multiformats.svg?maxAge=86400&style=flat-square)](//github.com/multiformats/js-multiformats/releases) | [![Deps](https://david-dm.org/multiformats/js-multiformats.svg?style=flat-square)](https://david-dm.org/multiformats/js-multiformats) | [![Travis CI](https://flat.badgen.net/travis/multiformats/js-multiformats/master)](https://travis-ci.com/multiformats/js-multiformats) | [![codecov](https://codecov.io/gh/multiformats/js-multiformats/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multiformats) | N/A | | [`mafmt`](//github.com/multiformats/js-mafmt) | [![npm](https://img.shields.io/npm/v/mafmt.svg?maxAge=86400&style=flat-square)](//github.com/multiformats/js-mafmt/releases) | [![Deps](https://david-dm.org/multiformats/js-mafmt.svg?style=flat-square)](https://david-dm.org/multiformats/js-mafmt) | [![Travis CI](https://flat.badgen.net/travis/multiformats/js-mafmt/master)](https://travis-ci.com/multiformats/js-mafmt) | [![codecov](https://codecov.io/gh/multiformats/js-mafmt/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-mafmt) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | | [`multiaddr`](//github.com/multiformats/js-multiaddr) | [![npm](https://img.shields.io/npm/v/multiaddr.svg?maxAge=86400&style=flat-square)](//github.com/multiformats/js-multiaddr/releases) | [![Deps](https://david-dm.org/multiformats/js-multiaddr.svg?style=flat-square)](https://david-dm.org/multiformats/js-multiaddr) | [![Travis CI](https://flat.badgen.net/travis/multiformats/js-multiaddr/master)](https://travis-ci.com/multiformats/js-multiaddr) | [![codecov](https://codecov.io/gh/multiformats/js-multiaddr/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multiaddr) | [Jacob Heun](mailto:jacobheun@gmail.com) | -| [`multihashes`](//github.com/multiformats/js-multihash) | [![npm](https://img.shields.io/npm/v/multihashes.svg?maxAge=86400&style=flat-square)](//github.com/multiformats/js-multihash/releases) | [![Deps](https://david-dm.org/multiformats/js-multihash.svg?style=flat-square)](https://david-dm.org/multiformats/js-multihash) | [![Travis CI](https://flat.badgen.net/travis/multiformats/js-multihash/master)](https://travis-ci.com/multiformats/js-multihash) | [![codecov](https://codecov.io/gh/multiformats/js-multihash/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multihash) | [David Dias](mailto:daviddias@ipfs.io) | > This table is generated using the module [`package-table`](https://www.npmjs.com/package/package-table) with `package-table --data=package-list.json`. @@ -168,7 +160,7 @@ List of the main packages that make up the IPFS ecosystem. [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) -The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out: +The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out: Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md). @@ -179,7 +171,6 @@ Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of b. ensure quality, and c. reduce possible future bugs. - **Add tests**. There can never be enough tests. -- **Join the [Weekly Core Implementations Call](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next ## License diff --git a/docs/BROWSERS.md b/docs/BROWSERS.md index 5599541944..33366f26a7 100644 --- a/docs/BROWSERS.md +++ b/docs/BROWSERS.md @@ -8,28 +8,29 @@ - [Code Examples](#code-examples) JS IPFS is the implementation of IPFS protocol in JavaScript. It can run on any -evergreen browser, inside a service or web worker, browser extensions, Electron and in Node.js. +evergreen browser, inside a service or web worker, browser extensions, Electron, and in Node.js. **This document provides key information about running JS IPFS in the browser. Save time and get familiar with common caveats and limitations of the browser context.** ## Limitations of the Browser Context -- Transport options are limited to [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) and [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API). +- Transport options are currently limited to [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) and [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API). This means JS IPFS running in the browser is limited to Web APIs available on a web page. - There is no access to raw TCP sockets nor low level UDP, only WebSockets and WebRTC. + There is no access to raw TCP sockets nor low-level UDP, only WebSockets, and WebRTC. - Key [Web APIs](https://developer.mozilla.org/en-US/docs/Web/API) require or are restricted by [Secure Context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) policies. This means JS IPFS needs to run within Secure Context (HTTPS or localhost). - JS IPFS running on HTTPS website requires Secure WebSockets (TLS) and won't work with unencrypted one. + JS IPFS running on HTTPS website requires Secure WebSockets (TLS) and won't work with unencrypted ones. [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) not being available at all. -- [DHT](https://en.wikipedia.org/wiki/Distributed_hash_table) is not available in JS IPFS yet. +- JS IPFS comes with limited support for the [DHT](https://docs.ipfs.tech/concepts/dht/) in client mode which delegates content discovery requests to other DHT nodes. - [We are working on it](https://github.com/ipfs/js-ipfs/pull/1994). For now, the discovery and connectivity to other peers is achieved with a mix of rendezvous and - relay servers, delegated peer/content routing and preload servers. + However, it's worth noting that even though you'll get results from DHT queries, most nodes in the network are not dialable from browsers because they only support TCP and/or QUIC transports. + + For now, the content discovery and connectivity to other peers are achieved with a mix of DHT client requests, rendezvous and relay servers, delegated peer/content routing, and preload servers. ## Addressing Limitations @@ -40,23 +41,24 @@ We provide a few additional components useful for running JS IPFS in the browser - [libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star) - incorporates both a transport and a discovery service that is facilitated by the custom rendezvous server available in the repo - Instructions on enabling `webrtc-star` in js-ipfs config can be found [here](https://github.com/ipfs/js-ipfs/blob/master/docs/FAQ.md#how-to-enable-webrtc-support-for-js-ipfs-in-the-browser). - Make sure to [run your own rendezvous server](https://github.com/libp2p/js-libp2p-webrtc-star#rendezvous-server-aka-signalling-server). -- [libp2p-webrtc-direct](https://github.com/libp2p/js-libp2p-webrtc-direct) - a WebRTC transport that doesn't require the set up a signalling server. +- [libp2p-webrtc-direct](https://github.com/libp2p/js-libp2p-webrtc-direct) - a WebRTC transport that doesn't require the set up a signaling server. - Caveat: you can only establish Browser to Node.js and Node.js to Node.js connections. -**Note:** those are semi-centralized solutions. We are working towards replacing `*-star` with and ambient relays and [libp2p-rendezvous](https://github.com/libp2p/js-libp2p-rendezvous). Details and progress can be found [here](https://github.com/libp2p/js-libp2p/issues/385). +**Note:** those are semi-centralized solutions. We are working towards replacing `*-star` with ambient relays and [libp2p-rendezvous](https://github.com/libp2p/js-libp2p-rendezvous). Details and progress can be found [here](https://github.com/libp2p/js-libp2p/issues/385). You can find detailed information about running js-ipfs [here](https://github.com/ipfs/js-ipfs#table-of-contents). ## Best Practices -- Configure nodes for using self-hosted `*-star` signalling and transport service. When in doubt, use WebSockets ones. +- Configure nodes for using self-hosted `*-star` signalling and transport service. When in doubt, use WebSockets ones. - Run your own instance of `*-star` signalling service. The default ones are under high load and should be used only for tests and development. -- Make sure content added to js-ipfs running in the browser is persisted/cached somewhere on regular IPFS daemon +- Make sure content added to js-ipfs running in the browser is persisted/cached somewhere on a regular long-running IPFS daemon, e.g. [kubo](https://github.com/ipfs/kubo/) - Manually `pin` or preload CIDs of interest with `refs -r` beforehand. - - Preload content on the fly using [preload](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/docs/MODULE.md#optionspreload) feature and/or - configure [delegated routing](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/docs/DELEGATE_ROUTERS.md). - - Avoid public instances in production environment. Make sure preload and delegate nodes used in config are self-hosted and under your control (expose a subset of go-ipfs APIs via reverse proxy such as Nginx). + - Preload content on the fly using [preload](https://github.com/ipfs/js-ipfs/blob/master/docs/MODULE.md#optionspreload) feature and/or + configure [delegated routing](https://github.com/ipfs/js-ipfs/blob/master/docs/DELEGATE_ROUTERS.md). + - Avoid public instances in production environments. Make sure preload and delegate nodes used in config are self-hosted and under your control (expose a subset of [kubo](https://github.com/ipfs/kubo/) (formerly go-ipfs) APIs via reverse proxy such as Nginx). +- If your main goal is to provide content and files to the IPFS network from a browser and you would like to avoid running infrastructure, consider using a pinning service like [Web3.storage](https://web3.storage/). ## Code Examples @@ -76,4 +78,4 @@ document.addEventListener('DOMContentLoaded', async () => { ``` -More advanced examples and tutorials can be found in the [examples](../examples) +More advanced examples and tutorials can be found in the [examples](https://github.com/ipfs-examples) diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 173d349f2f..546d9d1ddf 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -7,6 +7,7 @@ The js-ipfs config file is a JSON document located in the root directory of the - [Profiles](#profiles) - [`Addresses`](#addresses) - [`API`](#api) + - [`RPC`](#rpc) - [`Delegates`](#delegates) - [`Gateway`](#gateway) - [`Swarm`](#swarm) @@ -85,6 +86,14 @@ The IPFS daemon exposes an HTTP API that allows to control the node and run the Default: `/ip4/127.0.0.1/tcp/5002` +### `RPC` + +js-IPFS has a gRPC-over-websockets server that allows it to do things that you cannot do over HTTP like bi-directional streaming. It implements the same API as the [HTTP API Spec](https://docs.ipfs.io/reference/api/http) and can be accessed using the [ipfs-client](https://www.npmjs.com/package/ipfs-client) module. + +Configure the address it listens on using this config key. + +Default: `/ip4/127.0.0.1/tcp/5003` + ### `Delegates` Delegate peers are used to find peers and retrieve content from the network on your behalf. @@ -191,7 +200,7 @@ Options for Multicast DNS peer discovery: ### `webRTCStar` -WebRTCStar is a discovery mechanism prvided by a signalling-star that allows peer-to-peer communications in the browser. +WebRTCStar is a discovery mechanism provided by a signalling-star that allows peer-to-peer communications in the browser. Options for webRTCstar peer discovery: diff --git a/docs/DAEMON.md b/docs/DAEMON.md index 04ca934b90..febd011eb7 100644 --- a/docs/DAEMON.md +++ b/docs/DAEMON.md @@ -23,7 +23,7 @@ The IPFS Daemon exposes the API defined in the [HTTP API spec](https://docs.ipfs If you want a programmatic way to spawn a IPFS Daemon using JavaScript, check out the [ipfsd-ctl](https://github.com/ipfs/js-ipfsd-ctl) module. ```javascript -const { createFactory } = require('ipfsd-ctl') +import { createFactory } from 'ipfsd-ctl' const factory = createFactory({ type: 'proc' // or 'js' to run in a separate process }) diff --git a/docs/DELEGATE_ROUTERS.md b/docs/DELEGATE_ROUTERS.md index da68539ddf..03b906a6c0 100644 --- a/docs/DELEGATE_ROUTERS.md +++ b/docs/DELEGATE_ROUTERS.md @@ -24,7 +24,7 @@ Available delegate multiaddrs are: **Note**: If more than 1 delegate multiaddr is specified, the actual delegate will be randomly selected on startup. -**Note**: If you wish to use delegated routing and are creating your node _programmatically_ in Node.js or the browser you must `npm install libp2p-delegated-content-routing` and/or `npm install libp2p-delegated-peer-routing` and provide configured instances of them in [`options.libp2p`](#optionslibp2p). See the module repos for further instructions: +**Note**: If you wish to use delegated routing and are creating your node _programmatically_ in Node.js or the browser you must `npm install libp2p-delegated-content-routing` and/or `npm install libp2p-delegated-peer-routing` and provide configured instances of them in [`options.libp2p`](./MODULE.md#optionslibp2p). See the module repos for further instructions: - https://github.com/libp2p/js-libp2p-delegated-content-routing - https://github.com/libp2p/js-libp2p-delegated-peer-routing diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index d59e2d66b1..6ac3a4f7d9 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -2,6 +2,7 @@ > Getting started with development on IPFS +- [Install npm@7](#install-npm7) - [Clone and install dependencies](#clone-and-install-dependencies) - [Run tests](#run-tests) - [Lint](#lint) @@ -14,6 +15,14 @@ - [Core](#core) - [Non-Core](#non-core) +## Install npm@7 + +This project uses a [workspace](https://docs.npmjs.com/cli/v7/using-npm/workspaces) structure so requires npm@7 or above. If you are running node 15 or later you already have it, if not run: + +```sh +$ npm install -g npm@latest +``` + ## Clone and install dependencies ```sh @@ -26,7 +35,7 @@ This will install [lerna](https://www.npmjs.com/package/lerna) and bootstrap the If later you add new dependencies to submodules or just wish to remove all the `node_modules`/`dist` folders and start again, run `npm run reset && npm install` from the root. -See the scripts section of the root [`package.json`](./package.json) for more commands. +See the scripts section of the root [`package.json`](../package.json) for more commands. ## Run tests diff --git a/docs/EARLY_TESTERS.md b/docs/EARLY_TESTERS.md index 24162a0c67..f1cc5b0e27 100644 --- a/docs/EARLY_TESTERS.md +++ b/docs/EARLY_TESTERS.md @@ -31,6 +31,7 @@ We will ask early testers to participate at two points in the process: - [orbit-db](https://github.com/orbitdb/orbit-db) - Peer-to-Peer Databases for the Decentralized Web - [ipfs-log](https://github.com/orbitdb/ipfs-log) - Append-only log CRDT on IPFS - [Sidetree DID Protocol](https://github.com/decentralized-identity/sidetree) - Decentralized Identifier Layer-2 network protocol +- [Constellation](https://julienmalard.github.io/constellation/) - Distributed scientific databases for citizen science and more ## How to sign up? diff --git a/docs/FAQ.md b/docs/FAQ.md index 0fb54b3756..c7b314cb5d 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -73,8 +73,8 @@ Yes, however, bear in mind that there isn't a 100% stable solution to use WebRTC To add WebRTC support in a IPFS node instance, do: ```JavaScript -const wrtc = require('wrtc') // or require('electron-webrtc')() -const WebRTCStar = require('libp2p-webrtc-star') +import wrtc from 'wrtc' // or 'electron-webrtc' +import WebRTCStar from '@libp2p/webrtc-star' const node = await IPFS.create({ repo: 'your-repo-path', diff --git a/docs/IPLD.md b/docs/IPLD.md index 28bb5f6e6e..8f3fcfaae4 100644 --- a/docs/IPLD.md +++ b/docs/IPLD.md @@ -3,64 +3,131 @@ ## Table of Contents - [Overview](#overview) -- [Bundled Codecs](#bundled-codecs) -- [Adding additional codecs](#adding-additional-codecs) +- [Bundled BlockCodecs](#bundled-blockcodecs) +- [Bundled Multihashes](#bundled-multihashes) +- [Bundled Multibases](#bundled-multibases) +- [Adding additional BlockCodecs, Multihashes and Multibases](#adding-additional-blockcodecs-multihashes-and-multibases) - [Next steps](#next-steps) ## Overview -The IPFS repo contains a blockstore that holds [Blocks](https://github.com/ipld/js-ipld-block). These blocks can be thought of as a [CID][] and associated byte array. +The IPFS repo contains a blockstore that holds the data that makes up the files on the IPFS network. These blocks can be thought of as a [CID][] and associated byte array. -The [CID][] contains a `codec` property that lets us know how to interpret the byte array associated with it. +The [CID][] contains a `code` property that lets us know how to interpret the byte array associated with it. -In order to perform that interpretation, an [IPLD Format][] must be loaded that corresponds to the `codec` property of the [CID][]. +In order to perform that interpretation, a [BlockCodec][] must be loaded that corresponds to the `code` property of the [CID][]. -## Bundled Codecs +Similarly implementations of [Multihash][]es or [Multibase][]s must be available to be used. -js-IPFS ships with three bundled codecs, the ones that are required to create and interpret [UnixFS][] structures. +## Bundled BlockCodecs + +js-IPFS ships with four bundled codecs, the ones that are required to create and interpret [UnixFS][] structures. These are: -1. [ipld-dag-pb](https://github.com/ipld/js-ipld-dag-pb) - used for file and directory structures -2. [ipld-raw](https://github.com/ipld/js-ipld-raw) - used for file data where imported with `raw-leaves=true` -3. [ipld-dag-cbor](https://github.com/ipld/js-ipld-dag-cbor) - used for general storage of JavaScript Objects +1. [@ipld/dag-pb](https://github.com/ipld/js-dag-pb) - used for file and directory structures +2. [raw](https://github.com/multiformats/js-multiformats/blob/master/src/codecs/raw.js) - used for file data where imported with `--raw-leaves=true` +3. [@ipld/dag-cbor](https://github.com/ipld/js-dag-cbor) - used for storage of JavaScript Objects with [CID] links to other blocks +4. [json](https://github.com/multiformats/js-multiformats/blob/master/src/codecs/json.js) - used for storage of plain JavaScript Objects + +## Bundled Multihashes + +js-IPFS ships with all multihashes [exported by js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/src/hashes), including `sha2-256` and others. + +Additional hashers can be configured using the `hashers` config property. + +## Bundled Multibases + +js-IPFS ships with all multibases [exported by js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/src/bases), including `base58btc`, `base32` and others. -## Adding additional codecs +Additional bases can be configured using the `bases` config property. + +## Adding additional BlockCodecs, Multihashes and Multibases If your application requires support for extra codecs, you can configure them as follows: 1. Configure the [IPLD layer](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/docs/MODULE.md#optionsipld) of your IPFS daemon to support the codec. This step is necessary so the node knows how to prepare data received over HTTP to be passed to IPLD for serialization: + ```javascript - const ipfs = require('ipfs') + import { create } from 'ipfs' + import customBlockCodec from 'custom-blockcodec' + import customMultibase from 'custom-multibase' + import customMultihasher from 'custom-multihasher' - const node = await ipfs({ + const node = await create({ ipld: { - // either specify them as part of the `formats` list - formats: [ - require('my-format') + // either specify BlockCodecs as part of the `codecs` list + codecs: [ + customBlockCodec + ], + + // and/or supply a function to load them dynamically + loadCodec: async (codecNameOrCode) => { + return import(codecNameOrCode) + }, + + // either specify Multibase codecs as part of the `bases` list + bases: [ + customMultibase + ], + + // and/or supply a function to load them dynamically + loadBase: async (baseNameOrCode) => { + return import(baseNameOrCode) + }, + + // either specify Multihash hashers as part of the `hashers` list + hashers: [ + customMultihasher ], - // or supply a function to load them dynamically - loadFormat: async (format) => { - return require(format) + // and/or supply a function to load them dynamically + loadHasher: async (hashNameOrCode) => { + return import(hashNameOrCode) } } }) + ``` + 2. Configure your IPFS HTTP API Client to support the codec. This is necessary so that the client can send the data to the IPFS node over HTTP: + ```javascript - const ipfsHttpClient = require('ipfs-http-client') + import { create } from 'ipfs-http-client' + import customBlockCodec from 'custom-blockcodec' + import customMultibase from 'custom-multibase' + import customMultihasher from 'custom-multihasher' - const client = ipfsHttpClient({ + const client = create({ url: 'http://127.0.0.1:5002', ipld: { - // either specify them as part of the `formats` list - formats: [ - require('my-format') + // either specify BlockCodecs as part of the `codecs` list + codecs: [ + customBlockCodec + ], + + // and/or supply a function to load them dynamically + loadCodec: async (codecNameOrCode) => { + return import(codecNameOrCode) + }, + + // either specify Multibase codecs as part of the `bases` list + bases: [ + customMultibase + ], + + // and/or supply a function to load them dynamically + loadBase: async (baseNameOrCode) => { + return import(baseNameOrCode) + }, + + // either specify Multihash hashers as part of the `hashers` list + hashers: [ + customMultihasher ], - // or supply a function to load them dynamically - loadFormat: async (format) => { - return require(format) + // and/or supply a function to load them dynamically + loadHasher: async (hashNameOrCode) => { + return import(hashNameOrCode) } } }) @@ -68,8 +135,12 @@ If your application requires support for extra codecs, you can configure them as ## Next steps -* See [examples/custom-ipld-formats](https://github.com/ipfs/js-ipfs/tree/master/examples/custom-ipld-formats) for runnable code that demonstrates the above with in-process IPFS nodes, IPFS run as a daemon and also the http client +* See [examples/custom-ipld-formats](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/custom-ipld-formats) for runnable code that demonstrates the above with in-process IPFS nodes, IPFS run as a daemon and also the http client +* Also [examples/traverse-ipld-graphs](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/traverse-ipld-graphs) which uses the [ipld-format-to-blockcodec](https://www.npmjs.com/package/ipld-format-to-blockcodec) module to use older [IPLD format][]s that have not been ported over to the new [BlockCodec][] interface, as well as additional [Multihash Hashers](https://www.npmjs.com/package/multiformats#multihash-hashers). -[cid]: https://www.npmjs.com/package/cids -[ipld format]: https://github.com/ipld/interface-ipld-format +[cid]: https://docs.ipfs.io/concepts/content-addressing/ +[blockcodec]: https://www.npmjs.com/package/multiformats#multicodec-encoders--decoders--codecs [unixfs]: https://github.com/ipfs/specs/blob/master/UNIXFS.md +[ipld format]: https://github.com/ipld/interface-ipld-format +[multihash]: https://github.com/multiformats/multihash +[multibase]: https://github.com/multiformats/multibase \ No newline at end of file diff --git a/docs/MIGRATION-TO-ASYNC-AWAIT.md b/docs/MIGRATION-TO-ASYNC-AWAIT.md index b9cb823987..718071a0d4 100644 --- a/docs/MIGRATION-TO-ASYNC-AWAIT.md +++ b/docs/MIGRATION-TO-ASYNC-AWAIT.md @@ -94,20 +94,20 @@ Libp2p `PeerId` instances are no longer returned from the API. If your applicati Peer ID strings are also CIDs so converting them is simple: ```js -const peerId = PeerId.createFromCID(peerIdStr) +const peerId = PeerId.createFromB58String(peerIdStr) ``` You can get hold of the `PeerId` class using npm or in a script tag: ```js -const PeerId = require('peer-id') -const peerId = PeerId.createFromCID(peerIdStr) +import { PeerId } from '@libp2p/interface-peer-id' +const peerId = PeerId.createFromB58String(peerIdStr) ``` ```html ``` @@ -120,7 +120,7 @@ Libp2p `PeerInfo` instances are no longer returned from the API. Instead, plain Instantiate a new `PeerInfo` and add addresses to it: ```js -const peerInfo = new PeerInfo(PeerId.createFromCID(info.id)) +const peerInfo = new PeerInfo(PeerId.createFromB58String(info.id)) info.addrs.forEach(addr => peerInfo.multiaddrs.add(addr)) ``` @@ -128,8 +128,8 @@ You can get hold of the `PeerInfo` class using npm or in a script tag: ```js const PeerInfo = require('peer-info') -const PeerId = require('peer-id') -const peerInfo = new PeerInfo(PeerId.createFromCID(info.id)) +import { PeerId } from '@libp2p/interface-peer-id' +const peerInfo = new PeerInfo(PeerId.createFromB58String(info.id)) info.addrs.forEach(addr => peerInfo.multiaddrs.add(addr)) ``` @@ -137,7 +137,7 @@ info.addrs.forEach(addr => peerInfo.multiaddrs.add(addr)) ``` @@ -217,7 +217,7 @@ readable.on('end', () => { Becomes: ```js -const toStream = require('it-to-stream') +import toStream from 'it-to-stream' const readable = toStream.readable(ipfs.cat('QmHash')) const decoder = new TextDecoder() @@ -285,7 +285,7 @@ console.log(decoder.decode(data)) ...which, by the way, could more succinctly be written as: ```js -const toBuffer = require('it-to-buffer') +import toBuffer from 'it-to-buffer' const decoder = new TextDecoder() const data = await toBuffer(ipfs.cat('QmHash')) console.log(decoder.decode(data)) @@ -321,7 +321,7 @@ pipeline( Becomes: ```js -const toStream = require('it-to-stream') +import toStream from 'it-to-stream' const { pipeline, Writable } = require('stream') const decoder = new TextDecoder() @@ -353,7 +353,7 @@ Use `it-pipe` and a [for/await](https://developer.mozilla.org/en-US/docs/Web/Jav e.g. ```js -const fs = require('fs') +import fs from 'fs' const { pipeline } = require('stream') const items = [] @@ -378,7 +378,7 @@ pipeline( Becomes: ```js -const fs = require('fs') +import fs from 'fs' const pipe = require('it-pipe') const items = [] @@ -400,9 +400,9 @@ console.log(items) ...which, by the way, could more succinctly be written as: ```js -const fs = require('fs') +import fs from 'fs' const pipe = require('it-pipe') -const all = require('it-all') +import all from 'it-all' const items = await pipe( fs.createReadStream('/path/to/file'), @@ -420,7 +420,7 @@ Convert the async iterable to a readable stream. e.g. ```js -const fs = require('fs') +import fs from 'fs' const { pipeline } = require('stream') const items = [] @@ -445,8 +445,8 @@ pipeline( Becomes: ```js -const toStream = require('it-to-stream') -const fs = require('fs') +import toStream from 'it-to-stream' +import fs from 'fs' const { pipeline } = require('stream') const items = [] @@ -568,7 +568,7 @@ Becomes: ```js const pipe = require('it-pipe') -const concat = require('it-concat') +import concat from 'it-concat' const decoder = new TextDecoder() const data = await pipe( @@ -590,7 +590,7 @@ Use `it-pipe` and `it-all` to collect all items from an async iterable. e.g. ```js -const fs = require('fs') +import fs from 'fs' const toPull = require('stream-to-pull-stream') pull( @@ -605,7 +605,7 @@ pull( Becomes: ```js -const fs = require('fs') +import fs from 'fs' const file = await ipfs.add(fs.createReadStream('/path/to/file')) @@ -619,7 +619,7 @@ Convert the async iterable to a pull stream. e.g. ```js -const fs = require('fs') +import fs from 'fs' const toPull = require('stream-to-pull-stream') pull( @@ -634,7 +634,7 @@ pull( Becomes: ```js -const fs = require('fs') +import fs from 'fs' const streamToPull = require('stream-to-pull-stream') const itToPull = require('async-iterator-to-pull-stream') @@ -685,7 +685,7 @@ for await (const file of addSource) { Alternatively you can buffer up the results using the `it-all` utility: ```js -const all = require('it-all') +import all from 'it-all' const results = await all(ipfs.addAll([ { path: 'root/1.txt', content: 'one' }, @@ -744,7 +744,7 @@ Reading files. e.g. ```js -const fs = require('fs') +import fs from 'fs' const data = await ipfs.cat('/ipfs/QmHash') @@ -759,8 +759,8 @@ Becomes: ```js const pipe = require('it-pipe') -const toIterable = require('stream-to-it') -const fs = require('fs') +import toIterable from 'stream-to-it' +import fs from 'fs' // Note that as chunks arrive they are written to the file and memory can be freed and re-used await pipe( @@ -774,8 +774,8 @@ console.log('done') Alternatively you can buffer up the chunks using the `it-concat` utility (not recommended!): ```js -const fs = require('fs') -const concat = require('it-concat') +import fs from 'fs' +import concat from 'it-concat' const data = await concat(ipfs.cat('/ipfs/QmHash')) @@ -812,7 +812,7 @@ for await (const file of filesSource) { Alternatively you can buffer up the directory listing using the `it-all` utility: ```js -const all = require('it-all') +import all from 'it-all' const results = await all(ipfs.ls('/ipfs/QmHash')) @@ -905,7 +905,7 @@ files.forEach(file => { Becomes: ```js -const fs = require('fs') +import fs from 'fs' const ipfs = IpfsHttpClient() const file = await ipfs.add(fs.createReadStream('/path/to/file.txt')) diff --git a/docs/MODULE.md b/docs/MODULE.md index e970e1b149..23e612d708 100644 --- a/docs/MODULE.md +++ b/docs/MODULE.md @@ -23,11 +23,14 @@ Use the IPFS module as a dependency of your project to spawn in process instance - [`node.start()`](#nodestart) - [Static types and utils](#static-types-and-utils) - [Glob source](#glob-source) - - [`globSource(path, [options])`](#globsourcepath-options) + - [`globSource(path, pattern, [options])`](#globsourcepath-pattern-options) - [Example](#example) - [URL source](#url-source) - [`urlSource(url)`](#urlsourceurl) - [Example](#example-1) + - [Path](#path) + - [`path()`](#path-1) + - [Example](#example-2) ## Getting started @@ -71,9 +74,9 @@ const node = await IPFS.create({ repo: '/var/ipfs/data' }) ### `options.repoAutoMigrate` -| Type | Default | -|------|---------| -| `boolean` | `true` | +| Type | Default | +| --------- | ------- | +| `boolean` | `true` | `js-ipfs` comes bundled with a tool that automatically migrates your IPFS repository when a new version is available. @@ -83,9 +86,9 @@ a case, you should provide a way to trigger migrations manually.** ### `options.init` -| Type | Default | -|------|---------| -| boolean or object | `true` | +| Type | Default | +| ----------------- | ------- | +| boolean or object | `true` | Perform repo initialization steps when creating the IPFS node. @@ -99,7 +102,7 @@ Instead of a boolean, you may provide an object with custom initialization optio - `privateKey` (string/PeerId) A pre-generated private key to use. Can be either a base64 string or a [PeerId](https://github.com/libp2p/js-peer-id) instance. **NOTE: This overrides `bits`.** ```js // Generating a Peer ID: - const PeerId = require('peer-id') + import { PeerId } from '@libp2p/interface-peer-id' // Generates a new Peer ID, complete with public/private keypair // See https://github.com/libp2p/js-peer-id const peerId = await PeerId.create({ bits: 2048 }) @@ -110,24 +113,24 @@ Instead of a boolean, you may provide an object with custom initialization optio ### `options.start` -| Type | Default | -|------|---------| -| `boolean` | `true` | +| Type | Default | +| --------- | ------- | +| `boolean` | `true` | - If `false`, do not automatically start the IPFS node. Instead, you’ll need to manually call [`node.start()`](#nodestart) yourself. +If `false`, do not automatically start the IPFS node. Instead, you’ll need to manually call [`node.start()`](#nodestart) yourself. ### `options.pass` -| Type | Default | -|------|---------| -| string | `null` | +| Type | Default | +| ------ | ------- | +| string | `null` | A passphrase to encrypt/decrypt your keys. ### `options.silent` -| Type | Default | -|------|---------| +| Type | Default | +| ------- | ------- | | Boolean | `false` | Prevents all logging output from the IPFS node. @@ -138,25 +141,25 @@ Prevents all logging output from the IPFS node. |------|---------| | object | `{ enabled: true, hop: { enabled: false, active: false } }` | -Configure circuit relay (see the [circuit relay tutorial](https://github.com/ipfs/js-ipfs/tree/master/examples/circuit-relaying) to learn more). +Configure circuit relay (see the [circuit relay tutorial](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/circuit-relaying) to learn more). - `enabled` (boolean): Enable circuit relay dialer and listener. (Default: `true`) - `hop` (object) - - `enabled` (boolean): Make this node a relay (other nodes can connect *through* it). (Default: `false`) - - `active` (boolean): Make this an *active* relay node. Active relay nodes will attempt to dial a destination peer even if that peer is not yet connected to the relay. (Default: `false`) + - `enabled` (boolean): Make this node a relay (other nodes can connect *through* it). (Default: `false`) + - `active` (boolean): Make this an *active* relay node. Active relay nodes will attempt to dial a destination peer even if that peer is not yet connected to the relay. (Default: `false`) ### `options.offline` -| Type | Default | -|------|---------| +| Type | Default | +| ------- | ------- | | Boolean | `false` | Run ipfs node offline. The node does not connect to the rest of the network but provides a local API. ### `options.preload` -| Type | Default | -|------|---------| +| Type | Default | +| ------ | ------------------------------------- | | object | `{ enabled: true, addresses: [...] }` | Configure remote preload nodes. The remote will preload content added on this node, and also attempt to preload objects requested by this node. @@ -166,8 +169,8 @@ Configure remote preload nodes. The remote will preload content added on this no ### `options.EXPERIMENTAL` -| Type | Default | -|------|---------| +| Type | Default | +| ------ | ---------------------------------------- | | object | `{ ipnsPubsub: false, sharding: false }` | Enable and configure experimental features. @@ -179,46 +182,60 @@ Enable and configure experimental features. | Type | Default | |------|---------| -| object | [`config-nodejs.js`](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core/src/runtime/config-nodejs.js) in Node.js, [`config-browser.js`](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core/src/runtime/config-browser.js) in browsers | +| object | [`config.js`](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/config.js) in Node.js, [`config-browser.js`](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/config.browser.js) in browsers | -Modify the default IPFS node config. This object will be *merged* with the default config; it will not replace it. The default config is documented in [the js-ipfs config file docs](./docs/CONFIG.md). +Modify the default IPFS node config. This object will be *merged* with the default config; it will not replace it. The default config is documented in [the js-ipfs config file docs](./CONFIG.md). ### `options.ipld` - | Type | Default | +| Type | Default | |------|---------| -| object | [`ipld.js`](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core/src/runtime/ipld.js) | +| object | [`ipld.js`](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/ipld.js) | - Modify the default IPLD config. This object will be *merged* with the default config; it will not replace it. Check IPLD [docs](https://github.com/ipld/js-ipld#ipld-constructor) for more information on the available options. +Modify the default IPLD config. This object will be *merged* with the default config; it will not replace it. Check IPLD [docs](https://github.com/ipld/js-ipld#ipld-constructor) for more information on the available options. - > Browser config does **NOT** include by default all the IPLD formats. Only `ipld-dag-pb`, `ipld-dag-cbor` and `ipld-raw` are included. +> Browser config does **NOT** include by default all the IPLD formats. Only `ipld-dag-pb`, `ipld-dag-cbor` and `ipld-raw` are included. - To add support for other formats we provide two options, one sync and another async. +To add support for other formats we provide two options, one sync and another async. - Examples for the sync option: +Examples for the sync option:
ESM Environments ```js import ipldGit from 'ipld-git' import ipldBitcoin from 'ipld-bitcoin' +import { convert } from 'ipld-format-to-blockcodec' const node = await IPFS.create({ ipld: { - formats: [ipldGit, ipldBitcoin] + codecs: [ + convert(ipldGit), + convert(ipldBitcoin) + ] } }) ``` +
Commonjs Environments ```js +const IPFS = require('ipfs') +const ipldGit = require('ipld-git') +const ipldBitcoin = require('ipld-bitcoin') +const { convert } = require('ipld-format-to-blockcodec') + const node = await IPFS.create({ ipld: { - formats: [require('ipld-git'), require('ipld-bitcoin')] + codecs: [ + convert(ipldGit), + convert(ipldBitcoin) + ] } }) ``` +
Using script tags @@ -226,29 +243,34 @@ const node = await IPFS.create({ + ``` +
- Examples for the async option: +Examples for the async option:
ESM Environments ```js const node = await IPFS.create({ ipld: { - async loadFormat (codec) { + async loadCodec (codec) { if (codec === multicodec.GIT_RAW) { - return import('ipld-git') // This is a dynamic import + return convert(await import('ipld-git')) // This is a dynamic import } else { throw new Error('unable to load format ' + multicodec.print[codec]) } @@ -256,11 +278,13 @@ const node = await IPFS.create({ } }) ``` + > For more information about dynamic imports please check [webpack docs](https://webpack.js.org/guides/code-splitting/#dynamic-imports) or search your bundler documention. Using dynamic imports will tell your bundler to create a separate file (normally called *chunk*) that will **only** be requested by the browser if it's really needed. This strategy will reduce your bundle size and load times without removing any functionality. With Webpack IPLD formats can even be grouped together using magic comments `import(/* webpackChunkName: "ipld-formats" */ 'ipld-git')` to produce a single file with all of them. +
Commonjs Environments @@ -278,6 +302,7 @@ const node = await IPFS.create({ } }) ``` +
Using Script tags @@ -309,19 +334,19 @@ const node = await self.IPFS.create({ }) ``` -
+ ### `options.libp2p` | Type | Default | |------|---------| -| object | [`libp2p-nodejs.js`](../src/core/runtime/libp2p-nodejs.js) in Node.js, [`libp2p-browser.js`](../src/core/runtime/libp2p-browser.js) in browsers | -| function | [`libp2p bundle`](https://github.com/ipfs/js-ipfs/tree/master/examples/custom-libp2p) | +| object | [`libp2p-nodejs.js`](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-config/src/libp2p-nodejs.js) in Node.js, [`libp2p-browser.js`](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-config/src)/libp2p-browser.js) in browsers | +| function | [`libp2p bundle`](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/custom-libp2p) | The libp2p option allows you to build your libp2p node by configuration, or via a bundle function. If you are looking to just modify the below options, using the object format is the quickest way to get the default features of libp2p. If you need to create a more customized libp2p node, such as with custom transports or peer/content routers that need some of the ipfs data on startup, a custom bundle is a great way to achieve this. -You can see the bundle in action in the [custom libp2p example](https://github.com/ipfs/js-ipfs/tree/master/examples/custom-libp2p). +You can see the bundle in action in the [custom libp2p example](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/custom-libp2p). Please see [libp2p/docs/CONFIGURATION.md](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md) for the list of options libp2p supports. @@ -340,7 +365,7 @@ console.log('Node is ready to use but not started!') try { await node.start() console.log('Node started!') -} catch (error) { +} catch (/** @type {any} */ error) { console.error('Node failed to start!', error) } ``` @@ -352,14 +377,14 @@ Aside from the default export, `ipfs` exports various types and utilities that a - [`crypto`](https://www.npmjs.com/package/libp2p-crypto) - [`isIPFS`](https://www.npmjs.com/package/is-ipfs) - [`Buffer`](https://www.npmjs.com/package/buffer) -- [`PeerId`](https://www.npmjs.com/package/peer-id) +- [`PeerId`](https://docs.libp2p.io/concepts/peer-id/) - [`PeerInfo`](https://www.npmjs.com/package/peer-info) - [`multiaddr`](https://www.npmjs.com/package/multiaddr) - [`multibase`](https://www.npmjs.com/package/multibase) - [`multihash`](https://www.npmjs.com/package/multihashes) - [`multihashing`](https://www.npmjs.com/package/multihashing-async) - [`multicodec`](https://www.npmjs.com/package/multicodec) -- [`CID`](https://www.npmjs.com/package/cids) +- [`CID`](https://docs.ipfs.io/concepts/content-addressing) These can be accessed like this, for example: @@ -373,12 +398,11 @@ import { CID } from 'ipfs' A utility to allow files on the file system to be easily added to IPFS. -###### `globSource(path, [options])` +###### `globSource(path, pattern, [options])` - `path`: A path to a single file or directory to glob from +- `pattern`: A pattern to match files under `path` - `options`: Optional options -- `options.recursive`: If `path` is a directory, use option `{ recursive: true }` to add the directory and all its sub-directories. -- `options.ignore`: To exclude file globs from the directory, use option `{ ignore: ['ignore/this/folder/**', 'and/this/file'] }`. - `options.hidden`: Hidden/dot files (files or folders starting with a `.`, for example, `.git/`) are not included by default. To add them, use the option `{ hidden: true }`. Returns an async iterable that yields `{ path, content }` objects suitable for passing to `ipfs.add`. @@ -386,10 +410,11 @@ Returns an async iterable that yields `{ path, content }` objects suitable for p ###### Example ```js -const IPFS = require('ipfs') -const { globSource } = IPFS -const ipfs = await IPFS.create() -for await (const file of ipfs.addAll(globSource('./docs', { recursive: true }))) { +import { create, globSource } from 'ipfs' + +const ipfs = await create() + +for await (const file of ipfs.addAll(globSource('./docs', '**/*'))) { console.log(file) } /* @@ -420,9 +445,9 @@ Returns an async iterable that yields `{ path, content }` objects suitable for p ###### Example ```js -const IPFS = require('ipfs') -const { urlSource } = IPFS -const ipfs = await IPFS.create() +import { create, urlSource } from 'ipfs' + +const ipfs = await create() const file = await ipfs.add(urlSource('https://ipfs.io/images/ipfs-logo.svg')) console.log(file) @@ -435,3 +460,21 @@ console.log(file) } */ ``` + +##### Path + +A function that returns the path to the js-ipfs CLI. + +This is analogous to the `.path()` function exported by the [go-ipfs](https://www.npmjs.com/package/go-ipfs) module. + +###### `path()` + +Returns the path to the js-ipfs CLI + +###### Example + +```js +import { path } from 'ipfs' + +console.info(path()) // /foo/bar/node_modules/ipfs/src/cli.js +``` diff --git a/docs/core-api/BITSWAP.md b/docs/core-api/BITSWAP.md index 8c4eb0c62f..41cc548399 100644 --- a/docs/core-api/BITSWAP.md +++ b/docs/core-api/BITSWAP.md @@ -62,7 +62,7 @@ A great source of [examples][] can be found in the tests for this API. | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| peerId | [PeerId][], [CID][], `String` or `Uint8Array` | A peer ID to return the wantlist for | +| peerId | [PeerId][] | A peer ID to return the wantlist for | ### Options @@ -159,7 +159,7 @@ The returned object contains the following keys: - `provideBufLen` is an integer. - `wantlist` (array of [CID][cid]s) -- `peers` (array of peer IDs represented by strings) +- `peers` (array of [PeerId][peerId]s) - `blocksReceived` is a [BigInt][1] - `dataReceived` is a [BigInt][1] - `blocksSent` is a [BigInt][1] @@ -192,6 +192,6 @@ A great source of [examples][] can be found in the tests for this API. [1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/bitswap -[cid]: https://www.npmjs.com/package/cids -[peerid]: https://www.npmjs.com/package/peer-id +[cid]: https://docs.ipfs.io/concepts/content-addressing +[peerid]: https://docs.libp2p.io/concepts/peer-id/ [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/BLOCK.md b/docs/core-api/BLOCK.md index e0f54f1e85..d325971b8e 100644 --- a/docs/core-api/BLOCK.md +++ b/docs/core-api/BLOCK.md @@ -39,18 +39,19 @@ An optional object which may have the following keys: | ---- | ---- | ------- | ----------- | | timeout | `Number` | `undefined` | A timeout in ms | | signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | +| preload | `boolean` | `false` | Whether to preload all blocks created during this operation | ### Returns | Type | Description | | -------- | -------- | -| `Promise` | A [Block][block] type object, containing both the data and the hash of the block | +| `Promise` | A Uint8Array containing the data of the block | ### Example ```JavaScript const block = await ipfs.block.get(cid) -console.log(block.data) +console.log(block) ``` A great source of [examples][] can be found in the tests for this API. @@ -63,7 +64,7 @@ A great source of [examples][] can be found in the tests for this API. | Name | Type | Description | | ---- | ---- | ----------- | -| block | A `Uint8Array` or [Block][] instance | The block or data to store | +| block | `Uint8Array` | The block of data to store | ### Options @@ -71,22 +72,20 @@ An optional object which may have the following keys: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| cid | [CID][] | `undefined` | A CID to store the block under | | format | `String` | `'dag-pb'` | The codec to use to create the CID | | mhtype | `String` | `sha2-256` | The hashing algorithm to use to create the CID | -| mhlen | `Number` | | | +| mhlen | `Number` | `undefined` | The hash length (only relevant for `go-ipfs`) | | version | `Number` | `0` | The version to use to create the CID | | pin | `boolean` | `false` | If true, pin added blocks recursively | | timeout | `Number` | `undefined` | A timeout in ms | | signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | - -**Note:** If you pass a [`Block`][block] instance as the block parameter, you don't need to pass options, as the block instance will carry the CID value as a property. +| preload | `boolean` | `false` | Whether to preload all blocks created during this operation | ### Returns | Type | Description | | -------- | -------- | -| `Promise` | A [Block][block] type object, containing both the data and the hash of the block | +| `Promise` | A [CID][CID] type object containing the hash of the block | ### Example @@ -97,20 +96,6 @@ const decoder = new TextDecoder() const block = await ipfs.block.put(buf) -console.log(decoder.decode(block.data)) -// Logs: -// a serialized object -console.log(block.cid.toString()) -// Logs: -// the CID of the object - -// With custom format and hashtype through CID -const CID = require('cids') -const buf = new TextEncoder().encode('another serialized object') -const cid = new CID(1, 'dag-pb', multihash) - -const block = await ipfs.block.put(blob, cid) - console.log(decoder.decode(block.data)) // Logs: // a serialized object @@ -191,6 +176,7 @@ An optional object which may have the following keys: | ---- | ---- | ------- | ----------- | | timeout | `Number` | `undefined` | A timeout in ms | | signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | +| preload | `boolean` | `false` | Whether to preload all blocks created during this operation | ### Returns @@ -211,7 +197,7 @@ the returned object has the following keys: ```JavaScript const multihashStr = 'QmQULBtTjNcMwMr4VMNknnVv3RpytrLSdgpvMcTnfNhrBJ' -const cid = new CID(multihashStr) +const cid = CID.parse(multihashStr) const stats = await ipfs.block.stat(cid) console.log(stats.cid.toString()) @@ -226,4 +212,4 @@ A great source of [examples][] can be found in the tests for this API. [multihash]: https://github.com/multiformats/multihash [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/block [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing diff --git a/docs/core-api/DAG.md b/docs/core-api/DAG.md index 33d59f79e8..92dc51220e 100644 --- a/docs/core-api/DAG.md +++ b/docs/core-api/DAG.md @@ -2,31 +2,76 @@ > The dag API comes to replace the `object API`, it supports the creation and manipulation of dag-pb object, as well as other IPLD formats (i.e dag-cbor, ethereum-block, git, etc) -- [`ipfs.dag.put(dagNode, [options])`](#ipfsdagputdagnode-options) +- [`ipfs.dag.export(cid, [options])`](#ipfsdagexportcid-options) - [Parameters](#parameters) - [Options](#options) - [Returns](#returns) - [Example](#example) -- [`ipfs.dag.get(cid, [options])`](#ipfsdaggetcid-options) +- [`ipfs.dag.put(dagNode, [options])`](#ipfsdagputdagnode-options) - [Parameters](#parameters-1) - [Options](#options-1) - [Returns](#returns-1) - [Example](#example-1) -- [`ipfs.dag.tree(cid, [options])`](#ipfsdagtreecid-options) +- [`ipfs.dag.get(cid, [options])`](#ipfsdaggetcid-options) - [Parameters](#parameters-2) - [Options](#options-2) - [Returns](#returns-2) - [Example](#example-2) -- [`ipfs.dag.resolve(ipfsPath, [options])`](#ipfsdagresolveipfspath-options) +- [`ipfs.dag.import(source, [options])`](#ipfsdagimportsource-options) - [Parameters](#parameters-3) - [Options](#options-3) - [Returns](#returns-3) - [Example](#example-3) +- [`ipfs.dag.resolve(ipfsPath, [options])`](#ipfsdagresolveipfspath-options) + - [Parameters](#parameters-4) + - [Options](#options-4) + - [Returns](#returns-4) + - [Example](#example-4) _Explore the DAG API through interactive coding challenges in our ProtoSchool tutorials:_ - _[P2P data links with content addressing](https://proto.school/#/basics/) (beginner)_ - _[Blogging on the Decentralized Web](https://proto.school/#/blog/) (intermediate)_ +## `ipfs.dag.export(cid, [options])` + +> Returns a stream of Uint8Arrays that make up a [CAR file][] + +Exports a CAR for the entire DAG available from the given root CID. The CAR will have a single +root and IPFS will attempt to fetch and bundle all blocks that are linked within the connected +DAG. + +### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| cid | [CID][] | The root CID of the DAG we wish to export | + +### Options + +An optional object which may have the following keys: + +| Name | Type | Default | Description | +| ---- | ---- | ------- | ----------- | +| timeout | `Number` | `undefined` | A timeout in ms | +| signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | + +### Returns + +| Type | Description | +| -------- | -------- | +| `AsyncIterable` | A stream containing the car file bytes | + +### Example + +```JavaScript +import { Readable } from 'stream' + +const out = await ipfs.dag.export(cid) + +Readable.from(out).pipe(fs.createWriteStream('example.car')) +``` + +A great source of [examples][] can be found in the tests for this API. ## `ipfs.dag.put(dagNode, [options])` > Store an IPLD format node @@ -43,12 +88,13 @@ An optional object which may have the following keys: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| format | `String` | `'dag-cbor'` | The IPLD format multicodec | +| storeCodec | `String` | `'dag-cbor'` | The codec that the stored object will be encoded with | +| inputCodec | `String` | `undefined` | If an already encoded object is provided (as a `Uint8Array`), the codec that the object is encoded with, otherwise it is assumed the `dagNode` argument is an object to be encoded | | hashAlg | `String` | `'sha2-256'` | The hash algorithm to be used over the serialized DAG node | | cid | [CID][] | `'dag-cbor'` | The IPLD format multicodec | | pin | `boolean` | `false` | Pin this node when adding to the blockstore | | timeout | `Number` | `undefined` | A timeout in ms | -| signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | +| signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | **Note**: You should pass `cid` or the `format` & `hashAlg` pair but _not both_. @@ -62,7 +108,7 @@ An optional object which may have the following keys: ```JavaScript const obj = { simple: 'object' } -const cid = await ipfs.dag.put(obj, { format: 'dag-cbor', hashAlg: 'sha3-512' }) +const cid = await ipfs.dag.put(obj, { storeCodec: 'dag-cbor', hashAlg: 'sha2-512' }) console.log(cid.toString()) // zBwWX9ecx5F4X54WAjmFLErnBT6ByfNxStr5ovowTL7AhaUR98RWvXPS1V3HqV1qs3r5Ec5ocv7eCdbqYQREXNUfYNuKG @@ -115,7 +161,7 @@ const obj = { } } -const cid = await ipfs.dag.put(obj, { format: 'dag-cbor', hashAlg: 'sha2-256' }) +const cid = await ipfs.dag.put(obj, { storeCodec: 'dag-cbor', hashAlg: 'sha2-256' }) console.log(cid.toString()) // zdpuAmtur968yprkhG9N5Zxn6MFVoqAWBbhUAkNLJs2UtkTq5 @@ -146,15 +192,18 @@ await getAndLog(cid, '/c/ca/1') A great source of [examples][] can be found in the tests for this API. -## `ipfs.dag.tree(cid, [options])` +## `ipfs.dag.import(source, [options])` -> Enumerate all the entries in a graph +> Adds one or more [CAR file][]s full of blocks to the repo for this node + +Import all blocks from one or more CARs and optionally recursively pin the roots identified +within the CARs. ### Parameters | Name | Type | Description | | ---- | ---- | ----------- | -| cid | [CID][] | A DAG node that follows one of the supported IPLD formats | +| sources | `AsyncIterable` | One or more [CAR file][] streams | ### Options @@ -162,8 +211,7 @@ An optional object which may have the following keys: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| path | `String` | An optional path within the DAG to resolve | -| recursive | `boolean` | `false` | If set to true, it will follow the links and continuously run tree on them, returning all the paths in the graph | +| pinRoots | `boolean` | `true` | Whether to recursively pin each root to the blockstore | | timeout | `Number` | `undefined` | A timeout in ms | | signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | @@ -171,39 +219,17 @@ An optional object which may have the following keys: | Type | Description | | -------- | -------- | -| `Promise` | An array with the paths passed | +| `AsyncIterable<{ root: { cid: CID, pinErrorMsg?: string } }>` | A stream containing all roots from the car file(s) that are pinned | ### Example ```JavaScript -// example obj -const obj = { - a: 1, - b: [1, 2, 3], - c: { - ca: [5, 6, 7], - cb: 'foo' - } -} +import fs from 'fs' -const cid = await ipfs.dag.put(obj, { format: 'dag-cbor', hashAlg: 'sha2-256' }) -console.log(cid.toString()) -// zdpuAmtur968yprkhG9N5Zxn6MFVoqAWBbhUAkNLJs2UtkTq5 - -const result = await ipfs.dag.tree('zdpuAmtur968yprkhG9N5Zxn6MFVoqAWBbhUAkNLJs2UtkTq5') -console.log(result) -// Logs: -// a -// b -// b/0 -// b/1 -// b/2 -// c -// c/ca -// c/ca/0 -// c/ca/1 -// c/ca/2 -// c/cb +for await (const result of ipfs.dag.import(fs.createReadStream('./path/to/archive.car'))) { + console.info(result) + // Qmfoo +} ``` A great source of [examples][] can be found in the tests for this API. @@ -247,7 +273,7 @@ const obj = { } } -const cid = await ipfs.dag.put(obj, { format: 'dag-cbor', hashAlg: 'sha2-256' }) +const cid = await ipfs.dag.put(obj, { storeCodec: 'dag-cbor', hashAlg: 'sha2-256' }) console.log(cid.toString()) // bafyreicyer3d34cutdzlsbe2nqu5ye62mesuhwkcnl2ypdwpccrsecfmjq @@ -262,7 +288,7 @@ console.log(result) A great source of [examples][] can be found in the tests for this API. - [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/dag -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal +[CAR file]: https://ipld.io/specs/transport/car/ diff --git a/docs/core-api/DHT.md b/docs/core-api/DHT.md index e27c88d6e5..964bb20eed 100644 --- a/docs/core-api/DHT.md +++ b/docs/core-api/DHT.md @@ -39,7 +39,7 @@ | Name | Type | Description | | ---- | ---- | ----------- | -| peerId | [PeerID][] or [CID][] | The Peer ID of the node to find | +| peerId | [PeerID][] | The Peer ID of the node to find | ### Options @@ -61,7 +61,7 @@ An optional object which may have the following keys: ```JavaScript const info = await ipfs.dht.findPeer('QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt') -console.log(info.id) +console.log(info.id.toString()) /* QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt */ @@ -109,7 +109,9 @@ Note that if `options.numProviders` are not found an error will be thrown. ### Example ```JavaScript -const providers = ipfs.dht.findProvs('QmdPAhQRxrDKqkGPvQzBvjYe3kU8kiEEAd2J6ETEamKAD9') +import { CID } from 'multiformats/cid' + +const providers = ipfs.dht.findProvs(CID.parse('QmdPAhQRxrDKqkGPvQzBvjYe3kU8kiEEAd2J6ETEamKAD9')) for await (const provider of providers) { console.log(provider.id.toString()) @@ -191,7 +193,7 @@ Prints objects like: { extra: 'dial backoff', - id: 'QmWtewmnzJiQevJPSmG9s8aC7yRfK2WXTCdRc1pCbDFu6z', + id: PeerId('QmWtewmnzJiQevJPSmG9s8aC7yRfK2WXTCdRc1pCbDFu6z'), responses: [ { addrs: [ @@ -199,7 +201,7 @@ Prints objects like: Multiaddr(/ip4/172.20.0.3/tcp/4001), Multiaddr(/ip4/35.178.190.196/tcp/1024) ], - id: 'QmRz5Nth4jTFuJJKcjyb6uwvrhxWbruRvamKY2PJxwJKw8' + id: PeerId('QmRz5Nth4jTFuJJKcjyb6uwvrhxWbruRvamKY2PJxwJKw8') } ], type: 1 @@ -210,11 +212,11 @@ https://github.com/libp2p/go-libp2p-core/blob/6e566d10f4a5447317a66d64c7459954b9 */ ``` -Alternatively you can simply "consume" the iterable: +Alternatively you can simply "drain" the iterable: ```js -const { consume } = require('streaming-iterables') -await consume(ipfs.dht.provide('QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR')) +import drain from 'it-drain' +await drain(ipfs.dht.provide('QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR')) ``` A great source of [examples][] can be found in the tests for this API. @@ -258,7 +260,7 @@ Prints objects like: { extra: 'dial backoff', - id: 'QmWtewmnzJiQevJPSmG9s8aC7yRfK2WXTCdRc1pCbDFu6z', + id: PeerId('QmWtewmnzJiQevJPSmG9s8aC7yRfK2WXTCdRc1pCbDFu6z'), responses: [ { addrs: [ @@ -266,7 +268,7 @@ Prints objects like: Multiaddr(/ip4/172.20.0.3/tcp/4001), Multiaddr(/ip4/35.178.190.196/tcp/1024) ], - id: 'QmRz5Nth4jTFuJJKcjyb6uwvrhxWbruRvamKY2PJxwJKw8' + id: PeerId('QmRz5Nth4jTFuJJKcjyb6uwvrhxWbruRvamKY2PJxwJKw8') } ], type: 1 @@ -277,18 +279,18 @@ https://github.com/libp2p/go-libp2p-core/blob/6e566d10f4a5447317a66d64c7459954b9 */ ``` -Alternatively you can simply "consume" the iterable: +Alternatively you can simply "drain" the iterable: ```js -const { consume } = require('streaming-iterables') -await consume(ipfs.dht.put(key, value)) +import drain from 'it-drain' +await drain(ipfs.dht.put(key, value)) ``` A great source of [examples][] can be found in the tests for this API. ## `ipfs.dht.query(peerId, [options])` -> Find the closest Peer IDs to a given Peer ID by querying the DHT. +> Find the closest Peer IDs to a given Peer ID or CID by querying the DHT. ### Parameters @@ -331,7 +333,7 @@ Prints objects like: Multiaddr(/ip4/172.20.0.3/tcp/4001), Multiaddr(/ip4/35.178.190.196/tcp/1024) ], - id: 'QmRz5Nth4jTFuJJKcjyb6uwvrhxWbruRvamKY2PJxwJKw8' + id: PeerId('QmRz5Nth4jTFuJJKcjyb6uwvrhxWbruRvamKY2PJxwJKw8') } ], type: 1 @@ -345,6 +347,6 @@ https://github.com/libp2p/go-libp2p-core/blob/6e566d10f4a5447317a66d64c7459954b9 A great source of [examples][] can be found in the tests for this API. [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/dht -[peerid]: https://www.npmjs.com/package/peer-id -[cid]: https://www.npmjs.com/package/cids +[peerid]: https://docs.libp2p.io/concepts/peer-id/ +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/FILES.md b/docs/core-api/FILES.md index 2c6ad68622..9828c324f3 100644 --- a/docs/core-api/FILES.md +++ b/docs/core-api/FILES.md @@ -204,7 +204,7 @@ const file = { content: 'ABC' } -const result = await ipfs.add(content) +const result = await ipfs.add(file) console.info(result) @@ -334,10 +334,9 @@ See the [multihash](https://github.com/multiformats/js-multihash/blob/master/src Both js-ipfs and js-ipfs-http-client export a utility to make importing files from the file system easier (Note: it not available in the browser). ```js -const IPFS = require('ipfs') -const { globSource } = IPFS +import { create, globSource } from 'ipfs' -const ipfs = await IPFS.create() +const ipfs = await create() //options specific to globSource const globSourceOptions = { @@ -375,10 +374,9 @@ for await (const file of ipfs.addAll(globSource('./docs', globSourceOptions), ad Both js-ipfs and js-ipfs-http-client export a utility to make importing a file from a URL easier. ```js -const IPFS = require('ipfs') -const { urlSource } = IPFS +import { create, urlSource } from 'ipfs' -const ipfs = await IPFS.create() +const ipfs = await create() const file = await ipfs.add(urlSource('https://ipfs.io/images/ipfs-logo.svg')) console.log(file) @@ -447,6 +445,9 @@ An optional object which may have the following keys: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | +| archive | `boolean` | `undefined` | Return the file/directory in a tarball | +| compress | `boolean` | `false` | Gzip the returned stream | +| compressionLevel | `Number` | `undefined` | How much compression to apply (1-9) | | timeout | `Number` | `undefined` | A timeout in ms | | signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | @@ -454,46 +455,29 @@ An optional object which may have the following keys: | Type | Description | | -------- | -------- | -| `AsyncIterable` | An async iterable that yields objects representing the files | +| `AsyncIterable` | An async iterable that yields bytes | -Each yielded object is of the form: +What is streamed as a response depends on the options passed and what the `ipfsPath` resolves to. -```js -{ - type: string, // 'file' or 'dir' - path: string, // a deeply nested path within the directory structure - content?: >, // only present if `type` is 'file' - mode: Number, // implicit if not provided - 0644 for files, 0755 for directories - mtime?: { secs: Number, nsecs: Number } -} -``` - -Here, each `path` corresponds to the name of a file, and `content` is an async iterable with the file contents. +1. If `ipfsPath` resolves to a file: + * By default you will get a tarball containing the file + * Pass `compress: true` (and an optional `compressionLevel`) to instead get the gzipped file contents + * Pass `compress: true` (and an optional `compressionLevel`) AND `archive: true` to get a gzipped tarball containing the file +2. If `ipfsPath` resolves to a directory: + * By default you will get a tarball containing the contents of the directory + * Passing `compress: true` will cause an error + * Pass `compress: true` (and an optional `compressionLevel`) AND `archive: true` to get a gzipped tarball containing the contents of the directory #### Example ```JavaScript const cid = 'QmQ2r6iMNpky5f1m4cnm3Yqw8VSvjuKpTcK1X7dBR1LkJF' -for await (const file of ipfs.get(cid)) { - console.log(file.type, file.path) - - if (!file.content) continue; - - const content = [] - - for await (const chunk of file.content) { - content.push(chunk) - } - - console.log(content) +for await (const buf of ipfs.get(cid)) { + // do something with buf } ``` -When invoking this method via the HTTP API client, the response arrives as a stream containing either the entire contents of the file (if the passed [CID][] resolves to a file) or recursive directory tree and all files contained therein (if the passed [CID][] resolves to a directory). - -If you are iterating over a directory, in order to proceed to the next entry in the stream, you must consume the `content` field of the current entry if it is present. - A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/get.js) can be found in the tests for this API. ### `ipfs.ls(ipfsPath)` @@ -1040,7 +1024,7 @@ for await (const file of ipfs.files.ls('/screenshots')) { [b]: https://www.npmjs.com/package/buffer [file]: https://developer.mozilla.org/en-US/docs/Web/API/File -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [blob]: https://developer.mozilla.org/en-US/docs/Web/API/Blob [IPFS Path]: https://www.npmjs.com/package/is-ipfs#isipfspathpath [MFS Path]: https://docs.ipfs.io/guides/concepts/mfs/ diff --git a/docs/core-api/KEY.md b/docs/core-api/KEY.md index 6d2d5da60b..8a91e2fcaa 100644 --- a/docs/core-api/KEY.md +++ b/docs/core-api/KEY.md @@ -278,7 +278,7 @@ An optional object which may have the following keys: ### Example ```JavaScript -const key = await ipfs.key.import('clone', 'password') +const key = await ipfs.key.import('clone', pem, 'password') console.log(key) // { id: 'QmQRiays958UM7norGRQUG3tmrLq8pJdmJarwYSk2eLthQ', @@ -288,5 +288,5 @@ console.log(key) A great source of [examples][] can be found in the tests for this API. [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/key -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/MISCELLANEOUS.md b/docs/core-api/MISCELLANEOUS.md index 61b74fab61..93055266ad 100644 --- a/docs/core-api/MISCELLANEOUS.md +++ b/docs/core-api/MISCELLANEOUS.md @@ -300,5 +300,5 @@ A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/package [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous [rs]: https://www.npmjs.com/package/readable-stream [ps]: https://www.npmjs.com/package/pull-stream -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/NAME.md b/docs/core-api/NAME.md index 5069d45f24..e7126b15e2 100644 --- a/docs/core-api/NAME.md +++ b/docs/core-api/NAME.md @@ -226,7 +226,7 @@ A great source of [examples][examples-pubsub] can be found in the tests for this | Name | Type | Description | | ---- | ---- | ----------- | -| value | `String` | An IPNS address such as `/ipns/ipfs.io` | +| value | `PeerId` or `string` | An IPNS address such as `/ipns/ipfs.io` | ### Options @@ -261,5 +261,5 @@ A great source of [examples][] can be found in the tests for this API. [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/name [examples-pubsub]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/name-pubsub -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/OBJECT.md b/docs/core-api/OBJECT.md index 9382abcb33..bc48225f91 100644 --- a/docs/core-api/OBJECT.md +++ b/docs/core-api/OBJECT.md @@ -1,5 +1,7 @@ # Object API +> ⚠️ Object API is [deprecated](https://github.com/ipfs/go-ipfs/issues/7936), use [FILES](FILES.md) and [DAG](DAG.md) APIs instead. + - [`ipfs.object.new([options])`](#ipfsobjectnewoptions) - [Parameters](#parameters) - [Options](#options) @@ -343,7 +345,7 @@ An optional object which may have the following keys: const cid = await ipfs.object.patch.addLink(node, { name: 'some-link', size: 10, - cid: new CID('QmPTkMuuL6PD8L2SwTwbcs1NPg14U8mRzerB1ZrrBrkSDD') + cid: CID.parse('QmPTkMuuL6PD8L2SwTwbcs1NPg14U8mRzerB1ZrrBrkSDD') }) ``` @@ -357,7 +359,7 @@ The `DAGLink` to be added can also be passed as an object containing: `name`, `c const link = { name: 'Qmef7ScwzJUCg1zUSrCmPAz45m8uP5jU7SLgt2EffjBmbL', size: 37, - cid: new CID('Qmef7ScwzJUCg1zUSrCmPAz45m8uP5jU7SLgt2EffjBmbL') + cid: CID.parse('Qmef7ScwzJUCg1zUSrCmPAz45m8uP5jU7SLgt2EffjBmbL') }; ``` @@ -398,9 +400,9 @@ An optional object which may have the following keys: ```JavaScript // cid is CID of the DAG node created by removing a link const cid = await ipfs.object.patch.rmLink(node, { - name: 'some-link', - size: 10, - cid: new CID('QmPTkMuuL6PD8L2SwTwbcs1NPg14U8mRzerB1ZrrBrkSDD') + Name: 'some-link', + Tsize: 10, + Hash: CID.parse('QmPTkMuuL6PD8L2SwTwbcs1NPg14U8mRzerB1ZrrBrkSDD') }) ``` diff --git a/docs/core-api/PIN.md b/docs/core-api/PIN.md index 54a25e3df4..7c6723d24e 100644 --- a/docs/core-api/PIN.md +++ b/docs/core-api/PIN.md @@ -81,12 +81,12 @@ An optional object which may have the following keys: | Type | Description | | -------- | -------- | -| [CID][] | The CIDs that was pinned | +| [CID][] | The CID that was pinned | ### Example ```JavaScript -const cid of ipfs.pin.add(new CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')) +const cid of ipfs.pin.add(CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')) console.log(cid) // Logs: // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u') @@ -130,7 +130,7 @@ Each yielded object has the form: ### Example ```JavaScript -for await (const cid of ipfs.pin.addAll(new CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u'))) { +for await (const cid of ipfs.pin.addAll(CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u'))) { console.log(cid) } // Logs: @@ -178,7 +178,7 @@ for await (const { cid, type } of ipfs.pin.ls()) { ```JavaScript for await (const { cid, type } of ipfs.pin.ls({ - paths: [ new CID('Qmc5..'), new CID('QmZb..'), new CID('QmSo..') ] + paths: [ CID.parse('Qmc5..'), CID.parse('QmZb..'), CID.parse('QmSo..') ] })) { console.log({ cid, type }) } @@ -218,7 +218,7 @@ An optional object which may have the following keys: ### Example ```JavaScript -const cid of ipfs.pin.rm(new CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')) +const cid of ipfs.pin.rm(CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')) console.log(cid) // prints the CID that was unpinned // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u') @@ -254,7 +254,7 @@ An optional object which may have the following keys: ### Example ```JavaScript -for await (const cid of ipfs.pin.rmAll(new CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u'))) { +for await (const cid of ipfs.pin.rmAll(CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u'))) { console.log(cid) } // prints the CIDs that were unpinned @@ -295,13 +295,13 @@ An object may have the following optional fields: | Type | Description | | ---- | -------- | -| Promise | Resolves if added succesfully, or fails with error e.g. if service with such name is already registered | +| Promise | Resolves if added successfully, or fails with error e.g. if service with such name is already registered | ### Example ```JavaScript -await ipfs.pin.remote.sevice.add('pinata', { +await ipfs.pin.remote.service.add('pinata', { endpoint: new URL('https://api.pinata.cloud'), key: 'your-pinata-key' }) @@ -320,7 +320,7 @@ An object may have the following optional fields: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| stat | `boolean` | `false` | If `true` will include service stats. | +| stat | `boolean` | `false` | If `true` will include service stats. | | timeout | `number` | `undefined` | A timeout in ms | | signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call | @@ -349,7 +349,7 @@ If stats could not be fetched from service (e.g. endpoint was unreachable) objec | status | `'invalid'` | Service status | -If stats were fetched from service succesfully object has following form: +If stats were fetched from service successfully object has following form: | Name | Type | Description | | ---- | ---- | -------- | @@ -372,7 +372,7 @@ Object has following fields: ### Example ```JavaScript -await ipfs.pin.remote.sevice.ls() +await ipfs.pin.remote.service.ls() // [{ // service: 'pinata' // endpoint: new URL('https://api.pinata.cloud'), @@ -426,7 +426,7 @@ An object may have the following optional fields: ### Example ```JavaScript -await ipfs.pin.remote.sevice.rm('pinata') +await ipfs.pin.remote.service.rm('pinata') ``` A great source of [examples][] can be found in the tests for this API. @@ -486,7 +486,7 @@ Status is one of the following string values: ### Example ```JavaScript -const cid = new CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u') +const cid = CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u') const pin = await ipfs.pin.remote.add(cid, { service: 'pinata', name: 'block-party' @@ -529,21 +529,20 @@ An object may have the following optional fields: | Type | Description | | ---- | -------- | -| AyncIterable<[Pin][]> | Pin Objects | +| AysncIterable<[Pin][]> | Pin Objects | ### Example ```JavaScript -const pins = await ipfs.pin.remote.ls({ - service: 'pinata' -}) -console.log(pins) +for await (const pin of ipfs.pin.remote.ls({ service: 'pinata' })) { + console.log(pin) +} // Logs: -// [{ +// { // status: 'pinned', // cid: CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u'), // name: 'block-party' -// }] +// } ``` A great source of [examples][] can be found in the tests for this API. @@ -635,5 +634,5 @@ A great source of [examples][] can be found in the tests for this API. [Stat]: #stat [PinCount]: #pincount [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/pin -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/PUBSUB.md b/docs/core-api/PUBSUB.md index 4778181e6b..3a9674fd0b 100644 --- a/docs/core-api/PUBSUB.md +++ b/docs/core-api/PUBSUB.md @@ -32,7 +32,7 @@ | Name | Type | Description | | ---- | ---- | ----------- | | topic | `String` | The topic name | -| handler | `Function<(msg) => {}>` | Event handler which will be called with a message object everytime one is received. The `msg` has the format `{from: String, seqno: Uint8Array, data: Uint8Array, topicIDs: Array}` | +| handler | `Function<(msg) => {}>` | Event handler which will be called with a message object everytime one is received. The `msg` has the format `{from: PeerId, sequenceNumber: bigint, data: Uint8Array, topicIDs: Array}` | ### Options @@ -53,7 +53,7 @@ An optional object which may have the following keys: ```JavaScript const topic = 'fruit-of-the-day' -const receiveMsg = (msg) => console.log(msg.data.toString()) +const receiveMsg = (msg) => console.log(new TextDecoder().decode(msg.data)) await ipfs.pubsub.subscribe(topic, receiveMsg) console.log(`subscribed to ${topic}`) @@ -203,4 +203,4 @@ console.log(peerIds) A great source of [examples][] can be found in the tests for this API. [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/pubsub -[AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal \ No newline at end of file +[AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/README.md b/docs/core-api/README.md index 0578a9eef7..6b058fb8c7 100644 --- a/docs/core-api/README.md +++ b/docs/core-api/README.md @@ -1,6 +1,11 @@ # IPFS Core API -This directory contains the description of the core IPFS API. In order to be considered "valid", an IPFS core implementation must expose the API described here. You can also use this loose spec as documentation for consuming the core APIs. +This directory contains the description of the core JS IPFS API. In order to be considered "valid", a JS IPFS core implementation must expose the API described here. +This abstraction allows for different implementations including: +1. Full JavaScript native implementation +2. Delgate implementation that invokes another IPFS implementation (e.g., Kubo) + +You can use this loose spec as documentation for consuming the core APIs. It is broken up into the following sections: @@ -14,10 +19,13 @@ It is broken up into the following sections: * [KEY.md](KEY.md) * [MISCELLANEOUS.md](MISCELLANEOUS.md) * [NAME.md](NAME.md) -* [OBJECT.md](OBJECT.md) +* [OBJECT.md](OBJECT.md) ([deprecated](https://github.com/ipfs/go-ipfs/issues/7936), use the [DAG API](DAG.md) instead) * [PIN.md](PIN.md) * [PUBSUB.md](PUBSUB.md) * [REFS.md](REFS.md) * [REPO.md](REPO.md) * [STATS.md](STATS.md) * [SWARM.md](SWARM.md) + +## History +This API was created based off the [Kubo RPC HTTP API](https://docs.ipfs.io/reference/kubo/rpc/). There is no guarantee they stay fully in sync. diff --git a/docs/core-api/REFS.md b/docs/core-api/REFS.md index 8a302fece3..5168998a96 100644 --- a/docs/core-api/REFS.md +++ b/docs/core-api/REFS.md @@ -112,6 +112,6 @@ for await (const ref of ipfs.refs.local()) { [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/files-regular [b]: https://www.npmjs.com/package/buffer -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [blob]: https://developer.mozilla.org/en-US/docs/Web/API/Blob [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/REPO.md b/docs/core-api/REPO.md index 834599a289..432ceae43b 100644 --- a/docs/core-api/REPO.md +++ b/docs/core-api/REPO.md @@ -136,5 +136,5 @@ console.log(version) ``` [1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt -[cid]: https://www.npmjs.com/package/cids +[cid]: https://docs.ipfs.io/concepts/content-addressing [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal diff --git a/docs/core-api/STATS.md b/docs/core-api/STATS.md index bc661c069b..da2de54e01 100644 --- a/docs/core-api/STATS.md +++ b/docs/core-api/STATS.md @@ -34,7 +34,7 @@ An optional object which may have the following keys: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| peer | [PeerId][], [CID][] or `String` | `undefined` | Specifies a peer to print bandwidth for | +| peer | [PeerId][] | `undefined` | Specifies a peer to print bandwidth for | | proto | `String` | `undefined` | Specifies a protocol to print bandwidth for | | poll | `boolean` | `undefined` | Is used to yield bandwidth info at an interval | | interval | `Number` | `undefined` | The time interval to wait between updating output, if `poll` is `true` | @@ -51,8 +51,8 @@ Each yielded object contains the following keys: - `totalIn` - is a [BigInt][bigNumber], in bytes. - `totalOut` - is a [BigInt][bigNumber], in bytes. -- `rateIn` - is a [BigInt][bigNumber], in bytes. -- `rateOut` - is a [BigInt][bigNumber], in bytes. +- `rateIn` - is a `float`, in bytes. +- `rateOut` - is a `float`, in bytes. ### Example @@ -62,8 +62,8 @@ for await (const stats of ipfs.stats.bw()) { } // { totalIn: BigInt {...}, // totalOut: BigInt {...}, -// rateIn: BigInt {...}, -// rateOut: BigInt {...} } +// rateIn: number {...}, +// rateOut: number {...} } ``` A great source of [examples][] can be found in the tests for this API. @@ -71,5 +71,5 @@ A great source of [examples][] can be found in the tests for this API. [bigNumber]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/stats [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal -[cid]: https://www.npmjs.com/package/cids -[peerid]: https://www.npmjs.com/package/peer-id +[cid]: https://docs.ipfs.io/concepts/content-addressing +[peerid]: https://docs.libp2p.io/concepts/peer-id/ diff --git a/docs/core-api/SWARM.md b/docs/core-api/SWARM.md index c9db832628..60c9b7b2f3 100644 --- a/docs/core-api/SWARM.md +++ b/docs/core-api/SWARM.md @@ -83,7 +83,7 @@ A great source of [examples][] can be found in the tests for this API. | Name | Type | Description | | ---- | ---- | ----------- | -| addr | [MultiAddr][] | The object to search for references | +| addr | [MultiAddr][] or [PeerId][] | The PeerId or Multiaddr to connect to | ### Options @@ -116,7 +116,7 @@ A great source of [examples][] can be found in the tests for this API. | Name | Type | Description | | ---- | ---- | ----------- | -| addr | [MultiAddr][] | The object to search for references | +| addr | [MultiAddr][] or [PeerId][] | The PeerId or Multiaddr to disconnect from | ### Options @@ -228,3 +228,4 @@ A great source of [examples][] can be found in the tests for this API. [examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/swarm [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal [MultiAddr]: https://github.com/multiformats/js-multiaddr +[peerid]: https://docs.libp2p.io/concepts/peer-id/ diff --git a/docs/upgrading/v0.62-v0.63.md b/docs/upgrading/v0.62-v0.63.md new file mode 100644 index 0000000000..ed3dcb1c8e --- /dev/null +++ b/docs/upgrading/v0.62-v0.63.md @@ -0,0 +1,167 @@ + +# Migrating to ipfs@0.63 and ipfs-core@0.15 + +> A migration guide for refactoring your application code from `ipfs@0.62.x` to `ipfs@0.63.x` + +## Table of Contents + +- [ESM](#esm) + - [TypeScript and ESM](#typescript-and-esm) +- [`libp2p@0.37.x`](#libp2p037x) +- [PeerIds](#peerids) +- [multiaddrs](#multiaddrs) + +## ESM + +The biggest change to `ipfs@0.63.x` is that the module is now [ESM-only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). + +ESM is the module system for JavaScript. It allows us to structure our code in separate files without polluting a global namespace. + +Other systems have tried to fill this gap, notably CommonJS, AMD, RequireJS and others, but ESM is [the official standard format](https://tc39.es/ecma262/#sec-modules) to package JavaScript code for reuse. + +If you see errors similar to `Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: No "exports" main defined in node_modules/ipfs/package.json` you are likely trying to load ESM code from a CJS environment via `require`. This is not possible, instead it must be loaded using `import`. + +If your application is not yet ESM or you are not ready to port it to ESM, you can use the [dynamic `import` function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) to load `ipfs` at runtime from a CJS module: + +```js +async function loadIpfs () { + const { create } = await import('ipfs-core') + + const node = await create({ + // ... config here + }) + + return node +} +``` + +### TypeScript and ESM + +When authoring typescript it can often look like you are writing ESM: + +```ts +import { create } from 'ipfs-core' + +create() +``` + +When this is transpiled to JavaScript the default settings will emit CJS which will fail at runtime: + +```js +"use strict"; +exports.__esModule = true; +var ipfs_core_1 = require("ipfs-core"); +(0, ipfs_core_1.create)(); +``` + +You may also see errors about private identifiers: + +```console +node_modules/@libp2p/interfaces/dist/src/events.d.ts:19:5 - error TS18028: Private identifiers are only available when targeting ECMAScript 2015 and higher. + +19 #private; + ~~~~~~~~ +``` + +To build correctly with ESM as a target, update your `tsconfig.json` to include the following: + +```js +{ + "module": "es2020", // ensures output is ESM + "target": "es2020", // support modern features like private identifiers + // other settings +} +``` + +They must both be set to `es2020` at least, more recent versions will also work. + +If in doubt, examine the JavaScript files `tsc` emits and ensure that any `ipfs` modules are being loaded with `import` and not `require`. + +## `libp2p@0.37.x` + +`ipfs@0.63.x` upgrades to `libp2p@0.37.x`. This is a significant refactor that ports the entire stack to TypeScript and publishes all modules as ESM-only code. + +Please see the [libp2p 0.37.x upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.36-v0.37.md) for how this may affect your application. + +## PeerIds + +The core `libp2p` module and all supporting modules have now been ported to TypeScript in a complete ground-up rewrite. We took this opportunity to solve a few long-standing problems with some of the data types, particularly in how they relate to use in the browser. + +One problem we have solved is that the `PeerId` objects used internally expose some cryptographic operations that require heavyweight libraries to be included in browser bundles due to there being no native web-crypto implementation of the algorithms used in those operations. + +With `libp2p@0.37.x` those operations have been encapsulated in the `@libp2p/crypto` module which means `PeerId` objects become a lot more lightweight and can now be exposed/accepted as core-api types so we can use them to differentiate between different data types instead of having to treat everything as strings. + +The affected methods are: + +```js +// `peerId` must now be a `PeerId`, previously it was a `string` +ipfs.bitswap.wantlistForPeer(peerId, options) + +// Bitswp peers are now returned as `PeerId[]` instead of `string[]` +ipfs.bitswap.stat(options) + +// `peerId` must now be a `PeerId` +ipfs.dht.findPeer(peerId, options) + +// `peerIdOrCid` must now be a `PeerId` or a `CID`, previously it was a `string` or a `CID` +ipfs.dht.query(peerIdOrCid, options) + +// the following DHT events have their `from` field as `PeerId`, previously it was a `string` +PeerResponseEvent +ValueEvent +DialingPeerEvent + +// the following DHT events have had their `from` property removed because it is not exposed by go-ipfs so causes incompatibilities +QueryErrorEvent +FinalPeerEvent + +// the folloing DHT events have had their `to` property removed because it is not exposed by go-ipfs so causes incompatibilities +SendingQueryEvent + +// the `providers` and `closer` properties (where applicable) of the following events have the `peerId` property specified as a `PeerId`, previously it was a `string` +PeerResponseEvent +PeerResponseEvent + +// `value` can now be a string or a `PeerId`. If a string is passed it will be interpreted as a DNS address. +ipfs.name.resolve(value, options) + +// The return type of this method is now `Promise`, previously it was a `Promise` +ipfs.pubsub.peers(topic, options) + +// `peerId` must now be a `PeerId`, previously it was a `string` +ipfs.ping(peerId, options) + +// the `peer` property of `options` must now be a `PeerId` when specified, previously it was a `string` +ipfs.stats.bw(options) + +// `multiaddrOrPeerId` must be a `Multiaddr` or `PeerId`, previously it was a `Multiaddr` or `string` +ipfs.swarm.connect(multiaddrOrPeerId, options) + +// `multiaddrOrPeerId` must be a `Multiaddr` or `PeerId`, previously it was a `Multiaddr` or `string` +ipfs.swarm.disconnect(multiaddrOrPeerId, options) +``` + +`PeerId`s can be created from strings using the `@libp2p/peer-id` module: + +```js +import { peerIdFromString } from '@libp2p/peer-id' + +const peerId = peerIdFromString('Qmfoo') +``` + +They can also be created using the `@libp2p/peer-id-factory` module: + +```js +import { createEd25519PeerId } from '@libp2p/peer-id-factory' + +const peerId = await createEd25519PeerId() +``` + +## multiaddrs + +The `multiaddr` module has been ported to TypeScript and is now published as ESM-only. + +It has been renamed to `@multiformats/multiaddr` so please update your dependencies and replace usage in your code. + +The API otherwise is compatible. + diff --git a/docs/upgrading/v0.63-v0.64.md b/docs/upgrading/v0.63-v0.64.md new file mode 100644 index 0000000000..cc685da864 --- /dev/null +++ b/docs/upgrading/v0.63-v0.64.md @@ -0,0 +1,16 @@ + +# Migrating to ipfs@0.64 and ipfs-core@0.16 + +> A migration guide for refactoring your application code from `ipfs@0.63.x` to `ipfs@0.64.x` + +## Table of Contents + +- [libp2p](#libp2p) + +## libp2p + +The upgrade to `ipfs@0.64.x` incorporates an update to `libp2p@0.38.x` but no API changes. + +If your application uses only the default libp2p config there is nothing to do. + +If you supply a custom `libp2p` instance to the `ipfs` factory function you should consult the [`libp2p@0.38.x` upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.37-v0.38.md) for any changes you need to make. diff --git a/docs/upgrading/v0.64-v0.65.md b/docs/upgrading/v0.64-v0.65.md new file mode 100644 index 0000000000..b765f0c91b --- /dev/null +++ b/docs/upgrading/v0.64-v0.65.md @@ -0,0 +1,23 @@ + +# Migrating to ipfs@0.65 and ipfs-core@0.17 + +> A migration guide for refactoring your application code from `ipfs@0.64.x` to `ipfs@0.65.x` + +## Table of Contents + +- [libp2p](#libp2p) +- [multiformats](#multiformats) + +## libp2p + +The upgrade to `ipfs@0.65.x` incorporates an update to `libp2p@0.40.x` but no API changes. + +If your application uses only the default libp2p config there is nothing to do. + +If you supply a custom `libp2p` instance to the `ipfs` factory function you should consult the [`libp2p@0.40.x` upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.39-v0.40.md) for any changes you need to make. + +## multiformats + +`ipfs@0.65.x` now uses `multiformats@10.x.x`, this means instances of the `CID` class now come from that module and not `multiformats@9.x.x` so any `instanceof` checks your codebase has may break if instances are compare to the class loaded from a different module version. + +If your project also has a dependency on the `multiformats` module, it should be updated to `10.x.x` in line with js-ipfs. diff --git a/examples/browser-add-readable-stream/CHANGELOG.md b/examples/browser-add-readable-stream/CHANGELOG.md deleted file mode 100644 index f8fa48ba6d..0000000000 --- a/examples/browser-add-readable-stream/CHANGELOG.md +++ /dev/null @@ -1,34 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. -See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. - -## [2.0.1](https://github.com/ipfs/js-ipfs/compare/example-browser-add-readable-stream@2.0.0...example-browser-add-readable-stream@2.0.1) (2020-04-08) - -**Note:** Version bump only for package example-browser-add-readable-stream - - - - - -# 2.0.0 (2020-03-31) - - -### Bug Fixes - -* examples after files API refactor ([#1740](https://github.com/ipfs/js-ipfs/issues/1740)) ([34ec036](https://github.com/ipfs/js-ipfs/commit/34ec036b0df9563a014c1348f0a056c1f98aadad)) - - -### Code Refactoring - -* export types and utilities statically ([#1908](https://github.com/ipfs/js-ipfs/issues/1908)) ([79d7fef](https://github.com/ipfs/js-ipfs/commit/79d7fef7d28c0e0405fb69af149ff09681ac4273)) - - -### BREAKING CHANGES - -* `ipfs.util.isIPFS` and `ipfs.util.crypto` have moved to static exports and should be accessed via `const { isIPFS, crypto } = require('ipfs')`. - -The modules available under `ipfs.types.*` have also become static exports. - -License: MIT -Signed-off-by: Alan Shaw diff --git a/examples/browser-add-readable-stream/README.md b/examples/browser-add-readable-stream/README.md deleted file mode 100644 index d2293d1bf7..0000000000 --- a/examples/browser-add-readable-stream/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Using duplex streams to add files to IPFS in the browser - -If you have a number of files that you'd like to add to IPFS and end up with a hash representing the directory containing your files, you can invoke [`ipfs.add`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#add) with an array of objects. - -But what if you don't know how many there will be in advance? You can add multiple files to a directory in IPFS over time by using [`ipfs.addReadableStream`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#addreadablestream). - -## Before you start - -First clone this repo, install dependencies in the project root and build the project. - -```console -$ git clone https://github.com/ipfs/js-ipfs.git -$ cd js-ipfs -$ npm install -$ npm run build -``` - -## Running the example - -See [`index.js`](./index.js) for a working example and open [`index.html`](./index.html) in your browser to see it run. diff --git a/examples/browser-add-readable-stream/index.html b/examples/browser-add-readable-stream/index.html deleted file mode 100644 index 3b5d853e6d..0000000000 --- a/examples/browser-add-readable-stream/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - Add readable stream - - - 

-    
-    
-  
-
diff --git a/examples/browser-add-readable-stream/index.js b/examples/browser-add-readable-stream/index.js
deleted file mode 100644
index 4c870f2193..0000000000
--- a/examples/browser-add-readable-stream/index.js
+++ /dev/null
@@ -1,69 +0,0 @@
-'use strict'
-
-/* global Ipfs */
-/* eslint-env browser */
-
-const main = async () => {
-  const repoPath = `ipfs-${Math.random()}`
-  const ipfs = await Ipfs.create({ repo: repoPath })
-
-  const directoryName = 'directory'
-
-  // Our list of files
-  const inputFiles = createFiles(directoryName)
-
-  const directoryHash = await streamFiles(ipfs, directoryName, inputFiles)
-
-  const fileList = await ipfs.ls(directoryHash)
-
-  log(`\n--\n\nDirectory contents:\n\n${directoryName}/ ${directoryHash}`)
-
-  fileList.forEach((file, index) => {
-    log(` ${index < fileList.length - 1 ? '\u251C' : '\u2514'}\u2500 ${file.name} ${file.path} ${file.hash}`)
-  })
-}
-
-const createFiles = (directory) => {
-  return [{
-    path: `${directory}/file1.txt`,
-
-    // content could be a stream, a url, a Uint8Array, a File etc
-    content: 'one'
-  }, {
-    path: `${directory}/file2.txt`,
-    content: 'two'
-  }, {
-    path: `${directory}/file3.txt`,
-    content: 'three'
-  }]
-}
-
-const streamFiles = async (ipfs, directory, files) => {
-  // Create a stream to write files to
-  const stream = new ReadableStream({
-    start(controller) {
-      for (let i = 0; i < files.length; i++) {
-        // Add the files one by one
-        controller.enqueue(files[i])
-      }
-
-      // When we have no more files to add, close the stream
-      controller.close()
-    }
-  })
-
-  const data = await ipfs.add(stream)
-
-  log(`Added ${data.path} hash: ${data.hash}`)
-
-  // The last data event will contain the directory hash
-  if (data.path === directory) {
-    return data.cid
-  }
-}
-
-const log = (line) => {
-  document.getElementById('output').appendChild(document.createTextNode(`${line}\r\n`))
-}
-
-main()
diff --git a/examples/browser-add-readable-stream/package.json b/examples/browser-add-readable-stream/package.json
deleted file mode 100644
index dc130f6773..0000000000
--- a/examples/browser-add-readable-stream/package.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
-  "name": "example-browser-add-readable-stream",
-  "description": "How to add readable streams in the browser",
-  "version": "2.0.1",
-  "main": "index.js",
-  "private": true,
-  "scripts": {
-    "serve": "http-server public -a 127.0.0.1 -p 8888",
-    "start": "npm run serve",
-    "test": "test-ipfs-example"
-  },
-  "keywords": [],
-  "license": "MIT",
-  "devDependencies": {
-    "ipfs": "^0.55.3",
-    "test-ipfs-example": "^3.0.0"
-  }
-}
diff --git a/examples/browser-add-readable-stream/test.js b/examples/browser-add-readable-stream/test.js
deleted file mode 100644
index 87f76119ca..0000000000
--- a/examples/browser-add-readable-stream/test.js
+++ /dev/null
@@ -1,13 +0,0 @@
-'use strict'
-
-module.exports = {
-  'Add readable stream example': function (browser) {
-    browser
-      .url(process.env.IPFS_EXAMPLE_TEST_URL)
-      .waitForElementVisible('#output')
-
-    browser.expect.element('#output').text.to.contain('directory/ QmVgJePRxp1vhRxDcJWdmuFGfUB5S5RYTtG1NR3bQM4BBn')
-
-    browser.end()
-  }
-}
diff --git a/examples/browser-browserify/CHANGELOG.md b/examples/browser-browserify/CHANGELOG.md
deleted file mode 100644
index fcbaf2c030..0000000000
--- a/examples/browser-browserify/CHANGELOG.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [1.1.1](https://github.com/ipfs/js-ipfs/compare/example-browser-browserify@1.1.0...example-browser-browserify@1.1.1) (2020-04-08)
-
-**Note:** Version bump only for package example-browser-browserify
-
-
-
-
-
-# 1.1.0 (2020-03-31)
-
-
-### Bug Fixes
-
-* examples after files API refactor ([#1740](https://github.com/ipfs/js-ipfs/issues/1740)) ([34ec036](https://github.com/ipfs/js-ipfs/commit/34ec036b0df9563a014c1348f0a056c1f98aadad))
-
-
-### Features
-
-* implementing the new streaming interfaces ([#1086](https://github.com/ipfs/js-ipfs/issues/1086)) ([2c4b8b3](https://github.com/ipfs/js-ipfs/commit/2c4b8b325b94d4506b87441f06c5d29bb6f37f72))
diff --git a/examples/browser-browserify/README.md b/examples/browser-browserify/README.md
deleted file mode 100644
index 532125fd28..0000000000
--- a/examples/browser-browserify/README.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Bundle js-ipfs with Browserify!
-
-In this example, you will find a boilerplate you can use to guide yourself into bundling js-ipfs with [browserify](http://browserify.org/), so that you can use it in your own web app!
-
-## Clone repo and run the example
-
-```bash
-> git clone https://github.com/ipfs/js-ipfs.git
-> cd js-ipfs/examples/browser-browserify
-> npm install
-> npm start
-```
-
-Now open your browser at `http://localhost:8888`
-
-You should see the following:
-
-![](https://ipfs.io/ipfs/QmNtpcWCEd6LjdPNfBFDaVZdD4jpgT8ZTAwoFJXKhYMJdo/1.png)
-![](https://ipfs.io/ipfs/QmNtpcWCEd6LjdPNfBFDaVZdD4jpgT8ZTAwoFJXKhYMJdo/2.png)
diff --git a/examples/browser-browserify/img/1.png b/examples/browser-browserify/img/1.png
deleted file mode 100644
index 580511dad7..0000000000
Binary files a/examples/browser-browserify/img/1.png and /dev/null differ
diff --git a/examples/browser-browserify/img/2.png b/examples/browser-browserify/img/2.png
deleted file mode 100644
index 5c72fc0a38..0000000000
Binary files a/examples/browser-browserify/img/2.png and /dev/null differ
diff --git a/examples/browser-browserify/package.json b/examples/browser-browserify/package.json
deleted file mode 100644
index 378a8f8a14..0000000000
--- a/examples/browser-browserify/package.json
+++ /dev/null
@@ -1,25 +0,0 @@
-{
-  "name": "example-browser-browserify",
-  "description": "Bundle js-ipfs with Browserify",
-  "version": "1.1.1",
-  "main": "index.js",
-  "private": true,
-  "scripts": {
-    "bundle": "browserify src/index.js > public/bundle.js",
-    "serve": "http-server public -a 127.0.0.1 -p 8888",
-    "start": "npm run bundle && npm run serve",
-    "clean": "rimraf public/bundle.js",
-    "test": "test-ipfs-example"
-  },
-  "keywords": [],
-  "license": "MIT",
-  "devDependencies": {
-    "browserify": "^17.0.0",
-    "concat-stream": "^2.0.0",
-    "execa": "^5.0.0",
-    "http-server": "^0.12.3",
-    "ipfs": "^0.55.3",
-    "rimraf": "^3.0.2",
-    "test-ipfs-example": "^3.0.0"
-  }
-}
diff --git a/examples/browser-browserify/public/index.html b/examples/browser-browserify/public/index.html
deleted file mode 100644
index 8d00381454..0000000000
--- a/examples/browser-browserify/public/index.html
+++ /dev/null
@@ -1,25 +0,0 @@
-
-
-  
-    
-    js-ipfs example
-    
-    
-  
-  
-    
JS IPFS - Add data to IPFS from the browser

-    
-    
-    
-  
-
diff --git a/examples/browser-browserify/src/index.js b/examples/browser-browserify/src/index.js
deleted file mode 100644
index c99eb77391..0000000000
--- a/examples/browser-browserify/src/index.js
+++ /dev/null
@@ -1,35 +0,0 @@
-'use strict'
-
-const IPFS = require('ipfs')
-
-document.addEventListener('DOMContentLoaded', async () => {
-  const node = await IPFS.create({
-    repo: String(Math.random() + Date.now()),
-    init: { alogorithm: 'ed25519' }
-
-  })
-  const button = document.getElementById('store')
-
-  console.log('IPFS node is ready')
-
-  async function store () {
-    const toStore = document.getElementById('source').value
-
-    const file = await node.add(toStore)
-
-    console.log('successfully stored', file.cid)
-
-    await display(file.cid)
-  }
-
-  async function display (cid) {
-    for await (const data of node.cat(cid)) {
-      document.getElementById('cid').innerText = cid
-      document.getElementById('content').innerText = new TextDecoder().decode(data)
-      document.getElementById('output').setAttribute('style', 'display: block')
-    }
-  }
-
-  button.onclick = store
-  button.setAttribute('style', 'display: inline')
-})
diff --git a/examples/browser-browserify/test.js b/examples/browser-browserify/test.js
deleted file mode 100644
index 516c302a87..0000000000
--- a/examples/browser-browserify/test.js
+++ /dev/null
@@ -1,20 +0,0 @@
-'use strict'
-
-const pkg = require('./package.json')
-
-module.exports = {
-  [pkg.name]: function (browser) {
-    browser
-      .url(process.env.IPFS_EXAMPLE_TEST_URL)
-      .waitForElementVisible('#source')
-      .setValue('#source', 'hello')
-      .waitForElementVisible('#store')
-      .click('#store')
-      .waitForElementVisible('#output', 5e3, 100)
-
-    browser.expect.element('#cid').text.to.contain('QmWfVY9y3xjsixTgbd9AorQxH7VtMpzfx2HaWtsoUYecaX')
-    browser.expect.element('#content').text.to.contain('hello')
-
-    browser.end()
-  }
-}
diff --git a/examples/browser-create-react-app/.env b/examples/browser-create-react-app/.env
deleted file mode 100644
index 26a83ff0f6..0000000000
--- a/examples/browser-create-react-app/.env
+++ /dev/null
@@ -1,3 +0,0 @@
-# required because react-scripts scans *up* the tree from this project and finds
-# a conflicting version of eslint in the node_modules dir for js-ipfs.
-SKIP_PREFLIGHT_CHECK=true
diff --git a/examples/browser-create-react-app/CHANGELOG.md b/examples/browser-create-react-app/CHANGELOG.md
deleted file mode 100644
index 0a8af510b0..0000000000
--- a/examples/browser-create-react-app/CHANGELOG.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.1.2](https://github.com/ipfs/js-ipfs/compare/example-browser-create-react-app@0.1.1...example-browser-create-react-app@0.1.2) (2020-04-08)
-
-**Note:** Version bump only for package example-browser-create-react-app
-
-
-
-
-
-## 0.1.1 (2020-03-31)
-
-**Note:** Version bump only for package example-browser-create-react-app
diff --git a/examples/browser-create-react-app/README.md b/examples/browser-create-react-app/README.md
deleted file mode 100755
index 1d07fd7fc3..0000000000
--- a/examples/browser-create-react-app/README.md
+++ /dev/null
@@ -1,87 +0,0 @@
-## IPFS React app
-
-A minimal demonstration of how to use js-ipfs in a `create-react-app` generated app.
-
-It boots up a js-ipfs instance via a custom React hook in `./src/hooks/use-ipfs-factory.js`, which is called from `./src/App.js`, which is where the magic happens.
-
-![Screen shot of the js ipfs node id info](./screenshot.png)
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). **v2.1.3**
-
-## Before you start
-
-First clone this repo, install dependencies in the project root and build the project.
-
-```console
-$ git clone https://github.com/ipfs/js-ipfs.git
-$ cd js-ipfs
-$ npm install
-$ npm run build
-```
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.

-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.

-You will also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.

-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.

-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.

-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
diff --git a/examples/browser-create-react-app/package.json b/examples/browser-create-react-app/package.json
deleted file mode 100644
index 50ef611f71..0000000000
--- a/examples/browser-create-react-app/package.json
+++ /dev/null
@@ -1,31 +0,0 @@
-{
-  "name": "example-browser-create-react-app",
-  "version": "1.0.0",
-  "private": true,
-  "dependencies": {
-    "dot-prop": "^6.0.1",
-    "ipfs": "^0.55.3",
-    "ipfs-css": "^1.3.0",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-scripts": "^4.0.3",
-    "tachyons": "^4.11.1"
-  },
-  "devDependencies": {
-    "rimraf": "^3.0.2",
-    "test-ipfs-example": "^3.0.0"
-  },
-  "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "eject": "react-scripts eject",
-    "test": "test-ipfs-example",
-    "clean": "rimraf ./build"
-  },
-  "eslintConfig": {
-    "extends": "react-app"
-  },
-  "browserslist": [
-    "last 2 versions and not dead and > 2%"
-  ]
-}
diff --git a/examples/browser-create-react-app/public/favicon.ico b/examples/browser-create-react-app/public/favicon.ico
deleted file mode 100644
index b2f1f9683f..0000000000
Binary files a/examples/browser-create-react-app/public/favicon.ico and /dev/null differ
diff --git a/examples/browser-create-react-app/public/index.html b/examples/browser-create-react-app/public/index.html
deleted file mode 100755
index 35878351ef..0000000000
--- a/examples/browser-create-react-app/public/index.html
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-  
-    
-    
-    
-    
-    
-    
-    
-    IPFS React App
-  
-  
-    
-    

-    
-  
-
diff --git a/examples/browser-create-react-app/public/manifest.json b/examples/browser-create-react-app/public/manifest.json
deleted file mode 100755
index 5845b822ec..0000000000
--- a/examples/browser-create-react-app/public/manifest.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
-  "short_name": "IPFS React App",
-  "name": "IPFS Create React App Example",
-  "icons": [
-    {
-      "src": "favicon.ico",
-      "sizes": "64x64 32x32 24x24 16x16",
-      "type": "image/x-icon"
-    }
-  ],
-  "start_url": ".",
-  "display": "standalone",
-  "theme_color": "#000000",
-  "background_color": "#ffffff"
-}
diff --git a/examples/browser-create-react-app/screenshot.png b/examples/browser-create-react-app/screenshot.png
deleted file mode 100644
index 7dab75b469..0000000000
Binary files a/examples/browser-create-react-app/screenshot.png and /dev/null differ
diff --git a/examples/browser-create-react-app/src/App.js b/examples/browser-create-react-app/src/App.js
deleted file mode 100755
index f742be5208..0000000000
--- a/examples/browser-create-react-app/src/App.js
+++ /dev/null
@@ -1,52 +0,0 @@
-import React from 'react'
-import useIpfsFactory from './hooks/use-ipfs-factory.js'
-import useIpfs from './hooks/use-ipfs.js'
-import logo from './ipfs-logo.svg'
-
-const App = () => {
-  const { ipfs, ipfsInitError } = useIpfsFactory({ commands: ['id'] })
-  const id = useIpfs(ipfs, 'id')
-  return (
-    

-      

-        
-          IPFS logo
-        
-        
IPFS React

-      

-      

-        {ipfsInitError && (
-          

-            Error: {ipfsInitError.message || ipfsInitError}
-          

-        )}
-        {id && }
-      

-    

-  )
-}
-
-const Title = ({ children }) => {
-  return (
-    
{children}

-  )
-}
-
-const IpfsId = (props) => {
-  if (!props) return null
-  return (
-    

-      
Connected to IPFS

-      

-        {['id', 'agentVersion'].map((key) => (
-          

-            {key}
-            
{props[key]}

-          

-        ))}
-      

-    

-  )
-}
-
-export default App
diff --git a/examples/browser-create-react-app/src/App.test.js b/examples/browser-create-react-app/src/App.test.js
deleted file mode 100755
index 4bf19359ea..0000000000
--- a/examples/browser-create-react-app/src/App.test.js
+++ /dev/null
@@ -1,9 +0,0 @@
-import React from 'react'
-import ReactDOM from 'react-dom'
-import App from './App'
-
-it('renders without crashing', () => {
-  const div = document.createElement('div')
-  ReactDOM.render(, div)
-  ReactDOM.unmountComponentAtNode(div)
-})
diff --git a/examples/browser-create-react-app/src/hooks/use-ipfs-factory.js b/examples/browser-create-react-app/src/hooks/use-ipfs-factory.js
deleted file mode 100644
index dcd4da6607..0000000000
--- a/examples/browser-create-react-app/src/hooks/use-ipfs-factory.js
+++ /dev/null
@@ -1,57 +0,0 @@
-import Ipfs from 'ipfs'
-import { useEffect, useState } from 'react'
-
-let ipfs = null
-
-/*
- * A quick demo using React hooks to create an ipfs instance.
- *
- * Hooks are brand new at the time of writing, and this pattern
- * is intended to show it is possible. I don't know if it is wise.
- *
- * Next steps would be to store the ipfs instance on the context
- * so use-ipfs calls can grab it from there rather than expecting
- * it to be passed in.
- */
-export default function useIpfsFactory () {
-  const [isIpfsReady, setIpfsReady] = useState(Boolean(ipfs))
-  const [ipfsInitError, setIpfsInitError] = useState(null)
-
-  useEffect(() => {
-    // The fn to useEffect should not return anything other than a cleanup fn,
-    // So it cannot be marked async, which causes it to return a promise,
-    // Hence we delegate to a async fn rather than making the param an async fn.
-    async function startIpfs () {
-      if (ipfs) {
-        console.log('IPFS already started')
-      } else if (window.ipfs && window.ipfs.enable) {
-        console.log('Found window.ipfs')
-        ipfs = await window.ipfs.enable({ commands: ['id'] })
-      } else {
-        try {
-          console.time('IPFS Started')
-          ipfs = await Ipfs.create()
-          console.timeEnd('IPFS Started')
-        } catch (error) {
-          console.error('IPFS init error:', error)
-          ipfs = null
-          setIpfsInitError(error)
-        }
-      }
-
-      setIpfsReady(Boolean(ipfs))
-    }
-
-    startIpfs()
-    return function cleanup () {
-      if (ipfs && ipfs.stop) {
-        console.log('Stopping IPFS')
-        ipfs.stop().catch(err => console.error(err))
-        ipfs = null
-        setIpfsReady(false)
-      }
-    }
-  }, [])
-
-  return { ipfs, isIpfsReady, ipfsInitError }
-}
diff --git a/examples/browser-create-react-app/src/hooks/use-ipfs.js b/examples/browser-create-react-app/src/hooks/use-ipfs.js
deleted file mode 100644
index 39678bb16b..0000000000
--- a/examples/browser-create-react-app/src/hooks/use-ipfs.js
+++ /dev/null
@@ -1,26 +0,0 @@
-import { useState, useEffect } from 'react'
-import dotProp from 'dot-prop'
-
-/*
- * Pass the command you'd like to call on an ipfs instance.
- *
- * Uses setState to capture the response, so your component
- * will re-render when the result turns up.
- *
- */
-export default function useIpfs (ipfs, cmd, opts) {
-  const [res, setRes] = useState(null)
-  useEffect(() => {
-    callIpfs(ipfs, cmd, opts, setRes)
-  }, [ipfs, cmd, opts])
-  return res
-}
-
-async function callIpfs (ipfs, cmd, opts, setRes) {
-  if (!ipfs) return null
-  console.log(`Call ipfs.${cmd}`)
-  const ipfsCmd = dotProp.get(ipfs, cmd)
-  const res = await ipfsCmd(opts)
-  console.log(`Result ipfs.${cmd}`, res)
-  setRes(res)
-}
diff --git a/examples/browser-create-react-app/src/index.css b/examples/browser-create-react-app/src/index.css
deleted file mode 100755
index d49edef62c..0000000000
--- a/examples/browser-create-react-app/src/index.css
+++ /dev/null
@@ -1,2 +0,0 @@
-@import "../node_modules/tachyons";
-@import "../node_modules/ipfs-css";
diff --git a/examples/browser-create-react-app/src/index.js b/examples/browser-create-react-app/src/index.js
deleted file mode 100755
index 49624cc3e5..0000000000
--- a/examples/browser-create-react-app/src/index.js
+++ /dev/null
@@ -1,6 +0,0 @@
-import React from 'react'
-import ReactDOM from 'react-dom'
-import './index.css'
-import App from './App'
-
-ReactDOM.render(, document.getElementById('root'))
diff --git a/examples/browser-create-react-app/src/ipfs-logo.svg b/examples/browser-create-react-app/src/ipfs-logo.svg
deleted file mode 100644
index 5d24074b66..0000000000
--- a/examples/browser-create-react-app/src/ipfs-logo.svg
+++ /dev/null
@@ -1 +0,0 @@
-IPFS logo (new)
\ No newline at end of file
diff --git a/examples/browser-create-react-app/test.js b/examples/browser-create-react-app/test.js
deleted file mode 100644
index 812769aca0..0000000000
--- a/examples/browser-create-react-app/test.js
+++ /dev/null
@@ -1,16 +0,0 @@
-'use strict'
-
-const pkg = require('./package.json')
-
-module.exports = {
-  [pkg.name]: function (browser) {
-    browser
-      .url(process.env.IPFS_EXAMPLE_TEST_URL)
-      .waitForElementVisible('[data-test=title]')
-      .assert.containsText('[data-test=title]', 'Connected to IPFS')
-      .assert.elementPresent('[data-test=id')
-      .assert.elementPresent('[data-test=agentVersion')
-      .end()
-  }
-}
-
diff --git a/examples/browser-exchange-files/CHANGELOG.md b/examples/browser-exchange-files/CHANGELOG.md
deleted file mode 100644
index ec56590c16..0000000000
--- a/examples/browser-exchange-files/CHANGELOG.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.1.1](https://github.com/ipfs/js-ipfs/compare/example-exchange-files-in-browser@0.1.0...example-exchange-files-in-browser@0.1.1) (2020-04-08)
-
-**Note:** Version bump only for package example-exchange-files-in-browser
-
-
-
-
-
-# 0.1.0 (2020-03-31)
-
-
-### Bug Fixes
-
-* examples after files API refactor ([#1740](https://github.com/ipfs/js-ipfs/issues/1740)) ([34ec036](https://github.com/ipfs/js-ipfs/commit/34ec036b0df9563a014c1348f0a056c1f98aadad))
-* fix exchange in files example ([#2913](https://github.com/ipfs/js-ipfs/issues/2913)) ([cd46c78](https://github.com/ipfs/js-ipfs/commit/cd46c7899e805227dfe8a566cf354a1a127299c3))
-* update *-star multiaddrs to explicity say that they need tcp and a port ([#1117](https://github.com/ipfs/js-ipfs/issues/1117)) ([9eda8a8](https://github.com/ipfs/js-ipfs/commit/9eda8a8287159c12b4df017c3d0cdac083a0b4f0))
-* update option in exchange files in browser example ([#2087](https://github.com/ipfs/js-ipfs/issues/2087)) ([63469ed](https://github.com/ipfs/js-ipfs/commit/63469ed2a21f207a947d915bfe1c1beda3eaa0e3))
-
-
-### Code Refactoring
-
-* return peer IDs as strings not CIDs ([#2729](https://github.com/ipfs/js-ipfs/issues/2729)) ([16d540c](https://github.com/ipfs/js-ipfs/commit/16d540c540f375061d83dafaf6c38d0b7c4a3d60))
-
-
-### Features
-
-* add circuit relay and aegir 12 (+ big refactor) ([104ef1e](https://github.com/ipfs/js-ipfs/commit/104ef1ef6cc64c09ec886f67c28e9b5d37bc9e66))
-* gossipsub as default pubsub ([#2298](https://github.com/ipfs/js-ipfs/issues/2298)) ([902e045](https://github.com/ipfs/js-ipfs/commit/902e04547e8cd0aaee994193ef664f662ff07683))
-* implementing the new streaming interfaces ([#1086](https://github.com/ipfs/js-ipfs/issues/1086)) ([2c4b8b3](https://github.com/ipfs/js-ipfs/commit/2c4b8b325b94d4506b87441f06c5d29bb6f37f72))
-
-
-### BREAKING CHANGES
-
-* Where `PeerID`s were previously [CID](https://www.npmjs.com/package/cids)s, now they are Strings
-
-- `ipfs.bitswap.stat().peers[n]` is now a String (was a CID)
-- `ipfs.dht.findPeer().id` is now a String (was a CID)
-- `ipfs.dht.findProvs()[n].id` is now a String (was a CID)
-- `ipfs.dht.provide()[n].id` is now a String (was a CID)
-- `ipfs.dht.put()[n].id` is now a String (was a CID)
-- `ipfs.dht.query()[n].id` is now a String (was a CID)
-- `ipfs.id().id` is now a String (was a CID)
-- `ipfs.id().addresses[n]` are now [Multiaddr](https://www.npmjs.com/package/multiaddr)s (were Strings)
-* The default pubsub implementation has changed from floodsub to [gossipsub](https://github.com/ChainSafe/gossipsub-js). Additionally, to enable pubsub programmatically set `pubsub.enabled: true` instead of `EXPERIMENTAL.pubsub: true` or via the CLI pass `--enable-pubsub` instead of `--enable-pubsub-experiment` to `jsipfs daemon`.
diff --git a/examples/browser-exchange-files/README.md b/examples/browser-exchange-files/README.md
deleted file mode 100644
index a23111c236..0000000000
--- a/examples/browser-exchange-files/README.md
+++ /dev/null
@@ -1,243 +0,0 @@
-# Exchange files between the browser and other IPFS nodes
-
-This tutorial will help you exchange files between browser nodes and go-ipfs or js-ipfs nodes!
-
-**Note:** As `js-ipfs@0.41.x` currently doesn't support DHT peer discovery, the peer from which you are fetching data should be within the reach (local or in public IP) of the browser node.
-
-That being said, we will explain how to circumvent these caveats and once they are fixed, we'll update the tutorial as well.
-
-## Application diagram
-
-The goal of this tutorial is to create a simple application with an IPFS node that dials to other instances using WebRTC, and at the same time dial and transfer files from a browser IPFS node using WebSockets as the transport.
-
-```
-┌──────────────┐                ┌──────────────┐
-│   Browser    │ libp2p(WebRTC) │   Browser    │
-│              │◀──────────────▶│              │
-└──────────────┘                └──────────────┘
-       ▲                                  ▲
-       │WebSockets              WebSockets│
-       │        ┌──────────────┐          │
-       │        │   Desktop    │          │
-       └───────▶│   Terminal   │◀─────────┘
-                └──────────────┘
-```
-
-## Tutorial goal
-
-The goal of this tutorial is for you to have something like this in the end:
-
-![](img/goal.png)
-
-## Step-by-step instructions
-
-Here's what we are going to be doing:
-
-1. Install a `go-ipfs` or `js-ipfs` node in your machine
-2. Make your daemons listen on WebSockets
-3. Start a `libp2p-webrtc-star` signaling server
-4. Start the app
-5. Dial to a node using WebSockets (your desktop ones)
-6. Transfer files between all of your nodes!
-
-Just follow the instructions below and it will be up and running in no time!
-
-## Before you start
-
-First clone this repo, install dependencies in the project root and build the project.
-
-```console
-$ git clone https://github.com/ipfs/js-ipfs.git
-$ cd js-ipfs
-$ npm install
-$ npm run bundle
-```
-
-## Running the example
-
-### 1. Install `go-ipfs` or `js-ipfs`
-
-If you already have `go-ipfs` or `js-ipfs` installed in your machine, you can skip this step. Otherwise, read on.
-
-This tutorial works with either `go-ipfs` or `js-ipfs`, so you can install one of your choosing.
-
-`go-ipfs` can be installed via its binary [here](https://ipfs.io/ipns/dist.ipfs.io/#go-ipfs). Alternatively, you can follow the install instructions in [ipfs/go-ipfs](https://github.com/ipfs/go-ipfs#install).
-
-`js-ipfs` requires you to have [node and npm](https://www.npmjs.com/get-npm) installed. Then, you simply run:
-
-```sh
-> npm install --global ipfs
-```
-
-This will alias `jsipfs` on your machine; this is to avoid issues with `go-ipfs` being called `ipfs`.
-
-At this point, you should have either `js-ipfs` or `go-ipfs` running. Now, initialize it:
-
-```sh
-> ipfs init
-# or
-> jsipfs init
-```
-
-This will set up an IPFS repo in your home directory.
-
-### 2. Make your daemons listen on WebSockets
-
-Now you need to edit your `config` file, the one you just set up with `{js}ipfs init`. It should be in either `~/.jsipfs/config` or `~/.ipfs/config`, depending on whether you're using JS or Go.
-
-**Note:** `js-ipfs` sets up a websocket listener by default, so if you're using the JS implementation you can skip this and just start the daemon.
-
-Since websockets support is currently not on by default, you'll need to add a WebSockets address manually. Look into your config file to find the `Addresses` section:
-
-```json
-"Addresses": {
-  "Swarm": [
-    "/ip4/0.0.0.0/tcp/4002"
-  ],
-  "API": "/ip4/127.0.0.1/tcp/5002",
-  "Gateway": "/ip4/127.0.0.1/tcp/9090"
-}
-```
-
-Add the `/ip4/127.0.0.1/tcp/4003/ws` entry to your `Swarm` array. Now it should look like this:
-
-```json
-"Addresses": {
-  "Swarm": [
-    "/ip4/0.0.0.0/tcp/4002",
-    "/ip4/127.0.0.1/tcp/4003/ws"
-  ],
-  "API": "/ip4/127.0.0.1/tcp/5002",
-  "Gateway": "/ip4/127.0.0.1/tcp/9090"
-}
-```
-
-Save the file and it should be able to listen on Websockets. We're ready to start the daemon.
-
-```sh
-> ipfs daemon
-# or
-> jsipfs daemon
-```
-
-You should see the Websocket address in the output:
-
-```sh
-Initializing daemon...
-Swarm listening on /ip4/127.0.0.1/tcp/4001
-Swarm listening on /ip4/127.0.0.1/tcp/4003/ws
-Swarm listening on /ip4/192.168.10.38/tcp/4001
-Swarm listening on /ip4/192.168.10.38/tcp/4003/ws
-API server listening on /ip4/127.0.0.1/tcp/5001
-Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080
-Daemon is ready
-```
-
-Check the `/ws` in line 5, that means it is listening. Cool.
-
-### 3. Start the app
-
-Make sure you're in `js-ipfs/examples/exchange-files-in-browser`.
-
-We'll need to bundle the dependencies to run the app. Let's do it:
-
-```sh
-> npm run bundle
-...
-> npm start
-```
-
-You should see something like this if all went well:
-
-```sh
-Starting up http-server, serving public
-Available on:
-  http://127.0.0.1:12345
-  http://192.168.2.92:12345
-Hit CTRL-C to stop the server
-```
-
-Now go to http://127.0.0.1:12345 in a modern browser and you're on!
-
-### 4. Dial to a node using WebSockets (your desktop ones)
-
-Make sure you have a daemon running. If you don't, run:
-
-```sh
-> ipfs daemon
-# or
-> jsipfs daemon
-```
-
-Open another terminal window to find the websocket addresses that it is listening on:
-
-```sh
-> ipfs id
-# or
-> jsipfs id
-```
-
-It should look like this: `/ip4/127.0.0.1/tcp/4003/ws/ipfs/`.
-
-Copy and paste the *multiaddr* to connect to that peer:
-
-![](img/connect-1.png)
-
-Check that you got connected:
-
-![](img/connect-2.png)
-
-> It only works on localhost environments because of a restriction with WebCrypto where it will not load in a page unless that page is loaded over https, or the page is served from localhost: [libp2p/js-libp2p-crypto#105][js-libp2p-crypto#105]
-
-[js-libp2p-crypto#105]: https://github.com/libp2p/js-libp2p-crypto/issues/105
-
-### 5. Transfer files between all of your nodes!
-
-Now you can add files through the CLI with:
-
-```sh
-> ipfs add 
-# or
-> jsipfs add 
-```
-
-Copy and paste the *multihash* and fetch the file in the browser!
-
-![](img/fetch.png)
-
-You can also open two browser tabs, drag and drop files in one of them, and fetch them in the other!
-
-But the coolest thing about this tutorial is `pubsub`! You can open two tabs that will share files through workspaces named after the url. Try opening two tabs with the following url:
-
-```
-http://127.0.0.1:12345/#file-exchange
-# You can substitute `file-exchange` with anything you like, just make sure the two tabs are in the same workspace.
-```
-
-Now every file that you upload in one tab will appear in the other! You can even open a new tab in that workspace and it will sync the files that were added before!
-
-![](img/pubsub.png)
-
-## Going to production?
-
-This example uses public webrtc-star servers. These servers should be used for experimenting and demos, they **MUST** not be used in production as there is no guarantee on availability.
-
-### Use your own `libp2p-webrtc-star` signaling server
-
-This server allows the two browser nodes to talk to each other by doing the initial handshake and network introductions.
-
-First install the `libp2p-webrtc-star` module globally:
-
-```sh
-> npm install -g libp2p-webrtc-star
-```
-
-This will give you the `webrtc-star` command.  Use this to start a signaling server:
-
-```sh
-> webrtc-star
-```
-
-By default it will listen to all incoming connections on port 13579. Override this with the `--host` and/or `--port` options. That is, the following multiaddr: `/ip4/127.0.0.1/tcp/13579/wss/p2p-webrtc-star`.
-
-You should add your signaling server in the IPFS config swarm addresses, so that you listen for new connections through it.
diff --git a/examples/browser-exchange-files/img/connect-1.png b/examples/browser-exchange-files/img/connect-1.png
deleted file mode 100644
index 5b247a9470..0000000000
Binary files a/examples/browser-exchange-files/img/connect-1.png and /dev/null differ
diff --git a/examples/browser-exchange-files/img/connect-2.png b/examples/browser-exchange-files/img/connect-2.png
deleted file mode 100644
index a481be379d..0000000000
Binary files a/examples/browser-exchange-files/img/connect-2.png and /dev/null differ
diff --git a/examples/browser-exchange-files/img/diagram.monopic b/examples/browser-exchange-files/img/diagram.monopic
deleted file mode 100644
index 35f88ab30f..0000000000
Binary files a/examples/browser-exchange-files/img/diagram.monopic and /dev/null differ
diff --git a/examples/browser-exchange-files/img/diagram.txt b/examples/browser-exchange-files/img/diagram.txt
deleted file mode 100644
index 05c9ff91cb..0000000000
--- a/examples/browser-exchange-files/img/diagram.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-┌──────────────┐                   ┌──────────────┐
-│   Browser    │                   │   Browser    │
-│              │      WebRTC       │              │
-│              │◀─────────────────▶│              │
-│              │                   │              │
-└──────────────┘                   └──────────────┘
-        ▲                                  ▲
-        │                                  │
-        │                                  │
-        │                                  │
-        │WebSockets              WebSockets│
-        │                                  │
-        │                                  │
-        │        ┌──────────────┐          │
-        │        │   Desktop    │          │
-        │        │              │          │
-        └───────▶│              │◀─────────┘
-                 │              │
-                 └──────────────┘
\ No newline at end of file
diff --git a/examples/browser-exchange-files/img/fetch.png b/examples/browser-exchange-files/img/fetch.png
deleted file mode 100644
index 2bcfef1d9d..0000000000
Binary files a/examples/browser-exchange-files/img/fetch.png and /dev/null differ
diff --git a/examples/browser-exchange-files/img/goal.png b/examples/browser-exchange-files/img/goal.png
deleted file mode 100644
index 50fb3d5a94..0000000000
Binary files a/examples/browser-exchange-files/img/goal.png and /dev/null differ
diff --git a/examples/browser-exchange-files/img/pubsub.png b/examples/browser-exchange-files/img/pubsub.png
deleted file mode 100644
index 9fc39b464a..0000000000
Binary files a/examples/browser-exchange-files/img/pubsub.png and /dev/null differ
diff --git a/examples/browser-exchange-files/package.json b/examples/browser-exchange-files/package.json
deleted file mode 100644
index 1c122d4f5c..0000000000
--- a/examples/browser-exchange-files/package.json
+++ /dev/null
@@ -1,27 +0,0 @@
-{
-  "name": "example-exchange-files-in-browser",
-  "version": "1.0.0",
-  "private": true,
-  "scripts": {
-    "clean": "rimraf public/bundle.js",
-    "bundle": "browserify public/app.js > public/bundle.js",
-    "start": "http-server -c-1 -p 12345 public",
-    "dev": "npm run bundle && npm run start",
-    "test": "test-ipfs-example"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "browserify": "^17.0.0",
-    "execa": "^5.0.0",
-    "http-server": "^0.12.3",
-    "ipfs-http-client": "^50.1.1",
-    "uint8arrays": "^2.1.3"
-  },
-  "dependencies": {
-    "ipfs": "^0.55.3",
-    "it-all": "^1.0.4",
-    "libp2p-websockets": "^0.15.6",
-    "rimraf": "^3.0.2",
-    "test-ipfs-example": "^3.0.0"
-  }
-}
diff --git a/examples/browser-exchange-files/public/app.css b/examples/browser-exchange-files/public/app.css
deleted file mode 100644
index 61b04121d0..0000000000
--- a/examples/browser-exchange-files/public/app.css
+++ /dev/null
@@ -1,298 +0,0 @@
-
-/* ===========================================================================
-   Layout
-   =========================================================================== */
-
-* {
-  box-sizing: border-box;
-}
-
-body {
-  min-height: 100vh;
-  font-family: sans-serif;
-  color: #0B3A53;
-  background: #141E30; /* Fallback for old browsers */
-  background: -webkit-linear-gradient(to top, #243B55, #141E30); /* Chrome 10-25, Safari 5.1-6 */
-  background: linear-gradient(to top, #243B55, #141E30); /* W3C, IE 10+/ Edge, Firefox 16+, Chrome 26+, Opera 12+, Safari 7+ */
-  pointer-events: auto;
-  padding: 0;
-  margin: 0;
-}
-
-h1, h2, h3 {
-  margin: 0;
-}
-
-h1 {
-  font-size: 2em;
-  font-weight: 300;
-}
-
-h2 {
-  font-size: 1.25em;
-  font-weight: 700;
-}
-
-h3 {
-  font-size: 1.0em;
-  font-weight: 700;
-}
-
-header {
-  display: flex;
-  justify-content: center;
-  align-items: center;
-  padding: 2em 0;
-}
-
-main {
-    width: 90%;
-    margin: 0 auto;
-}
-
-.columns {
-  display: flex;
-  justify-content: space-between;
-}
-
-
-/* ===========================================================================
-   Buttons & Inputs
-   =========================================================================== */
-
-button {
-  padding: 0.625em 1.5em;
-  border: 2px solid #69C4CD;
-  border-radius: 2px;
-  background-color: #69C4CD;
-  color: #FFF;
-  font-size: 0.9em;
-  cursor: pointer;
-  outline: none;
-}
-
-button:hover {
-  opacity: 0.9;
-}
-
-input {
-  width: 100%;
-  margin-right: 3px;
-  padding: 0.7em;
-  border: 2px solid rgba(0, 0, 0, 0.2);
-  border-radius: 2px;
-  color: #000;
-  outline: none;
-}
-
-input:hover,
-input:focus,
-input:active {
-  border-color: #69C4CD;
-}
-
-.input-button {
-  display: flex;
-}
-
-.disabled *,
-input:disabled,
-button:disabled {
-  opacity: 0.2;
-}
-
-/* ===========================================================================
-   Tables
-   =========================================================================== */
-
-table {
-  width: 100%;
-  margin: 1em 0;
-  padding: 1em;
-  border-spacing: 0;
-  background-color: #FFF;
-  word-break: break-all;
-}
-
-table th,
-table td {
-  padding: 1em;
-  font-size: 0.8em;
-  text-align: left;
-  font-weight: normal;
-}
-
-table th {
-  padding-top: 0;
-  font-size: 0.7em;
-  text-transform: uppercase;
-  opacity: 0.5;
-}
-
-table tbody tr:nth-child(odd) {
-  background-color: #F7F8FA;
-}
-
-table tbody tr:hover {
-  background-color: rgb(100, 196, 205);
-  background-color: rgba(100, 196, 205, 0.2);
-}
-
-.table-action {
-  opacity: 0.5;
-}
-
-.table-action:hover {
-  opacity: 1;
-}
-
-/* ===========================================================================
-   Box
-   =========================================================================== */
-
-.box {
-  display: flex;
-  flex-direction: column;
-  margin-bottom: 1em;
-  padding: 1em;
-  border-radius: 2px;
-  background-color: #F7F8FA;
-}
-
-.box > h2 {
-  display: block;
-  border-bottom: 1px solid #B7BBC8;
-  text-align: center;
-  padding-bottom: 0.5em;
-  margin-bottom: 1em;
-}
-
-/* Node
-   =========================================================================== */
-
-.box.node > div {
-  display: flex;
-  margin-bottom: 1em;
-}
-
-.box.node > div:last-child {
-  margin-bottom: 0;
-}
-
-.box.node > div > h3 {
-  flex: 0 0 15%;
-}
-
-.box.node > div pre,
-.box.node > div > ul {
-  flex: 0 0 85%;
-  margin: 0;
-}
-
-.box.node ul {
-  margin: 0;
-  padding: 0;
-  list-style: none;
-}
-
-.node-addresses li {
-  margin-bottom: 0.5em;
-  font-size: 0.7em;
-  word-wrap: break-word;
-}
-
-#logs {
-  margin: 0;
-  color: #EA5037;
-}
-
-#logs.success {
-    color: #0CB892;
-}
-
-/* Peers
-   =========================================================================== */
-
-#peers {
-  flex: 0 0 calc(35% - 1em);
-}
-
-/* Files
-   =========================================================================== */
-
-#files {
-  flex: 0 0 65%;
-  min-height: 500px;
-}
-
-#file-status {
-  font-style: italic;
-  color: #6ACAD1;
-  font-size: 0.8em;
-  margin: 1em 0;
-}
-
-#files table th:nth-child(1),
-#files table td:nth-child(1) {
-  width: 35%;
-}
-
-#files table th:nth-child(2),
-#files table td:nth-child(2) {
-  width: 50%;
-}
-
-#files table th:nth-child(3),
-#files table td:nth-child(3) {
-  width: 15%;
-}
-
-#files .empty-row td {
-  text-align: center;
-  opacity: 0.5;
-}
-
-#drag-container {
-  height: 10em;
-  margin-top: 1em;
-  display: flex;
-  justify-content: center;
-  align-items: center;
-  border: 1px dashed;
-  border-radius: 2px;
-  opacity: 0.7;
-}
-
-#drag-container.dragging {
-  background-color: #E7E8EE;
-  opacity: 1;
-
-}
-
-#drag-container p {
-  margin-left: 1em;
-}
-
-#progress-container {
-  margin-top: 1em;
-  border-radius: 0.5em;
-  background-color: #0B3A53;
-  overflow-x: hidden;
-}
-
-#progress-bar {
-  height: 1em;
-  border-radius: 0.5em;
-  background-color: #6ACAD1;
-  transform: translateX(-100%);
-}
-
-/* ===========================================================================
-   Responsiveness
-   =========================================================================== */
-
-@media (max-width: 768px) {
-  .columns {
-    flex-direction: column-reverse;
-  }
-}
diff --git a/examples/browser-exchange-files/public/app.js b/examples/browser-exchange-files/public/app.js
deleted file mode 100644
index 5b20d82f84..0000000000
--- a/examples/browser-exchange-files/public/app.js
+++ /dev/null
@@ -1,401 +0,0 @@
-/* global location */
-'use strict'
-
-const IPFS = require('ipfs')
-const WS = require('libp2p-websockets')
-const filters = require('libp2p-websockets/src/filters')
-const transportKey = WS.prototype[Symbol.toStringTag]
-
-const all = require('it-all')
-const uint8ArrayConcat = require('uint8arrays/concat')
-const uint8ArrayFromString = require('uint8arrays/from-string')
-
-// Node
-const $nodeId = document.querySelector('.node-id')
-const $nodeAddresses = document.querySelector('.node-addresses')
-const $logs = document.querySelector('#logs')
-// Peers
-const $peers = document.querySelector('#peers')
-const $peersList = $peers.querySelector('#connected-peers')
-const $workspacePeersList = $peers.querySelector('#workspace-peers')
-const $multiaddrInput = document.querySelector('#multiaddr-input')
-const $connectButton = document.querySelector('#peer-btn')
-// Files
-const $cidInput = document.querySelector('#cid-input')
-const $fetchButton = document.querySelector('#fetch-btn')
-const $dragContainer = document.querySelector('#drag-container')
-const $progressBar = document.querySelector('#progress-bar')
-const $fileHistory = document.querySelector('#file-history tbody')
-const $emptyRow = document.querySelector('.empty-row')
-// Misc
-const $allDisabledButtons = document.querySelectorAll('button:disabled')
-const $allDisabledInputs = document.querySelectorAll('input:disabled')
-const $allDisabledElements = document.querySelectorAll('.disabled')
-
-// Workspace inputs
-const $workspaceInput = document.querySelector('#workspace-input')
-const $workspaceBtn = document.querySelector('#workspace-btn')
-
-let FILES = []
-let workspace = (location.hash || 'default-workspace').replace(/^#/, '')
-
-let fileSize = 0
-
-/** @type {import('ipfs').IPFS} */
-let node
-let info
-
-/* ===========================================================================
-   Start the IPFS node
-   =========================================================================== */
-
-async function start () {
-  if (!node) {
-    node = await IPFS.create({
-      repo: 'ipfs-' + Math.random(),
-      config: {
-        Addresses: {
-          Swarm: [
-            // This is a public webrtc-star server
-            '/dns4/wrtc-star1.par.dwebops.pub/tcp/443/wss/p2p-webrtc-star',
-            '/dns4/wrtc-star2.sjc.dwebops.pub/tcp/443/wss/p2p-webrtc-star',
-            '/ip4/127.0.0.1/tcp/13579/wss/p2p-webrtc-star'
-          ]
-        },
-        // If you want to connect to the public bootstrap nodes, remove the next line
-        Bootstrap: []
-      },
-      libp2p: {
-        config: {
-          transport: {
-            // This is added for local demo!
-            // In a production environment the default filter should be used
-            // where only DNS + WSS addresses will be dialed by websockets in the browser.
-            [transportKey]: {
-              filter: filters.all
-            }
-          }
-        }
-      }
-    })
-
-    try {
-      info = await node.id()
-
-      const addressesHtml = info.addresses.map((address) => {
-        return `
  • ${address}
    • `
-      }).join('')
-      $nodeId.innerText = info.id
-      $nodeAddresses.innerHTML = addressesHtml
-      $allDisabledButtons.forEach(b => { b.disabled = false })
-      $allDisabledInputs.forEach(b => { b.disabled = false })
-      $allDisabledElements.forEach(el => { el.classList.remove('disabled') })
-    } catch (err) {
-      return onError(err)
-    }
-
-    onSuccess('Node is ready.')
-
-    setInterval(async () => {
-      try {
-        await refreshPeerList()
-      } catch (err) {
-        err.message = `Failed to refresh the peer list: ${err.message}`
-        onError(err)
-      }
-    }, 1000)
-
-    setInterval(async () => {
-      try {
-        await refreshWorkspacePeerList()
-      } catch (err) {
-        err.message = `Failed to refresh the workspace peer list: ${err.message}`
-        onError(err)
-      }
-    }, 1000)
-
-    setInterval(async () => {
-      try {
-        await sendFileList()
-      } catch (err) {
-        err.message = `Failed to publish the file list: ${err.message}`
-        onError(err)
-      }
-    }, 10000)
-
-    try {
-      await subscribeToWorkspace()
-    } catch (err) {
-      err.message = `Failed to subscribe to the workspace: ${err.message}`
-      return onError(err)
-    }
-
-    window.addEventListener('hashchange', async () => {
-      try {
-        await workspaceUpdated()
-      } catch (err) {
-        err.message = `Failed to subscribe to the updated workspace: ${err.message}`
-        onError(err)
-      }
-    })
-  }
-}
-
-/* ===========================================================================
-   Pubsub
-   =========================================================================== */
-
-const messageHandler = (message) => {
-  const myNode = info.id.toString()
-  const hash = message.data.toString()
-  const messageSender = message.from
-
-  // append new files when someone uploads them
-  if (myNode !== messageSender && !FILES.includes(hash)) {
-    $cidInput.value = hash
-    getFile()
-  }
-}
-
-const subscribeToWorkspace = async () => {
-  await node.pubsub.subscribe(workspace, messageHandler)
-  const msg = `Subscribed to workspace '${workspace}'`
-  $logs.innerHTML = msg
-}
-
-// unsubscribe from old workspace and re-subscribe to new one
-const workspaceUpdated = async () => {
-  await node.pubsub.unsubscribe(workspace)
-  // clear files from old workspace
-  FILES = []
-  $fileHistory.innerHTML = ''
-
-  workspace = location.hash.replace(/^#/, '')
-  await subscribeToWorkspace()
-}
-
-const publishHash = (hash) => {
-  const data = uint8ArrayFromString(hash)
-  return node.pubsub.publish(workspace, data)
-}
-
-/* ===========================================================================
-   Files handling
-   =========================================================================== */
-
-const sendFileList = () => Promise.all(FILES.map(publishHash))
-
-const updateProgress = (bytesLoaded) => {
-  let percent = 100 - ((bytesLoaded / fileSize) * 100)
-
-  $progressBar.style.transform = `translateX(${-percent}%)`
-}
-
-const resetProgress = () => {
-  $progressBar.style.transform = 'translateX(-100%)'
-}
-
-function appendFile (name, hash, size, data) {
-  const file = new window.Blob([data], { type: 'application/octet-binary' })
-  const url = window.URL.createObjectURL(file)
-  const row = document.createElement('tr')
-
-  const nameCell = document.createElement('td')
-  nameCell.innerHTML = name
-
-  const hashCell = document.createElement('td')
-  hashCell.innerHTML = hash
-
-  const sizeCell = document.createElement('td')
-  sizeCell.innerText = size
-
-  const downloadCell = document.createElement('td')
-  const link = document.createElement('a')
-  link.setAttribute('href', url)
-  link.setAttribute('download', name)
-  link.innerHTML = 'Download'
-  downloadCell.appendChild(link)
-
-  row.appendChild(nameCell)
-  row.appendChild(hashCell)
-  row.appendChild(sizeCell)
-  row.appendChild(downloadCell)
-
-  $fileHistory.insertBefore(row, $fileHistory.firstChild)
-
-  return publishHash(hash)
-}
-
-async function getFile () {
-  const hash = $cidInput.value
-
-  $cidInput.value = ''
-
-  if (!hash) {
-    return onError('No CID was inserted.')
-  } else if (FILES.includes(hash)) {
-    return onSuccess('The file is already in the current workspace.')
-  }
-
-  FILES.push(hash)
-
-  for await (const file of node.get(hash)) {
-    if (file.content) {
-      const content = uint8ArrayConcat(await all(file.content))
-
-      await appendFile(file.name, hash, file.size, content)
-      onSuccess(`The ${file.name} file was added.`)
-      $emptyRow.style.display = 'none'
-    }
-  }
-}
-
-/* Drag & Drop
-   =========================================================================== */
-
-const onDragEnter = () => $dragContainer.classList.add('dragging')
-
-const onDragLeave = () => $dragContainer.classList.remove('dragging')
-
-async function onDrop (event) {
-  onDragLeave()
-  event.preventDefault()
-
-  const files = Array.from(event.dataTransfer.files)
-
-  for (const file of files) {
-    fileSize = file.size // Note: fileSize is used by updateProgress
-
-    const fileAdded = await node.add({
-      path: file.name,
-      content: file
-    }, {
-      wrapWithDirectory: true,
-      progress: updateProgress
-    })
-
-    // As we are wrapping the content we use that hash to keep
-    // the original file name when adding it to the table
-    $cidInput.value = fileAdded.cid.toString()
-
-    resetProgress()
-    await getFile()
-  }
-}
-
-/* ===========================================================================
-   Peers handling
-   =========================================================================== */
-
-async function connectToPeer (event) {
-  const multiaddr = $multiaddrInput.value
-
-  if (!multiaddr) {
-    throw new Error('No multiaddr was inserted.')
-  }
-
-  await node.swarm.connect(multiaddr)
-
-  onSuccess(`Successfully connected to peer.`)
-  $multiaddrInput.value = ''
-}
-
-async function refreshPeerList () {
-  const peers = await node.swarm.peers()
-
-  const peersAsHtml = peers.reverse()
-    .map((peer) => {
-      if (peer.addr) {
-        const addr = peer.addr.toString()
-
-        if (addr.indexOf('/p2p/') >= 0) {
-          return addr
-        } else {
-          return addr + '/p2p/' + peer.peer
-        }
-      }
-    })
-    .map((addr) => {
-      return `${addr}`
-    }).join('')
-
-  $peersList.innerHTML = peersAsHtml
-}
-
-async function refreshWorkspacePeerList () {
-  const peers = await node.pubsub.peers(workspace)
-
-  const peersAsHtml = peers.reverse()
-    .map((addr) => {
-      return `${addr}`
-    }).join('')
-
-  $workspacePeersList.innerHTML = peersAsHtml
-}
-
-/* ===========================================================================
-   Error handling
-   =========================================================================== */
-
-function onSuccess (msg) {
-  $logs.classList.add('success')
-  $logs.innerHTML = msg
-}
-
-function onError (err) {
-  console.log(err)
-  let msg = 'An error occured, check the dev console'
-
-  if (err.stack !== undefined) {
-    msg = err.stack
-  } else if (typeof err === 'string') {
-    msg = err
-  }
-
-  $logs.classList.remove('success')
-  $logs.innerHTML = msg
-}
-
-window.onerror = onError
-
-/* ===========================================================================
-   Boot the app
-   =========================================================================== */
-
-const startApplication = () => {
-  // Setup event listeners
-  $dragContainer.addEventListener('dragenter', onDragEnter)
-  $dragContainer.addEventListener('dragover', onDragEnter)
-  $dragContainer.addEventListener('drop', async e => {
-    try {
-      await onDrop(e)
-    } catch (err) {
-      err.message = `Failed to add files: ${err.message}`
-      onError(err)
-    }
-  })
-  $dragContainer.addEventListener('dragleave', onDragLeave)
-  $fetchButton.addEventListener('click', async () => {
-    try {
-      await getFile()
-    } catch (err) {
-      err.message = `Failed to fetch CID: ${err.message}`
-      onError(err)
-    }
-  })
-  $connectButton.addEventListener('click', async () => {
-    try {
-      await connectToPeer()
-    } catch (err) {
-      err.message = `Failed to connect to peer: ${err.message}`
-      onError(err)
-    }
-  })
-  $workspaceBtn.addEventListener('click', () => {
-    window.location.hash = $workspaceInput.value
-  })
-
-  start()
-}
-
-startApplication()
diff --git a/examples/browser-exchange-files/public/assets/download.svg b/examples/browser-exchange-files/public/assets/download.svg
deleted file mode 100644
index 23ed96c51f..0000000000
--- a/examples/browser-exchange-files/public/assets/download.svg
+++ /dev/null
@@ -1,44 +0,0 @@
-
-
-
-
-	
-		
-		
-	
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/examples/browser-exchange-files/public/assets/ipfs-logo.svg b/examples/browser-exchange-files/public/assets/ipfs-logo.svg
deleted file mode 100644
index 5091cce61e..0000000000
--- a/examples/browser-exchange-files/public/assets/ipfs-logo.svg
+++ /dev/null
@@ -1 +0,0 @@
-IPFS logo (new)
\ No newline at end of file
diff --git a/examples/browser-exchange-files/public/assets/upload.svg b/examples/browser-exchange-files/public/assets/upload.svg
deleted file mode 100644
index 6e2f818a24..0000000000
--- a/examples/browser-exchange-files/public/assets/upload.svg
+++ /dev/null
@@ -1,39 +0,0 @@
-
-
-
-
-	
-	
-	
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/examples/browser-exchange-files/public/favicon.ico b/examples/browser-exchange-files/public/favicon.ico
deleted file mode 100644
index 801f728c08..0000000000
Binary files a/examples/browser-exchange-files/public/favicon.ico and /dev/null differ
diff --git a/examples/browser-exchange-files/public/index.html b/examples/browser-exchange-files/public/index.html
deleted file mode 100644
index cbf8000c59..0000000000
--- a/examples/browser-exchange-files/public/index.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-  
-    
-    
-    IPFS - Exchange Files
-  
-
-  
-    
    
-      IPFS
-    
    
-
-    
    
-      
    
-        
    Node
    
-
-        
    
-          
    ID
    
-          
    
-        
    
-
-        
    
-          
    Addresses
    
-          
      
-        
      
-
-        
      
-          
      Logs
      
-          
      
-            
      Initializing node...
      
-          
      
-        
      
-
-        
      
-          
      Workspace
      
-          
      
-            
-            
-          
      
-        
      
-      
      
-
-
-      
      
-        
      
-          
      Workspace Peers
      
-
-          
-            
-              
-                
-              
-            
-            
-          
      Connected Peers
      
-
-          
      Network Peers
      
-
-          
      
-            
-            
-          
      
-
-          
-            
-              
-                
-              
-            
-            
-          
      Connected Peers
      
-        
      
-
-        
      
-          
      Files
      
-
-          
      
-            
-            
-          
      
-
-          
      
-            Upload
-            
      Drag & drop a file to upload it.
      
-          
      
-
-          
      
-            
      
-          
      
-
-          
-            
-              
-                
-                
-                
-              
-            
-            
-              
-                
-              
-            
-          
      NameCIDSize
      There are no files in this workspace.
      
-        
      
-      
      
-    
      
-
-    
-    
-  
-
diff --git a/examples/browser-exchange-files/test.js b/examples/browser-exchange-files/test.js
deleted file mode 100644
index f893098c17..0000000000
--- a/examples/browser-exchange-files/test.js
+++ /dev/null
@@ -1,203 +0,0 @@
-'use strict'
-
-const http = require('http')
-const fs = require('fs-extra')
-const path = require('path')
-const os = require('os')
-const execa = require('execa')
-const delay = require('delay')
-const { createFactory } = require('ipfsd-ctl')
-const df = createFactory({
-  ipfsModule: require('ipfs'),
-  ipfsHttpModule: require('ipfs-http-client')
-}, {
-  js: {
-    ipfsBin: require.resolve('ipfs/src/cli.js')
-  }
-})
-const {
-  startServer
-} = require('test-ipfs-example/utils')
-const pkg = require('./package.json')
-const webRTCStarSigServer = require('libp2p-webrtc-star/src/sig-server')
-
-const FILE_CONTENT = 'A file with some content'
-
-async function testUI (env) {
-  const proc = execa(require.resolve('test-ipfs-example/node_modules/.bin/nightwatch'), [ '--config', require.resolve('test-ipfs-example/nightwatch.conf.js'),  path.join(__dirname, 'test.js') ], {
-    cwd: path.resolve(__dirname, '../'),
-    env: {
-      ...process.env,
-      ...env,
-      CI: true
-    },
-    all: true
-  })
-  proc.all.on('data', (data) => {
-    process.stdout.write(data)
-  })
-
-  await proc
-}
-
-async function runTest () {
-  const sigServer = await webRTCStarSigServer.start({
-    host: '127.0.0.1',
-    port: 13579
-  })
-
-  const relay = await df.spawn({
-    type: 'js',
-    ipfsOptions: {
-      config: {
-        Addresses: {
-          Swarm: [
-            '/ip4/127.0.0.1/tcp/0/ws'
-          ]
-        }
-      }
-    }
-  })
-
-  const { cid } = await relay.api.add(FILE_CONTENT)
-
-  const server1 = await startServer(__dirname)
-  const server2 = await startServer(__dirname)
-
-  try {
-    const id = await relay.api.id()
-    const address = id.addresses
-      .map(ma => ma.toString())
-      .find(addr => addr.includes('/ws/p2p'))
-
-    if (!address) {
-      throw new Error(`Could not find web socket address in ${id.addresses}`)
-    }
-
-    const workspaceName = `test-${Math.random()}`
-    const peerA = path.join(os.tmpdir(), `test-${Date.now()}-a.txt`)
-    const peerB = path.join(os.tmpdir(), `test-${Date.now()}-b.txt`)
-
-    console.info('Relay address', address)
-
-    await Promise.all([
-      testUI({
-        IPFS_EXAMPLE_TEST_URL: server1.url,
-        IPFS_RELAY_ADDRESS: address,
-        IPFS_CID: cid,
-        IPFS_WORKSPACE_NAME: workspaceName,
-        IPFS_ADD_FILE: true,
-        IPFS_LOCAL_PEER_ID_FILE: peerA,
-        IPFS_REMOTE_PEER_ID_FILE: peerB
-      }),
-      testUI({
-        IPFS_EXAMPLE_TEST_URL: server1.url,
-        IPFS_RELAY_ADDRESS: address,
-        IPFS_CID: cid,
-        IPFS_WORKSPACE_NAME: workspaceName,
-        IPFS_LOCAL_PEER_ID_FILE: peerB,
-        IPFS_REMOTE_PEER_ID_FILE: peerA
-      })
-    ])
-  } finally {
-    await server2.stop()
-    await server1.stop()
-    await relay.stop()
-    await sigServer.stop()
-  }
-}
-
-module.exports = runTest
-
-module.exports[pkg.name] = function (browser) {
-  let localPeerId = null
-  let remotePeerId = null
-
-  browser
-    .url(process.env.IPFS_EXAMPLE_TEST_URL)
-    .waitForElementVisible('#connected-peers tr td')
-    .pause(1000)
-
-  console.info('dialling relay', process.env.IPFS_RELAY_ADDRESS)
-
-  browser
-    .clearValue('#multiaddr-input')
-    .setValue('#multiaddr-input', process.env.IPFS_RELAY_ADDRESS)
-    .pause(1000)
-    .click('#peer-btn')
-
-  const relayPeerId = process.env.IPFS_RELAY_ADDRESS.split('/').pop()
-
-  browser.expect.element('#connected-peers').text.to.contain(relayPeerId)
-
-  console.info('joining workspace', process.env.IPFS_WORKSPACE_NAME)
-
-  browser
-    .clearValue('#workspace-input')
-    .setValue('#workspace-input', process.env.IPFS_WORKSPACE_NAME)
-    .pause(1000)
-    .click('#workspace-btn')
-
-  // exchange peer info
-  browser.getText('.node-id', (result) => {
-    localPeerId = result.value.trim()
-    console.info('got local peer id', localPeerId)
-  })
-    .perform(async (browser, done) => {
-      console.info('writing local peer id')
-      await fs.writeFile(process.env.IPFS_LOCAL_PEER_ID_FILE, localPeerId)
-
-      console.info('reading remote peer id')
-      for (let i = 0; i < 100; i++) {
-        try {
-          remotePeerId = await fs.readFile(process.env.IPFS_REMOTE_PEER_ID_FILE, {
-            encoding: 'utf8'
-          })
-
-          console.info('got remote peer id', remotePeerId)
-          done()
-
-          break
-        } catch (err) {
-
-        }
-
-        await delay(1000)
-      }
-
-      console.info('waiting for remote peer', remotePeerId, 'to join workspace')
-      browser.expect.element('#workspace-peers').text.to.contain(remotePeerId)
-
-      await delay(1000)
-    })
-
-  // only one browser should add the file to the workspace
-  if (process.env.IPFS_ADD_FILE) {
-    browser
-      .clearValue('#cid-input')
-      .setValue('#cid-input', process.env.IPFS_CID)
-      .pause(1000)
-      .click('#fetch-btn')
-  }
-
-  browser.pause(1000)
-
-  // but should both see the added file
-  browser.expect.element('#file-history').text.to.contain(process.env.IPFS_CID)
-
-  if (!process.env.IPFS_ADD_FILE) {
-    // download the file from the other browser
-    browser
-      .getAttribute(`a[download=${process.env.IPFS_CID}]`, 'href', ({ value: url }) => {
-        browser.executeAsync(function (url, done) {
-          fetch(url)
-            .then(res => res.text())
-            .then(done, done)
-        }, [ url ], ({ value: contents }) => {
-          browser.expect(contents).to.equal(FILE_CONTENT)
-        })
-      })
-  }
-
-  browser.end()
-}
diff --git a/examples/browser-http-client-upload-file/README.md b/examples/browser-http-client-upload-file/README.md
deleted file mode 100644
index e05452b03a..0000000000
--- a/examples/browser-http-client-upload-file/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# Upload file to IPFS via browser using js-ipfs-http-client
-
-> In this example, you will find a simple React app to upload a file to IPFS via the browser using js-ipfs-http-client and Webpack.
-
-## Setup
-
-As for any js-ipfs-http-client example, **you need a running IPFS daemon**, you learn how to do that here:
-
-- [Spawn a go-ipfs daemon](https://ipfs.io/docs/getting-started/)
-- [Spawn a js-ipfs daemon](https://github.com/ipfs/js-ipfs#usage)
-
-**Note:** If you load your app from a different domain than the one the daemon is running (most probably), you will need to set up CORS, see https://github.com/ipfs/js-ipfs-http-client#cors to learn how to do that.
-
-A quick (and dirty way to get it done) is:
-
-```bash
-> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin "[\"*\"]"
-> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials "[\"true\"]"
-```
-
-## Run this example
-
-Once the daemon is on, run the following commands within this folder:
-
-```bash
-> npm install
-> npm start
-```
-After uploading a file (left screen), and opening the uploaded file (right screen), you should see something like:
-
-> ![App Screenshot](https://github.com/ipfs/js-ipfs-http-client/raw/master/examples/upload-file-via-browser/screenshot.png)
diff --git a/examples/browser-http-client-upload-file/index.html b/examples/browser-http-client-upload-file/index.html
deleted file mode 100644
index 172aecc6ed..0000000000
--- a/examples/browser-http-client-upload-file/index.html
+++ /dev/null
@@ -1,10 +0,0 @@
-
-  
-    Sample App
-  
-  
-    
      
-    
      
-    
-  
-
diff --git a/examples/browser-http-client-upload-file/package.json b/examples/browser-http-client-upload-file/package.json
deleted file mode 100644
index 9d2e4123f0..0000000000
--- a/examples/browser-http-client-upload-file/package.json
+++ /dev/null
@@ -1,31 +0,0 @@
-{
-  "name": "example-http-client-upload-file-via-browser",
-  "version": "1.0.0",
-  "description": "Upload file to IPFS via browser using js-ipfs-http-client with Webpack",
-  "private": true,
-  "scripts": {
-    "clean": "rimraf ./dist ./.cache ./.parcel-cache",
-    "build": "parcel build index.html --no-scope-hoist",
-    "start": "parcel index.html",
-    "test": "test-ipfs-example"
-  },
-  "author": "Harlan T Wood ",
-  "contributors": [
-    "Victor Bjelkholm "
-  ],
-  "license": "MIT",
-  "dependencies": {
-    "ipfs-http-client": "^50.1.1"
-  },
-  "devDependencies": {
-    "ipfs": "^0.55.3",
-    "parcel": "2.0.0-beta.2",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "rimraf": "^3.0.2",
-    "test-ipfs-example": "^3.0.0"
-  },
-  "browserslist": [
-    "last 2 versions and not dead and > 2%"
-  ]
-}
diff --git a/examples/browser-http-client-upload-file/screenshot.png b/examples/browser-http-client-upload-file/screenshot.png
deleted file mode 100644
index 09666e5160..0000000000
Binary files a/examples/browser-http-client-upload-file/screenshot.png and /dev/null differ
diff --git a/examples/browser-http-client-upload-file/src/App.js b/examples/browser-http-client-upload-file/src/App.js
deleted file mode 100644
index 852d963830..0000000000
--- a/examples/browser-http-client-upload-file/src/App.js
+++ /dev/null
@@ -1,109 +0,0 @@
-/* eslint-disable no-console */
-'use strict'
-
-const React = require('react')
-const { create: ipfsHttpClient } = require('ipfs-http-client')
-
-class App extends React.Component {
-  constructor () {
-    super()
-    this.state = {
-      added_file_hash: null
-    }
-
-    // bind methods
-    this.captureFile = this.captureFile.bind(this)
-    this.saveToIpfs = this.saveToIpfs.bind(this)
-    this.handleSubmit = this.handleSubmit.bind(this)
-    this.connect = this.connect.bind(this)
-    this.multiaddr = React.createRef()
-  }
-
-  captureFile (event) {
-    event.stopPropagation()
-    event.preventDefault()
-    if (document.getElementById('keep-filename').checked) {
-      this.saveToIpfsWithFilename(event.target.files)
-    } else {
-      this.saveToIpfs(event.target.files)
-    }
-  }
-
-  // Example #1
-  // Add file to IPFS and return a CID
-  async saveToIpfs ([ file ]) {
-    try {
-      const added = await this.state.ipfs.add(
-        file,
-        {
-          progress: (prog) => console.log(`received: ${prog}`)
-        }
-      )
-      console.log(added)
-      this.setState({ added_file_hash: added.cid.toString() })
-    } catch (err) {
-      console.error(err)
-    }
-  }
-
-  // Example #2
-  // Add file to IPFS and wrap it in a directory to keep the original filename
-  async saveToIpfsWithFilename ([ file ]) {
-    const fileDetails = {
-      path: file.name,
-      content: file
-    }
-    const options = {
-      wrapWithDirectory: true,
-      progress: (prog) => console.log(`received: ${prog}`)
-    }
-
-    try {
-      const added = await this.state.ipfs.add(fileDetails, options)
-      console.log(added)
-      this.setState({ added_file_hash: added.cid.toString() })
-    } catch (err) {
-      console.error(err)
-    }
-  }
-
-  handleSubmit (event) {
-    event.preventDefault()
-  }
-
-  async connect () {
-    this.setState({
-      ipfs: ipfsHttpClient(this.multiaddr.current.value)
-    })
-  }
-
-  render () {
-    if (this.state.ipfs) {
-      return (
-        
      
-          
      
-            
      
-            
-          
      
-          
-        
      
-      )
-    }
-
-    return (
-      
      
-        
      Enter the multiaddr for an IPFS node HTTP API
      
-        
      
-          
-          
-        
      
-      
      
-    )
-  }
-}
-module.exports = App
diff --git a/examples/browser-http-client-upload-file/src/index.js b/examples/browser-http-client-upload-file/src/index.js
deleted file mode 100644
index 2bd77c1df2..0000000000
--- a/examples/browser-http-client-upload-file/src/index.js
+++ /dev/null
@@ -1,7 +0,0 @@
-/* eslint-disable no-unused-vars */
-'use strict'
-const React = require('react')
-const ReactDOM = require('react-dom')
-const App = require('./App')
-
-ReactDOM.render(, document.getElementById('root'))
diff --git a/examples/browser-http-client-upload-file/test.js b/examples/browser-http-client-upload-file/test.js
deleted file mode 100644
index 837c48b4ea..0000000000
--- a/examples/browser-http-client-upload-file/test.js
+++ /dev/null
@@ -1,101 +0,0 @@
-'use strict'
-
-const path = require('path')
-const execa = require('execa')
-const { createFactory } = require('ipfsd-ctl')
-const df = createFactory({
-  ipfsHttpModule: require('ipfs-http-client'),
-  ipfsBin: require.resolve('ipfs/src/cli.js')
-})
-const {
-  startServer
-} = require('test-ipfs-example/utils')
-const pkg = require('./package.json')
-
-async function testUI (url, api, id) {
-  const proc = execa(require.resolve('test-ipfs-example/node_modules/.bin/nightwatch'), ['--config', require.resolve('test-ipfs-example/nightwatch.conf.js'), path.join(__dirname, 'test.js')], {
-    cwd: path.resolve(__dirname, '../'),
-    env: {
-      ...process.env,
-      CI: true,
-      IPFS_EXAMPLE_TEST_URL: url,
-      IPFS_API_MULTIADDR: api,
-      IPFS_ID: id
-    },
-    all: true
-  })
-  proc.all.on('data', (data) => {
-    process.stdout.write(data)
-  })
-
-  await proc
-}
-
-async function runTest () {
-  const app = await startServer(__dirname)
-  const daemon = await df.spawn({
-    type: 'js',
-    test: true,
-    ipfsOptions: {
-      config: {
-        Addresses: {
-          API: '/ip4/127.0.0.1/tcp/0'
-        },
-        API: {
-          HTTPHeaders: {
-            'Access-Control-Allow-Origin': [
-              app.url
-            ]
-          }
-        }
-      }
-    }
-  })
-
-  try {
-    await testUI(app.url, daemon.apiAddr, daemon.api.peerId.id)
-  } finally {
-    await daemon.stop()
-    await app.stop()
-  }
-}
-
-module.exports = runTest
-
-module.exports[pkg.name] = function (browser) {
-  browser
-    .url(process.env.IPFS_EXAMPLE_TEST_URL)
-    .waitForElementVisible('#connect-input')
-    .clearValue('#connect-input')
-    .setValue('#connect-input', process.env.IPFS_API_MULTIADDR)
-    .pause(1000)
-    .click('#connect-submit')
-
-  // upload file
-  browser
-    .waitForElementVisible('#capture-media')
-    .setValue('#input-file', require('path').resolve(__dirname + '/screenshot.png'))
-    .pause(1000)
-
-  browser.expect.element('#gateway-link').text.to.contain('QmWGmeq2kxsXqhrPhtTEhvck6PXucPf5153PSpZZRxvTwT')
-
-  browser
-    .url(process.env.IPFS_EXAMPLE_TEST_URL)
-    .waitForElementVisible('#connect-input')
-    .clearValue('#connect-input')
-    .setValue('#connect-input', process.env.IPFS_API_MULTIADDR)
-    .pause(1000)
-    .click('#connect-submit')
-
-  // upload file with file name
-  browser
-    .waitForElementVisible('#capture-media')
-    .click('#keep-filename')
-    .pause(1000)
-    .setValue('#input-file', require('path').resolve(__dirname + '/screenshot.png'))
-    .pause(1000)
-
-  browser.expect.element('#gateway-link').text.to.contain('QmPJw5AYXfbqYXRX51zmdm7itSdt5tAWfGLSehwAhizLqp')
-
-  browser.end()
-}
diff --git a/examples/browser-ipns-publish/.gitignore b/examples/browser-ipns-publish/.gitignore
deleted file mode 100644
index 46b007034c..0000000000
--- a/examples/browser-ipns-publish/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-bundle.js
-.cache
-/node_modules/
\ No newline at end of file
diff --git a/examples/browser-ipns-publish/README.md b/examples/browser-ipns-publish/README.md
deleted file mode 100644
index de26585fb0..0000000000
--- a/examples/browser-ipns-publish/README.md
+++ /dev/null
@@ -1,85 +0,0 @@
-# Publish to IPNS from the browser
-
-> Use ipns from the browser!
-
-This example is a demo web application that allows you to connect to a go-IPFS node, and publish your IPNS record to the go-DHT network but using your js-ipfs private key. We'll start two IPFS nodes; one in the browser and one on a go-Server. We'll use `ipfs-http-client` to connect to the go-Node to ensure our pubsub messages are getting through, and confirm the IPNS record resolves on the go-Node. We're aiming for something like this:
-
-```
-   +-----------+     websocket     +-----------+
-   |           +------------------->           |
-   |  js-ipfs  |      pubsub       |  go-ipfs  |
-   |           <-------------------+           |
-   +-----^-----+                   +-----^-----+
-         |                               |
-         | IPFS in browser               | HTTP API
-         |                               |
-+-------------------------------------------------+
-|                     Browser                     |
-+-------------------------------------------------+
-|                   |         |                   |
-|                   |         |                   |
-|  IPFS direct      |         |  js-http-client   |
-|  a.k.a. ipfsNode  |         |  a.k.a. ipfsAPI   |
-|                   |         |                   |
-+-------------------------------------------------+
-```
-
-## 1. Get started
-
-With Node.js and git installed, clone the repo and install the project dependencies:
-
-```sh
-git clone https://github.com/ipfs/js-ipfs.git
-cd examples/browser-ipns-publish
-npm install # Installs browser-pubsub app dependencies
-```
-
-Start the example application:
-
-```sh
-npm start
-```
-
-You should see something similar to the following in your terminal and the web app should now be available if you navigate to http://127.0.0.1:1234 using your browser:
-
-```sh
-Starting up http-server, serving ./
-Available on:
-  http://127.0.0.1:1234
-```
-
-## 2. Start two IPFS nodes
-
-The first node is the js-ipfs made in the browser and the demo does that for you.
-
-The second is a go-ipfs node on a server. To get our IPNS record to the DHT, we'll need [a server running go-IPFS](https://blog.ipfs.io/22-run-ipfs-on-a-vps/) with the API enabled on port 5001.
-
-Right now the easiest way to do this is to install and start a `go-ipfs` node.
-
-### Install and start the Go IPFS node
-
-Head over to https://dist.ipfs.io/#go-ipfs and hit the "Download go-ipfs" button. Extract the archive and read the instructions to install.
-
-After installation:
-
-```sh
-ipfs init
-# Configure CORS to allow ipfs-http-client to access this IPFS node
-ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin "[\"*\"]"
-# Configure go-ipfs to listen on a websocket address
-npx json -I -f ~/.ipfs/config -e "this.Addresses.Swarm.push('/ip4/127.0.0.1/tcp/4003/ws')"
-# Start the IPFS node, enabling pubsub and IPNS over pubsub
-ipfs daemon --enable-pubsub-experiment --enable-namesys-pubsub
-```
-
-## 3. Open the demo in a browser and connect to the go-node
-
-Now, open up the demo in a browser window.
-
-In the "CONNECT TO GO-IPFS VIA API MULTIADDRESS" field enter `/ip4/YourServerIP/tcp/5001` (where `YourSeverIP` is your server's IP address or use `/dns4/yourdomain.com/tcp/5001`) and click connect. Once it connects, put your go-IPFS websocket address in the next field `/dns4/yourdomain.com/tcp/4003/wss/p2p/QmPeerIDHash` and hit the second "Connect" button.
-
-This connects the API to the go-Node and connects your js-IPFS node via websocket to the go-IPFS node so pubsub will work.
-
-You can choose whether to publish this record under the PeerId of the node that is running in the browser ('self') or choose to add a custom key to the IPFS keychain and publish under that instead. Either should work.
-
-Finally, enter `/ipfs/QmSomeHash` as the content you want to publish to IPNS. You should see the messages sent from the browser to the server appear in the logs below, ending with "Success, resolved" if it all worked.
diff --git a/examples/browser-ipns-publish/index.html b/examples/browser-ipns-publish/index.html
deleted file mode 100644
index ce7c5c9187..0000000000
--- a/examples/browser-ipns-publish/index.html
+++ /dev/null
@@ -1,209 +0,0 @@
-
-
-  
-    Publish to IPNS from the browser
-    
-    
-  
-  
-    
      
-      
-        
-      
-      
      
-        IPNS Publish from JS to Go Peer
-      
      
-    
      
-    
      
-      
      
-        IPNS PUBLISH SET-UP STEPS
-      
      
-      
      
-        
      
-          
      
-            
      
-              Code repo for this demo
-              on Github
-            
      
-            
      
-              The idea is to publish from js-ipfs so you control your own
-              private keys, but publish to go-ipfs to benefit from the DHT.
-              Since the DHT in js-ipfs is still in the experimental phase, we need to use PubSub
-              and have a go-ipfs node subscribed to that PubSub to get our IPNS
-              record onto the DHT. In order to use PubSub between these two
-              nodes, you'll need a websocket to connect them.
-            
      
-            
      
-              To make this demo work, you're going to need:
-              
        
-                
      • 
-                  1. Access to a go-ipfs node and it's API, a-la
-                  
        /dns4/domain.com/tcp/5001
        
-                
        • 
-                
      • 
-                  This is how the demo talks to the server, to ensure things
-                  like:
-                
        • 
-                
          
-                  
        • 
-                    A) pubsub is enabled, { EXPERIMENTAL: { ipnsPubsub: true } }
-                    and --enable-pubsub-experiment
-                  
          • 
-                  
        • 
-                    B) go-ipfs is connected to the js-ipfs node in the browser,
-                    via node.swarm.peers(),
-                  
          • 
-                  
        • 
-                    C) the pubsub messages are getting through to the go node,
-                    via node.pubsub.subscribe().
-                  
          • 
-                
        
-              
      
-              
        
-                
      • 
-                  2. Access to a go-ipfs Websocket port, a-la
-                  
        /dns4/domain.com/tcp/4003/wss/p2p/QmTheDomainPeerId
        
-                
        • 
-                
      • 
-                  Since we need PubSub for IPNS to reach the go-IPFS node (and
-                  further replicate through the go-DHT network) we need to
-                  connect our pubsub enabled JS-IPFS node in the browser to our
-                  go-IPFS node on the server. The way we connect is via
-                  Websocket. See
-                  this example
-                  for reference.
-                
        • 
-              
      
-              
      
-                Once we can talk to go-IPFS and we're connected via Websocket,
-                then we can publish in our browser node, have the pubsub push it
-                to the go-IPFS server, and then check with the server that it's
-                confirmed as published. Once it's on the go-IPFS node it should
-                replicate throughout the rest of the DHT amongst the go-Nodes.
-              
      
-            
      
-          
      
-        
      
-      
      
-    
      
-    
      
-      
      
-        1. Connect to Go-IPFS via API MultiAddress
-      
      
-      
-      
-    
      
-    
      
-      
      
-        2. Connect to Go-IPFS via Websocket MultiAddress (for PubSub to work)
-      
      
-      
-      
-    
      
-
-    
      
-      
      
-        3. Choose a key:
-      
      
-      
      
-        
-      
      
-    
      
-    
      
-      
      
-        4. IPFS hash to publish
-      
      
-      
-      
-    
      
-
-    
      
-      
      Browser Console
      
-      
      
-    
      
-    
      
-      
      Server Console
      
-      
      
-    
      
-    
-  
-
diff --git a/examples/browser-ipns-publish/index.js b/examples/browser-ipns-publish/index.js
deleted file mode 100644
index e0e5ef72d2..0000000000
--- a/examples/browser-ipns-publish/index.js
+++ /dev/null
@@ -1,262 +0,0 @@
-"use strict";
-
-const IpfsHttpClient = require("ipfs-http-client");
-const ipns = require("ipns");
-const IPFS = require("ipfs");
-const pRetry = require("p-retry");
-const last = require("it-last");
-const cryptoKeys = require("human-crypto-keys"); // { getKeyPairFromSeed }
-const uint8ArrayToString = require('uint8arrays/to-string')
-const uint8ArrayFromString = require('uint8arrays/from-string')
-
-const { sleep, Logger, onEnterPress, catchAndLog } = require("./util");
-
-async function main() {
-  const apiUrlInput = document.getElementById("api-url");
-  const nodeConnectBtn = document.getElementById("node-connect");
-
-  const peerAddrInput = document.getElementById("peer-addr");
-  const wsConnectBtn = document.getElementById("peer-connect");
-
-  const ipnsInput = document.getElementById("topic");
-  const publishBtn = document.getElementById("publish");
-
-  const namespace = "/record/";
-  const retryOptions = {
-    retries: 5,
-  };
-
-  let log = Logger(document.getElementById("console"));
-  let sLog = Logger(document.getElementById("server-console"));
-  let keyName = "self";
-
-  let ipfsAPI; // remote server IPFS node
-  let ipfsBrowser; // local browser IPFS node
-  let peerId;
-
-  // init local browser node right away
-  log(`Browser IPFS getting ready...`);
-  ipfsBrowser = await IPFS.create({
-    pass: "01234567890123456789",
-    EXPERIMENTAL: { ipnsPubsub: true },
-  });
-  const { id } = await ipfsBrowser.id();
-  log(`Browser IPFS ready! Node id: ${id}`);
-  document.getElementById("api-url").disabled = false;
-  document.getElementById("node-connect").disabled = false;
-
-  async function nodeConnect(url) {
-    log(`Connecting to ${url}`);
-    ipfsAPI = IpfsHttpClient(url);
-    const { id, agentVersion } = await ipfsAPI.id();
-    peerId = id;
-    log(`Success!`);
-    log(`Version ${agentVersion}`);
-    log(`Peer ID ${id}`);
-    document.getElementById("peer-addr").disabled = false;
-    document.getElementById("peer-connect").disabled = false;
-  }
-
-  async function wsConnect(addr) {
-    if (!addr) throw new Error("Missing peer multiaddr");
-    if (!ipfsBrowser)
-      throw new Error("Wait for the local IPFS node to start first");
-    log(`Connecting to peer ${addr}`);
-    await ipfsBrowser.swarm.connect(addr);
-    log(`Success!`);
-    log("Listing swarm peers...");
-    await sleep();
-    const peers = await ipfsBrowser.swarm.peers();
-    peers.forEach((peer) => {
-      //console.log(`peer: ${JSON.stringify(peer, null, 2)}`);
-      const fullAddr = `${peer.addr}/ipfs/${peer.peer}`;
-      log(
-        `${fullAddr}`
-      );
-    });
-    log(`(${peers.length} peers total)`);
-    document.getElementById("topic").disabled = false;
-    document.getElementById("publish").disabled = false;
-  }
-
-  // Wait until a peer subscribes a topic
-  const waitForPeerToSubscribe = async (daemon, topic) => {
-    await pRetry(async () => {
-      const res = await daemon.pubsub.ls();
-
-      if (!res || !res.length || !res.includes(topic)) {
-        throw new Error("Could not find subscription");
-      }
-
-      return res[0];
-    }, retryOptions);
-  };
-
-  // wait until a peer know about other peer to subscribe a topic
-  const waitForNotificationOfSubscription = (daemon, topic, peerId) =>
-    pRetry(async () => {
-      const res = await daemon.pubsub.peers(topic);
-
-      if (!res || !res.length || !res.includes(peerId)) {
-        throw new Error("Could not find peer subscribing");
-      }
-    }, retryOptions);
-
-  async function subs(node, topic, tLog) {
-    tLog(`Subscribing to ${topic}`);
-    await node.pubsub.subscribe(
-      topic,
-      (msg) => {
-        const from = msg.from;
-        const seqno = msg.seqno.toString("hex");
-
-        tLog(
-          `${new Date(
-            Date.now()
-          ).toLocaleTimeString()}\n Message ${seqno} from ${from}`
-        );
-
-        let regex = "/record/";
-        if (topic.match(regex) ? topic.match(regex).length > 0 : false) {
-          tLog(
-            "\n#" +
-              ipns.unmarshal(msg.data).sequence.toString() +
-              ") Topic: " +
-              msg.topicIDs[0].toString()
-          );
-          tLog("Value:\n" + ipns.unmarshal(msg.data).value.toString());
-        } else {
-          try {
-            tLog(JSON.stringify(msg.data.toString(), null, 2));
-          } catch (_) {
-            tLog(msg.data.toString("hex"));
-          }
-        }
-      }
-    );
-  }
-
-  async function createKey(keyName) {
-    return new Promise(async (resolve, reject) => {
-      try {
-        // quick and dirty key gen, don't do this in real life
-        const key = await IPFS.multihashing.digest(
-          uint8ArrayFromString(keyName + Math.random().toString(36).substring(2)),
-          "sha2-256"
-        );
-        const keyPair = await cryptoKeys.getKeyPairFromSeed(key, "rsa");
-
-        // put it on the browser IPNS keychain and name it
-        await ipfsBrowser.key.import(keyName, keyPair.privateKey);
-        // now this key can be used to publish to this ipns publicKey
-        resolve(true);
-      } catch (err) {
-        console.log(`Error creating Key ${keyName}: \n ${err}`);
-        reject(false);
-      }
-    });
-  }
-
-  async function publish(content) {
-    if (!content) throw new Error("Missing ipns content to publish");
-    if (!ipfsAPI) throw new Error("Connect to a go-server node first");
-    if (!ipfsAPI.name.pubsub.state() || !ipfsBrowser.name.pubsub.state())
-      throw new Error(
-        "IPNS Pubsub must be enabled on bother peers, use --enable-namesys-pubsub"
-      );
-
-    log(`Publish to IPNS`); // subscribes the server to our IPNS topic
-
-    let browserNode = await ipfsBrowser.id();
-    let serverNode = await ipfsAPI.id();
-
-    // get which key this will be publish under, self or an imported custom key
-    keyName = document.querySelector('input[name="keyName"]:checked').value;
-    let keys = { name: "self", id: browserNode.id }; // default init
-
-    if (keyName != "self") {
-      if (!(await ipfsBrowser.key.list()).find((k) => k.name == keyName))
-        // skip if custom key exists already
-        await createKey(keyName);
-      let r = await ipfsBrowser.key.list();
-      keys = r.find((k) => k.name == keyName);
-      log(JSON.stringify(keys));
-    }
-
-    log(`Initial Resolve ${keys.id}`); // subscribes the server to our IPNS topic
-    last(ipfsAPI.name.resolve(keys.id, { stream: false })); // save the pubsub topic to the server to make them listen
-
-    // set up the topic from ipns key
-    let b58 = await IPFS.multihash.fromB58String(keys.id);
-    const ipnsKeys = ipns.getIdKeys(b58);
-    const topic = `${namespace}${uint8ArrayToString(ipnsKeys.routingKey, 'base64url')}`;
-
-    // subscribe and log on both nodes
-    await subs(ipfsBrowser, topic, log); // browserLog
-    await subs(ipfsAPI, topic, sLog); // serverLog
-
-    // confirm they are subscribed
-    await waitForPeerToSubscribe(ipfsAPI, topic); // confirm topic is on THEIR list  // API
-    await waitForNotificationOfSubscription(ipfsBrowser, topic, serverNode.id); // confirm they are on OUR list
-
-    let remList = await ipfsAPI.pubsub.ls(); // API
-    if (!remList.includes(topic))
-      sLog(`[Fail] !Pubsub.ls ${topic}`);
-    else sLog(`[Pass] Pubsub.ls`);
-
-    let remListSubs = await ipfsAPI.name.pubsub.subs(); // API
-    if (!remListSubs.includes(`/ipns/${keys.id}`))
-      sLog(`[Fail] !Name.Pubsub.subs ${keys.id}`);
-    else sLog(`[Pass] Name.Pubsub.subs`);
-
-    // publish will send a pubsub msg to the server to update their ipns record
-    log(`Publishing ${content} to ${keys.name} /ipns/${keys.id}`);
-    const results = await ipfsBrowser.name.publish(content, {
-      resolve: false,
-      key: keyName,
-    });
-    log(`Published ${results.name} to ${results.value}`); //
-
-    log(`Try resolve ${keys.id} on server through API`);
-
-    let name = await last(
-      ipfsAPI.name.resolve(keys.id, {
-        stream: false,
-      })
-    );
-    log(`Resolved: ${name}`);
-    if (name == content) {
-      log(`IPNS Publish Success!`);
-      log(
-        `Look at that! /ipns/${keys.id} resolves to ${content}`
-      );
-    } else {
-      log(
-        `Error, resolve did not match ${name} !== ${content}`
-      );
-    }
-  }
-
-  const onNodeConnectClick = catchAndLog(
-    () => nodeConnect(apiUrlInput.value),
-    log
-  );
-
-  apiUrlInput.addEventListener("keydown", onEnterPress(onNodeConnectClick));
-  nodeConnectBtn.addEventListener("click", onNodeConnectClick);
-
-  const onwsConnectClick = catchAndLog(
-    () => wsConnect(peerAddrInput.value),
-    log
-  );
-  peerAddrInput.addEventListener("keydown", onEnterPress(onwsConnectClick));
-  wsConnectBtn.addEventListener("click", onwsConnectClick);
-
-  const onPublishClick = catchAndLog(() => publish(ipnsInput.value), log);
-  ipnsInput.addEventListener("keydown", onEnterPress(onPublishClick));
-  publishBtn.addEventListener("click", onPublishClick);
-}
-
-main();
diff --git a/examples/browser-ipns-publish/package.json b/examples/browser-ipns-publish/package.json
deleted file mode 100644
index 681722aaa3..0000000000
--- a/examples/browser-ipns-publish/package.json
+++ /dev/null
@@ -1,45 +0,0 @@
-{
-  "name": "browser-ipns-publish",
-  "version": "1.0.0",
-  "description": "An example demonstrating publishing to IPNS in the browser",
-  "private": true,
-  "main": "index.js",
-  "scripts": {
-    "clean": "rimraf ./dist ./.cache ./.parcel-cache",
-    "build": "parcel build index.html --no-scope-hoist",
-    "start": "parcel index.html",
-    "test": "test-ipfs-example"
-  },
-  "author": "Doug Anderson",
-  "license": "MIT",
-  "dependencies": {
-    "human-crypto-keys": "^0.1.4",
-    "ipfs": "^0.55.3",
-    "ipfs-http-client": "^50.1.1",
-    "ipfs-utils": "^8.1.2",
-    "ipns": "^0.11.0",
-    "it-last": "^1.0.4",
-    "p-retry": "^4.2.0",
-    "uint8arrays": "^2.1.3"
-  },
-  "browserslist": [
-    "last 2 versions and not dead and > 2%"
-  ],
-  "devDependencies": {
-    "delay": "^5.0.0",
-    "execa": "^5.0.0",
-    "ipfsd-ctl": "^8.0.1",
-    "go-ipfs": "0.8.0",
-    "parcel": "2.0.0-beta.2",
-    "path": "^0.12.7",
-    "test-ipfs-example": "^3.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ipfs/js-ipfs/examples"
-  },
-  "keywords": [
-    "IPNS",
-    "Publish"
-  ]
-}
diff --git a/examples/browser-ipns-publish/test.js b/examples/browser-ipns-publish/test.js
deleted file mode 100644
index 2b6dece1ff..0000000000
--- a/examples/browser-ipns-publish/test.js
+++ /dev/null
@@ -1,138 +0,0 @@
-"use strict";
-
-const path = require("path");
-const execa = require("execa");
-const { createFactory } = require("ipfsd-ctl");
-const df = createFactory({
-  ipfsHttpModule: require("ipfs-http-client"),
-  ipfsBin: require("go-ipfs").path(),
-  args: [
-    "--enable-pubsub-experiment",
-    '--enable-namesys-pubsub'
-  ],
-  test: true
-});
-const { startServer } = require("test-ipfs-example/utils");
-const pkg = require("./package.json");
-
-async function testUI(url, apiAddr, peerAddr, topic) {
-  const proc = execa(
-    require.resolve("test-ipfs-example/node_modules/.bin/nightwatch"),
-    [
-      "--config",
-      require.resolve("test-ipfs-example/nightwatch.conf.js"),
-      path.join(__dirname, "test.js"),
-    ],
-    {
-      cwd: path.resolve(__dirname, "../"),
-      env: {
-        ...process.env,
-        CI: true,
-        IPFS_EXAMPLE_TEST_URL: url,
-        IPFS_API_ADDRESS: apiAddr,
-        IPFS_PEER_ADDRESS: peerAddr,
-        IPFS_TOPIC: topic,
-      },
-      all: true,
-    }
-  );
-  proc.all.on("data", (data) => {
-    process.stdout.write(data);
-  });
-
-  await proc;
-}
-
-async function runTest() {
-  const app = await startServer(__dirname);
-  const go = await df.spawn({
-    ipfsOptions: {
-      config: {
-        Addresses: {
-          API: "/ip4/127.0.0.1/tcp/0",
-          Swarm: [
-            "/ip4/127.0.0.1/tcp/0/ws"
-          ]
-        },
-        API: {
-          HTTPHeaders: {
-            "Access-Control-Allow-Origin": [app.url],
-          },
-        },
-      },
-    },
-  });
-
-  const go2 = await df.spawn();
-  await go.api.swarm.connect(go2.api.peerId.addresses[0]);
-
-  const { cid } = await go.api.add(`Some data ${Date.now()}`)
-  const topic = `/ipfs/${cid}`;
-
-  const peerAddr = go.api.peerId.addresses
-    .map(addr => addr.toString())
-    .filter(addr => addr.includes("/ws/p2p/"))
-    .pop()
-
-  try {
-    await testUI(
-      app.url,
-      go.apiAddr,
-      peerAddr,
-      topic
-    );
-  } finally {
-    await app.stop();
-    await df.clean();
-  }
-}
-
-module.exports = runTest;
-
-module.exports[pkg.name] = function (browser) {
-  const apiSelector = "#api-url:enabled";
-
-  // connect to the API
-  browser
-    .url(process.env.IPFS_EXAMPLE_TEST_URL)
-    .waitForElementVisible(apiSelector)
-    .clearValue(apiSelector)
-    .setValue(apiSelector, process.env.IPFS_API_ADDRESS)
-    .pause(1000)
-    .click("#node-connect");
-
-  browser.expect
-    .element("#console")
-    .text.to.contain(`Connecting to ${process.env.IPFS_API_ADDRESS}\nSuccess!`);
-
-  // connect via websocket
-  const peerAddrSelector = "#peer-addr:enabled";
-  browser
-    .waitForElementVisible(peerAddrSelector)
-    .clearValue(peerAddrSelector)
-    .setValue(peerAddrSelector, process.env.IPFS_PEER_ADDRESS)
-    .pause(1000)
-    .click("#peer-connect");
-
-  browser.expect
-    .element("#console")
-    .text.to.contain(
-      `Connecting to peer ${process.env.IPFS_PEER_ADDRESS}\nSuccess!`
-    );
-
-  // publish to IPNS
-  const publishSelector = "#topic:enabled";
-  browser
-    .waitForElementVisible(publishSelector)
-    .clearValue(publishSelector)
-    .setValue(publishSelector, process.env.IPFS_TOPIC)
-    .pause(1000)
-    .click("#publish");
-
-  browser.expect.element("#console").text.to.contain('Publish to IPNS');
-  browser.expect.element("#console").text.to.contain('Initial Resolve');
-  browser.expect.element("#console").text.to.contain('Published');
-  browser.expect.element("#console").text.to.contain(`IPNS Publish Success!`);
-
-  browser.end();
-};
diff --git a/examples/browser-ipns-publish/util.js b/examples/browser-ipns-publish/util.js
deleted file mode 100644
index e6aada61f8..0000000000
--- a/examples/browser-ipns-publish/util.js
+++ /dev/null
@@ -1,31 +0,0 @@
-exports.sleep = (ms = 1000) => new Promise(resolve => setTimeout(resolve, ms))
-
-exports.Logger = outEl => {
-  outEl.innerHTML = ''
-  return message => {
-    const container = document.createElement('div')
-    container.innerHTML = message
-    outEl.appendChild(container)
-    outEl.scrollTop = outEl.scrollHeight
-  }
-}
-
-exports.onEnterPress = fn => {
-  return e => {
-    if (event.which == 13 || event.keyCode == 13) {
-      e.preventDefault()
-      fn()
-    }
-  }
-}
-
-exports.catchAndLog = (fn, log) => {
-  return async (...args) => {
-    try {
-      await fn(...args)
-    } catch (err) {
-      console.error(err)
-      log(`${err.message}`)
-    }
-  }
-}
diff --git a/examples/browser-mfs/CHANGELOG.md b/examples/browser-mfs/CHANGELOG.md
deleted file mode 100644
index 6e4754a525..0000000000
--- a/examples/browser-mfs/CHANGELOG.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [1.0.2](https://github.com/ipfs/js-ipfs/compare/example-browser-mfs@1.0.1...example-browser-mfs@1.0.2) (2020-04-08)
-
-**Note:** Version bump only for package example-browser-mfs
-
-
-
-
-
-## 1.0.1 (2020-03-31)
-
-
-### Bug Fixes
-
-* browser-mfs example ([#2089](https://github.com/ipfs/js-ipfs/issues/2089)) ([e7d6d3a](https://github.com/ipfs/js-ipfs/commit/e7d6d3a8462e9692530bcd037a4dcd7a236eeae2))
diff --git a/examples/browser-mfs/README.md b/examples/browser-mfs/README.md
deleted file mode 100644
index 035b8ed276..0000000000
--- a/examples/browser-mfs/README.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# Mutable File System examples
-
-The MFS is a file system abstraction built on top of IPFS.  It supports all the operations you would expect such as creating directories, adding files to them, renaming, coping, deleting, etc.
-
-This demo allows you to upload files from your computer and use them to explore MFS methods from within your web browser.
-
-![screenshot](screenshot_1.png)
-
-![screenshot](screenshot_2.png)
-
-## Before you start
-
-First clone this repo, install dependencies in the project root and build the project.
-
-```console
-$ git clone https://github.com/ipfs/js-ipfs.git
-$ cd js-ipfs
-$ npm install
-$ npm run build
-```
-
-## Running the example
-
-Navigate into this directory:
-
-```
-$ cd js-ipfs/examples/browser-mfs
-```
-
-In this directory run:
-
-```
-$ npm start
-```
-
-Then open [http://localhost:8888](http://localhost:8888) in your browser.
diff --git a/examples/browser-mfs/filetree.js b/examples/browser-mfs/filetree.js
deleted file mode 100644
index e0ac293043..0000000000
--- a/examples/browser-mfs/filetree.js
+++ /dev/null
@@ -1,74 +0,0 @@
-'use strict'
-
-const {
-  createNode
-} = require('./utils')
-
-const FILE_TYPES = {
-  FILE: 'file',
-  DIRECTORY: 'directory'
-}
-
-let selected = {}
-
-const getSelected = () => {
-  return Object.values(selected)
-}
-
-const loadFiles = async (ipfs, path) => {
-  const output = {}
-  path = path.replace(/\/\/+/g, '/')
-
-  for await (const entry of ipfs.files.ls(path)) {
-    output[entry.name] = entry
-
-    if (entry.type === FILE_TYPES.DIRECTORY) {
-      entry.contents = await loadFiles(ipfs, `${path}/${entry.name}`)
-    }
-  }
-
-  return output
-}
-
-const listFiles = (parent, files, prefix) => {
-  const fileNames = Object.keys(files)
-
-  fileNames.forEach((name, index) => {
-    const file = files[name]
-    const lastFile = index === fileNames.length - 1
-    const listIcon = lastFile ? '└── ' : '├── '
-    const listing = `${prefix}${listIcon}${name}`
-
-    if (file.type === FILE_TYPES.DIRECTORY) {
-      parent.appendChild(createNode('pre', `${listing}/`))
-      let descender = '|'
-      let directoryPrefix = `${prefix}${descender}   `
-
-      if (lastFile) {
-        directoryPrefix = `${prefix}    `
-      }
-
-      listFiles(parent, file.contents, directoryPrefix)
-    } else {
-      parent.appendChild(createNode('pre', listing))
-    }
-  })
-}
-
-const updateTree = async (ipfs) => {
-  const files = await loadFiles(ipfs, '/')
-  const container = document.querySelector('#files')
-
-  while (container.firstChild) {
-    container.removeChild(container.firstChild)
-  }
-
-  container.appendChild(createNode('pre', '/'))
-
-  listFiles(container, files, '')
-}
-
-module.exports = {
-  getSelected,
-  updateTree
-}
diff --git a/examples/browser-mfs/forms.js b/examples/browser-mfs/forms.js
deleted file mode 100644
index 1af7552dbd..0000000000
--- a/examples/browser-mfs/forms.js
+++ /dev/null
@@ -1,178 +0,0 @@
-'use strict'
-
-const modalScreen = document.getElementById('modal-screen')
-
-modalScreen.onclick = (event) => {
-  if (event.target === modalScreen) {
-    hideForms()
-  }
-}
-
-const forms = {
-  mkdir: document.getElementById('form-mkdir'),
-  mv: document.getElementById('form-mv'),
-  cp: document.getElementById('form-cp'),
-  rm: document.getElementById('form-rm'),
-  stat: document.getElementById('form-stat'),
-  read: document.getElementById('form-read')
-}
-
-const getValue = (id) => {
-  const element = document.getElementById(id)
-
-  if (element.type === 'checkbox') {
-    return Boolean(element.checked)
-  }
-
-  if (element.type === 'number') {
-    const result = parseInt(element.value.trim())
-
-    return isNaN(result) ? undefined : result
-  }
-
-  return element.value.trim()
-}
-
-const hideForms = () => {
-  modalScreen.style.display = 'none'
-
-  Object.values(forms)
-    .forEach(form => {
-      form.style.display = 'none'
-    })
-}
-
-const showForm = (form) => {
-  return (event) => {
-    event.preventDefault()
-
-    modalScreen.style.display = 'block'
-    form.style.display = 'block'
-  }
-}
-
-const mkdirForm = (onMkdir) => {
-  const button = document.getElementById('button-mkdir')
-  const submit = document.getElementById('button-form-mkdir-submit')
-
-  button.onclick = showForm(forms.mkdir)
-  submit.onclick = () => {
-    hideForms()
-
-    onMkdir(
-      getValue('form-mkdir-path'),
-      getValue('form-mkdir-parents'),
-      getValue('form-mkdir-format'),
-      getValue('form-mkdir-hashalg'),
-      getValue('form-mkdir-flush')
-    )
-  }
-
-  button.disabled = false
-}
-
-const mvForm = (onMv) => {
-  const button = document.getElementById('button-mv')
-  const submit = document.getElementById('button-form-mv-submit')
-
-  button.onclick = showForm(forms.mv)
-  submit.onclick = () => {
-    hideForms()
-
-    onMv(
-      [getValue('form-mv-path')],
-      getValue('form-mv-dest'),
-      getValue('form-mv-parents'),
-      getValue('form-mv-format'),
-      getValue('form-mv-hashalg'),
-      getValue('form-mv-flush')
-    )
-  }
-
-  button.disabled = false
-}
-
-const cpForm = (onCp) => {
-  const button = document.getElementById('button-cp')
-  const submit = document.getElementById('button-form-cp-submit')
-
-  button.onclick = showForm(forms.cp)
-  submit.onclick = () => {
-    hideForms()
-
-    onCp(
-      [getValue('form-cp-path')],
-      getValue('form-cp-dest'),
-      getValue('form-cp-parents'),
-      getValue('form-cp-format'),
-      getValue('form-cp-hashalg'),
-      getValue('form-cp-flush')
-    )
-  }
-
-  button.disabled = false
-}
-
-const rmForm = (onRm) => {
-  const button = document.getElementById('button-rm')
-  const submit = document.getElementById('button-form-rm-submit')
-
-  button.onclick = showForm(forms.rm)
-  submit.onclick = () => {
-    hideForms()
-
-    onRm(
-      [getValue('form-rm-path')],
-      getValue('form-rm-recursive')
-    )
-  }
-
-  button.disabled = false
-}
-
-const statForm = (onStat) => {
-  const button = document.getElementById('button-stat')
-  const submit = document.getElementById('button-form-stat-submit')
-
-  button.onclick = showForm(forms.stat)
-  submit.onclick = () => {
-    hideForms()
-
-    onStat(
-      getValue('form-stat-path'),
-      getValue('form-stat-hash'),
-      getValue('form-stat-size'),
-      getValue('form-stat-withlocal')
-    )
-  }
-
-  button.disabled = false
-}
-
-const readForm = (onRead) => {
-  const button = document.getElementById('button-read')
-  const submit = document.getElementById('button-form-read-submit')
-
-  button.onclick = showForm(forms.read)
-  submit.onclick = () => {
-    hideForms()
-
-    onRead(
-      getValue('form-read-path'),
-      getValue('form-read-offset'),
-      getValue('form-read-length')
-    )
-  }
-
-  button.disabled = false
-}
-
-module.exports = {
-  mkdirForm,
-  mvForm,
-  rmForm,
-  cpForm,
-  statForm,
-  readForm,
-  hideForms
-}
diff --git a/examples/browser-mfs/index.html b/examples/browser-mfs/index.html
deleted file mode 100644
index 52cb4c8ebf..0000000000
--- a/examples/browser-mfs/index.html
+++ /dev/null
@@ -1,239 +0,0 @@
-
-
-  
-    
-    <%= htmlWebpackPlugin.options.title %>
-    
-  
-  
-    
      
-      
      
-        
-        
-        
-        
-        
-        
-      
      
-      
      
-        
      
-        
      
-      
      
-    
      
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-  
-
diff --git a/examples/browser-mfs/index.js b/examples/browser-mfs/index.js
deleted file mode 100644
index c08794abc3..0000000000
--- a/examples/browser-mfs/index.js
+++ /dev/null
@@ -1,179 +0,0 @@
-'use strict'
-
-/* eslint-env browser */
-
-const IPFS = require('ipfs')
-const {
-  dragDrop,
-  log,
-  bufferToArrayBuffer
-} = require('./utils')
-const {
-  updateTree
-} = require('./filetree')
-const {
-  mvForm,
-  mkdirForm,
-  rmForm,
-  cpForm,
-  statForm,
-  readForm,
-  hideForms
-} = require('./forms')
-const mime = require('mime-sniffer')
-
-document.addEventListener('DOMContentLoaded', async () => {
-  const ipfs = await IPFS.create({
-    repo: `ipfs-${Math.random()}`
-  })
-
-  hideForms()
-
-  log('IPFS: Initialising')
-
-  // Allow adding files to IPFS via drag and drop
-  dragDrop(async (files) => {
-    /* eslint-disable-next-line no-alert */
-    const destinationDirectory = prompt(`Dropped ${files.length} file${files.length > 1 ? 's' : ''}, please enter a directory to store them in`, '/')
-
-    if (!destinationDirectory || !`${destinationDirectory}`.trim()) {
-      return
-    }
-
-    await Promise.all(
-      files.map(file => {
-        const path = `${destinationDirectory}/${file.name}`.replace(/\/\/+/g, '/')
-        log(`ipfs.files.write('${path}', , { create: true, parents: true })`)
-        return ipfs.files.write(path, file, {
-          create: true,
-          parents: true
-        })
-          .catch(error => log(error))
-      })
-    )
-
-    updateTree(ipfs)
-  })
-
-  mkdirForm(async (path, parents, format, hashAlg, flush) => {
-    log(`ipfs.files.mkdir('${path}', ${JSON.stringify({
-      parents,
-      format,
-      hashAlg,
-      flush
-    }, null, 2)})`)
-
-    await ipfs.files.mkdir(path, {
-      parents,
-      format,
-      hashAlg,
-      flush
-    })
-      .catch(error => log(error))
-
-    updateTree(ipfs)
-  })
-
-  mvForm(async (paths, destination, parents, format, hashAlg, flush) => {
-    log(`ipfs.files.mv(${paths.map(path => `'${path}'`).join(', ')}, ${JSON.stringify({
-      parents,
-      format,
-      hashAlg,
-      flush
-    }, null, 2)})`)
-
-    await ipfs.files.mv.apply(null, paths.concat(destination, {
-      parents,
-      format,
-      hashAlg,
-      flush
-    }))
-      .catch(error => log(error))
-
-    updateTree(ipfs)
-  })
-
-  rmForm(async (paths, recursive) => {
-    log(`ipfs.files.rm(${paths.map(path => `'${path}'`).join(', ')}, ${JSON.stringify({
-      recursive
-    }, null, 2)})`)
-
-    await ipfs.files.rm.apply(null, paths.concat({
-      recursive
-    }))
-      .catch(error => log(error))
-
-    updateTree(ipfs)
-  })
-
-  cpForm(async (paths, destination, parents, format, hashAlg, flush) => {
-    log(`ipfs.files.cp(${paths.map(path => `'${path}'`).join(', ')}, '${destination}', ${JSON.stringify({
-      parents,
-      format,
-      hashAlg,
-      flush
-    }, null, 2)})`)
-
-    await ipfs.files.cp.apply(null, paths.concat(destination, {
-      parents,
-      format,
-      hashAlg,
-      flush
-    }))
-      .catch(error => log(error))
-
-    updateTree(ipfs)
-  })
-
-  statForm(async (path, hash, size, withLocal) => {
-    log(`ipfs.files.stat('${path}', ${JSON.stringify({
-      hash,
-      size,
-      withLocal
-    }, null, 2)})`)
-
-    await ipfs.files.stat(path, {
-      hash,
-      size,
-      withLocal
-    })
-      .then((stats) => log(stats))
-      .catch(error => log(error))
-  })
-
-  readForm(async (path, offset, length) => {
-    log(`ipfs.files.read('${path}', ${JSON.stringify({
-      offset,
-      length
-    }, null, 2)})`)
-
-    await ipfs.files.read(path, {
-      offset,
-      length
-    })
-      .then((buffer) => {
-        mime.lookup(buffer, (error, result) => {
-          // will cause file to be downloaded if we don't know what it is
-          let mimeType = 'application/octet-stream'
-
-          if (!error) {
-            mimeType = result.mime
-          }
-
-          const data = bufferToArrayBuffer(buffer)
-          const file = new Blob([data], {
-            type: mimeType
-          })
-          const fileURL = URL.createObjectURL(file)
-          window.open(fileURL)
-        })
-      })
-      .catch(error => log(error))
-  })
-
-  log('IPFS: Ready')
-  log('IPFS: Drop some files into this window to get started')
-  log('')
-
-  updateTree(ipfs)
-})
diff --git a/examples/browser-mfs/package.json b/examples/browser-mfs/package.json
deleted file mode 100644
index e619189b72..0000000000
--- a/examples/browser-mfs/package.json
+++ /dev/null
@@ -1,28 +0,0 @@
-{
-  "name": "example-browser-mfs",
-  "description": "",
-  "version": "1.0.2",
-  "main": "index.js",
-  "private": true,
-  "scripts": {
-    "clean": "rimraf ./dist",
-    "build": "webpack",
-    "start": "npm run build && http-server dist -a 127.0.0.1 -p 8888",
-    "test": "test-ipfs-example"
-  },
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "html-webpack-plugin": "^5.3.1",
-    "http-server": "^0.12.3",
-    "node-polyfill-webpack-plugin": "^1.0.3",
-    "rimraf": "^3.0.2",
-    "test-ipfs-example": "^3.0.0",
-    "webpack": "^5.28.0",
-    "webpack-cli": "^4.5.0"
-  },
-  "dependencies": {
-    "ipfs": "^0.55.3",
-    "mime-sniffer": "~0.0.3"
-  }
-}
diff --git a/examples/browser-mfs/screenshot_1.png b/examples/browser-mfs/screenshot_1.png
deleted file mode 100644
index bf8a6ca226..0000000000
Binary files a/examples/browser-mfs/screenshot_1.png and /dev/null differ
diff --git a/examples/browser-mfs/screenshot_2.png b/examples/browser-mfs/screenshot_2.png
deleted file mode 100644
index e2e41a33bb..0000000000
Binary files a/examples/browser-mfs/screenshot_2.png and /dev/null differ
diff --git a/examples/browser-mfs/test.js b/examples/browser-mfs/test.js
deleted file mode 100644
index 59f88a0460..0000000000
--- a/examples/browser-mfs/test.js
+++ /dev/null
@@ -1,47 +0,0 @@
-'use strict'
-
-const pkg = require('./package.json')
-
-module.exports = {
-  [pkg.name]: function (browser) {
-    browser
-      .url(process.env.IPFS_EXAMPLE_TEST_URL)
-      .waitForElementNotVisible('#modal-screen')
-      .waitForElementVisible('#log')
-
-    browser.expect.element('#log').text.to.contain('IPFS: Drop some files into this window to get started')
-
-    browser.waitForElementVisible('#button-mkdir')
-      .click('#button-mkdir')
-      .waitForElementVisible('#form-mkdir-path')
-      .clearValue('#form-mkdir-path')
-      .setValue('#form-mkdir-path', '/folder')
-      .click('#button-form-mkdir-submit')
-
-    browser.expect.element('#files').text.to.contain('folder/')
-
-    browser.click('#button-cp')
-      .waitForElementVisible('#form-cp-path')
-      .clearValue('#form-cp-path')
-      .setValue('#form-cp-path', '/folder')
-      .clearValue('#form-cp-dest')
-      .setValue('#form-cp-dest', '/folder-copy')
-      .click('#button-form-cp-submit')
-
-    browser.expect.element('#files').text.to.contain('folder-copy/')
-
-    browser.click('#button-mv')
-      .waitForElementVisible('#form-mv-path')
-      .clearValue('#form-mv-path')
-      .setValue('#form-mv-path', '/folder')
-      .clearValue('#form-mv-dest')
-      .setValue('#form-mv-dest', '/folder-other')
-      .click('#button-form-mv-submit')
-
-    browser.expect.element('#files').text.to.not.contain('folder/')
-    browser.expect.element('#files').text.to.contain('folder-other/')
-
-    browser.end()
-  }
-}
-
diff --git a/examples/browser-mfs/utils.js b/examples/browser-mfs/utils.js
deleted file mode 100644
index 5499a06792..0000000000
--- a/examples/browser-mfs/utils.js
+++ /dev/null
@@ -1,92 +0,0 @@
-'use strict'
-
-const createNode = (type, content, attrbutes) => {
-  attrbutes = attrbutes || {}
-
-  const node = document.createElement(type)
-  node.innerText = content
-
-  Object.keys(attrbutes).forEach(attrbute => {
-    if (attrbute === 'className') {
-      node.className = attrbutes[attrbute]
-
-      return
-    }
-
-    node.setAttribute(attrbute, attrbutes[attrbute])
-  })
-
-  return node
-}
-
-const log = (line) => {
-  const output = document.querySelector('#log')
-  let message
-  let className = ''
-
-  if (line instanceof Error) {
-    className = 'error'
-    message = `Error: ${line.message}`
-  } else if (typeof line === 'string') {
-    message = line
-  } else {
-    className = 'output'
-    message = JSON.stringify(line, null, 2)
-  }
-
-  if (!message) {
-    return
-  }
-
-  const node = createNode('p', message, {
-    className
-  })
-  output.appendChild(node)
-  output.scrollTop = output.offsetHeight
-
-  return node
-}
-
-const dragDrop = (onFiles) => {
-  const container = document.querySelector('#container')
-
-  container.ondragover = (event) => {
-    container.className = 'drag-over'
-    event.preventDefault()
-  }
-
-  container.ondragleave = () => {
-    container.className = ''
-  }
-
-  container.ondrop = (event) => {
-    container.className = ''
-    event.preventDefault()
-
-    const files = Array.from(event.dataTransfer.items)
-      .map(item => item.getAsFile())
-      .filter(item => Boolean(item))
-
-    if (files.length) {
-      onFiles(files)
-    }
-  }
-}
-
-const bufferToArrayBuffer = (buffer) => {
-  const ab = new ArrayBuffer(buffer.length)
-  const view = new Uint8Array(ab)
-
-  for (let i = 0; i < buffer.length; ++i) {
-    view[i] = buffer[i]
-  }
-
-  return ab
-}
-
-module.exports = {
-  log,
-  dragDrop,
-  createNode,
-  bufferToArrayBuffer
-}
diff --git a/examples/browser-mfs/webpack.config.js b/examples/browser-mfs/webpack.config.js
deleted file mode 100644
index 95c414f71a..0000000000
--- a/examples/browser-mfs/webpack.config.js
+++ /dev/null
@@ -1,33 +0,0 @@
-'use strict'
-
-const path = require('path')
-const webpack = require('webpack')
-const NodePolyfillPlugin = require('node-polyfill-webpack-plugin')
-const HtmlWebpackPlugin = require('html-webpack-plugin')
-
-module.exports = {
-  devtool: 'eval',
-  entry: [
-    './index.js'
-  ],
-  output: {
-    path: path.join(__dirname, 'dist'),
-    filename: 'bundle.js'
-  },
-  plugins: [
-    new HtmlWebpackPlugin({
-      title: 'IPFS MFS example',
-      template: 'index.html'
-    }),
-    // fixes Module not found: Error: Can't resolve 'stream' in '.../node_modules/nofilter/lib'
-    new NodePolyfillPlugin(),
-    // Note: stream-browserify has assumption about `Buffer` global in its
-    // dependencies causing runtime errors. This is a workaround to provide
-    // global `Buffer` until https://github.com/isaacs/core-util-is/issues/29
-    // is fixed.
-    new webpack.ProvidePlugin({
-      Buffer: ['buffer', 'Buffer'],
-      process: 'process/browser'
-    })
-  ]
-}
diff --git a/examples/browser-parceljs/CHANGELOG.md b/examples/browser-parceljs/CHANGELOG.md
deleted file mode 100644
index 3dff5b21f2..0000000000
--- a/examples/browser-parceljs/CHANGELOG.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [1.0.2](https://github.com/ipfs/js-ipfs/compare/example-browser-parceljs@1.0.1...example-browser-parceljs@1.0.2) (2020-04-08)
-
-**Note:** Version bump only for package example-browser-parceljs
-
-
-
-
-
-## 1.0.1 (2020-03-31)
-
-**Note:** Version bump only for package example-browser-parceljs
diff --git a/examples/browser-parceljs/README.md b/examples/browser-parceljs/README.md
deleted file mode 100644
index ef016c0d2f..0000000000
--- a/examples/browser-parceljs/README.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# Bundle js-ipfs with [Parcel.js](https://parceljs.org/)
-
-> In this example, you will find a boilerplate application that connects to
-IPFS using JS-IPFS and is bundled with [Parcel.js](https://parceljs.org/), so
-that you can follow it for creating Parcel.js bundled js-ipfs DApps.
-
-## Before you start
-
-First clone this repo, install dependencies in the project root and build the project.
-
-```console
-$ git clone https://github.com/ipfs/js-ipfs.git
-$ cd js-ipfs
-$ npm install
-$ npm run build
-```
-
-## Running the example
-
-1. Start your IPFS daemon of choice e.g. `ipfs daemon` (optional if you do not
-want to serve the example over IPFS)
-1. Open a new terminal
-1. `cd` into this folder
-
-## Running this example in development mode with auto-reloading
-
-1. `npm start`
-1. Open your browser at `http://localhost:1234`
-
-You should see the following:
-
-![](https://ipfs.io/ipfs/QmSiZ18GffagbbJ3z72kK7u3SP9MXqBB1vrU1KFYP3GMYs/1.png)
-
-## Build and add to IPFS
-
-1. Clear the contents of `dist` if this is not the first time you are building
-e.g. `rm -r dist` on a unix system
-1. `npm run build`
-1. The production build of the site is now in the `dist` folder
-1. Add the folder to ipfs using your IPFS client of choice e.g.
-`ipfs add -r dist`
-
-The last hash output is the hash of the directory.  This can be used to access
-this example served over IPFS and will be accessible by a public gateway:
-
-> https://ipfs.io/ipfs//
-
-
diff --git a/examples/browser-parceljs/img/1.png b/examples/browser-parceljs/img/1.png
deleted file mode 100644
index 733256c37f..0000000000
Binary files a/examples/browser-parceljs/img/1.png and /dev/null differ
diff --git a/examples/browser-parceljs/package.json b/examples/browser-parceljs/package.json
deleted file mode 100644
index 03ebf6debf..0000000000
--- a/examples/browser-parceljs/package.json
+++ /dev/null
@@ -1,29 +0,0 @@
-{
-  "name": "example-browser-parceljs",
-  "description": "",
-  "version": "1.0.2",
-  "main": "dist/index.html",
-  "private": true,
-  "browserslist": [
-    "last 2 versions and not dead and > 2%"
-  ],
-  "scripts": {
-    "clean": "rimraf ./dist ./.cache ./.parcel-cache",
-    "lint": "standard public/**/*.js",
-    "start": "parcel public/index.html",
-    "build": "parcel build public/index.html --no-scope-hoist",
-    "test": "test-ipfs-example"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "ipfs": "^0.55.3"
-  },
-  "devDependencies": {
-    "parcel": "2.0.0-beta.2",
-    "rimraf": "^3.0.2",
-    "standard": "^16.0.3",
-    "test-ipfs-example": "^3.0.0"
-  }
-}
diff --git a/examples/browser-parceljs/public/index.html b/examples/browser-parceljs/public/index.html
deleted file mode 100644
index 5431174d89..0000000000
--- a/examples/browser-parceljs/public/index.html
+++ /dev/null
@@ -1,23 +0,0 @@
-
-
-
-
-  
-    
-    js-ipfs parcel.js browser example
-  
-
-  
-    
      
-      
      Connecting to IPFS...
      
-    
      
-
-    
      
-      
      
-    
      
-
-    
-
-  
-
-
diff --git a/examples/browser-parceljs/public/index.js b/examples/browser-parceljs/public/index.js
deleted file mode 100644
index b75b54e601..0000000000
--- a/examples/browser-parceljs/public/index.js
+++ /dev/null
@@ -1,39 +0,0 @@
-import IPFS from 'ipfs'
-import uint8ArrayConcat from 'uint8arrays/concat'
-import uint8ArrayToString from 'uint8arrays/to-string'
-
-document.addEventListener('DOMContentLoaded', async () => {
-  // IPFS node setup
-  const node = await IPFS.create({ repo: String(Math.random() + Date.now()) })
-
-  // UI elements
-  const status = document.getElementById('status')
-  const output = document.getElementById('output')
-
-  output.textContent = ''
-
-  function log (txt) {
-    console.info(txt)
-    output.textContent += `${txt.trim()}\n`
-  }
-
-  status.innerText = 'Connected to IPFS :)'
-
-  const version = await node.version()
-
-  log(`The IPFS node version is ${version.version}`)
-
-  const entry = await node.add({
-    path: 'hello-parcel.txt',
-    content: 'Hello from parcel.js bundled ipfs example'
-  })
-  log(`This page deployed ${entry.path} to IPFS and its CID is ${entry.cid}`)
-
-  const buffers = []
-
-  for await (const buf of node.cat(entry.cid)) {
-    buffers.push(buf)
-  }
-
-  log(`The contents of the file was: ${uint8ArrayToString(uint8ArrayConcat(buffers))}`)
-})
diff --git a/examples/browser-parceljs/test.js b/examples/browser-parceljs/test.js
deleted file mode 100644
index ad5f99558a..0000000000
--- a/examples/browser-parceljs/test.js
+++ /dev/null
@@ -1,15 +0,0 @@
-'use strict'
-
-const pkg = require('./package.json')
-
-module.exports = {
-  [pkg.name]: function (browser) {
-    browser
-      .url(process.env.IPFS_EXAMPLE_TEST_URL)
-      .waitForElementVisible('#output')
-
-    browser.expect.element('#output').text.to.contain('The contents of the file was: Hello from parcel.js bundled ipfs example')
-
-    browser.end()
-  }
-}
diff --git a/examples/browser-readablestream/CHANGELOG.md b/examples/browser-readablestream/CHANGELOG.md
deleted file mode 100644
index a9504adfe0..0000000000
--- a/examples/browser-readablestream/CHANGELOG.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [2.0.1](https://github.com/ipfs/js-ipfs/compare/example-browser-readablestream@2.0.0...example-browser-readablestream@2.0.1) (2020-04-08)
-
-**Note:** Version bump only for package example-browser-readablestream
-
-
-
-
-
-# 2.0.0 (2020-03-31)
-
-
-### Bug Fixes
-
-* examples after files API refactor ([#1740](https://github.com/ipfs/js-ipfs/issues/1740)) ([34ec036](https://github.com/ipfs/js-ipfs/commit/34ec036b0df9563a014c1348f0a056c1f98aadad))
-
-
-### Code Refactoring
-
-* export types and utilities statically ([#1908](https://github.com/ipfs/js-ipfs/issues/1908)) ([79d7fef](https://github.com/ipfs/js-ipfs/commit/79d7fef7d28c0e0405fb69af149ff09681ac4273))
-
-
-### Features
-
-* Allows for byte offsets when using ipfs.files.cat and friends to request slices of files ([a93971a](https://github.com/ipfs/js-ipfs/commit/a93971a8905358a291b2cf3724df32382b05f5ce))
-
-
-### BREAKING CHANGES
-
-* `ipfs.util.isIPFS` and `ipfs.util.crypto` have moved to static exports and should be accessed via `const { isIPFS, crypto } = require('ipfs')`.
-
-The modules available under `ipfs.types.*` have also become static exports.
-
-License: MIT
-Signed-off-by: Alan Shaw 
diff --git a/examples/browser-readablestream/README.md b/examples/browser-readablestream/README.md
deleted file mode 100644
index c4d02907a5..0000000000
--- a/examples/browser-readablestream/README.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Streaming video from IPFS using ReadableStreams
-
-We can use the excellent [`videostream`](https://www.npmjs.com/package/videostream) to stream video from IPFS to the browser.  All we need to do is return a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)-like object that contains the requested byte ranges.
-
-Take a look at [`index.js`](./index.js) to see a working example.
-
-## Before you start
-
-First clone this repo, install dependencies in the project root and build the project.
-
-```console
-$ git clone https://github.com/ipfs/js-ipfs.git
-$ cd js-ipfs
-$ npm install
-$ npm run build
-```
-
-## Running the example
-
-In this directory:
-
-```
-$ npm start
-```
-
-Then open [http://localhost:8888](http://localhost:8888) in your browser.
diff --git a/examples/browser-readablestream/index.html b/examples/browser-readablestream/index.html
deleted file mode 100644
index ba1e63b87e..0000000000
--- a/examples/browser-readablestream/index.html
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
-  
-    
-    <%= htmlWebpackPlugin.options.title %>
-    
-  
-  
-    
      
-      
      
-          
      
-            
-            
-          
      
-          
-      
      
-      
      
-    
      
-  
-
diff --git a/examples/browser-readablestream/index.js b/examples/browser-readablestream/index.js
deleted file mode 100644
index 9ada153084..0000000000
--- a/examples/browser-readablestream/index.js
+++ /dev/null
@@ -1,79 +0,0 @@
-'use strict'
-
-/* eslint-env browser */
-
-const Ipfs = require('ipfs')
-const VideoStream = require('videostream')
-const toStream = require('it-to-stream')
-const {
-  dragDrop,
-  statusMessages,
-  createVideoElement,
-  log
-} = require('./utils')
-
-document.addEventListener('DOMContentLoaded', async () => {
-  const ipfs = await Ipfs.create({ repo: 'ipfs-' + Math.random() })
-
-  log('IPFS: Initialising')
-
-  // Set up event listeners on the