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

sdk release v2023.10.2 #142

Merged
merged 6 commits into from
Oct 20, 2023
Merged

sdk release v2023.10.2 #142

merged 6 commits into from
Oct 20, 2023

Conversation

andrewkmin
Copy link
Collaborator

@andrewkmin andrewkmin commented Oct 19, 2023

Summary & Motivation

Another day another release!

Main updates:

@turnkey/http

  • Consolidated signing routes:
    • We now have a single route, /api/v1/submit/sign_raw_payload for SignRawPayload activities (previously this was split into SignRawPayload and SignRawPayloadV2)
    • This extends to /api/v1/submit/sign_transaction as well. SignTransaction and SignTransactionV2 now have a unified activity: SignTransaction
    • Under the hood, these routes stay largely the same: you can sign raw payloads and transactions with an address (from a wallet account), or a private key ID

@turnkey/viem

  • 59dcd2f: Unpin typescript
  • da7c960: Bump Viem dependency to fix getAddresses() for LocalAccount

Also, deleted some examples as they've been moved to https://github.com/tkhq/demo-viem-passkeys and https://github.com/tkhq/demo-ethers-passkeys, respectively

How I Tested These Changes

@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 19, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@@ -1,5 +1,15 @@
# @turnkey/http

## 1.4.0

### Minor Changes
Copy link
Contributor

@r-n-o r-n-o Oct 19, 2023

Choose a reason for hiding this comment

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

Because we've changed the shape of the params for signing (privateKeyId => signWith) it's technically a breaking change.

Let's mention this in its own line item or section?

### Upgrade notes
* `signRawPayload` and `signTransaction` now expect a `signWith` param instead of `privateKeyId` previously
* `signRawPayload` and `signTransaction` have been updated to expect a new type: `ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2` and `ACTIVITY_TYPE_SIGN_TRANSACTION_V2`, respectively
* if you have policies authorizing `ACTIVITY_TYPE_SIGN_RAW_PAYLOAD` or `ACTIVITY_TYPE_SIGN_TRANSACTION` specifically, they will need to be updated to authorize `ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2` and `ACTIVITY_TYPE_SIGN_TRANSACTION_V2` (or better yet, update your policies to allow all signing actions using policy resources and actions, see https://docs.turnkey.com/managing-policies/examples

After writing this up I think a breaking change is warranted because of the policy implications.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

👍 makes sense. Think it warrants a major change? b3d31ef I can go either way on this

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah I think that's safer. I don't think I'd want a major change if it was another activity type; but given this is signing let's make sure people have a chance to look at the notes when they upgrade. Thanks for putting this together!

@andrewkmin andrewkmin merged commit 95b1352 into main Oct 20, 2023
3 checks passed
@andrewkmin andrewkmin deleted the andrew/sdk-release-v2023.10.2 branch October 20, 2023 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants