Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Add md-book documentation + Rustdocs #1758

Merged
merged 57 commits into from May 24, 2024

Conversation

talekhinezh
Copy link
Member

@talekhinezh talekhinezh commented Apr 2, 2024

  • Add md book documentation on Radix Engine internals
  • Add more rustdocs on apis at each layer

Copy link

github-actions bot commented Apr 2, 2024

Docker tags
docker.io/radixdlt/private-scrypto-builder:a35e2e10ae

Copy link

github-actions bot commented Apr 2, 2024

Benchmark for a35e2e1

Click to view benchmark
Test Base PR %
costing::bench_prepare_wasm 66.0±0.16ms 65.5±0.15ms -0.76%
costing::decode_sbor 10.9±0.01µs 10.7±0.04µs -1.83%
costing::decode_sbor_bytes 29.2±0.06µs 29.5±0.13µs +1.03%
costing::deserialize_wasm 1286.2±3.99µs 1295.5±2.77µs +0.72%
costing::instantiate_flash_loan 4.0±0.70ms 3.9±0.52ms -2.50%
costing::instantiate_radiswap 5.7±0.06ms 5.8±0.07ms +1.75%
costing::spin_loop 21.9±0.22ms 22.2±0.18ms +1.37%
costing::validate_sbor_payload 29.9±0.05µs 26.1±0.03µs -12.71%
costing::validate_sbor_payload_bytes 250.2±0.76ns 229.1±0.54ns -8.43%
costing::validate_secp256k1 76.4±0.18µs 76.4±0.09µs 0.00%
costing::validate_wasm 36.8±0.03ms 36.3±0.05ms -1.36%
decimal::add/0 8.4±0.00ns 8.4±0.00ns 0.00%
decimal::add/rust-native 9.8±0.00ns 9.8±0.00ns 0.00%
decimal::add/wasmer 111.5±0.14ns 112.6±0.12ns +0.99%
decimal::add/wasmer-call-native 455.6±0.37ns 456.5±0.47ns +0.20%
decimal::add/wasmi 585.0±0.52ns 674.0±2.77ns +15.21%
decimal::add/wasmi-call-native 5.3±0.02µs 5.5±0.01µs +3.77%
decimal::div/0 189.7±0.11ns 189.7±0.37ns 0.00%
decimal::from_string/0 154.6±0.33ns 154.3±0.24ns -0.19%
decimal::mul/0 142.6±0.29ns 142.7±0.15ns +0.07%
decimal::mul/rust-native 139.6±0.06ns 138.1±0.29ns -1.07%
decimal::mul/wasmer 1507.5±1.70ns 1513.8±0.48ns +0.42%
decimal::mul/wasmer-call-native 568.5±0.76ns 570.1±0.50ns +0.28%
decimal::mul/wasmi 42.3±0.10µs 41.5±0.06µs -1.89%
decimal::mul/wasmi-call-native 5.5±0.01µs 5.7±0.01µs +3.64%
decimal::pow/0 654.4±0.29ns 653.9±0.68ns -0.08%
decimal::pow/rust-native 633.7±1.15ns 631.8±0.57ns -0.30%
decimal::pow/wasmer 6.6±0.00µs 6.6±0.01µs 0.00%
decimal::pow/wasmer-call-native 1055.7±1.84ns 1036.9±2.04ns -1.78%
decimal::pow/wasmi 200.0±0.38µs 192.4±0.26µs -3.80%
decimal::pow/wasmi-call-native 5.4±0.01µs 5.5±0.00µs +1.85%
decimal::root/0 7.8±0.01µs 7.8±0.01µs 0.00%
decimal::sub/0 8.5±0.01ns 8.5±0.01ns 0.00%
decimal::to_string/0 435.8±0.39ns 435.1±0.45ns -0.16%
precise_decimal::add/0 10.0±0.01ns 10.0±0.01ns 0.00%
precise_decimal::add/rust-native 11.4±0.00ns 11.4±0.00ns 0.00%
precise_decimal::add/wasmer 118.4±0.16ns 118.6±0.09ns +0.17%
precise_decimal::add/wasmer-call-native 488.6±0.38ns 495.8±0.74ns +1.47%
precise_decimal::add/wasmi 757.3±0.92ns 823.4±3.84ns +8.73%
precise_decimal::add/wasmi-call-native 6.8±0.01µs 6.9±0.01µs +1.47%
precise_decimal::div/0 303.8±3.32ns 302.7±1.72ns -0.36%
precise_decimal::from_string/0 194.9±0.23ns 195.1±0.13ns +0.10%
precise_decimal::mul/0 370.8±5.47ns 374.7±1.70ns +1.05%
precise_decimal::mul/rust-native 302.8±0.43ns 303.2±0.61ns +0.13%
precise_decimal::mul/wasmer 3.4±0.00µs 3.4±0.00µs 0.00%
precise_decimal::mul/wasmer-call-native 878.5±1.46ns 845.1±0.62ns -3.80%
precise_decimal::mul/wasmi 107.7±0.24µs 106.3±0.14µs -1.30%
precise_decimal::mul/wasmi-call-native 7.3±0.01µs 7.3±0.01µs 0.00%
precise_decimal::pow/0 1919.5±4.36ns 1912.0±7.74ns -0.39%
precise_decimal::pow/rust-native 1497.9±2.63ns 1459.1±2.69ns -2.59%
precise_decimal::pow/wasmer 16.1±0.03µs 16.1±0.01µs 0.00%
precise_decimal::pow/wasmer-call-native 2.2±0.00µs 2.2±0.00µs 0.00%
precise_decimal::pow/wasmi 521.2±1.27µs 512.3±1.40µs -1.71%
precise_decimal::pow/wasmi-call-native 13.2±0.04µs 13.3±0.02µs +0.76%
precise_decimal::root/0 56.4±0.06µs 57.1±0.04µs +1.24%
precise_decimal::sub/0 9.6±0.02ns 9.6±0.01ns 0.00%
precise_decimal::to_string/0 721.7±1.62ns 719.7±3.10ns -0.28%
schema::validate_payload 343.3±0.43µs 342.0±0.55µs -0.38%
transaction::radiswap 5.4±0.02ms 5.3±0.03ms -1.85%
transaction::transfer 1745.1±7.22µs 1750.0±14.09µs +0.28%
transaction_processing::prepare 2.2±0.00ms 2.3±0.00ms +4.55%
transaction_processing::prepare_and_decompile 6.1±0.02ms 6.2±0.04ms +1.64%
transaction_processing::prepare_and_decompile_and_recompile 24.5±0.10ms 24.6±0.79ms +0.41%
transaction_validation::validate_manifest 42.1±0.06µs 42.1±0.03µs 0.00%
transaction_validation::verify_bls_2KB 1062.3±79.75µs 1097.4±136.62µs +3.30%
transaction_validation::verify_bls_32B 1095.9±121.73µs 1061.3±122.83µs -3.16%
transaction_validation::verify_ecdsa 74.3±0.11µs 74.3±0.05µs 0.00%
transaction_validation::verify_ed25519 55.1±0.20µs 54.6±0.17µs -0.91%

@talekhinezh talekhinezh changed the title WIP: Add markdowns Documentation: Add md-book documentation + Rustdocs May 10, 2024
Copy link
Member

@iamyulong iamyulong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good documentation!

radix-blueprint-schema-init/src/lib.rs Outdated Show resolved Hide resolved
radix-blueprint-schema-init/src/lib.rs Outdated Show resolved Hide resolved
radix-engine-interface/src/api/costing_api.rs Outdated Show resolved Hide resolved
radix-engine/book/src/native/auth/auth_stack.svg Outdated Show resolved Hide resolved
radix-engine/book/src/native/auth/system_module.md Outdated Show resolved Hide resolved
radix-engine/book/src/native/auth/system_module.md Outdated Show resolved Hide resolved
radix-engine/book/src/native/auth/system_module.md Outdated Show resolved Hide resolved
radix-engine/book/src/native/auth/system_module.md Outdated Show resolved Hide resolved
@talekhinezh talekhinezh merged commit 59b512c into develop May 24, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants