Skip to content

Commit bd99fb6

Browse files
authored
chore(bip0032): update docs and agents.md (#128)
* chore(bip0032): update docs and agents.md * update agents.md
1 parent 51df26e commit bd99fb6

4 files changed

Lines changed: 12 additions & 13 deletions

File tree

bip0032/AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- `src/lib.rs` is the crate entry and re-exports the public API.
66
- `src/path/` defines derivation paths and child numbers.
77
- `src/xkey/` contains extended key types and payload/version handling.
8-
- `src/curve/secp256k1/` holds backend-specific secp256k1 implementations (k256, secp256k1, libsecp256k1).
8+
- `src/curve/secp256k1/` holds backend-specific secp256k1 implementations (k256, secp256k1).
99
- `src/curve/nist256p1/` holds the NIST P-256 (p256) backend implementation for SLIP-0010.
1010
- `src/curve/ed25519/` holds the ed25519 backend implementation for SLIP-0010.
1111
- `src/curve/slip10.rs` contains SLIP-0010 marker traits.
@@ -43,8 +43,8 @@
4343
## Feature Flags & Backends
4444

4545
- `std` enables standard library support; `k256` is the default secp256k1 backend.
46-
- Optional backends: `secp256k1` and `libsecp256k1` (note: libsecp256k1 is unmaintained).
47-
- SLIP-0010 features: `slip10` (core), `k256`|`secp256k1`|`libsecp256k1` (secp256k1), `p256` (nist256p1), `ed25519-dalek` (ed25519).
46+
- Optional backends: `k256` and `secp256k1`.
47+
- SLIP-0010 features: `slip10` (core), `k256`|`secp256k1` (secp256k1), `p256` (nist256p1), `ed25519-dalek` (ed25519).
4848
- When modifying backend code, validate the affected feature set with explicit `--features` flags.
4949

5050
## Commit & Pull Request Guidelines

bip0032/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Another Rust implementation of [BIP-0032](https://github.com/bitcoin/bips/blob/m
1616

1717
## Support curves and features
1818

19-
| Curve | Feature | Backends | Hardened | Non-hardened (private) | Non-hardened (public) | Serialization |
20-
| --------- | --------------------------------------- | ----------------------------- | -------- | ---------------------- | --------------------- | ------------- |
21-
| secp256k1 | `k256` \| `secp256k1` \| `libsecp256k1` | k256, secp256k1, libsecp256k1 | yes | yes | yes | yes |
19+
| Curve | Feature | Backends | Hardened | Non-hardened (private) | Non-hardened (public) | Serialization |
20+
| --------- | --------------------- | --------------- | -------- | ---------------------- | --------------------- | ------------- |
21+
| secp256k1 | `k256` \| `secp256k1` | k256, secp256k1 | yes | yes | yes | yes |
2222

2323
## Usage
2424

@@ -96,7 +96,6 @@ See documentation and examples at https://docs.rs/bip0032.
9696
- [x] Multiple secp256k1 backends
9797
- [`k256`](https://github.com/RustCrypto/elliptic-curves/tree/master/k256) (by default)
9898
- [`secp256k1`](https://github.com/rust-bitcoin/rust-secp256k1)
99-
- [`libsecp256k1`](https://github.com/paritytech/libsecp256k1)
10099
- [x] Optional SLIP-0010 support
101100
- secp256k1 ([compatible with BIP32](https://github.com/satoshilabs/slips/blob/master/slip-0010.md#compatibility-with-bip-0032))
102101
- NIST P-256 (a.k.a. secp256r1, prime256v1) ([`p256`](https://github.com/RustCrypto/elliptic-curves/tree/master/p256))

bip0032/SLIP-0010.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ but the derivation rules and supported curves differ.
66

77
## Supported curves and features
88

9-
| Curve | Feature | Backends | Hardened | Non-hardened (private) | Non-hardened (public) | Serialization |
10-
| --------- | ---------------------------------------------------- | ----------------------------- | -------- | ---------------------- | --------------------- | ------------- |
11-
| secp256k1 | `slip10` + (`k256` \| `secp256k1` \| `libsecp256k1`) | k256, secp256k1, libsecp256k1 | yes | yes | yes | no |
12-
| nist256p1 | `slip10` + `p256` | p256 | yes | yes | yes | no |
13-
| ed25519 | `slip10` + `ed25519-dalek` | ed25519-dalek | yes | no | no | no |
9+
| Curve | Feature | Backends | Hardened | Non-hardened (private) | Non-hardened (public) | Serialization |
10+
| --------- | ---------------------------------- | --------------- | -------- | ---------------------- | --------------------- | ------------- |
11+
| secp256k1 | `slip10` + (`k256` \| `secp256k1`) | k256, secp256k1 | yes | yes | yes | no |
12+
| nist256p1 | `slip10` + `p256` | p256 | yes | yes | yes | no |
13+
| ed25519 | `slip10` + `ed25519-dalek` | ed25519-dalek | yes | no | no | no |
1414

1515
Note: SLIP-0010 does not define a standardized extended key serialization.
1616
Only the BIP32 secp256k1 encoding (xpub/xprv) is supported for serialization.

bip0032/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
//!
1919
//! | Curve | Feature | Backends | Hardened | Non-hardened (private) | Non-hardened (public) | Serialization |
2020
//! | --- | --- | --- | --- | --- | --- | --- |
21-
//! | secp256k1 | `k256` \| `secp256k1` \| `libsecp256k1` | k256, secp256k1, libsecp256k1 | yes | yes | yes | yes |
21+
//! | secp256k1 | `k256` \| `secp256k1` | k256, secp256k1 | yes | yes | yes | yes |
2222
//!
2323
//! ## Usage
2424
//!

0 commit comments

Comments
 (0)