Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

examples: import examples from main repo #15

Merged
merged 14 commits into from
Nov 26, 2024
Merged

examples: import examples from main repo #15

merged 14 commits into from
Nov 26, 2024

Conversation

dignifiedquire
Copy link
Collaborator

@dignifiedquire dignifiedquire commented Nov 19, 2024

This shows how to use iroh with iroh-blobs

We have to build our own node since there is no more standard iroh node.

Copy link

github-actions bot commented Nov 19, 2024

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/15/docs/iroh_blobs/

Last updated: 2024-11-26T10:34:02Z

github-merge-queue bot pushed a commit to n0-computer/iroh that referenced this pull request Nov 25, 2024
## Description

As previously announced and planned, this removes all protocol
implementations from the `iroh` crate, as well as removes the `iroh-cli`
crate.

The core functionality of those protocols, including RPC & CLI now is in
the individual crates.


## Remove from `iroh`

- [x] `iroh-docs`
- [x] `iroh-blobs`
- [x] `iroh-gossip`
 
## Examples

- [x] Move examples to the appropriate repos:
n0-computer/iroh-blobs#15

## Tests

- [x] Move the remaining tests to the appropriate repos

CLI
- [x] Remove 

## Breaking Changes

- `iroh-cli` removed
  - the crate itself
- the ability to run `iroh` itself in a docker container, as there is no
binary anymore
- removed 
  - `iroh::blobs` use `iroh_blobs`
  - `iroh::docs` use `iroh_docs`
  - `iroh::gossip` use `iroh_gossip`
- `iroh::client::blobs` use `iroh_blobs::rpc::client`. a memory client
is available on Blobs
- `iroh::client::tags` use `iroh_blobs::rpc::client`. a memory client is
available on Blobs
- `iroh::client::gossip` use `iroh_gossip::rpc::client`. a memory client
is available on Gossip
- `iroh::client::docs` use `iroh_docs::rpc::client`. a memory client is
available on Docs
- `iroh::client::authors` use `iroh_docs::rpc::client`. a memory client
is available on Docs
  - `iroh::node::MemNode`, use `Node` directly
  - `iroh::node::FsNode`, use `Node` directly
  - `iroh::node::Node::local_pool_handle`
  - `iroh::node::builder::DocsStorage`
  - `iroh::node::builder::Builder::enable_gc_policy`
  - `iroh::node::builder::Builder::enable_docs`
  - `iroh::node::builder::Builder::register_cb_done`
  - `iroh::node::builder::ProtocolBuilder::local_pool_handle`
  - `iroh::node::builder::GcPolicy`
  - `iroh::util::progress`
  - `iroh::util::path::IrohPaths::BaoStoreDir`
  - `iroh::util::path::IrohPaths::DocsDatabase `
  - `iroh::util::path::IrohPaths::Console`
  - `iroh::util::path::IrohPaths::DefaultAuthor`
- `iroh::node::Builder` has no more generic parameters anymore
- `iroh::node::Node` has no more generic parameters anymore



## Notes & open questions



## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.

---------

Co-authored-by: Asmir Avdicevic <[email protected]>
@rklaehn rklaehn merged commit 8ab19fe into main Nov 26, 2024
23 of 24 checks passed
@rklaehn rklaehn deleted the import-exapmles branch November 26, 2024 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants