rust-bitcoin / rust-bitcoin/rust-miniscript
`sanity_check` methods throughout the codebase shouldn't be part of the API
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Rust
- Star
- 426
- Fork
- 200
- Merge trung bình
- 7 ngày 17 giờ
- Pull request đã merge (30 ngày)
- 8
Mô tả
Actually I'll just file an issue. There are a lot of sanity_check methods in the code, many of which are not called from within the library, and at least one has a doc example suggesting to use it to check "whether all spend paths are accessible in the Bitcoin network".
So we need to re-assess all these functions and see if they can be pulled into the type system somehow so you simply can't create the objects without running the (non-pub) methods.
Originally posted by @apoelstra in https://github.com/rust-bitcoin/rust-miniscript/pull/652#discussion_r1514517762
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách lập danh mục các phương thức sanity_check trong toàn bộ codebase và xem lại phần thảo luận của pull request được liên kết, bao gồm cả ví dụ trong tài liệu về các đường dẫn chi tiêu Bitcoin. Xác định những phương thức nào có thể được gọi từ bên ngoài và những bất biến nào thay vào đó nên được hệ thống kiểu thực thi; công việc được xem là hoàn tất khi API không còn để lộ các kiểm tra không phù hợp và tính hợp lệ của đối tượng được xử lý nhất quán.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- rust
- Lĩnh vực
- blockchain
- Loại issue
- Tái cấu trúc
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100