-
Notifications
You must be signed in to change notification settings - Fork 14
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
Conversation
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. |
packages/http/CHANGELOG.md
Outdated
@@ -1,5 +1,15 @@ | |||
# @turnkey/http | |||
|
|||
## 1.4.0 | |||
|
|||
### Minor Changes |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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!
Summary & Motivation
Another day another release!
Main updates:
@turnkey/http
/api/v1/submit/sign_raw_payload
forSignRawPayload
activities (previously this was split intoSignRawPayload
andSignRawPayloadV2
)/api/v1/submit/sign_transaction
as well.SignTransaction
andSignTransactionV2
now have a unified activity:SignTransaction
@turnkey/viem
getAddresses()
for LocalAccountAlso, 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