Skip to content
This repository was archived by the owner on Dec 18, 2023. It is now read-only.

refactor: rename iroh -> beetle #307

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ jobs:

# - name: build release
# run: |
# cargo build --profile optimized-release -p iroh -p iroh-gateway -p iroh-p2p -p iroh-store -p iroh-one
# cargo build --profile optimized-release -p beetle -p beetle-gateway -p beetle-p2p -p beetle-store -p beetle-one

# - name: Setup awscli on linux
# if: matrix.name == 'ubuntu-latest'
Expand Down Expand Up @@ -243,20 +243,20 @@ jobs:
# - name: push release
# if: matrix.os != 'windows-latest'
# run: |
# aws s3 cp ./target/optimized-release/iroh-gateway s3://vorc/iroh-gateway-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/iroh-p2p s3://vorc/iroh-p2p-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/iroh-store s3://vorc/iroh-store-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/iroh s3://vorc/iroh-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/iroh-one s3://vorc/iroh-one-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/beetle-gateway s3://vorc/beetle-gateway-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/beetle-p2p s3://vorc/beetle-p2p-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/beetle-store s3://vorc/beetle-store-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/beetle s3://vorc/beetle-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress
# aws s3 cp ./target/optimized-release/beetle-one s3://vorc/beetle-one-${RELEASE_OS}-${RELEASE_ARCH}-${GITHUB_SHA::7} --no-progress

# - name: push release latest
# if: matrix.os != 'windows-latest'
# run: |
# aws s3 cp ./target/optimized-release/iroh-gateway s3://vorc/iroh-gateway-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/iroh-p2p s3://vorc/iroh-p2p-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/iroh-store s3://vorc/iroh-store-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/iroh s3://vorc/iroh-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/iroh-one s3://vorc/iroh-one-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/beetle-gateway s3://vorc/beetle-gateway-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/beetle-p2p s3://vorc/beetle-p2p-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/beetle-store s3://vorc/beetle-store-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/beetle s3://vorc/beetle-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress
# aws s3 cp ./target/optimized-release/beetle-one s3://vorc/beetle-one-${RELEASE_OS}-${RELEASE_ARCH}-latest --no-progress

coverage:
name: Coverage
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/target
/iroh_gateway/test_files/*
/beetle_gateway/test_files/*
.env
Cargo.lock
367 changes: 0 additions & 367 deletions CHANGELOG.md

This file was deleted.

10 changes: 5 additions & 5 deletions CONTRIBUTOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ the effort we can spend fixing issues and adding new features, by not reporting
## <a name="submit-pr"></a> Pull Request Submission Guidelines
Before you submit your pull request consider the following guidelines:

* Search [GitHub](https://github.com/n0-computer/iroh/pulls) for an open or closed Pull Request
* Search [GitHub](https://github.com/n0-computer/beetle/pulls) for an open or closed Pull Request
that relates to your submission. You don't want to duplicate effort.
* Create the [development environment][developers.setup]
* Make your changes in a new git branch:
Expand All @@ -99,7 +99,7 @@ Before you submit your pull request consider the following guidelines:
git push origin my-fix-branch
```

* In GitHub, send a pull request to ` iroh:main`.
* In GitHub, send a pull request to ` beetle:main`.
* Follow our [Pull Request Guidelines](developers.prs) to understand who to tag for review and how best to merge your work.

* If we suggest changes, then:
Expand Down Expand Up @@ -139,13 +139,13 @@ from the main (upstream) repository:
git pull --ff upstream main
```

[coc]: https://github.com/n0-computer/iroh/blob/main/code_of_conduct.md
[coc]: https://github.com/n0-computer/beetle/blob/main/code_of_conduct.md
[developers]: DEVELOPERS.md
[developers.setup]: DEVELOPERS.md#setup
[developers.commits]: DEVELOPERS.md#commits
[developers.rules]: DEVELOPERS.md#rules
[github-issues]: https://github.com/n0-computer/iroh/issues
[github]: https://github.com/n0-computer/iroh
[github-issues]: https://github.com/n0-computer/beetle/issues
[github]: https://github.com/n0-computer/beetle
[jsfiddle]: http://jsfiddle.net/
[plunker]: http://plnkr.co/edit

Expand Down
68 changes: 34 additions & 34 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@
members = [
"examples/embed",
"examples/importer",
"iroh",
"iroh-api",
"iroh-bitswap",
"iroh-car",
"iroh-embed",
"iroh-gateway",
"iroh-localops",
"iroh-metrics",
"iroh-one",
"iroh-p2p",
"iroh-resolver",
"iroh-rpc-client",
"iroh-rpc-types",
"iroh-share",
"iroh-unixfs",
"iroh-store",
"iroh-util",
"beetle",
"beetle-api",
"beetle-bitswap",
"beetle-car",
"beetle-embed",
"beetle-gateway",
"beetle-localops",
"beetle-metrics",
"beetle-one",
"beetle-p2p",
"beetle-resolver",
"beetle-rpc-client",
"beetle-rpc-types",
"beetle-share",
"beetle-unixfs",
"beetle-store",
"beetle-util",
"xtask",
]
# even if all crates are set to edition 2021, we still need to force the
Expand All @@ -31,7 +31,7 @@ version = "0.2.0"
edition = "2021"
license = "Apache-2.0/MIT"
rust-version = "1.65"
repository = "https://github.com/n0-computer/iroh"
repository = "https://github.com/n0-computer/beetle"

[workspace.dependencies]
# We prefer to place all dependencies for our workspace crates here.
Expand Down Expand Up @@ -90,22 +90,22 @@ hyper = "0.14.23"
ignore = "0.4.18"
indicatif = "0.17.1"
integer-encoding = "3.0"
iroh = { version = "0.2.0", path = "./iroh" }
iroh-api = { version = "0.2.0", path = "./iroh-api" }
iroh-bitswap = { version = "0.2.0", path = "./iroh-bitswap" }
iroh-car = { version = "0.2.0", path = "./iroh-car" }
iroh-embed = { version = "0.2.0", path = "./iroh-embed" }
iroh-gateway = { version = "0.2.0", path = "./iroh-gateway" }
iroh-localops = { version = "0.2.0", path = "./iroh-localops" }
iroh-metrics = { version = "0.2.0", path = "./iroh-metrics" }
iroh-one = { version = "0.2.0", path = "./iroh-one" }
iroh-p2p = { version = "0.2.0", path = "./iroh-p2p" }
iroh-resolver = { version = "0.2.0", path = "./iroh-resolver" }
iroh-rpc-client = { version = "0.2.0", path = "./iroh-rpc-client" }
iroh-rpc-types = { version = "0.2.0", path = "./iroh-rpc-types" }
iroh-store = { version = "0.2.0", path = "./iroh-store" }
iroh-unixfs = { version = "0.2.0", path = "./iroh-unixfs" }
iroh-util = { version = "0.2.0", path = "./iroh-util" }
beetle = { version = "0.2.0", path = "./beetle" }
beetle-api = { version = "0.2.0", path = "./beetle-api" }
beetle-bitswap = { version = "0.2.0", path = "./beetle-bitswap" }
beetle-car = { version = "0.2.0", path = "./beetle-car" }
beetle-embed = { version = "0.2.0", path = "./beetle-embed" }
beetle-gateway = { version = "0.2.0", path = "./beetle-gateway" }
beetle-localops = { version = "0.2.0", path = "./beetle-localops" }
beetle-metrics = { version = "0.2.0", path = "./beetle-metrics" }
beetle-one = { version = "0.2.0", path = "./beetle-one" }
beetle-p2p = { version = "0.2.0", path = "./beetle-p2p" }
beetle-resolver = { version = "0.2.0", path = "./beetle-resolver" }
beetle-rpc-client = { version = "0.2.0", path = "./beetle-rpc-client" }
beetle-rpc-types = { version = "0.2.0", path = "./beetle-rpc-types" }
beetle-store = { version = "0.2.0", path = "./beetle-store" }
beetle-unixfs = { version = "0.2.0", path = "./beetle-unixfs" }
beetle-util = { version = "0.2.0", path = "./beetle-util" }
keyed_priority_queue = "0.4.1"
lazy_static = "1.4"
libipld = "0.15"
Expand Down
24 changes: 12 additions & 12 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ Use `cargo` commands to build and run the various Iroh binaries.
For example:

```shell
# run each command in a different terminal to simulate running iroh as
# run each command in a different terminal to simulate running beetle as
# microservices on different boxes:
$ cargo run -p iroh-p2p
$ cargo run -p iroh-gateway
$ cargo run -p iroh-store
$ cargo run -p iroh -- status --watch
$ cargo run -p beetle-p2p
$ cargo run -p beetle-gateway
$ cargo run -p beetle-store
$ cargo run -p beetle -- status --watch
```

If you want to use the `iroh` binary to start and stop the services, you can
If you want to use the `beetle` binary to start and stop the services, you can
use `xtask` to move previously built binaries to the correct bin:

```shell
Expand Down Expand Up @@ -94,21 +94,21 @@ cargo clippy --workspace --all-features --all-targets && cargo test --workspace

## <a name="dependecies"></a> Dependencies

Any crate added to iroh will need to use a license compatible with ours. Any PR that introduces a new crate will require additional review time to audit the crate being introduced, including rationale on why you chose *this* crate, and what alternatives you considered willl speed up the review process.
Any crate added to beetle will need to use a license compatible with ours. Any PR that introduces a new crate will require additional review time to audit the crate being introduced, including rationale on why you chose *this* crate, and what alternatives you considered willl speed up the review process.

Crate lists in `Cargo.toml` files must be kept alphabetically sorted.

## <a name="prs"></a> Pull Request Guidelines

The tests must pass and you must get an approval from someone on the Iroh team before you can merge your PR.

Depending on your permissions in the `iroh` repo, you may not have the the ability to "request a review". Instead, please tag your selected reviewers in the PR itself (using the `@`) and specify that you would like them to review. If you are a member of our discord community, you can and should ping your reviewer(s) there as well.
Depending on your permissions in the `beetle` repo, you may not have the the ability to "request a review". Instead, please tag your selected reviewers in the PR itself (using the `@`) and specify that you would like them to review. If you are a member of our discord community, you can and should ping your reviewer(s) there as well.

If you don't know who to tag for review, here are some good guidelines. For any markdown documentations changes, tag `ramfox` or `b5`. If your PR solves an issue that someone else created, tag that person in review. If it's an issue you have created, tag team members who have been discussing the issue. Otherwise, create the PR and note that you aren't sure who to tag! Someone will drop in to give you guidance. If you are apart of our discord community, ask who should be tagged in the `iroh` channel.
If you don't know who to tag for review, here are some good guidelines. For any markdown documentations changes, tag `ramfox` or `b5`. If your PR solves an issue that someone else created, tag that person in review. If it's an issue you have created, tag team members who have been discussing the issue. Otherwise, create the PR and note that you aren't sure who to tag! Someone will drop in to give you guidance. If you are apart of our discord community, ask who should be tagged in the `beetle` channel.

### A note about our current CI testing set up

The MacOS testing infrastructure currently does not work on forked branches of `iroh`. If you are working on a forked branch, you will notice that the MacOS tests on your PRs will always fail (because they will not run). This is the only case where you may have a "failing" test and still merge your PR.
The MacOS testing infrastructure currently does not work on forked branches of `beetle`. If you are working on a forked branch, you will notice that the MacOS tests on your PRs will always fail (because they will not run). This is the only case where you may have a "failing" test and still merge your PR.

### Merging

Expand Down Expand Up @@ -163,7 +163,7 @@ Must be one of the following:

### Scope

The scope could be anything specifying place of the commit change. For example, if I am refactoring something in the `iroh` package, I may start my commit with "refactor(iroh)".
The scope could be anything specifying place of the commit change. For example, if I am refactoring something in the `beetle` package, I may start my commit with "refactor(beetle)".

You can use `*` when the change affects more than a single scope.

Expand Down Expand Up @@ -192,7 +192,7 @@ A detailed explanation can be found in this [document][commit-message-format].

[closing-issues]: https://help.github.com/articles/closing-issues-via-commit-messages/
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
[github]: https://github.com/n0-computer/iroh
[github]: https://github.com/n0-computer/beetle
[git-revert]: https://git-scm.com/docs/git-revert
[git-setup]: https://help.github.com/articles/set-up-git
[git-hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile-ci
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Dockerfile for CircleCI
# build with
# `docker build -t dignifiedquire/iroh-ci:latest -f ./Dockerfile-ci .`
# rebuild: `docker build --pull --no-cache -t dignifiedquire/iroh-ci:latest -f ./Dockerfile-ci .`
# `docker build -t dignifiedquire/beetle-ci:latest -f ./Dockerfile-ci .`
# rebuild: `docker build --pull --no-cache -t dignifiedquire/beetle-ci:latest -f ./Dockerfile-ci .`

FROM cimg/rust:1.62.0

Expand Down
20 changes: 10 additions & 10 deletions README.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@b5 would be ok to just apply these readme changes for now, just to reduce confusion for drive-by visitors?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! I'll open a separate PR with the readme changes 😄

Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# iroh
# beetle

[![crates.io](https://img.shields.io/crates/v/iroh.svg?style=flat-square)](https://crates.io/crates/iroh)
[![Released API docs](https://img.shields.io/docsrs/iroh?style=flat-square)](https://docs.rs/iroh)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/iroh?style=flat-square)](./LICENSE-MIT)
[![CI](https://img.shields.io/github/workflow/status/n0-computer/iroh/Continuous%20integration?style=flat-square)](https://github.com/n0-computer/iroh/actions?query=workflow%3A%22Continuous+integration%22)
[![crates.io](https://img.shields.io/crates/v/beetle.svg?style=flat-square)](https://crates.io/crates/beetle)
[![Released API docs](https://img.shields.io/docsrs/beetle?style=flat-square)](https://docs.rs/beetle)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/beetle?style=flat-square)](./LICENSE-MIT)
[![CI](https://img.shields.io/github/workflow/status/n0-computer/beetle/Continuous%20integration?style=flat-square)](https://github.com/n0-computer/beetle/actions?query=workflow%3A%22Continuous+integration%22)

Iroh is a next-generation implementation of the Interplanetary File System ([IPFS](https://ipfs.io)) for Cloud & Mobile platforms.

IPFS is a networking protocol for exchanging _content-addressed_ blocks of immutable data. “Content-addressed” means referring to data by the *hash of its content*, which makes the reference unique and verifiable. These two properties make it possible to get data from *any* node in the network that speaks the IPFS protocol, including IPFS content being served by other implementations of IPFS.

This repo is a common core for three distributions of iroh:
This repo is a common core for three distributions of beetle:

- **Iroh Cloud:** core features of iroh split into configurable microservices, optimized for running at datacenter scale.
- **Iroh One:** A select set of iroh cloud features packaged as a single binary for simplified deployment.
- **Iroh Cloud:** core features of beetle split into configurable microservices, optimized for running at datacenter scale.
- **Iroh One:** A select set of beetle cloud features packaged as a single binary for simplified deployment.
- **Iroh Mobile:** iOS & Android libraries that bring efficient data distribution to mobile apps.

Here is an [install guide](https://iroh.computer/install).
Here is an [install guide](https://beetle.computer/install).

## Working on Iroh
Check out the [CONTRIBUTOR docs](./CONTRIBUTOR.md) to get familiar with ways you can contribute to the Iroh project. The [DEVELOPERS docs](./DEVELOPERS.md) will help you get starting with building and developing Iroh.
Expand All @@ -26,7 +26,7 @@ A full suite of automated benchmarks is in the works. [this talk](https://www.yo

## Who's behind this?

[Iroh](https://iroh.computer) is built & maintained by [number 0](https://n0.computer). We're a founder-backed startup hell-bent on building efficient distributed systems software.
[Iroh](https://beetle.computer) is built & maintained by [number 0](https://n0.computer). We're a founder-backed startup hell-bent on building efficient distributed systems software.

## License

Expand Down
8 changes: 4 additions & 4 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Install dependencies

```sh
$ npm install -g conventional-changelog-cli
$ cd iroh
$ cd beetle
$ conventional-changelog -p angular
```

Add the output of that to `CHANGELOG.md`, and write a human-centric summary of changes.
Update the linked output to reference the new version, which conventional-changelog doesn't know about:

```md
# [](https://github.com/n0-computer/iroh/compare/v0.1.1...v) (2022-11-28)
# [](https://github.com/n0-computer/beetle/compare/v0.1.1...v) (2022-11-28)
```
becomes:
```md
# [v0.1.2](https://github.com/n0-computer/iroh/compare/v0.1.1...v0.1.2) (2022-11-28)
# [v0.1.2](https://github.com/n0-computer/beetle/compare/v0.1.1...v0.1.2) (2022-11-28)
```

## Publishing
Expand All @@ -28,7 +28,7 @@ Publishing on crates.io, bumping version & generating tags is done using [`cargo

This requires the following permissions

- on github.com/n0-computer/iroh
- on github.com/n0-computer/beetle
- creating tags
- pushing to `main`
- on crates.io
Expand Down
18 changes: 9 additions & 9 deletions iroh-api/Cargo.toml → beetle-api/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "iroh-api"
name = "beetle-api"
readme = "README.md"
description = "Rust API for Iroh"
version.workspace = true
Expand All @@ -16,12 +16,12 @@ bytes.workspace = true
cid.workspace = true
config.workspace = true
futures.workspace = true
iroh-metrics.workspace = true
iroh-resolver.workspace = true
iroh-rpc-client.workspace = true
iroh-rpc-types.workspace = true
iroh-unixfs.workspace = true
iroh-util.workspace = true
beetle-metrics.workspace = true
beetle-resolver.workspace = true
beetle-rpc-client.workspace = true
beetle-rpc-types.workspace = true
beetle-unixfs.workspace = true
beetle-util.workspace = true
libp2p.workspace = true
relative-path.workspace = true
serde = { workspace = true, features = ["derive"] }
Expand All @@ -31,8 +31,8 @@ tracing.workspace = true

[dev-dependencies]
criterion = { workspace = true, features = ["async_tokio"] }
iroh-rpc-types.workspace = true
iroh-store.workspace = true
beetle-rpc-types.workspace = true
beetle-store.workspace = true
tempfile.workspace = true

[[bench]]
Expand Down
23 changes: 23 additions & 0 deletions beetle-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# beetle-api

[![crates.io](https://img.shields.io/crates/v/beetle-api.svg?style=flat-square)](https://crates.io/crates/beetle-api)
[![Released API docs](https://img.shields.io/docsrs/beetle-api?style=flat-square)](https://docs.rs/beetle-api)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/beetle-api?style=flat-square)](../LICENSE-MIT)
[![CI](https://img.shields.io/github/workflow/status/n0-computer/beetle/Continuous%20integration?style=flat-square)](https://github.com/n0-computer/beetle/actions?query=workflow%3A%22Continuous+integration%22)

This contains the API for controlling [beetle](https://github.com/n0-computer/beetle).

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br/>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>
Loading