Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swift-libp2p/swift-libp2p-identify
Peer Identification Protocols (Embedded)
https://github.com/swift-libp2p/swift-libp2p-identify
identify ipfs libp2p p2p swift
Last synced: 1 day ago
JSON representation
Peer Identification Protocols (Embedded)
- Host: GitHub
- URL: https://github.com/swift-libp2p/swift-libp2p-identify
- Owner: swift-libp2p
- Created: 2022-06-21T16:06:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T15:54:52.000Z (over 1 year ago)
- Last Synced: 2024-11-25T10:46:32.120Z (2 months ago)
- Topics: identify, ipfs, libp2p, p2p, swift
- Language: Swift
- Homepage:
- Size: 74.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Identify (Embedded)
[](https://breth.app)
[](http://libp2p.io/)
[](https://github.com/apple/swift-package-manager)
> A core set of protocols used for `Identify`ing peers within libp2p
## Table of Contents
- [Overview](#overview)
- [Install](#install)
- [Usage](#usage)
- [Example](#example)
- [API](#api)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Overview
Identify consists of a set of protocols used to help identify remote peers within the libp2p ecosystem. The protocols included within Identify are...
- /ipfs/id
- This protocol exchanges Signed Peer Records used for confirming a remote Peer is who they claim to be, the addresses they're listening on and the protocols they speak.
- /ipfs/id/push
- An extension of `/ipfs/id` that pushes changes to a Peers listening addresses and protocols as they update in realtime.
- /ipfs/id/delta
- An extension of `/ipfs/id` that pushes `delta` (partial) Peer Records that contain changes since an initial `/ipfs/id` Peer Record exchange
- /ipfs/ping
- A ping protocol that allows for quick and easy pings to libp2p Peers for measuring latency, testing liveness/connectivity, etc.
#### Heads up ‼️
- This package is embedded into [swift-libp2p](https://github.com/swift-libp2p/swift-libp2p) . There's no need to include this package as a dependency in your swift-libp2p project.
#### For more details see
- [Multiformats / Mulitbase Spec](https://github.com/multiformats/multibase/blob/master/README.md)
## Install
#### Heads up ‼️
- This package is embedded into [swift-libp2p](https://github.com/swift-libp2p/swift-libp2p) . There's no need to include this package as a dependency in your swift-libp2p project.
Include the following dependency in your Package.swift file
```Swift
let package = Package(
...
dependencies: [
...
.package(url: "https://github.com/swift-libp2p/swift-libp2p-identify.git", .upToNextMajor(from: "0.0.1"))
],
...
.target(
...
dependencies: [
...
.product(name: "LibP2PIdentify", package: "swift-libp2p-identify"),
]),
...
)
```
## Usage
#### Heads up ‼️
- This package is embedded into [swift-libp2p](https://github.com/swift-libp2p/swift-libp2p) . There's no need to include this package as a dependency in your swift-libp2p project.
```Swift
/// Tell swift-libp2p to use Identify (the standard swift-libp2p implementation does this automatically)
app.identityManager.use(.default)
```
### Example
```Swift
/// Manually ping a peer
app.identify.ping(peer: PeerID).map {
print("Latency: \($0)")
}
/// Manually ping a multiaddr
app.identify.ping(addr: Multiaddr).map {
print("Latency: \($0)")
}
```
### API
```Swift
/// Attempts to Ping a Peer, returns the time it took to receive a response.
public func ping(peer:PeerID) -> EventLoopFuture
/// Attempts to Ping a Multiaddr, returns the time it took to receive a response.
public func ping(addr:Multiaddr) -> EventLoopFuture
```
## Contributing
Contributions are welcomed! This code is very much a proof of concept. I can guarantee you there's a better / safer way to accomplish the same results. Any suggestions, improvements, or even just critques, are welcome!
Let's make this code better together! 🤝
## Credits
- [Identify Spec](https://github.com/libp2p/specs/blob/master/identify/README.md)
## License
[MIT](LICENSE) © 2022 Breth Inc.