Update for v.2025.12.2 #66
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
narimonf
force-pushed
the
nari/update_for_v.2025.12.1
branch
from
c12e17a to
c9324b2
Compare
narimonf
force-pushed
the
nari/update_for_v.2025.12.1
branch
2 times, most recently
from
2019de0 to
7fb964d
Compare
r-n-o
reviewed
Dec 10, 2025
Contributor
r-n-o
left a comment
r-n-o
left a comment
There was a problem hiding this comment.
Consider me impressed!
- the builder arg for app proof generation is looking great: it's out of the way for most callers, and easy to use for interested parties
- the wrapper struct is adding a bit of extra boilerplate (
.result), but I think that'll be useful for more than just app proofs! Having the activity ID returned is nice for other reasons (e.g. get votes, or get full activity by ID to get the intent, that kind of thing)
Comment on lines
+48
to
+61
| #[derive(Debug, Clone)] | ||
| pub struct ActivityResult<T> { | ||
| /// The typed result specific to this activity (e.g., `CreateWalletResult`, `SignTransactionResult`) | ||
| pub result: T, | ||
|
|
||
| /// The unique identifier for this activity | ||
| pub activity_id: String, | ||
|
|
||
| /// The status of the activity | ||
| pub status: ActivityStatus, | ||
|
|
||
| /// Proofs that can be used to verify the activity was performed in a secure Turnkey enclave. | ||
| pub app_proofs: Vec<AppProof>, | ||
| } |
Comment on lines
+258
to
+273
| /// Enable app proof generation for all activity requests. | ||
| /// | ||
| /// When enabled, the server will return app proofs with each response | ||
| /// that can be independently verified. | ||
| /// | ||
| /// # Example | ||
| /// ```rust,ignore | ||
| /// let client = TurnkeyClient::builder() | ||
| /// .api_key(api_key) | ||
| /// .build()? | ||
| /// .with_app_proofs(); | ||
| /// ``` | ||
| pub fn with_app_proofs(mut self) -> Self { | ||
| self.generate_app_proofs = Some(true); | ||
| self | ||
| } |
| /// | ||
| /// {description} | ||
| pub async fn {fn_name}(&self, organization_id: String, timestamp_ms: u128, params: immutable_activity::{activity_intent}) -> Result<immutable_activity::{activity_result}, TurnkeyClientError> {{ | ||
| pub async fn {fn_name}(&self, organization_id: String, timestamp_ms: u128, params: immutable_activity::{activity_intent}) -> Result<ActivityResult<immutable_activity::{activity_result}>, TurnkeyClientError> {{ |
Contributor
There was a problem hiding this comment.
Arguably this interface change is a breaking change. So maybe we should mark it as such in the changelog? Users of the SDK will have to update their code.
Contributor
Author
There was a problem hiding this comment.
You're very right. Fixed
client/CHANGELOG.md
Outdated
| ### Other | ||
|
|
||
| - Define activity result wrapper so that we return app proofs | ||
| - add with_app_proofs() method to client to toggle generate_app_proofs so that all calls don't have to be updated to populate the new optional field |
Contributor
There was a problem hiding this comment.
sounds like this should be in the ### Added section rather than "other"! Pretty big addition!
(and see my other comment, I think it's worth flagging the new return type: we go from typed results to a typed wrapper struct)
Contributor
Author
There was a problem hiding this comment.
I misunderstood the changelog's structure haha I pattern-matched the entry right below. Fixed!
BREAKING CHANGE: consumers must now handle wrapped activity results
narimonf
force-pushed
the
nari/update_for_v.2025.12.1
branch
from
7fb964d to
7d9ddc3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
generate_app_proofsby adding awith_app_proofs()method toclient