v1.0-rc.1

.github/workflows/bench.yml

@@ -51,7 +51,7 @@ jobs:
           tool: 'cargo'
           output-file-path: output.txt
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          auto-push: ${{ github.event_name == 'push' && github.repository == 'ucan-wg/rs-ucan' && github.ref == 'refs/heads/main' }}
+          auto-push: ${{ github.event_name == 'push' && github.repository == 'ucan-wg/ucan' && github.ref == 'refs/heads/main' }}
           alert-threshold: '200%'
           comment-on-alert: true
           fail-on-alert: true

.github/workflows/coverage.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Generate Code coverage
         env:
           CARGO_INCREMENTAL: '0'
-          LLVM_PROFILE_FILE: "rs-ucan-%p-%m.profraw"
+          LLVM_PROFILE_FILE: "ucan-%p-%m.profraw"
           RUSTFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off'
           RUSTDOCFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off'
         run: cargo test --all-features

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to rs-ucan
+# Contributing to ucan
 
 We welcome everyone to contribute what and where they can. Whether you are brand
 new, just want to contribute a little bit, or want to contribute a lot there is
@@ -84,7 +84,7 @@ need to be the best programmer to contribute. Our discord is open for questions.
 	- You can learn more about cloning repositories [here][git-clone].
 
  6. **Build** the project
-    - For a detailed look on how to build rs-ucan look at our
+    - For a detailed look on how to build ucan look at our
       [README file](./README.md).
 
  7. **Start writing** your code

Cargo.toml

@@ -1,25 +1,25 @@
 [package]
-name = "rs-ucan"
-version = "0.1.0"
+name = "ucan"
+version = "0.2.0"
 description = "Rust implementation of UCAN"
-keywords = []
+keywords = ["capabilities", "authorization", "ucan"]
 categories = []
 include = ["/src", "/examples", "/benches", "README.md", "LICENSE"]
 license = "Apache-2.0"
 readme = "README.md"
 edition = "2021"
-rust-version = "1.67"
-documentation = "https://docs.rs/rs-ucan"
-repository = "https://github.com/ucan-wg/rs-ucan"
-authors = ["Quinn Wilton <quinn@quinnwilton.com>"]
+rust-version = "1.75"
+documentation = "https://docs.rs/ucan"
+repository = "https://github.com/ucan-wg/ucan"
+authors = ["Quinn Wilton <quinn@quinnwilton.com>", "Brooklyn Zelenka <hello@brooklynzelenka.com"]
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 path = "src/lib.rs"
 bench = false
 
 [[bench]]
-name = "a_benchmark"
+name = "a_benchmark" # TODO rename
 harness = false
 required-features = ["test_utils"]
 
@@ -29,40 +29,49 @@ path = "examples/counterparts.rs"
 
 [dependencies]
 anyhow = "1.0.75"
+aquamarine = { version = "0.5", optional = true }
 async-signature = "0.4.0"
 async-trait = "0.1.73"
 blst = { version = "0.3.11", optional = true, default-features = false }
 cfg-if = "0.1"
-cid = "0.10.1"
+cid = "0.10"
+did_url = "0.1"
 downcast-rs = "1.2.0"
 dyn-clone = "1.0.14"
 ecdsa = { version = "0.16.8", optional = true, default-features = false }
 ed25519 = { version = "2.2.2", optional = true, default-features = false }
 ed25519-dalek = { version = "2.0.0", features = ["rand_core"], optional = true }
+enum-as-inner = "0.6"
 erased-serde = "0.3.31"
 jose-b64 = { version = "0.1.2", features = ["serde", "json"] }
 k256 = { version = "0.13.1", features = ["ecdsa"], optional = true, default-features = false }
 lazy_static = "1.4.0"
-libipld-core = "0.16.0"
+libipld-core = { version = "0.16", features = ["serde-codec"] }
+libipld-cbor = "0.16"
 multibase = "0.9.1"
+multihash = {version = "0.19", features = ["serde"]}
 p256 = { version = "0.13.2", features = ["ecdsa"], optional = true, default-features = false }
 p384 = { version = "0.13.0", features = ["ecdsa"], optional = true, default-features = false }
 p521 = { version = "0.13.0", optional = true, default-features = false }
 proptest = { version = "1.1", optional = true }
+regex = "1.10"
 rsa = { version = "0.9.2", features = ["sha2"], optional = true, default-features = false }
 semver = "1.0.19"
 serde = { version = "1.0.188", features = ["derive"] }
+serde_derive = "1.0"
 serde_json = "1.0.107"
 signature = { version = "2.1.0", features = ["alloc"] }
 thiserror = "1.0"
 tracing = "0.1.40"
 unsigned-varint = "0.7.2"
-url = "2.4.1"
+url = { version = "2.5", features = ["serde"] }
 web-time = "0.2.3"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 # `linkme` relies on linker features that aren't available in wasm32
 linkme = "0.3.15"
+uuid = { version = "1.7", features = ["v4"] }
+xid = "1.0"
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 console_error_panic_hook = { version = "0.1" }
@@ -74,7 +83,7 @@ wasm-bindgen-futures = { version = "0.4" }
 web-sys = { version = "0.3", features = ["Crypto", "CryptoKey", "CryptoKeyPair", "SubtleCrypto"] }
 
 [dev-dependencies]
-multihash = "0.18.0"
+multihash = "0.18"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
 criterion = "0.4"
@@ -105,12 +114,13 @@ es512-verifier = ["es512"]
 ps256-verifier = ["ps256"]
 rs256-verifier = ["rs256"]
 bls-verifier = ["bls"]
+mermaid_docs = ["aquamarine"]
 
-[metadata.docs.rs]
+[package.metadata.docs.rs]
 all-features = true
 # defines the configuration attribute `docsrs`
 rustdoc-args = ["--cfg", "docsrs"]
-#
+cargo-args = ["--features='mermaid_docs'"]
 # See https://doc.rust-lang.org/cargo/reference/profiles.html for more info.
 # [profile.release]
 # Do not perform backtrace for panic on release builds.

README.md

@@ -1,24 +1,24 @@
 <div align="center">
-  <a href="https://github.com/ucan-wg/rs-ucan" target="_blank">
-    <img src="https://raw.githubusercontent.com/ucan-wg/rs-ucan/main/assets/a_logo.png" alt="rs-ucan Logo" width="100"></img>
+  <a href="https://github.com/ucan-wg/ucan" target="_blank">
+    <img src="https://raw.githubusercontent.com/ucan-wg/ucan/main/assets/logo.png" alt="ucan Logo" width="100"></img>
   </a>
 
-  <h1 align="center">rs-ucan</h1>
+  <h1 align="center">ucan</h1>
 
   <p>
-    <a href="https://crates.io/crates/rs-ucan">
-      <img src="https://img.shields.io/crates/v/rs-ucan?label=crates" alt="Crate">
+    <a href="https://crates.io/crates/ucan">
+      <img src="https://img.shields.io/crates/v/ucan?label=crates" alt="Crate">
     </a>
-    <a href="https://codecov.io/gh/ucan-wg/rs-ucan">
-      <img src="https://codecov.io/gh/ucan-wg/rs-ucan/branch/main/graph/badge.svg?token=SOMETOKEN" alt="Code Coverage"/>
+    <a href="https://codecov.io/gh/ucan-wg/ucan">
+      <img src="https://codecov.io/gh/ucan-wg/ucan/branch/main/graph/badge.svg?token=SOMETOKEN" alt="Code Coverage"/>
     </a>
-    <a href="https://github.com/ucan-wg/rs-ucan/actions?query=">
-      <img src="https://github.com/ucan-wg/rs-ucan/actions/workflows/tests_and_checks.yml/badge.svg" alt="Build Status">
+    <a href="https://github.com/ucan-wg/ucan/actions?query=">
+      <img src="https://github.com/ucan-wg/ucan/actions/workflows/tests_and_checks.yml/badge.svg" alt="Build Status">
     </a>
-    <a href="https://github.com/ucan-wg/rs-ucan/blob/main/LICENSE">
+    <a href="https://github.com/ucan-wg/ucan/blob/main/LICENSE">
       <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License">
     </a>
-    <a href="https://docs.rs/rs-ucan">
+    <a href="https://docs.rs/ucan">
       <img src="https://img.shields.io/static/v1?label=Docs&message=docs.rs&color=blue" alt="Docs">
     </a>
     <a href="https://discord.gg/4UdeQhw7fv">
@@ -29,71 +29,63 @@
 
 <div align="center"><sub>:warning: Work in progress :warning:</sub></div>
 
-##
-
-## Outline
-
-- [Usage](#usage)
-- [Testing the Project](#testing-the-project)
-- [Benchmarking the Project](#benchmarking-the-project)
-- [Contributing](#contributing)
-- [Getting Help](#getting-help)
-- [External Resources](#external-resources)
-- [License](#license)
-
 ## Usage
 
 Add the following to the `[dependencies]` section of your `Cargo.toml` file:
 
 ```toml
-rs-ucan = "0.1.0"
+ucan = "1.0.0-rc.1"
 ```
 
 ## Testing the Project
 
-- Run tests
+Run tests
 
-  ```console
-  cargo test
-  ```
+| Nix        | Cargo        |
+|------------|--------------|
+| `test:all` | `cargo test` |
 
 ## Benchmarking the Project
 
 For benchmarking and measuring performance, this project leverages
-[criterion][criterion] and a `test_utils` feature flag
-for integrating [proptest][proptest] within the the suite for working with
-[strategies][strategies] and sampling from randomly generated values.
+[Criterion] and a `test_utils` feature flag
+for integrating [proptest] within the the suite for working with
+[strategies] and sampling from randomly generated values.
 
-- Run benchmarks
+## Benchmarks
 
-  ```console
-  cargo bench --features test_utils
-  ```
+| Nix     | Cargo                               |
+|---------|-------------------------------------|
+| `bench` | `cargo bench --features test_utils` |
 
 ## Contributing
 
 :balloon: We're thankful for any feedback and help in improving our project!
-We have a [contributing guide](./CONTRIBUTING.md) to help you get involved. We
-also adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).
+We have a [contributing guide][CONTRIBUTING] to help you get involved. We
+also adhere to our [Code of Conduct].
 
 ### Nix
 
-This repository contains a [Nix flake][nix-flake] that initiates both the Rust
-toolchain set in [rust-toolchain.toml](./rust-toolchain.toml) and a
-[pre-commit hook](#pre-commit-hook). It also installs helpful cargo binaries for
-development. Please install [nix][nix] and [direnv][direnv] to get started.
+This repository contains a [Nix flake] that initiates both the Rust
+toolchain set in [`rust-toolchain.toml`] and a [pre-commit hook]. It also
+installs helpful cargo binaries for development.
+
+Please install [Nix] to get started. We also recommend installing [direnv].
 
 Run `nix develop` or `direnv allow` to load the `devShell` flake output,
 according to your preference.
 
+The Nix shell also includes several helpful shortcut commands.
+You can see a complete list of commands via the `menu` command.
+
 ### Formatting
 
 For formatting Rust in particular, we automatically format on `nightly`, as it
 uses specific nightly features we recommend by default.
 
 ### Pre-commit Hook
 
-This project recommends using [pre-commit][pre-commit] for running pre-commit
+This project recommends using [pre-commit] for running pre-commit
 hooks. Please run this before every commit and/or push.
 
 - If you are doing interim commits locally, and for some reason if you _don't_
@@ -103,7 +95,7 @@ hooks. Please run this before every commit and/or push.
 ### Recommended Development Flow
 
 - We recommend leveraging [cargo-watch][cargo-watch],
-  [cargo-expand][cargo-expand] and [irust][irust] for Rust development.
+  [`cargo-expand`] and [IRust] for Rust development.
 - We recommend using [cargo-udeps][cargo-udeps] for removing unused dependencies
   before commits and pull-requests.
 
@@ -125,31 +117,51 @@ a type of `fix`, `feat`, `docs`, `ci`, `refactor`, etc..., structured like so:
 
 ## Getting Help
 
-For usage questions, usecases, or issues reach out to us in our [Discord channel](https://discord.gg/4UdeQhw7fv).
+For usage questions, usecases, or issues reach out to us in the [UCAN Discord].
 
-We would be happy to try to answer your question or try opening a new issue on Github.
+We would be happy to try to answer your question or try opening a new issue on GitHub.
 
 ## External Resources
 
 These are references to specifications, talks and presentations, etc.
 
 ## License
 
-This project is licensed under the [Apache License 2.0](./LICENSE), or
-[http://www.apache.org/licenses/LICENSE-2.0][apache].
+This project is [licensed under the Apache License 2.0][LICENSE], or
+[http://www.apache.org/licenses/LICENSE-2.0][Apache].
+
+<!-- Internal Links -->
+
+[Benchmarking the Project]: #benchmarking-the-project
+[Contributing]: #contributing
+[External Resources]: #external-resources
+[Getting Help]: #getting-help
+[License]: #license
+[Testing the Project]: #testing-the-project
+[Usage]: #usage
+[pre-commit hook]: #pre-commit-hook
+
+<!-- Local Links -->
+
+[CONTRIBUTING]: ./CONTRIBUTING.md
+[LICENSE]: ./LICENSE
+[Code of Conduct]: ./CODE_OF_CONDUCT.md
+[`rust-toolchain.toml`]: ./rust-toolchain.toml
 
+<!-- External Links -->
 
-[apache]: https://www.apache.org/licenses/LICENSE-2.0
-[cargo-expand]: https://github.com/dtolnay/cargo-expand
-[cargo-udeps]: https://github.com/est31/cargo-udeps
-[cargo-watch]: https://github.com/watchexec/cargo-watch
+[Apache]: https://www.apache.org/licenses/LICENSE-2.0
+[`cargo-expand`]: https://github.com/dtolnay/cargo-expand
+[`cargo-udeps`]: https://github.com/est31/cargo-udeps
+[`cargo-watch`]: https://github.com/watchexec/cargo-watch
 [commit-spec]: https://www.conventionalcommits.org/en/v1.0.0/#specification
 [commit-spec-site]: https://www.conventionalcommits.org/
-[criterion]: https://github.com/bheisler/criterion.rs
+[Criterion]: https://github.com/bheisler/criterion.rs
 [direnv]:https://direnv.net/
-[irust]: https://github.com/sigmaSd/IRust
-[nix]:https://nixos.org/download.html
-[nix-flake]: https://nixos.wiki/wiki/Flakes
+[IRust]: https://github.com/sigmaSd/IRust
+[Nix]:https://nixos.org/download.html
+[Nix flake]: https://nixos.wiki/wiki/Flakes
 [pre-commit]: https://pre-commit.com/
 [proptest]: https://github.com/proptest-rs/proptest
 [strategies]: https://docs.rs/proptest/latest/proptest/strategy/trait.Strategy.html
+[UCAN Discord]: https://discord.gg/4UdeQhw7fv

SECURITY.md

@@ -1,17 +1,17 @@
 ## Report a security issue or vulnerability
 
-The rs-ucan team welcomes security reports and is committed to
+The `ucan` team welcomes security reports and is committed to
 providing prompt attention to security issues. Security issues should be
 reported privately via [quinn@fission.codes][support-email]. Security issues should
 not be reported via the public GitHub Issue tracker.
 
 ## Security advisories
 
 The project team is committed to transparency in the security issue disclosure
-process. The rs-ucan team announces security advisories through our
+process. The ucan team announces security advisories through our
 Github respository's [security portal][sec-advisories] and and the
 [RustSec advisory database][rustsec-db].
 
 [rustsec-db]: https://github.com/RustSec/advisory-db
-[sec-advisories]: https://github.com/ucan-wg/rs-ucan/security/advisories
+[sec-advisories]: https://github.com/ucan-wg/ucan/security/advisories
 [support-email]: mailto:quinn@fission.codes

benches/a_benchmark.rs

@@ -1,13 +1,13 @@
 use criterion::{criterion_group, criterion_main, Criterion};
 
 pub fn add_benchmark(c: &mut Criterion) {
-    let mut rvg = rs_ucan::test_utils::Rvg::deterministic();
+    let mut rvg = ucan::test_utils::Rvg::deterministic();
     let int_val_1 = rvg.sample(&(0..100i32));
     let int_val_2 = rvg.sample(&(0..100i32));
 
     c.bench_function("add", |b| {
         b.iter(|| {
-            rs_ucan::add(int_val_1, int_val_2);
+            ucan::add(int_val_1, int_val_2);
         })
     });
 }

examples/counterparts.rs

@@ -1,5 +1,6 @@
 use std::error::Error;
 
+// TODO what is this?
 pub fn main() -> Result<(), Box<dyn Error>> {
     println!("Alien Shore!");
     Ok(())