Repository navigation
chore(release): prepare the repo for a public 0.1.0 - #3
Merged
Merged
Conversation
The sibling crates canton-lib and cbtc-lib use MIT, and the repo had no license file. The crate now ships the MIT text and declares MIT in Cargo.toml. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
deposit_call takes wei as a U256, and the burn takes ETH as a DamlDecimal. The docs said neither, so an integrator could pass the wrong unit. Each function now names its unit and the converters. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README spoke to contributors only: no install line, no setup and no quick start. It now covers install, prerequisites, the concepts, and a compiled quick start for each asset. The changelog records 0.1.0 and the changes from cbtc-lib. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
scolear
approved these changes
Oct 6, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This PR makes the repo ready for a public 0.1.0 release. It has five commits:
Cargo.tomlsaid Apache-2.0. The sibling cratescanton-libandcbtc-libuse MIT, so this crate now ships the MIT text and declares MIT.deposit_calltakes wei as aU256. The burn takes ETH as aDamlDecimal. The rustdoc now states each unit and names the converters,wei_to_daml_decimalanddaml_decimal_to_wei.CHANGELOG.mdfollowscbtc-lib's format and records 0.1.0 and the changes fromcbtc-lib.v0.10.0, and the changelog records the change.Why
A newcomer read only the old docs, with no prior knowledge. They scored minting BETH 2 of 5 and sending CBTC 3 of 5. The main gaps were no install line, no setup steps, no way to get a Minter credential, and unclear units. This PR closes those gaps.
How tested
cargo fmt --check,cargo clippy --all-targets --all-features -- -D warnings,cargo testandcargo doc --no-depspass with no warning.src/network.rsstill finds every registry URL and BitSafe API URL.Decisions
canton-libandcbtc-lib.CONTRIBUTING.mdorSECURITY.md: neither sibling repo has them.🤖 Generated with Claude Code