feat: add cost_* System API and methods that calculate cycles cost under the hood #570
Conversation
ic-cdk/src/api.rs
Outdated
| /// Gets the cost of a canister http outcall via [`http_request`](crate::management_canister::http_request). | ||
| pub fn cost_http_request(request_size: u64, max_res_bytes: u64) -> u128 { | ||
| let mut dst = 0u128; | ||
| // SAFETY: `dst` is a mutable reference to a 16-byte buffer, which is the expected size for `ic0.cost_http_request`. | ||
| unsafe { ic0::cost_http_request(request_size, max_res_bytes, &mut dst as *mut u128 as usize) } | ||
| dst | ||
| } |
There was a problem hiding this comment.
This direct binding to the system API is already useful, but there is an explicit wish from users to have a slightly higher-level API as well, which accepts a &HttpRequestArgs, which is what the caller already constructs before making the actual http outcall. The necessary information to go from HttpRequestArgs to request_size and max_res_bytes are in the spec, so I find it reasonable to perform this conversion in the CDK. Could you please also add such a convenience function? (section in design doc)
The same is true for cost_sign_with_ecdsa, cost_sign_with_schnorr and the future vetkd cost endpoint.
There was a problem hiding this comment.
Less importantly, more for consistency, the cost_call could also have an equivalent where the users passes the method name plus a reference to the actual payload.
SDK-1963
Description
ic0according to Add system API endpoints for cycle cost calculation portal#4110.cost_*System API inapi.rs._with_cyclessuffix from some Management canister methodscyclesas an argument.cost_*API.Note: No binding for
cost_vetkd_derive_encrypted_keybecause the corresponding Management canister methods hasn't been included.How Has This Been Tested?
Updated related e2e tests.
Checklist: