This repository has been archived by the owner on Jun 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Splits each interface area into it's own module so we can release breaking changes to (for example) the pubsub interface without also having to upgrade single transport module to the new `@libp2p/interfaces` major. Fixes: #226 BREAKING CHANGE: most modules have been split out of the `@libp2p/interfaces` and `@libp2p/interface-compliance-tests` packages
- Loading branch information
1 parent
24bcae0
commit 7e9caeb
Showing
383 changed files
with
5,982 additions
and
14,668 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # @libp2p/interface-address-manager <!-- omit in toc --> | ||
|
|
||
| [](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml) | ||
|
|
||
| > Address Manager interface for libp2p | ||
| ## Table of contents <!-- omit in toc --> | ||
|
|
||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
| - [Contribution](#contribution) | ||
|
|
||
| ## Install | ||
|
|
||
| ```console | ||
| $ npm i @libp2p/interface-address-manager | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```js | ||
| import type { AddressManager } from '@libp2p/interfaces-address-manager' | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under either of | ||
|
|
||
| - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>) | ||
| - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>) | ||
|
|
||
| ### Contribution | ||
|
|
||
| Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...p-interfaces/src/address-manager/index.ts → ...es/interface-address-manager/src/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # @libp2p/interface-compliance-tests <!-- omit in toc --> | ||
|
|
||
| [](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml) | ||
|
|
||
| > Compliance tests for JS libp2p interfaces | ||
| ## Table of contents <!-- omit in toc --> | ||
|
|
||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
| - [Contribution](#contribution) | ||
|
|
||
| ## Install | ||
|
|
||
| ```console | ||
| $ npm i @libp2p/interface-compliance-tests | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Each [interface](https://npmjs.org/packages/@libp2p/interfaces) has its documentation on how to use the compliance tests and should be used as the source of truth. | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under either of | ||
|
|
||
| - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>) | ||
| - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>) | ||
|
|
||
| ### Contribution | ||
|
|
||
| Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # @libp2p/interface-connection-compliance-tests <!-- omit in toc --> | ||
|
|
||
| [](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml) | ||
|
|
||
| > Compliance tests for implementations of the libp2p Connection interface | ||
| ## Table of contents <!-- omit in toc --> | ||
|
|
||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
| - [Contribution](#contribution) | ||
|
|
||
| ## Install | ||
|
|
||
| ```console | ||
| $ npm i @libp2p/interface-connection-compliance-tests | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| This is a test suite and interface you can use to implement a connection. The connection interface contains all the metadata associated with it, as well as an array of the streams opened through this connection. In the same way as the connection, a stream contains properties with its metadata, plus an iterable duplex object that offers a mechanism for writing and reading data, with back pressure. This module and test suite were heavily inspired by abstract-blob-store and interface-stream-muxer. | ||
|
|
||
| The primary goal of this module is to enable developers to pick, swap or upgrade their connection without losing the same API expectations and mechanisms such as back pressure and the ability to half close a connection. | ||
|
|
||
| Publishing a test suite as a module lets multiple modules ensure compatibility since they use the same test suite. | ||
|
|
||
| ```js | ||
| import tests from '@libp2p/interface-connection-compliance-tests' | ||
|
|
||
| describe('your connection', () => { | ||
| tests({ | ||
| // Options should be passed to your connection | ||
| async setup (options) { | ||
| return YourConnection | ||
| }, | ||
| async teardown () { | ||
| // cleanup resources created by setup() | ||
| } | ||
| }) | ||
| }) | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under either of | ||
|
|
||
| - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>) | ||
| - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>) | ||
|
|
||
| ### Contribution | ||
|
|
||
| Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
Oops, something went wrong.