feat: algokit_utils (Rust impl only) #166
Conversation
Had to work around this bug in maturin: PyO3/maturin#2459 This fix is relatively simple but requires you to modify the packages post-installation. A fix (more like feature) can be added to maturin and I think it should be fairly straightforward
There is something weird going on with the env package though. For now you need to bun rm env, run the build script, and then bun i env before running the tests
Mutex works in WASM and only adds a few nanos of overhead, so just easier to use Mutex for both uniffi and wasm
It works, but there seems to be some closure that isn't getting cleaned up properly in the async call
Bun prefers main over module for some reason at runtime. See oven-sh/bun#13430 (comment)
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR adds a pure Rust implementation of the algokit_utils crate for transaction composition and signing, introduces an ffi_mutex crate for FFI-safe interior mutability, and updates workspace and crate configurations for FFI and HTTP client support.
- Introduces
ffi_mutexcrate with a unified mutex/refcell wrapper for Uniffi and WASM. - Implements
algokit_utilswith aComposerfor building and signing Algorand transactions. - Updates workspace members and adjusts crate-types/features in FFI and HTTP client crates.
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/ffi_mutex/src/lib.rs | Adds FfiMutex wrapper selecting tokio::Mutex or RefCell by feature |
| crates/ffi_mutex/Cargo.toml | Defines features and optional dependencies for the FFI mutex crate |
| crates/algokit_utils/src/lib.rs | Implements Composer, transaction building, grouping, and signature logic |
| crates/algokit_utils/Cargo.toml | Configures features and dependencies for the algokit_utils crate |
| crates/algokit_transact_ffi/Cargo.toml | Adds "lib" to crate-type list for the FFI binding crate |
| crates/algokit_http_client/src/lib.rs | Defines HttpClient trait implementations for default and WASM |
| crates/algokit_http_client/Cargo.toml | Sets up features and deps for HTTP client crate |
| crates/algod_api/src/lib.rs | Implements AlgodClient wrapper over an HTTP client to fetch params |
| crates/algod_api/Cargo.toml | Configures features and dependencies for the algod_api crate |
| Cargo.toml | Updates workspace members to include new crates (ffi_mutex, algokit_utils, etc.) |
| // The rest of these fields are set further down per txn | ||
| first_valid: 0, | ||
| last_valid: 0, |
There was a problem hiding this comment.
The first_valid and last_valid fields are hard-coded to 0. You should initialize them from suggested_params.last_round or common_params.first_valid_round/last_valid_round to ensure transactions have a valid window.
| // The rest of these fields are set further down per txn | |
| first_valid: 0, | |
| last_valid: 0, | |
| // Initialize valid round range dynamically | |
| first_valid: common_params.first_valid_round.unwrap_or(suggested_params.last_round), | |
| last_valid: suggested_params.last_round, |
Copilot uses AI. Check for mistakes.
| pub rekey_to: Option<Address>, | ||
| pub note: Option<Vec<u8>>, | ||
| pub lease: Option<[u8; 32]>, | ||
| pub static_fee: Option<u64>, |
There was a problem hiding this comment.
The static_fee (and related validity_window, first_valid_round, last_valid_round) fields on CommonParams are never used when building transactions. Consider applying static_fee to override the calculated fee and use the validity fields when setting first_valid/last_valid.
Copilot uses AI. Check for mistakes.
| let result = self.get(&path).await.map_err(|e| { | ||
| HttpError::HttpError( | ||
| e.as_string().unwrap_or( | ||
| "A HTTP error ocurred in JavaScript, but it cannot be converted to a string" |
There was a problem hiding this comment.
Fix spelling: change "ocurred" to "occurred" in the error message.
| "A HTTP error ocurred in JavaScript, but it cannot be converted to a string" | |
| "A HTTP error occurred in JavaScript, but it cannot be converted to a string" |
Copilot uses AI. Check for mistakes.
| } | ||
|
|
||
| /// A temporary AlgodClient until the proper client is generated. | ||
| /// The exepectation is that this client will use a HttpClient to make requests to the Algorand API |
There was a problem hiding this comment.
Fix spelling: change "exepectation" to "expectation" in the documentation comment.
| /// The exepectation is that this client will use a HttpClient to make requests to the Algorand API | |
| /// The expectation is that this client will use a HttpClient to make requests to the Algorand API |
Copilot uses AI. Check for mistakes.
|
Will want to loop back and take a closer look at those copilot comments, but going ahead and merging as is to unblock everyone else adding new txn types to composer |
|
🎉 This PR is included in version 1.0.0-alpha.22 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.0.0-alpha.20 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.0.0-alpha.19 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.0.0-alpha.21 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Follows up on the spike in #119 but removes the FFI utils crate and packages for now. When working on them I realized that they will take a decent amount of time to implement due do all the new types/traits, so figured it makes more sense to review the rust impl on its own and then later PR the FFI crate and packages