@turnkey/viem
Version:
Turnkey Helpers to work with Viem
800 lines (514 loc) • 17 kB
Markdown
# @turnkey/viem
## 0.10.5
### Patch Changes
- Updated dependencies [[`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15)]:
- @turnkey/sdk-browser@5.4.1
## 0.10.4
### Patch Changes
- Updated dependencies [[`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e)]:
- @turnkey/sdk-browser@5.4.0
- @turnkey/sdk-server@4.3.0
- @turnkey/http@3.6.0
## 0.10.3
### Patch Changes
- [#777](https://github.com/tkhq/sdk/pull/777) [`cbb0ba0`](https://github.com/tkhq/sdk/commit/cbb0ba0dc2ea960415e1e7f21c3621e85765b02a) Author [@turnekybc](https://github.com/turnekybc) - Publish latest version of @turnkey/viem
- Updated dependencies [[`2db00b0`](https://github.com/tkhq/sdk/commit/2db00b0a799d09ae33fa08a117e3b2f433f2b0b4)]:
- @turnkey/sdk-server@4.2.4
## 0.10.2
### Patch Changes
- Updated dependencies [[`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a)]:
- @turnkey/sdk-browser@5.3.4
- @turnkey/sdk-server@4.2.3
- @turnkey/http@3.5.1
## 0.10.1
### Patch Changes
- Updated dependencies [[`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf)]:
- @turnkey/sdk-browser@5.3.3
## 0.10.0
### Minor Changes
- [#733](https://github.com/tkhq/sdk/pull/733) [`cc463d3`](https://github.com/tkhq/sdk/commit/cc463d3fde57f4d434fc41c5ed4ce42a0a506874) Author [@besler613](https://github.com/besler613) - Typed data hashing is now performed server-side using the new `PAYLOAD_ENCODING_EIP712` encoding, and EIP-712 Policies are supported via the `eth.eip_712` namespace.
## 0.9.12
### Patch Changes
- Updated dependencies []:
- @turnkey/sdk-browser@5.3.2
- @turnkey/sdk-server@4.2.2
## 0.9.11
### Patch Changes
- Updated dependencies [[`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]:
- @turnkey/sdk-browser@5.3.1
- @turnkey/sdk-server@4.2.1
## 0.9.10
### Patch Changes
- Updated dependencies [[`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd), [`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd), [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164)]:
- @turnkey/http@3.5.0
- @turnkey/sdk-browser@5.3.0
- @turnkey/sdk-server@4.2.0
- @turnkey/api-key-stamper@0.4.7
## 0.9.9
### Patch Changes
- Updated dependencies:
- @turnkey/sdk-browser@5.2.3
## 0.9.8
### Patch Changes
- Updated dependencies:
- @turnkey/sdk-browser@5.2.2
## 0.9.7
### Patch Changes
- [#665](https://github.com/tkhq/sdk/pull/665) [`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772) Author [@amircheikh](https://github.com/amircheikh) - Fix for `no runner registered` error when using mismatched versions of turnkey/http
- Updated dependencies [[`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772)]:
- @turnkey/http@3.4.2
- @turnkey/sdk-browser@5.2.1
- @turnkey/sdk-server@4.1.1
## 0.9.6
### Patch Changes
- Updated dependencies [[`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc), [`a38a6e3`](https://github.com/tkhq/sdk/commit/a38a6e36dc2bf9abdea64bc817d1cad95b8a289a), [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2)]:
- @turnkey/sdk-browser@5.2.0
- @turnkey/sdk-server@4.1.0
- @turnkey/http@3.4.1
- @turnkey/api-key-stamper@0.4.6
## 0.9.5
### Patch Changes
- Updated dependencies [[`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412)]:
- @turnkey/sdk-browser@5.1.0
- @turnkey/sdk-server@4.0.1
## 0.9.4
### Patch Changes
- Updated dependencies [[`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0), [`e8a5f1b`](https://github.com/tkhq/sdk/commit/e8a5f1b431623c4ff1cb85c6039464b328cf0e6a)]:
- @turnkey/sdk-browser@5.0.0
- @turnkey/sdk-server@4.0.0
- @turnkey/http@3.4.0
## 0.9.3
### Patch Changes
- Updated dependencies [25ca339]
- @turnkey/sdk-browser@4.3.0
- @turnkey/sdk-server@3.3.0
- @turnkey/http@3.3.0
## 0.9.2
### Patch Changes
- d440e7b: Update `signAuthorization` implementation to explicitly include `yParity` in the response
## 0.9.1
### Patch Changes
- Updated dependencies [3f6e415]
- Updated dependencies [4d1d775]
- @turnkey/sdk-browser@4.2.0
- @turnkey/sdk-server@3.2.0
- @turnkey/http@3.2.0
- @turnkey/api-key-stamper@0.4.5
## 0.9.0
### Minor Changes
- 2f75cf1: Add support for signing Type 3 (EIP-4844) transactions
- Note the inline comments on the `signTransaction` [implementation](https://github.com/tkhq/sdk/blob/5e5666aba978f756e2021c261830effc5559811f/packages/viem/src/index.ts#L392): when signing Type 3 transactions, our Viem implementation will extract the transaction payload (not including blobs, commitments, or proofs), sign it, extract the signature, and then reassemble the entire transaction payload.
- See [with-viem](https://github.com/tkhq/sdk/tree/main/examples/with-viem/) for examples.
### Patch Changes
- Updated dependencies [3e4a482]
- @turnkey/sdk-browser@4.1.0
- @turnkey/sdk-server@3.1.0
- @turnkey/http@3.1.0
## 0.8.0
### Minor Changes
- 1d709ce: - Add support for EIP 7702 (Type 4) transactions by way of a new `signAuthorization` method
- Update upstream `viem` version to `^2.24.2` (required for 7702)
- Introduce new `to` parameter, used for indicating the result shape of `signMessage` (and related) requests
- Affects `signTypedData` as well
- Is used by `signAuthorization`
- As a result, `serializeSignature` is updated as well
## 0.7.2
### Patch Changes
- Updated dependencies [7b72769]
- @turnkey/sdk-server@3.0.1
## 0.7.1
### Patch Changes
- 123406b: The organizationId parameter is ignored when using a client other than TurnkeyClient (e.g., passkeyClient). Consequently, the SDK calls the client without the specified organizationId, which is unintended. This patch resolves the issue
- Updated dependencies [e501690]
- Updated dependencies [d1083bd]
- Updated dependencies [f94d36e]
- @turnkey/sdk-browser@4.0.0
- @turnkey/sdk-server@3.0.0
- @turnkey/http@3.0.0
## 0.7.0
### Minor Changes
- d99fe40: Upgrade upstream viem dependency
### Patch Changes
- Updated dependencies [bf87774]
- @turnkey/sdk-browser@3.1.0
## 0.6.18
### Patch Changes
- Updated dependencies [5ec5187]
- @turnkey/sdk-browser@3.0.1
- @turnkey/sdk-server@2.6.1
## 0.6.17
### Patch Changes
- Updated dependencies [0e4e959]
- Updated dependencies [856f449]
- Updated dependencies [c9ae537]
- Updated dependencies [d4ce5fa]
- Updated dependencies [ecdb29a]
- Updated dependencies [72890f5]
- @turnkey/sdk-browser@3.0.0
- @turnkey/sdk-server@2.6.0
- @turnkey/http@2.22.0
## 0.6.16
### Patch Changes
- Updated dependencies [93540e7]
- Updated dependencies [fdb8bf0]
- Updated dependencies [9147962]
- @turnkey/sdk-browser@2.0.0
- @turnkey/sdk-server@2.5.0
## 0.6.15
### Patch Changes
- Updated dependencies [233ae71]
- Updated dependencies [9317588]
- @turnkey/sdk-browser@1.16.0
- @turnkey/sdk-server@2.4.0
## 0.6.14
### Patch Changes
- Updated dependencies [56a307e]
- @turnkey/sdk-browser@1.15.0
- @turnkey/sdk-server@2.3.0
- @turnkey/http@2.21.0
## 0.6.13
### Patch Changes
- Updated dependencies [3c44c4a]
- Updated dependencies [bfc833f]
- @turnkey/sdk-browser@1.14.0
- @turnkey/sdk-server@2.2.0
- @turnkey/http@2.20.0
## 0.6.12
### Patch Changes
- Updated dependencies [69d2571]
- Updated dependencies [57f9cb0]
- @turnkey/sdk-browser@1.13.0
- @turnkey/sdk-server@2.1.0
- @turnkey/http@2.19.0
## 0.6.11
### Patch Changes
- Updated dependencies [755833b]
- @turnkey/sdk-browser@1.12.1
- @turnkey/sdk-server@2.0.1
## 0.6.10
### Patch Changes
- Updated dependencies [6695af2]
- Updated dependencies [1ebd4e2]
- @turnkey/sdk-browser@1.12.0
- @turnkey/sdk-server@2.0.0
- @turnkey/http@2.18.0
## 0.6.9
### Patch Changes
- Updated dependencies [053fbfb]
- @turnkey/sdk-browser@1.11.2
- @turnkey/sdk-server@1.7.3
- @turnkey/http@2.17.3
## 0.6.8
### Patch Changes
- Updated dependencies [328d6aa]
- Updated dependencies [b90947e]
- Updated dependencies [2d5977b]
- Updated dependencies [fad7c37]
- @turnkey/sdk-browser@1.11.1
- @turnkey/sdk-server@1.7.2
- @turnkey/api-key-stamper@0.4.4
- @turnkey/http@2.17.2
## 0.6.7
### Patch Changes
- Updated dependencies [7988bc1]
- Updated dependencies [538d4fc]
- Updated dependencies [12d5aaa]
- @turnkey/sdk-browser@1.11.0
- @turnkey/sdk-server@1.7.1
- @turnkey/http@2.17.1
## 0.6.6
### Patch Changes
- @turnkey/sdk-browser@1.10.2
## 0.6.5
### Patch Changes
- Updated dependencies [78bc39c]
- @turnkey/sdk-server@1.7.0
- @turnkey/http@2.17.0
- @turnkey/sdk-browser@1.10.1
## 0.6.4
### Patch Changes
- Updated dependencies [8bea78f]
- @turnkey/sdk-browser@1.10.0
## 0.6.3
### Patch Changes
- Updated dependencies [3dd74ac]
- Updated dependencies [1e36edf]
- Updated dependencies [4df8914]
- Updated dependencies [11a9e2f]
- @turnkey/sdk-browser@1.9.0
- @turnkey/sdk-server@1.6.0
- @turnkey/http@2.16.0
## 0.6.2
### Patch Changes
- Updated dependencies [9ebd062]
- @turnkey/sdk-browser@1.8.0
- @turnkey/sdk-server@1.5.0
- @turnkey/http@2.15.0
## 0.6.1
### Patch Changes
- Updated dependencies [abe7138]
- Updated dependencies [96d7f99]
- @turnkey/sdk-server@1.4.2
- @turnkey/sdk-browser@1.7.1
- @turnkey/http@2.14.2
- @turnkey/api-key-stamper@0.4.3
## 0.6.0
### Minor Changes
- 2bb9ea0: Add synchronous createAccount variant (thank you @mshrieve)
- Closes https://github.com/tkhq/sdk/issues/349
- Originally attributed to https://github.com/tkhq/sdk/pull/348
- Upshot: no change required if your setup was working. However, if you would like a synchronous option for creating a Viem account, now you may do so with `createAccountWithAddress`
### Patch Changes
- Updated dependencies [ff059d5]
- Updated dependencies [ff059d5]
- @turnkey/sdk-browser@1.7.0
- @turnkey/sdk-server@1.4.1
- @turnkey/http@2.14.1
- @turnkey/api-key-stamper@0.4.2
## 0.5.0
### Minor Changes
- 848f8d3: Support awaiting consensus and improve error handling
- Add new error types that extend `BaseError` (and thus implement `error.walk`)
- `TurnkeyConsensusNeededError` wraps consensus-related errors
- `TurnkeyActivityError` wraps base Turnkey errors
- Add a few new helper functions:
- `serializeSignature` serializes a raw signature
- `isTurnkeyActivityConsensusNeededError` and `isTurnkeyActivityError` use `error.walk` to check the type of a Viem error
### Patch Changes
- Updated dependencies [c988ed0]
- Updated dependencies [848f8d3]
- @turnkey/sdk-browser@1.6.0
- @turnkey/sdk-server@1.4.0
- @turnkey/http@2.14.0
## 0.4.31
### Patch Changes
- Updated dependencies [1813ed5]
- @turnkey/sdk-browser@1.5.0
## 0.4.30
### Patch Changes
- Updated dependencies [bab5393]
- Updated dependencies [a16073c]
- Updated dependencies [7e7d209]
- @turnkey/sdk-browser@1.4.0
## 0.4.29
### Patch Changes
- Updated dependencies [93dee46]
- @turnkey/http@2.13.0
- @turnkey/sdk-browser@1.3.0
- @turnkey/sdk-server@1.3.0
## 0.4.28
### Patch Changes
- Updated dependencies [e2f2e0b]
- @turnkey/sdk-browser@1.2.4
- @turnkey/sdk-server@1.2.4
- @turnkey/http@2.12.3
## 0.4.27
### Patch Changes
- Updated dependencies
- @turnkey/sdk-browser@1.2.3
- @turnkey/sdk-server@1.2.3
## 0.4.26
### Patch Changes
- Updated dependencies [2d7e5a9]
- Updated dependencies [f4b607f]
- @turnkey/api-key-stamper@0.4.1
- @turnkey/http@2.12.2
- @turnkey/sdk-browser@1.2.2
- @turnkey/sdk-server@1.2.2
## 0.4.25
### Patch Changes
- Updated dependencies [f17a229]
- @turnkey/http@2.12.1
- @turnkey/sdk-browser@1.2.1
- @turnkey/sdk-server@1.2.1
## 0.4.24
### Patch Changes
- Updated dependencies
- @turnkey/http@2.12.0
- @turnkey/sdk-browser@1.2.0
- @turnkey/sdk-server@1.2.0
## 0.4.23
### Patch Changes
- Updated dependencies
- @turnkey/http@2.11.0
- @turnkey/sdk-browser@1.1.0
- @turnkey/sdk-server@1.1.0
## 0.4.22
### Patch Changes
- Updated dependencies
- @turnkey/sdk-browser@1.0.0
- @turnkey/sdk-server@1.0.0
## 0.4.21
### Patch Changes
- @turnkey/sdk-browser@0.4.1
## 0.4.20
### Patch Changes
- d59e1b6: Add export of turnkey viem account functions
- Updated dependencies [e4b29da]
- @turnkey/sdk-browser@0.4.0
## 0.4.19
### Patch Changes
- Updated dependencies [d409d81]
- @turnkey/sdk-browser@0.3.0
## 0.4.18
### Patch Changes
- @turnkey/sdk-browser@0.2.1
## 0.4.17
### Patch Changes
- Updated dependencies
- Updated dependencies [e4d2a84]
- @turnkey/sdk-browser@0.2.0
- @turnkey/sdk-server@0.2.0
## 0.4.16
### Patch Changes
- Updated dependencies
- @turnkey/sdk-browser@0.1.0
- @turnkey/sdk-server@0.1.0
## 0.4.15
### Patch Changes
- a6502e6: Add support for new Turnkey Client types
## 0.4.14
### Patch Changes
- Updated dependencies [7a9ce7a]
- @turnkey/http@2.10.0
## 0.4.13
### Patch Changes
- Updated dependencies
- @turnkey/http@2.9.1
## 0.4.12
### Patch Changes
- Updated dependencies [83b62b5]
- @turnkey/http@2.9.0
## 0.4.11
### Patch Changes
- Updated dependencies [46a7d90]
- @turnkey/http@2.8.0
## 0.4.10
### Patch Changes
- Updated dependencies
- @turnkey/http@2.7.1
## 0.4.9
### Patch Changes
- Updated dependencies ([c3b423b], [d73725b])
- @turnkey/api-key-stamper@0.4.0
- @turnkey/http@2.7.0
## 0.4.8
### Patch Changes
- 4794c64: Updated dependencies
## 0.4.7
### Patch Changes
- Updated dependencies [f9d636c]
- @turnkey/http@2.6.2
## 0.4.6
### Patch Changes
- Updated dependencies [52e2389]
- @turnkey/http@2.6.1
## 0.4.5
### Patch Changes
- Updated dependencies [7a3c890]
- @turnkey/http@2.6.0
## 0.4.4
### Patch Changes
- Upgrade to Node v18 (#184)
- Updated dependencies
- @turnkey/api-key-stamper@0.3.1
- @turnkey/http@2.5.1
## 0.4.3
### Patch Changes
- Updated dependencies [464ac0e]
- @turnkey/http@2.5.0
## 0.4.2
### Patch Changes
- @turnkey/http@2.4.2
## 0.4.1
### Patch Changes
- Updated dependencies [f87ced8]
- @turnkey/http@2.4.1
## 0.4.0
### Minor Changes
- Use rollup to build ESM and CommonJS, fix ESM support (#174)
### Patch Changes
- Updated dependencies [fc5b291]
- @turnkey/api-key-stamper@0.3.0
- @turnkey/http@2.4.0
## 0.3.4
### Patch Changes
- Updated dependencies
- @turnkey/api-key-stamper@0.2.0
- @turnkey/http@2.3.1
## 0.3.3
### Patch Changes
- Updated dependencies [f1bd68a]
- @turnkey/http@2.3.0
## 0.3.2
### Patch Changes
- Updated dependencies [ed50a0f]
- Updated dependencies
- @turnkey/http@2.2.0
## 0.3.0
### Minor Changes
- cf8631a: Update interface to support `signWith`
This change supports signing with wallet account addresses, private key addresses, or private key IDs. See below for an example:
```js
const httpClient = new TurnkeyClient(
{
baseUrl: "https://api.turnkey.com",
},
// This uses API key credentials.
// If you're using passkeys, use `@turnkey/webauthn-stamper` to collect webauthn signatures:
// new WebauthnStamper({...options...})
new ApiKeyStamper({
apiPublicKey: "...",
apiPrivateKey: "...",
}),
);
// Create the Viem custom account
const turnkeyAccount = await createAccount({
client: httpClient,
organizationId: "...",
signWith: "...",
// optional; will be fetched from Turnkey if not provided
ethereumAddress: "...",
});
```
## 0.2.7
### Patch Changes
- Updated dependencies [bb6ea0b]
- @turnkey/http@2.1.0
## 0.2.6
### Patch Changes
- 59dcd2f: Unpin typescript
- da7c960: Bump Viem dependency to fix `getAddresses()` for LocalAccount
- Updated dependencies
- @turnkey/http@2.0.0
- Updated the shape of signing
## 0.2.5
### Patch Changes
- Updated dependencies
- @turnkey/http@1.3.0
## 0.2.4
### Patch Changes
- 0ec2d94: Addresses a bug when signing raw messages (see https://github.com/tkhq/sdk/issues/116)
## 0.2.3
### Patch Changes
- Updated dependencies
- @turnkey/http@1.2.0
## 0.2.2
### Patch Changes
- Updated dependencies
- @turnkey/api-key-stamper@0.1.1
- @turnkey/http@1.1.1
## 0.2.1
### Patch Changes
- Fix code sample in the README; add more details and links
## 0.2.0
### Minor Changes
- Add new `createAccount` method and deprecates the existing `createApiAccount`. `createAccount` offers a superset of functionality and works with stampers (`@turnkey/api-key-stamper` / `@turnkey/webauthn-stamper`) to integrate with API keys or passkeys.
### Patch Changes
- Updated dependencies: @turnkey/http@1.1.0
- New dependency: @turnkey/api-key-stamper@0.1.0
## 0.1.1
### Patch Changes
- README updates
## 0.1.0
Initial release!