Merge branch 'master' into master

.github/workflows/go-check.yml

@@ -1,73 +1,18 @@
-# File managed by web3-bot. DO NOT EDIT.
-# See https://github.com/protocol/.github/ for details.
-
-on: [push, pull_request]
 name: Go Checks
 
+on:
+  pull_request:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  unit:
-    runs-on: ubuntu-latest
-    name: All
-    env:
-      RUNGOGENERATE: false
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: recursive
-      - uses: actions/setup-go@v2
-        with:
-          go-version: "1.18.x"
-      - name: Run repo-specific setup
-        uses: ./.github/actions/go-check-setup
-        if: hashFiles('./.github/actions/go-check-setup') != ''
-      - name: Read config
-        if: hashFiles('./.github/workflows/go-check-config.json') != ''
-        run: |
-          if jq -re .gogenerate ./.github/workflows/go-check-config.json; then
-            echo "RUNGOGENERATE=true" >> $GITHUB_ENV
-          fi
-      - name: Install staticcheck
-        run: go install honnef.co/go/tools/cmd/staticcheck@d7e217c1ff411395475b2971c0824e1e7cc1af98 # 2022.1 (v0.3.0)
-      - name: Check that go.mod is tidy
-        uses: protocol/[email protected]
-        with:
-          run: |
-            go mod tidy
-            if [[ -n $(git ls-files --other --exclude-standard --directory -- go.sum) ]]; then
-              echo "go.sum was added by go mod tidy"
-              exit 1
-            fi
-            git diff --exit-code -- go.sum go.mod
-      - name: gofmt
-        if: ${{ success() || failure() }} # run this step even if the previous one failed
-        run: |
-          out=$(gofmt -s -l .)
-          if [[ -n "$out" ]]; then
-            echo $out | awk '{print "::error file=" $0 ",line=0,col=0::File is not gofmt-ed."}'
-            exit 1
-          fi
-      - name: go vet
-        if: ${{ success() || failure() }} # run this step even if the previous one failed
-        uses: protocol/[email protected]
-        with:
-          run: go vet ./...
-      - name: staticcheck
-        if: ${{ success() || failure() }} # run this step even if the previous one failed
-        uses: protocol/[email protected]
-        with:
-          run: |
-            set -o pipefail
-            staticcheck ./... | sed -e 's@\(.*\)\.go@./\1.go@g'
-      - name: go generate
-        uses: protocol/[email protected]
-        if: (success() || failure()) && env.RUNGOGENERATE == 'true'
-        with:
-          run: |
-            git clean -fd # make sure there aren't untracked files / directories
-            go generate ./...
-            # check if go generate modified or added any files
-            if ! $(git add . && git diff-index HEAD --exit-code --quiet); then
-              echo "go generated caused changes to the repository:"
-              git status --short
-              exit 1
-            fi
+  go-check:
+    uses: ipdxco/unified-github-workflows/.github/workflows/[email protected]

.github/workflows/go-test.yml

@@ -1,68 +1,20 @@
-# File managed by web3-bot. DO NOT EDIT.
-# See https://github.com/protocol/.github/ for details.
-
-on: [push, pull_request]
 name: Go Test
 
+on:
+  pull_request:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  unit:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ "ubuntu", "windows", "macos" ]
-        go: [ "1.17.x", "1.18.x" ]
-    env:
-      COVERAGES: ""
-    runs-on: ${{ format('{0}-latest', matrix.os) }}
-    name: ${{ matrix.os }} (go ${{ matrix.go }})
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: recursive
-      - uses: actions/setup-go@v2
-        with:
-          go-version: ${{ matrix.go }}
-      - name: Go information
-        run: |
-          go version
-          go env
-      - name: Use msys2 on windows
-        if: ${{ matrix.os == 'windows' }}
-        shell: bash
-        # The executable for msys2 is also called bash.cmd
-        #   https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md#shells
-        # If we prepend its location to the PATH
-        #   subsequent 'shell: bash' steps will use msys2 instead of gitbash
-        run: echo "C:/msys64/usr/bin" >> $GITHUB_PATH
-      - name: Run repo-specific setup
-        uses: ./.github/actions/go-test-setup
-        if: hashFiles('./.github/actions/go-test-setup') != ''
-      - name: Run tests
-        uses: protocol/[email protected]
-        with:
-          # Use -coverpkg=./..., so that we include cross-package coverage.
-          # If package ./A imports ./B, and ./A's tests also cover ./B,
-          # this means ./B's coverage will be significantly higher than 0%.
-          run: go test -v -coverprofile=module-coverage.txt -coverpkg=./... ./...
-      - name: Run tests (32 bit)
-        if: ${{ matrix.os != 'macos' }} # can't run 32 bit tests on OSX.
-        uses: protocol/[email protected]
-        env:
-          GOARCH: 386
-        with:
-          run: |
-            export "PATH=${{ env.PATH_386 }}:$PATH"
-            go test -v ./...
-      - name: Run tests with race detector
-        if: ${{ matrix.os == 'ubuntu' }} # speed things up. Windows and OSX VMs are slow
-        uses: protocol/[email protected]
-        with:
-          run: go test -v -race ./...
-      - name: Collect coverage files
-        shell: bash
-        run: echo "COVERAGES=$(find . -type f -name 'module-coverage.txt' | tr -s '\n' ',' | sed 's/,$//')" >> $GITHUB_ENV
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
-        with:
-          files: '${{ env.COVERAGES }}'
-          env_vars: OS=${{ matrix.os }}, GO=${{ matrix.go }}
+  go-test:
+    uses: ipdxco/unified-github-workflows/.github/workflows/[email protected]
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release-check.yml

@@ -1,11 +1,19 @@
-# File managed by web3-bot. DO NOT EDIT.
-# See https://github.com/protocol/.github/ for details.
-
 name: Release Checker
+
 on:
-  pull_request:
+  pull_request_target:
     paths: [ 'version.json' ]
+    types: [ opened, synchronize, reopened, labeled, unlabeled ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   release-check:
-    uses: protocol/.github/.github/workflows/release-check.yml@master
+    uses: ipdxco/unified-github-workflows/.github/workflows/release-check.yml@v1.0

.github/workflows/releaser.yml

@@ -1,11 +1,17 @@
-# File managed by web3-bot. DO NOT EDIT.
-# See https://github.com/protocol/.github/ for details.
-
 name: Releaser
+
 on:
   push:
     paths: [ 'version.json' ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.sha }}
+  cancel-in-progress: true
 
 jobs:
   releaser:
-    uses: protocol/.github/.github/workflows/releaser.yml@master
+    uses: ipdxco/unified-github-workflows/.github/workflows/releaser.yml@v1.0

.github/workflows/stale.yml

@@ -0,0 +1,13 @@
+name: Close and mark stale issue
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    uses: pl-strflt/.github/.github/workflows/[email protected]

.github/workflows/tagpush.yml

@@ -1,12 +1,18 @@
-# File managed by web3-bot. DO NOT EDIT.
-# See https://github.com/protocol/.github/ for details.
-
 name: Tag Push Checker
+
 on:
   push:
     tags:
       - v*
 
+permissions:
+  contents: read
+  issues: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   releaser:
-    uses: protocol/.github/.github/workflows/tagpush.yml@master
+    uses: ipdxco/unified-github-workflows/.github/workflows/tagpush.yml@v1.0

CODEOWNERS

@@ -0,0 +1,15 @@
+# CODEOWNERS
+
+# default owner is the libp2p team
+*.go @libp2p/go-libp2p-maintainers @guillaumemichel
+/pb/ @libp2p/go-libp2p-maintainers @guillaumemichel
+
+# dual is an application for IPFS
+/dual/ @libp2p/kubo-maintainers @guillaumemichel
+# fullrt is IPFS specific
+/fullrt/ @libp2p/kubo-maintainers @guillaumemichel
+# providers describe the IPFS specific providers
+/providers/ @libp2p/kubo-maintainers @guillaumemichel
+# records are IPFS specific
+/records.go @libp2p/kubo-maintainers @guillaumemichel
+/records_test.go @libp2p/kubo-maintainers @guillaumemichel

README.md

@@ -2,18 +2,18 @@
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
 [![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io)
-[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23yellow)
 [![GoDoc](https://godoc.org/github.com/libp2p/go-libp2p-kad-dht?status.svg)](https://godoc.org/github.com/libp2p/go-libp2p-kad-dht)
-[![Build Status](https://travis-ci.org/libp2p/go-libp2p-kad-dht.svg?branch=master)](https://travis-ci.org/libp2p/go-libp2p-kad-dht)
 [![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
 
-> A Kademlia DHT implementation on go-libp2p
+> A Go implementation of [libp2p Kademlia DHT specification](https://github.com/libp2p/specs/tree/master/kad-dht)
 
 ## Table of Contents
 
 - [Install](#install)
 - [Usage](#usage)
+- [Optimizations](#optimizations)
 - [Contribute](#contribute)
+- [Maintainers](#maintainers)
 - [License](#license)
 
 ## Install
@@ -22,6 +22,10 @@
 go get github.com/libp2p/go-libp2p-kad-dht
 ```
 
+## Optimizations
+
+Client-side optimizations are described in [optimizations.md](./optimizations.md)
+
 ## Usage
 
 Go to https://godoc.org/github.com/libp2p/go-libp2p-kad-dht.
@@ -32,12 +36,16 @@ Contributions welcome. Please check out [the issues](https://github.com/libp2p/g
 
 Check out our [contributing document](https://github.com/libp2p/community/blob/master/CONTRIBUTE.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
-Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+<!-- Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. -->
 
-## License
+## Maintainers
 
-[MIT](LICENSE) © Protocol Labs Inc.
+- [@ipfs/kubo-maintainers](https://github.com/orgs/ipfs/teams/kubo-maintainers)
+- [@libp2p/go-libp2p-maintainers](https://github.com/orgs/libp2p/teams/go-libp2p-maintainers)
+- [@guillaumemichel](https://github.com/guillaumemichel)
 
----
+See [CODEOWNERS](./CODEOWNERS).
 
-The last gx published version of this module was: 4.4.34: QmXuNFLZc6Nb5akB4sZsxK3doShsFKT1sZFvxLXJvZQwAW
+## License
+
+[MIT](LICENSE) © Protocol Labs Inc.

amino/defaults.go

@@ -0,0 +1,57 @@
+// Package amino provides protocol parameters and suggested default values for the [Amino DHT].
+//
+// [Amino DHT] is an implementation of the Kademlia distributed hash table (DHT) algorithm,
+// originally designed for use in IPFS (InterPlanetary File System) network.
+// This package defines key constants and protocol identifiers used in the Amino DHT implementation.
+//
+// [Amino DHT]: https://probelab.io/ipfs/amino/
+package amino
+
+import (
+	"time"
+
+	"github.com/libp2p/go-libp2p/core/protocol"
+)
+
+const (
+	// ProtocolPrefix is the base prefix for Amono DHT protocols.
+	ProtocolPrefix protocol.ID = "/ipfs"
+
+	// ProtocolID is the latest protocol identifier for the Amino DHT.
+	ProtocolID protocol.ID = "/ipfs/kad/1.0.0"
+
+	// DefaultBucketSize is the Amino DHT bucket size (k in the Kademlia paper).
+	// It represents the maximum number of peers stored in each
+	// k-bucket of the routing table.
+	DefaultBucketSize = 20
+
+	// DefaultConcurrency is the suggested number of concurrent requests (alpha
+	// in the Kademlia paper) for a given query path in Amino DHT. It
+	// determines how many parallel lookups are performed during network
+	// traversal.
+	DefaultConcurrency = 10
+
+	// DefaultResiliency is the suggested number of peers closest to a target
+	// that must have responded in order for a given query path to complete in
+	// Amino DHT. This helps ensure reliable results by requiring multiple
+	// confirmations.
+	DefaultResiliency = 3
+
+	// DefaultProvideValidity is the default time that a Provider Record should
+	// last on Amino DHT before it needs to be refreshed or removed. This value
+	// is also known as Provider Record Expiration Interval.
+	DefaultProvideValidity = 48 * time.Hour
+
+	// DefaultProviderAddrTTL is the TTL to keep the multi addresses of
+	// provider peers around. Those addresses are returned alongside provider.
+	// After it expires, the returned records will require an extra lookup, to
+	// find the multiaddress associated with the returned peer id.
+	DefaultProviderAddrTTL = 24 * time.Hour
+)
+
+var (
+	// Protocols is a slice containing all supported protocol IDs for Amino DHT.
+	// Currently, it only includes the main ProtocolID, but it's defined as a slice
+	// to allow for potential future protocol versions or variants.
+	Protocols = []protocol.ID{ProtocolID}
+)