Skip to content

Commit

Permalink
chore: update project
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain committed Oct 7, 2024
1 parent 5b5b06f commit 1a49861
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ updates:
schedule:
interval: daily
time: "10:00"
open-pull-requests-limit: 10
open-pull-requests-limit: 20
commit-message:
prefix: "deps"
prefix-development: "deps(dev)"
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @libp2p/amino-dht-bootstrapper <!-- omit in toc -->
# @libp2p/amino-dht-bootstrapper

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
Expand All @@ -7,33 +7,26 @@

> Run an Amino DHT boostrapper with js-libp2p
## Table of contents <!-- omit in toc -->
# Install

- [Bootstrap details](#bootstrap-details)
- [Requirements of a bootstrap node](#requirements-of-a-bootstrap-node)
- [Start the bootstrapper](#start-the-bootstrapper)
- [RPC API](#rpc-api)
- [Configuring bootstrapper options](#configuring-bootstrapper-options)
- [Building the Docker Image](#building-the-docker-image)
- [Running the docker image (once built):](#running-the-docker-image-once-built)
- [Running the docker image with monitoring:](#running-the-docker-image-with-monitoring)
- [License](#license)
- [Contribution](#contribution)
```console
$ npm i @libp2p/amino-dht-bootstrapper
```

## Bootstrap details

EPIC tracking issue: https://github.com/protocol/bifrost-infra/issues/2778
EPIC tracking issue: <https://github.com/protocol/bifrost-infra/issues/2778>

Find more info at https://github.com/protocol/bifrost-infra/blob/master/docs/bootstrap.md
Find more info at <https://github.com/protocol/bifrost-infra/blob/master/docs/bootstrap.md>

Rust bootstrapper: https://github.com/libp2p/rust-libp2p/tree/master/misc/server
Rust bootstrapper: <https://github.com/libp2p/rust-libp2p/tree/master/misc/server>

### Requirements of a bootstrap node

* The Peer IDs of the default bootstrap nodes are set explicitly, to assert that you only trust a specific peer at a given ip or dns entry.
* This makes it harder for attackers to spoof or otherwise MITM attack, as they would also have to compromise our infrastructure to steal the private key behind the Peer ID.
* Defaults
* The default addresses for the bootstrap nodes are set in the ipfs/go-ipfs-config configuration
- The Peer IDs of the default bootstrap nodes are set explicitly, to assert that you only trust a specific peer at a given ip or dns entry.
- This makes it harder for attackers to spoof or otherwise MITM attack, as they would also have to compromise our infrastructure to steal the private key behind the Peer ID.
- Defaults
- The default addresses for the bootstrap nodes are set in the ipfs/go-ipfs-config configuration

## Start the bootstrapper

Expand Down Expand Up @@ -144,13 +137,13 @@ $ docker run -v $(pwd)/bootstrapper-config.json:/config.json -p 8888:8888 -it am
$ docker compose --profile dashboard up -d
```

## License
# 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>)
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-amino-dht-bootstrapper/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-amino-dht-bootstrapper/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

## Contribution
# 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.
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
"bugs": {
"url": "https://github.com/libp2p/js-libp2p-amino-dht-bootstrapper/issues"
},
"publishConfig": {
"access": "public",
"provenance": true
},
"bin": {
"amino": "./bin/amino.js",
"health-check": "./bin/amino-health-check.js"
Expand All @@ -33,6 +37,7 @@
"eslintConfig": {
"extends": "ipfs",
"parserOptions": {
"project": true,
"sourceType": "module"
}
},
Expand Down

0 comments on commit 1a49861

Please sign in to comment.