Skip to content

chore(release): prepare the repo for a public 0.1.0 - #3

Merged
hubagaspar91 merged 5 commits into
mainfrom
chore/release/prod-readiness
Oct 6, 2026
Merged

hubagaspar91 merged 5 commits into
mainfrom
chore/release/prod-readiness

Conversation

@hubagaspar91

@hubagaspar91 hubagaspar91 commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

What

This PR makes the repo ready for a public 0.1.0 release. It has five commits:

  • MIT license. The repo had no license file, and Cargo.toml said Apache-2.0. The sibling crates canton-lib and cbtc-lib use MIT, so this crate now ships the MIT text and declares MIT.
  • Units in the BETH docs. deposit_call takes wei as a U256. The burn takes ETH as a DamlDecimal. The rustdoc now states each unit and names the converters, wei_to_daml_decimal and daml_decimal_to_wei.
  • An integrator README and a changelog. The README covers install, prerequisites, the concepts, a quick start for each asset, hold and send, the networks, and what the library does not do. The contributor material moves to a short section at the end. CHANGELOG.md follows cbtc-lib's format and records 0.1.0 and the changes from cbtc-lib.
  • The release date. The changelog dates 0.1.0 as 2026-10-06.
  • canton-lib 0.10.0 in the README. PR chore(deps): pin canton-lib 0.10.0 #4 moved the crate to canton-lib 0.10.0. The README install line and its note now pin 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

  • The three README code samples compile. A scratch copy built them as examples; they call no network.
  • cargo fmt --check, cargo clippy --all-targets --all-features -- -D warnings, cargo test and cargo doc --no-deps pass with no warning.
  • The README test in src/network.rs still finds every registry URL and BitSafe API URL.

Decisions

  • The license is MIT, the pilot's choice, to match canton-lib and cbtc-lib.
  • The README states the limits plainly. The library lists only active withdraw requests, does not check a BTC address's network, and reads no Ethereum state.
  • No CONTRIBUTING.md or SECURITY.md: neither sibling repo has them.

🤖 Generated with Claude Code

hubagaspar91 and others added 4 commits October 6, 2026 15:40
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>
@hubagaspar91
hubagaspar91 merged commit a499097 into main Oct 6, 2026
6 checks passed
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